Remarks
Obtains the current volume balance for the given player. The volume balance can be modified through the StreamBalanceSet method.
Syntax
[Visual Basic]
Public Function StreamBalanceGet (
nPlayerIndex as Int16,
ByRef fValue as float
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes StreamBalanceGet (
Int16 nPlayerIndex,
ref float fValue
);
|
|
[C++]
public: enumErrorCodes StreamBalanceGet (
Int16 nPlayerIndex,
float __gc *fValue
);
|
|
Parameter
|
Description
|
|
|
nPlayerIndex
|
Number representing the zero-based index of the involved player
|
nValue
|
Reference that, on return from the method call, will contain the volume balance value in the range from -50 to 50. The value 0 means that the balance is centred
|
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
|
|
