PlayListLoadSync method

PlayListLoadSync method

Loads a playlist from a file in synchronized mode.

Differently from the PlayListLoad method, this call will perform playlist loading and analysis inside a secondary thread, avoiding any block of the user interface when dealing with very long playlists: in this case the container application is informed about the loading advancement through the PlayListLoadStart, PlayListLoadPerc and PlayListLoadDone events.

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

Syntax

[Visual Basic]

control.PlayListLoadSync (

nPlayer as Integer,

strPathname as String,

nMode as enumPlayListModes

) as enumErrorCodes

[C++]

short control.PlayListLoadSync (

short nPlayer,

LPCTSTR strPathname,

short nMode

);

Parameter

Description

nPlayer

Number representing the zero-based index of the player that will own the new playlist

strPathname

String containing the name of the playlist file: accepted playlist formats are M3U and PLS

nMode

Loading mode.

Supported values are the following:

Mnemonic constant	Value	Meaning
PLAYLIST_SPEED_MODE	0	Speed mode: playlist songs analysis is not performed: suggested when adding items coming from a local network
PLAYLIST_FULL_MODE	1	Full mode: will be calculated the duration of each of the local (not Internet) playlist items. The playlist loading will require a longer time.

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.