PreAmplifierEnable method

PreAmplifierEnable method

Remarks

Enables/disables pre-amplification of the loaded sound.

For stereo and mono sounds the current pre-amplification value can be obtained through the PreAmplifierGetValue method and changed through the PreAmplifierSetValue method.

For multi-channel songs like 5.1 or 7.1 the current pre-amplification value assigned to each speaker can be obtained through the PreAmplifierGetSpeakerValue method and changed through the PreAmplifierSetSpeakerValue method.

Syntax

[Visual Basic]

control.PreAmplifierEnable (

nPlayer as Integer,

bEnable as enumBoolean

) as enumErrorCodes

[C++]

short control.PreAmplifierEnable (

short nPlayer,

short bEnable

);

Parameter

Description

nPlayer

Number representing the zero-based index of the involved player

bEnable

Boolean value indicating if pre-amplification is enabled or disabled.

Supported values are the following:

Mnemonic constant	Value	Meaning
BOOL_FALSE (default)	0	Disables pre-amplification
BOOL_TRUE	1	Enables pre-amplification

Return value

Value	Meaning

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

Return to Table of contents