Copyright © 2005-2018 MultiMedia Soft

PlayListLoadSync method

Previous pageReturn to chapter overviewNext page

Remarks

 

Loads a playlist from a file through a secondary thread.

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 CallbackForPlayersEvents delegate which is invoked with the nEvent parameter set to EV_PLAYLIST_LOAD_STARTED, EV_PLAYLIST_LOAD_PERC and EV_PLAYLIST_LOAD_DONE..

 

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

 

 

Syntax

 

[Visual Basic]

Public Function PlayListLoadSync (

nPlayerIndex as Int16,

strPathname as string,

nMode as enumPlayListModes

) as enumErrorCodes


 

[C#]

public enumErrorCodes PlayListLoadSync (

Int16 nPlayerIndex,

string strPathname,

enumPlayListModes nMode

);


 

[C++]

public: enumErrorCodes PlayListLoadSync (

Int16 nPlayerIndex,

string strPathname,

enumPlayListModes nMode

);


 

 

Parameter

Description

 

 

nPlayerIndex

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 be longer.

PLAYLIST_AUTOMATION_MODE

2

Automation mode: allows the use of the PDJ playlist format with fader attributes: trying to load a playlist in a format different from PDJ will cause the method to return an error.

 

 

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.