Effects.MPXSetVocalAttenuation method |
|
Remarks
Sets the percentage of attenuation applied to the right channel of the original MPX file. This method call has no effect until the MPX DSP effect is enabled by a call to the Effects.MPXEnable method.
See the How to apply special effects to a playing sound section for further details.
Syntax
[Visual Basic] Public Function MPXSetVocalAttenuation ( nPlayerIndex as Int16, nAttenuation as Int16 ) as enumErrorCodes |
[C#] public enumErrorCodes MPXSetVocalAttenuation ( Int16 nPlayerIndex, Int16 nAttenuation ); |
[C++] public: enumErrorCodes MPXSetVocalAttenuation ( Int16 nPlayerIndex, Int16 nAttenuation ); |
Parameter |
Description |
|
|
nPlayer |
Number representing the zero-based index of the involved player |
nAttenuation |
Attenuation value expressed in percentage. If set to 100 no voice will be heard while if set to 0 the full voice will be heard. |
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. |