Difference between revisions of "MJPlaylistsAutomation"
From JRiverWiki
Rubberduck (talk | contribs) (→MJPlaylistAutomation * GetPlaylist(number nPlaylist)) |
|||
| Line 6: | Line 6: | ||
===MJPlaylistAutomation * GetPlaylist(number nPlaylist)=== | ===MJPlaylistAutomation * GetPlaylist(number nPlaylist)=== | ||
| − | '''Description:''' gets the MJPlaylistAutomation interface (see below) for the given playlist index<br> | + | '''Description:''' gets the [[MJPlaylistAutomation]] interface (see below) for the given playlist index<br> |
'''Parameters:''' | '''Parameters:''' | ||
* '''nPlaylist''': the index of the playlist to retrieve (0 to GetNumberPlaylists() - 1). To retrieve Top Hits and Recently Imported playlists use index -1 and -2 respectively. | * '''nPlaylist''': the index of the playlist to retrieve (0 to GetNumberPlaylists() - 1). To retrieve Top Hits and Recently Imported playlists use index -1 and -2 respectively. | ||
| − | '''Return Value:''' MJPlaylistAutomation interface | + | '''Return Value:''' MJPlaylistAutomation interface |
===MJPlaylistAutomation * CreatePlaylist(string PlaylistPath, string PlaylistName)=== | ===MJPlaylistAutomation * CreatePlaylist(string PlaylistPath, string PlaylistName)=== | ||
Revision as of 17:53, 2 February 2013
represents a collection of playlists
Contents
- 1 Functions
- 1.1 number GetNumberPlaylists()
- 1.2 MJPlaylistAutomation * GetPlaylist(number nPlaylist)
- 1.3 MJPlaylistAutomation * CreatePlaylist(string PlaylistPath, string PlaylistName)
- 1.4 boolean DeletePlaylist(string PlaylistPath, string PlaylistName)
- 1.5 IMJPlaylistAutomation *CreateServicelist(string Path, string Name, string Service, string ServiceID, string ServiceData)
Functions
number GetNumberPlaylists()
Description: returns the number of playlists contained in the collection
Return Value: number of playlists
MJPlaylistAutomation * GetPlaylist(number nPlaylist)
Description: gets the MJPlaylistAutomation interface (see below) for the given playlist index
Parameters:
- nPlaylist: the index of the playlist to retrieve (0 to GetNumberPlaylists() - 1). To retrieve Top Hits and Recently Imported playlists use index -1 and -2 respectively.
Return Value: MJPlaylistAutomation interface
MJPlaylistAutomation * CreatePlaylist(string PlaylistPath, string PlaylistName)
Description: creates new playlist at the specified location
Parameters:
- PlaylistPath: location of the playlist. If empty, the playlist will be created in the root of the playlist tree.
- PlaylistName: name of the new playlist
Return Value: MJPlaylistAutomation interface
boolean DeletePlaylist(string PlaylistPath, string PlaylistName)
Description: deletes existing playlist
Parameters:
- PlaylistPath: location of theplaylist.
- PlaylistName: name of the new playlist
Return Value: true - if success, otherwise false.
IMJPlaylistAutomation *CreateServicelist(string Path, string Name, string Service, string ServiceID, string ServiceData)
Description: Finds or creates the playlist associated with a service
Parameters:
- Path: Not Used
- Name: The name of the playlist
- Service: The name of the service
- ServiceID: The ID of the service
- ServiceData: Service-specific data
Return Value: the MJPlaylistAutomation interface
