Effects.PlaybackPitchGet method |
|
Remarks
Obtains the sound pitch or key. The pitch can be modified through the Effects.PlaybackPitchSet method.
Further details about songs mixing can be found inside the How to mix your songs section.
See the How to apply special effects to a playing sound section for further details.
Syntax
[Visual Basic] Public Function PlaybackPitchGet ( nPlayerIndex as Int16, ByRef fPitch as Single ) as Single |
[C#] public float PlaybackPitchGet ( Int16 nPlayerIndex, ref float fPitch ); |
[C++] public: float PlaybackPitchGet ( Int16 nPlayerIndex, float __gc *fPitch ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the involved player |
fPitch |
Reference that, on return from the method call, will contain the Pitch variation expressed in semitones; supported values are from -50 to 50. |
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. |