Copyright © 2005-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]

Public Function PlayListStop (

nPlayerIndex as Int16,

bStopCurrSound as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes PlayListStop (

Int16 nPlayerIndex,

bool bStopCurrSound

);


 

[C++]

public: enumErrorCodes PlayListStop (

Int16 nPlayerIndex,

bool bStopCurrSound

);


 

 

Parameter

Description

 

 

nPlayerIndex

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:

Value

Meaning

false

Stops the playlist after completing the currently playing sound

true

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.NOERROR (0)

The method call was successful.