Methods > Init and info > OutputVolumeSet method

Remarks

Changes the playback volume: changing this volume will not affect the volume of other applications. The current volume can be retrieved through the OutputVolumeGet method.

Syntax

[Visual Basic]

Public Function OutputVolumeSet (

nVolume as float,

nScaleType as enumVolumeScales

) as enumErrorCodes

[C#]

public enumErrorCodes OutputVolumeSet (

float nVolume,

enumVolumeScales nScaleType

);

[C++]

public: enumErrorCodes OutputVolumeSet (

float nVolume,

enumVolumeScales nScaleType

);

Parameter

Description

nVolume

Number representing the new volume (the meaning of the passed value depends upon the nScaleType parameter).

nScaleType

The volume scaling type.

Supported values are the following:

Mnemonic value

Value

Meaning

SCALE_LINEAR

The passed volume is based upon a linear scale and can be in the range from 0.0 (silence) to 100.0 (max volume)

SCALE_LOG

The passed volume, expressed in dB, is based upon a logarithmic scale and can be in the range from -100 (silence) to 0 (max volume)

The actual applied formula for converting a linear volume into a logarithmic volume is the following:

VolumeInDB = 20 * log10 (VolumeLinear/100)

The C syntax for converting a logarithmic volume into a linear volume is the following:

VolumeLinear = 100 * pow (10, VolumeInDB/20);

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumErrorCodes.ERR_NOERROR (0)	The method call was successful.