Methods > Players and stream mixers > StreamVolumeLevelGet method

Remarks

Retrieves the current volume for the given player. The volume can be changed through the StreamVolumeLevelSet method.

Syntax

[Visual Basic]

Public StreamVolumeLevelGet (

nPlayerIndex as Int16,

fValue as Single,

[C#]

public enumErrorCodes StreamVolumeLevelGet (

Int16 nPlayerIndex,

ref float fValue,

);

[C++]

public: enumErrorCodes StreamVolumeLevelGet (

Int16 nPlayerIndex,

float __gc *fValue,

);

Parameter

Description

nPlayerIndex

Number representing the zero-based index of the player whose volume will change

fValue

Reference that, on return from the method call, will contain the current volume (the meaning of the value depends upon the nScaleType parameter).

nScaleType

The volume scaling type.

Supported values are the following:

Mnemonic constant

Value

Meaning

SCALE_LINEAR

The returned 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 returned 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.NOERROR (0)	The method call was successful.