Effects.SoundDirectionGet method |
|
Remarks
Obtains the current sound's playback direction. The playback direction can be modified through the SoundDirectionSet method.
See the How to apply special effects to a playing sound section for further details.
Syntax
[Visual Basic] Public Function SoundDirectionGet ( nPlayerIndex as Int16, ByRef nDirection as enumSoundDirections ) as enumSoundDirections |
[C#] public enumSoundDirections SoundDirectionGet ( Int16 nPlayerIndex, ref enumSoundDirections nDirection ); |
[C++] public: enumSoundDirections SoundDirectionGet ( Int16 nPlayerIndex, enumSoundDirections __gc *nDirection ); |
Parameter |
Description |
|||||||||
|
|
|||||||||
nPlayerIndex |
Number representing the zero-based index of the involved player |
|||||||||
nDirection |
Reference that, on return from the method call, will contain the current playback direction. 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. |