|
PlaySoundRange method |
  
|
|
PlaySoundRange method |
|
Remarks
Plays a specific range of the song that has been previously loaded through one of the many methods having the "Load" prefix like LoadSound or LoadSoundFromMemory,
By default playback continues till the end of the defined range until the final position is not moved through the PlaySoundMoveFinalPos method.
A successful call to this method invokes the CallbackForPlayersEvents delegate with the nEvent parameter set to EV_SOUND_PLAYING.
Once the sound has been performed completely, the CallbackForPlayersEvents delegate is invoked with the nEvent parameter set to EV_SOUND_DONE..
Syntax
[Visual Basic] Public Function PlaySoundRange ( nPlayerIndex as Int16, nFromPosition as Int32, nToPosition as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes PlaySoundRange ( Int16 nPlayerIndex, Int32 nFromPosition, Int32 nToPosition ); |
[C++] public: enumErrorCodes PlaySoundRange ( Int16 nPlayerIndex, Int32 nFromPosition, Int32 nToPosition ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the player that will play the sound |
nFromPosition |
Range starting point expressed in the unit specified by the ScaleUnits property. |
nToPosition |
Range ending point expressed in the unit specified by the ScaleUnits property. Set this value to -1 for playing till the song end |
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 |
