Copyright © 2005-2018 MultiMedia Soft

PlayListSetShuffle method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets the playlist execution in random order.

 

The execution order is changed each time this method is called with the bShuffle parameter set to "true".

If the playlist has the Loop mode set to "true" (through the PlayListSetLoop method), each time the playlist is completed the execution order is randomly changed.

 

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

 

 

Syntax

 

[Visual Basic]

Public Function PlayListSetShuffle (

nPlayerIndex as Int16,

bShuffle as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes PlayListSetShuffle (

Int16 nPlayerIndex,

bool bShuffle

);


 

[C++]

public: enumErrorCodes PlayListSetShuffle (

Int16 nPlayerIndex,

bool bShuffle

);


 

 

 

Parameter

Description

 

 

nPlayerIndex

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

bShuffle

Boolean value that specifies to execute the playlist in shuffle mode

Supported values are the following:

Value

Meaning

false

Playlist is executed in ordered mode

true

Playlist is executed in Shuffle mode

 

 

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.