Copyright © 2005-2018 MultiMedia Soft

PlaySoundRangeLoop method

Previous pageReturn to chapter overviewNext page

Remarks

 

Plays in loop mode 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,

 

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.

 

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

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 PlaySoundRangeLoop (

nPlayerIndex as Int16,

nFromPosition as Int32,

nToPosition as Int32,

nLoopCount as Int32,

) as enumErrorCodes


 

[C#]

public enumErrorCodes PlaySoundRangeLoop (

Int16 nPlayerIndex,

Int32 nFromPosition,

Int32 nToPosition,

Int32 nLoopCount

);


 

[C++]

public: enumErrorCodes PlaySoundRangeLoop (

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