|
Effects.PreAmplifierEnable method |
  
|
|
Effects.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 Effects.PreAmplifierGetValue method and changed through the Effects.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 Effects.PreAmplifierGetSpeakerValue method and changed through the PreAmplifierSetSpeakerValue method.
See the How to apply special effects to a playing sound section for further details.
Syntax
[Visual Basic] Public Function PreAmplifierEnable ( nPlayerIndex as Int16, bEnable as Boolean ) as enumErrorCodes |
[C#] public enumErrorCodes PreAmplifierEnable ( Int16 nPlayerIndex, bool bEnable ); |
[C++] public: enumErrorCodes PreAmplifierEnable ( Int16 nPlayerIndex, bool bEnable ); |
Parameter |
Description |
||||||
|
|
||||||
nPlayerIndex |
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:
|
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. |
