Copyright © 2005-2018 MultiMedia Soft

PlayListLoad method

Previous pageReturn to chapter overviewNext page

Remarks

 

Loads a playlist from the specified file. A call to this method won't return control to the container application until the playlist has been loaded completely so, if the playlist should be very long, it could block your user interface for a while; for this reason there is the possibility to call the PlayListLoadSync method which will perform playlist analysis and loading in a separate thread.

 

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

 

 

Syntax

 

[Visual Basic]

Public Function PlayListLoad (

nPlayerIndex as Int16,

strPathname as string,

nMode as enumPlayListModes

) as enumErrorCodes


 

[C#]

public enumErrorCodes PlayListLoad (

Int16 nPlayerIndex,

string strPathname,

enumPlayListModes nMode

);


 

[C++]

public: enumErrorCodes PlayListLoad (

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.