Copyright © 2001-2018 MultiMedia Soft

PlayListStop method

Previous pageReturn to chapter overviewNext page

Remarks

 

Stops execution of the playlist associated with the specified player.

 

For further details about playlists management see the How to create and manage a playlist tutorial.

 

 

Syntax

 

[Visual Basic]

control.PlayListStop (

nPlayer as Integer,

bStopCurrSound as enumBoolean

) as enumErrorCodes


 

[C++]

short control.PlayListStop (

short nPlayer,

short bStopCurrSound

);


 

 

Parameter

Description

 

 

nPlayer

Number representing the zero-based index of the player that owns the playlist

bStopCurrSound

Boolean value that specifies if also the sound currently playing must be stopped.

Supported values are the following:

Mnemonic constant

Value

Meaning

BOOL_FALSE

0

Stops the playlist after completing the currently playing sound

BOOL_TRUE

1

Stops both the playlist and the currently playing sound

 

Return value

 

Value

Meaning

 

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.ERR_NOERROR (0)

The call was successful.