![]() |
![]() |
![]() |
Xplayer Playlist Parser Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy |
#include <xplayer-pl-playlist.h> XplayerPlPlaylist; XplayerPlPlaylistClass; XplayerPlPlaylist * xplayer_pl_playlist_new (void
); guint xplayer_pl_playlist_size (XplayerPlPlaylist *playlist
); void xplayer_pl_playlist_prepend (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
); void xplayer_pl_playlist_append (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
); void xplayer_pl_playlist_insert (XplayerPlPlaylist *playlist
,gint position
,XplayerPlPlaylistIter *iter
); gboolean xplayer_pl_playlist_iter_first (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
); gboolean xplayer_pl_playlist_iter_next (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
); gboolean xplayer_pl_playlist_iter_prev (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
); gboolean xplayer_pl_playlist_get_value (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
,const gchar *key
,GValue *value
); void xplayer_pl_playlist_get_valist (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
,va_list args
); void xplayer_pl_playlist_get (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
,...
); gboolean xplayer_pl_playlist_set_value (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
,const gchar *key
,GValue *value
); void xplayer_pl_playlist_set_valist (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
,va_list args
); void xplayer_pl_playlist_set (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
,...
);
XplayerPlPlaylist represents a playlist, provides API to either navigate through
the playlist elements, or perform additions or modifications. See also
xplayer_pl_parser_save()
.
typedef struct _XplayerPlPlaylist XplayerPlPlaylist;
All the fields in the XplayerPlPlaylist structure are private and should never be accessed directly.
typedef struct { GObjectClass parent_class; } XplayerPlPlaylistClass;
All the fields in the XplayerPlPlaylistClass structure are private and should never be accessed directly.
XplayerPlPlaylist * xplayer_pl_playlist_new (void
);
Creates a new XplayerPlPlaylist object.
Returns : |
The newly created XplayerPlPlaylist |
guint xplayer_pl_playlist_size (XplayerPlPlaylist *playlist
);
Returns the number of elements in playlist
.
|
a XplayerPlPlaylist |
Returns : |
The number of elements |
void xplayer_pl_playlist_prepend (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
);
Prepends a new empty element to playlist
, and modifies iter
so
it points to it. To fill in values, you need to call
xplayer_pl_playlist_set()
or xplayer_pl_playlist_set_value()
.
|
a XplayerPlPlaylist |
|
an unset XplayerPlPlaylistIter for returning the location. [out] |
void xplayer_pl_playlist_append (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
);
Appends a new empty element to playlist
, and modifies iter
so
it points to it. To fill in values, you need to call
xplayer_pl_playlist_set()
or xplayer_pl_playlist_set_value()
.
|
a XplayerPlPlaylist |
|
an unset XplayerPlPlaylistIter for returning the location. [out] |
void xplayer_pl_playlist_insert (XplayerPlPlaylist *playlist
,gint position
,XplayerPlPlaylistIter *iter
);
Inserts a new empty element to playlist
at position
, and modifies
iter
so it points to it. To fill in values, you need to call
xplayer_pl_playlist_set()
or xplayer_pl_playlist_set_value()
.
position
may be minor than 0 to prepend elements, or bigger than
the current playlist
size to append elements.
|
a XplayerPlPlaylist |
|
position in the playlist |
|
an unset XplayerPlPlaylistIter for returning the location. [out] |
gboolean xplayer_pl_playlist_iter_first (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
);
Modifies iter
so it points to the first element in playlist
.
|
a XplayerPlPlaylist |
|
an unset XplayerPlPlaylistIter for returning the location. [out] |
Returns : |
TRUE if there is such first element. |
gboolean xplayer_pl_playlist_iter_next (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
);
Modifies iter
so it points to the next element it previously
pointed to. This function will return FALSE
if there was no
next element, or iter
didn't actually point to any element
in playlist
.
|
a XplayerPlPlaylist |
|
a XplayerPlPlaylistIter pointing to some item in playlist . [in]
|
Returns : |
TRUE if there was next element. |
gboolean xplayer_pl_playlist_iter_prev (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
);
Modifies iter
so it points to the previous element it previously
pointed to. This function will return FALSE
if there was no
previous element, or iter
didn't actually point to any element
in playlist
.
|
a XplayerPlPlaylist |
|
a XplayerPlPlaylistIter pointing to some item in playlist . [in]
|
Returns : |
TRUE if there was previous element. |
gboolean xplayer_pl_playlist_get_value (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
,const gchar *key
,GValue *value
);
Gets the value for key
(Such as XPLAYER_PL_PARSER_FIELD_URI
) in
the playlist item pointed by iter
.
|
a XplayerPlPlaylist |
|
a XplayerPlPlaylistIter pointing to some item in playlist
|
|
data key |
|
an empty GValue to set |
Returns : |
TRUE if iter contains data for key . |
void xplayer_pl_playlist_get_valist (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
,va_list args
);
See xplayer_pl_playlist_get()
, this function takes a va_list.
|
a XplayerPlPlaylist |
|
a XplayerPlPlaylistIter pointing to some item in playlist
|
|
a va_list |
void xplayer_pl_playlist_get (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
,...
);
Gets the value for one or more keys from the element pointed
by iter
.
|
a XplayerPlPlaylist |
|
a XplayerPlPlaylistIter pointing to some item in playlist
|
|
pairs of key/return location for value, terminated by NULL
|
gboolean xplayer_pl_playlist_set_value (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
,const gchar *key
,GValue *value
);
Sets the value for key
in the element pointed by iter
.
|
a XplayerPlPlaylist |
|
a XplayerPlPlaylistIter pointing to some item in playlist
|
|
key to set the value for |
|
GValue containing the key value |
Returns : |
TRUE if the value could be stored in playlist
|
void xplayer_pl_playlist_set_valist (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
,va_list args
);
See xplayer_pl_playlist_set()
, this function takes a va_list.
|
a XplayerPlPlaylist |
|
a XplayerPlPlaylistIter pointing to some item in playlist
|
|
a va_list |
void xplayer_pl_playlist_set (XplayerPlPlaylist *playlist
,XplayerPlPlaylistIter *iter
,...
);
Sets the value for one or several keys in the element pointed
by iter
.
|
a XplayerPlPlaylist |
|
a XplayerPlPlaylistIter pointing to some item in playlist
|
|
key/value string pairs, terminated with NULL
|