sbIDynamicPlaylistService Interface Reference

import"sbIDynamicPlaylistService.idl";

Inheritance diagram for sbIDynamicPlaylistService:
[legend]
Collaboration diagram for sbIDynamicPlaylistService:
[legend]

Public Member Functions

sbIMediaList createList (in sbILibrary aLibrary, in nsIURI aUri, in unsigned long aIntervalSeconds, in nsILocalFile aDestinationDirectory)
 Create a new dynamnic playlist. More...
 
sbIMediaList createPodcast (in sbILibrary aLibrary, in nsIURI aUri, [optional] in sbIPropertyArray aProperties)
 Create a new podcast. More...
 
void updateList (in sbIMediaList aMediaList, in nsIURI aUri, in unsigned long aIntervalSeconds, in nsILocalFile aDestinationDirectory)
 Update a new dynamnic playlist. More...
 
void updateAllNow ()
 Force an update of all dynamic playlists. More...
 
void updateNow (in sbIMediaList aMediaList)
 Force an update of a specified dynamic playlist. More...
 

Public Attributes

readonly attribute
nsISimpleEnumerator 
scheduledLists
 Returns an enumerator of all dynamic playlists as |sbIMediaList|s. More...
 

Detailed Description

Definition at line 45 of file sbIDynamicPlaylistService.idl.

Member Function Documentation

sbIMediaList sbIDynamicPlaylistService::createList ( in sbILibrary  aLibrary,
in nsIURI  aUri,
in unsigned long  aIntervalSeconds,
in nsILocalFile  aDestinationDirectory 
)

Create a new dynamnic playlist.

Parameters
aLibraryThe library in which to create the new list
aUriThe URL that will be read to gather tracks for the list
aIntervalSecondsInterval between updates, in seconds
aDestinationDirectoryDirectory that the downloaded files will be saved in. If null, the default download directory is used.
Returns
sbIMediaList The new dynamic playlist
sbIMediaList sbIDynamicPlaylistService::createPodcast ( in sbILibrary  aLibrary,
in nsIURI  aUri,
[optional] in sbIPropertyArray  aProperties 
)

Create a new podcast.

Parameters
aLibraryThe library in which to create the new podcast
aUriThe URL of the podcast feed
aPropertiesOptional initial properties for this new podcast
void sbIDynamicPlaylistService::updateAllNow ( )

Force an update of all dynamic playlists.

void sbIDynamicPlaylistService::updateList ( in sbIMediaList  aMediaList,
in nsIURI  aUri,
in unsigned long  aIntervalSeconds,
in nsILocalFile  aDestinationDirectory 
)

Update a new dynamnic playlist.

Parameters
aMediaListThe dynamic playlist to update
aUriThe URL that will be read to gather tracks for the list
aIntervalSecondsInterval between updates, in seconds
aDestinationDirectoryDirectory that the downloaded files will be saved in. If null, the default download directory is used.
void sbIDynamicPlaylistService::updateNow ( in sbIMediaList  aMediaList)

Force an update of a specified dynamic playlist.

Parameters
aMediaListThe dynamic playlist to update

Member Data Documentation

readonly attribute nsISimpleEnumerator sbIDynamicPlaylistService::scheduledLists

Returns an enumerator of all dynamic playlists as |sbIMediaList|s.

Definition at line 101 of file sbIDynamicPlaylistService.idl.


The documentation for this interface was generated from the following file: