Playlist

Classes
struct	playlist_export_t
struct	playlist_item_t
struct	playlist_view_t
struct	playlist_t
Defines
#define	PLAYLIST_SAVE_FLAG   0x01
#define	PLAYLIST_SKIP_FLAG   0x02
#define	PLAYLIST_ENA_FLAG   0x04
#define	PLAYLIST_DEL_FLAG   0x08
#define	PLAYLIST_RO_FLAG   0x10
#define	PLAYLIST_REMOVE_FLAG   0x20
#define	VIEW_CATEGORY   1
Enumerations
enum	playlist_status_t
Functions
playlist_t *	__playlist_Create (vlc_object_t *)
int	playlist_Destroy (playlist_t *)
playlist_item_t *	playlist_FindNextFromParent (playlist_t *p_playlist, int i_view, playlist_item_t *p_root, playlist_item_t *p_node, playlist_item_t *p_item)
playlist_item_t *	playlist_FindPrevFromParent (playlist_t *p_playlist, int i_view, playlist_item_t *p_root, playlist_item_t *p_node, playlist_item_t *p_item)

---

Detailed Description

Brief description. Longer description

---

Define Documentation

#define PLAYLIST_DEL_FLAG   0x08

Autodelete ? Definition at line 85 of file vlc_playlist.h.

#define PLAYLIST_ENA_FLAG   0x04

Is it enabled ? Definition at line 84 of file vlc_playlist.h.

#define PLAYLIST_REMOVE_FLAG   0x20

Remove this item at the end Definition at line 87 of file vlc_playlist.h.

#define PLAYLIST_RO_FLAG   0x10

Write-enabled ? Definition at line 86 of file vlc_playlist.h. Referenced by __playlist_Create().

#define PLAYLIST_SAVE_FLAG   0x01

Must it be saved Definition at line 82 of file vlc_playlist.h.

#define PLAYLIST_SKIP_FLAG   0x02

Must playlist skip after it ? Definition at line 83 of file vlc_playlist.h.

#define VIEW_CATEGORY   1

predefined views Definition at line 105 of file vlc_playlist.h. Referenced by __playlist_Create().

---

Enumeration Type Documentation

enum playlist_status_t

Playlist status Definition at line 120 of file vlc_playlist.h.

---

Function Documentation

playlist_t* __playlist_Create (  vlc_object_t *  p_parent  )

Create playlist Create a playlist structure. Parameters: p_parent  the vlc object that is to be the parent of this playlist Returns: a pointer to the created playlist, or NULL on error Definition at line 94 of file playlist.c. References vlc_value_t::b_bool, playlist_t::b_go_next, playlist_t::gc_lock, playlist_t::i_all_size, playlist_item_t::i_flags, playlist_t::i_index, vlc_value_t::i_int, playlist_t::i_last_id, playlist_t::i_order, playlist_t::i_size, playlist_t::i_sort, playlist_t::i_views, playlist_t::p_general, playlist_t::p_input, playlist_t::p_preparse, playlist_view_t::p_root, PLAYLIST_RO_FLAG, playlist_t::pp_all_items, playlist_t::pp_items, playlist_t::pp_views, playlist_t::request, playlist_t::request_date, playlist_t::status, var_Create, var_CreateGetBool, var_Set, and VIEW_CATEGORY.

int playlist_Destroy (  playlist_t *  p_playlist  )

Destroy the playlist. Delete all items in the playlist and free the playlist structure. Parameters: p_playlist  the playlist structure to destroy Returns: VLC_SUCCESS or an error Definition at line 226 of file playlist.c. References playlist_t::gc_lock, playlist_t::i_sds, playlist_t::i_views, playlist_t::p_preparse, playlist_view_t::p_root, playlist_t::pp_sds, playlist_t::pp_views, playlist_view_t::psz_name, and var_Destroy. Referenced by VLC_CleanUp().

playlist_item_t* playlist_FindNextFromParent (  playlist_t *  p_playlist, int  i_view, playlist_item_t *  p_root, playlist_item_t *  p_node, playlist_item_t *  p_item )

Finds the next item to play Parameters: p_playlist  the playlist i_view  the view p_root  the root node p_node  the node we are playing from p_item  the item we were playing (NULL if none ) Returns: the next item to play, or NULL if none found Definition at line 633 of file view.c. References playlist_t::b_go_next, playlist_item_t::i_children, playlist_item_t::input, and playlist_t::status.

playlist_item_t* playlist_FindPrevFromParent (  playlist_t *  p_playlist, int  i_view, playlist_item_t *  p_root, playlist_item_t *  p_node, playlist_item_t *  p_item )

Finds the previous item to play Parameters: p_playlist  the playlist i_view  the view p_root  the root node p_node  the node we are playing from p_item  the item we were playing (NULL if none ) Returns: the next item to play, or NULL if none found Definition at line 720 of file view.c. References playlist_t::b_go_next, playlist_item_t::i_children, playlist_item_t::input, and playlist_t::status.

---