MJPlaylistAutomation: Difference between revisions
No edit summary |
No edit summary |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
===MJFilesAutomation * GetFiles()=== |
===MJFilesAutomation * GetFiles()=== |
||
'''Description:''' gets the collection of files in the playlist<br> |
'''Description:''' gets the collection of files in the playlist<br> |
||
'''Return Value:''' MJFilesAutomation interface |
'''Return Value:''' [[MJFilesAutomation]] interface |
||
===boolean AddFile(string strFilename, number nLocation)=== |
===boolean AddFile(string strFilename, number nLocation)=== |
||
| Line 26: | Line 26: | ||
'''Parameters:''' |
'''Parameters:''' |
||
* '''bstrProperty''': the name of the property |
* '''bstrProperty''': the name of the property |
||
'''Return Value:''' the value of the property for this playlist |
'''Return Value:''' the value of the property for this playlist<br> |
||
'''Properties (not complete list):''' |
|||
* '''Type''': 0 = playlist, 1 = playlist group, 2 = smartlist, 3 = special (e.g. 'Current Playcharts') |
|||
===void Set(string strProperty, string bstrValue)=== |
===void Set(string strProperty, string bstrValue)=== |
||
| Line 49: | Line 51: | ||
===string Path() (read / write)=== |
===string Path() (read / write)=== |
||
'''Description:''' the path of the playlist, delimited by backslashes (note: does not contain the name) (i.e. "Mixes\\New Playlist Group")<br> |
'''Description:''' the path of the playlist, delimited by backslashes (note: does not contain the name) (i.e. "Mixes\\New Playlist Group")<br> |
||
[[Category:COM Automation]] |
|||
Latest revision as of 05:39, 4 May 2015
interface for working with a single playlist
Functions
MJFilesAutomation * GetFiles()
Description: gets the collection of files in the playlist
Return Value: MJFilesAutomation interface
boolean AddFile(string strFilename, number nLocation)
Description: adds new file to the playlist
Parameters:
- strFilename: the filename of the file to add
- nLocation: position of the file in the playlist. If position -1, the file will be added to the end of the playlist.
Return Value: 0 on failure, non-zero on success
boolean RemoveFile(string strFilename)
Description: removes existing file from the playlist
Parameters:
- strFilename: the filename of the file to delete
Return Value: 0 on failure, non-zero on success
long GetID()
Description: returns the ID associated with a playlist
Return Value: the ID
string Get(string bstrProperty)
Description: lookup a property associated with a playlist
Parameters:
- bstrProperty: the name of the property
Return Value: the value of the property for this playlist
Properties (not complete list):
- Type: 0 = playlist, 1 = playlist group, 2 = smartlist, 3 = special (e.g. 'Current Playcharts')
void Set(string strProperty, string bstrValue)
Description: change the value of a property for this playlist
Parameters:
- strProperty: the property name
- bstrValue: The new value
boolean SaveAsRSS(string strFilename, string strURLPrefix, string strUser, string strEmail)
Description: 11.1.134 or higher, saves the playlist as an RSS (PodCast/PerbCast) file
Parameters:
- strFilename: the filename of the RSS file
- strURLPrefix: The URL prefix which will be concatenated with the keys of the playlist files to form the URL for accessing them
- strUser: the name of the PerbCast creator
- strEmail: the e-mail address of the PerbCast creator
Return Value: 0 on failure, non-zero on success
Properties
string Name() (read / write)
Description: the name of the playlist (i.e. "My Playlist")
string Path() (read / write)
Description: the path of the playlist, delimited by backslashes (note: does not contain the name) (i.e. "Mixes\\New Playlist Group")