Copyright © 2005-2011 MultiMedia Soft

PlaySound method

Return to chapter overview

Remarks

 

Plays in loop mode a specific range of the song loaded through one between LoadSound or LoadSoundFromMemory methods.

 

A successful call to this method will fire the SoundPlaying event; each loop completion will cause the control to fire the RangeLoopDone event: the only exception is the completion of the latest loop that will cause the control to fire the SoundDone event.

 

 

Syntax

 

[Visual Basic]

Public Function PlaySound (

nPlayerIndex as Int16,

nFromPosition as Int32,

nToPosition as Int32,

nLoopCount as Int32,

) as enumErrorCodes


 

[C#]

public enumErrorCodes PlaySound (

Int16 nPlayerIndex,

Int32 nFromPosition,

Int32 nToPosition,

Int32 nLoopCount

);


 

[C++]

public: enumErrorCodes PlaySound (

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