Playlist
[XMMSServer]

This is the playlist control. More...

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)
 Retrieve the currently active xmms_medialib_entry_t.
gboolean xmms_playlist_remove_by_entry (xmms_playlist_t *playlist, xmms_medialib_entry_t entry)
 Remove all additions of entry in the playlist.
void xmms_playlist_insert_entry (xmms_playlist_t *playlist, const gchar *plname, guint32 pos, xmms_medialib_entry_t file, xmms_error_t *err)
 Insert an entry at a given position in the playlist without validating it.
void xmms_playlist_add_entry (xmms_playlist_t *playlist, const 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, xmmsv_coll_t *plcoll, xmms_medialib_entry_t file, xmms_error_t *err)
 Add an entry to the playlist without locking the mutex.
xmms_mediainfo_reader_txmms_playlist_mediainfo_reader_get (xmms_playlist_t *playlist)
 returns pointer to mediainfo reader.

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


Function Documentation

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

Add an entry to the playlist without validating it.

Definition at line 1050 of file playlist.c.

void xmms_playlist_add_entry_unlocked ( xmms_playlist_t playlist,
const gchar *  plname,
xmmsv_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 1070 of file playlist.c.

Referenced by xmms_playlist_add_entry().

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 376 of file playlist.c.

xmms_medialib_entry_t xmms_playlist_current_entry ( xmms_playlist_t playlist  ) 

Retrieve the currently active xmms_medialib_entry_t.

Definition at line 394 of file playlist.c.

xmms_playlist_t* xmms_playlist_init ( void   ) 

Initializes a new xmms_playlist_t.

Definition at line 277 of file playlist.c.

Referenced by main().

void xmms_playlist_insert_entry ( xmms_playlist_t playlist,
const gchar *  plname,
guint32  pos,
xmms_medialib_entry_t  file,
xmms_error_t err 
)

Insert an entry at a given position in the playlist without validating it.

propagate the MID !

update position once client is familiar with the new item.

Definition at line 886 of file playlist.c.

xmms_mediainfo_reader_t* xmms_playlist_mediainfo_reader_get ( xmms_playlist_t playlist  ) 

returns pointer to mediainfo reader.

Definition at line 1529 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 671 of file playlist.c.

Referenced by xmms_medialib_entry_remove().


Generated on Tue Feb 23 18:14:36 2010 for XMMS2 by  doxygen 1.6.1