Playlist
[XMMSServer]


Detailed Description

This is the playlist control.

A playlist is a central thing in the XMMS server, it tells us what to do after we played the following entry


Functions

xmms_playlist_txmms_playlist_init (void)
 Initializes a new xmms_playlist_t.
gboolean xmms_playlist_advance (xmms_playlist_t *playlist)
 Go to next song in playlist according to current playlist mode.
xmms_medialib_entry_t xmms_playlist_current_entry (xmms_playlist_t *playlist)
 Retrive the currently active xmms_medialib_entry_t.
GTree * xmms_playlist_current_pos (xmms_playlist_t *playlist, gchar *plname, xmms_error_t *err)
 Retrieve the position of the currently active xmms_medialib_entry_t.
const gchar * xmms_playlist_current_active (xmms_playlist_t *playlist, xmms_error_t *err)
 Retrieve the name of the currently active playlist.
gboolean xmms_playlist_remove_by_entry (xmms_playlist_t *playlist, xmms_medialib_entry_t entry)
 Remove all additions of entry in the playlist.
gboolean xmms_playlist_remove (xmms_playlist_t *playlist, gchar *plname, guint pos, xmms_error_t *err)
 Remove an entry from playlist.
gboolean xmms_playlist_add_url (xmms_playlist_t *playlist, gchar *plname, gchar *nurl, xmms_error_t *err)
 Convenient function for adding a URL to the playlist, Creates a xmms_medialib_entry_t for you and adds it to the list.
gboolean xmms_playlist_add_id (xmms_playlist_t *playlist, gchar *plname, xmms_medialib_entry_t file, xmms_error_t *err)
 Adds a xmms_medialib_entry to the playlist.
gboolean xmms_playlist_add_idlist (xmms_playlist_t *playlist, gchar *plname, xmmsc_coll_t *coll, xmms_error_t *err)
gboolean xmms_playlist_add_collection (xmms_playlist_t *playlist, gchar *plname, xmmsc_coll_t *coll, GList *order, xmms_error_t *err)
void xmms_playlist_add_entry (xmms_playlist_t *playlist, gchar *plname, xmms_medialib_entry_t file, xmms_error_t *err)
 Add an entry to the playlist without validating it.
void xmms_playlist_add_entry_unlocked (xmms_playlist_t *playlist, const gchar *plname, xmmsc_coll_t *plcoll, xmms_medialib_entry_t file, xmms_error_t *err)
 Add an entry to the playlist without locking the mutex.
guint xmms_playlist_set_current_position (xmms_playlist_t *playlist, guint32 pos, xmms_error_t *err)
xmms_mediainfo_reader_txmms_playlist_mediainfo_reader_get (xmms_playlist_t *playlist)
 returns pointer to mediainfo reader.


Function Documentation

gboolean xmms_playlist_add_collection ( xmms_playlist_t playlist,
gchar *  plname,
xmmsc_coll_t coll,
GList *  order,
xmms_error_t err 
)

Definition at line 1063 of file playlist.c.

void xmms_playlist_add_entry ( xmms_playlist_t playlist,
gchar *  plname,
xmms_medialib_entry_t  file,
xmms_error_t err 
)

Add an entry to the playlist without validating it.

Definition at line 1089 of file playlist.c.

Referenced by xmms_playlist_add_collection(), xmms_playlist_add_id(), xmms_playlist_add_idlist(), and xmms_playlist_add_url().

void xmms_playlist_add_entry_unlocked ( xmms_playlist_t playlist,
const gchar *  plname,
xmmsc_coll_t plcoll,
xmms_medialib_entry_t  file,
xmms_error_t err 
)

Add an entry to the playlist without locking the mutex.

propagate the MID !

Definition at line 1109 of file playlist.c.

Referenced by xmms_playlist_add_entry().

gboolean xmms_playlist_add_id ( xmms_playlist_t playlist,
gchar *  plname,
xmms_medialib_entry_t  file,
xmms_error_t err 
)

Adds a xmms_medialib_entry to the playlist.

This will append or prepend the entry according to the option. This function will wake xmms_playlist_wait.

Parameters:
playlist the playlist to add the entry to.
plname the name of the playlist to modify.
file the xmms_medialib_entry_t to add
err Upon error this will be set.
Returns:
TRUE on success

Definition at line 1026 of file playlist.c.

gboolean xmms_playlist_add_idlist ( xmms_playlist_t playlist,
gchar *  plname,
xmmsc_coll_t coll,
xmms_error_t err 
)

Definition at line 1041 of file playlist.c.

gboolean xmms_playlist_add_url ( xmms_playlist_t playlist,
gchar *  plname,
gchar *  nurl,
xmms_error_t err 
)

Convenient function for adding a URL to the playlist, Creates a xmms_medialib_entry_t for you and adds it to the list.

Parameters:
playlist the playlist to add it URL to.
plname the name of the playlist to modify.
nurl the URL to add
err an xmms_error_t that should be defined upon error.
Returns:
TRUE on success and FALSE otherwise.

Definition at line 976 of file playlist.c.

gboolean xmms_playlist_advance ( xmms_playlist_t playlist  ) 

Go to next song in playlist according to current playlist mode.

xmms_playlist_current_entry is to be used to retrieve the entry.

See also:
xmms_playlist_current_entry
Returns:
FALSE if end of playlist is reached, TRUE otherwise.

Definition at line 412 of file playlist.c.

const gchar* xmms_playlist_current_active ( xmms_playlist_t playlist,
xmms_error_t err 
)

Retrieve the name of the currently active playlist.

Definition at line 547 of file playlist.c.

xmms_medialib_entry_t xmms_playlist_current_entry ( xmms_playlist_t playlist  ) 

Retrive the currently active xmms_medialib_entry_t.

Definition at line 467 of file playlist.c.

GTree* xmms_playlist_current_pos ( xmms_playlist_t playlist,
gchar *  plname,
xmms_error_t err 
)

Retrieve the position of the currently active xmms_medialib_entry_t.

Definition at line 512 of file playlist.c.

xmms_playlist_t* xmms_playlist_init ( void   ) 

Initializes a new xmms_playlist_t.

Definition at line 284 of file playlist.c.

Referenced by main().

xmms_mediainfo_reader_t* xmms_playlist_mediainfo_reader_get ( xmms_playlist_t playlist  ) 

returns pointer to mediainfo reader.

Definition at line 1536 of file playlist.c.

gboolean xmms_playlist_remove ( xmms_playlist_t playlist,
gchar *  plname,
guint  pos,
xmms_error_t err 
)

Remove an entry from playlist.

Definition at line 766 of file playlist.c.

gboolean xmms_playlist_remove_by_entry ( xmms_playlist_t playlist,
xmms_medialib_entry_t  entry 
)

Remove all additions of entry in the playlist.

Parameters:
playlist the playlist to remove entries from
entry the playlist entry to remove
See also:
xmms_playlist_remove

Definition at line 741 of file playlist.c.

Referenced by xmms_medialib_entry_remove().

guint xmms_playlist_set_current_position ( xmms_playlist_t playlist,
guint32  pos,
xmms_error_t err 
)

Definition at line 1211 of file playlist.c.


Generated on Wed Dec 10 18:06:45 2008 for XMMS2 by  doxygen 1.5.6