|
PlaySoundEnableLoop method |
  
|
|
PlaySoundEnableLoop method |
|
Remarks
Enables looping of a specific range of sound for the given player.
The loop can be disabled at any time in two ways:
| • | by calling the PlaySoundDisableLoop method: in this case the sound will continue playing without interruption until reaching the final position of the established range |
| • | by calling the PlaySound method: in this case the sound will continue playing without interruption until reaching the end of the sound file |
By default playback continues till the end of the defined range until the final position is not moved through the PlaySoundMoveFinalPos method.
If the player should be already in playback state, the following situations may occur:
| • | If the current playback position is located before the position set through the nToPosition parameter, playback will continue without interruption till reaching the position set into the nToPosition parameter where the loop will occur; if you should need an immediate repositioning of the playback position at the beginning of the sound range, use the of the PlaySoundRangeLoop method. |
| • | If the current playback position is located after the position set through the nToPosition parameter, playback is interrupted and restarted from the position set through the nFromPosition parameter. |
If the player should be in stopped state, a successful call to this method invokes the CallbackForPlayersEvents delegate with the nEvent parameter set to EV_SOUND_PLAYING.
Each loop completion invokes the CallbackForPlayersEvents delegate with the nEvent parameter set to EV_RANGE_LOOP_DONE : the only exception is the completion of the latest loop where the CallbackForPlayersEvents delegate is invoked with the nEvent parameter set to EV_SOUND_DONE.
Syntax
[Visual Basic] Public Function PlaySoundEnableLoop ( nPlayerIndex as Int16, nFromPosition as Int32, nToPosition as Int32, nLoopCount as Int32, ) as enumErrorCodes |
[C#] public enumErrorCodes PlaySoundEnableLoop ( Int16 nPlayerIndex, Int32 nFromPosition, Int32 nToPosition, Int32 nLoopCount ); |
[C++] public: enumErrorCodes PlaySoundEnableLoop ( Int16 nPlayerIndex, Int32 nFromPosition, Int32 nToPosition, Int32 nLoopCount ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the player that will play the sound |
nFromPosition |
Range starting point in the unit specified by the ScaleUnits property. Set this value to 0 for playing from the sound beginning. |
nToPosition |
Range ending point in the unit specified by the ScaleUnits property. Set this value to -1 for playing till the song end |
nLoopCount |
Specifies the number of loops over the defined range. Set this value to -1 for setting an infinite loop |
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 |
