vlc_playlist.h File Reference

#include <vlc_input.h>
#include <vlc_events.h>

Go to the source code of this file.

Classes
struct	playlist_export_t
struct	playlist_item_t
struct	playlist_t
struct	playlist_add_t

Macros
#define	VLC_DEFINE_SORT_FUNCTIONS
#define	DEF(s)   s,
#define	PLAYLIST_INSERT   0x0001
#define	PLAYLIST_APPEND   0x0002
#define	PLAYLIST_GO   0x0004
#define	PLAYLIST_PREPARSE   0x0008
#define	PLAYLIST_SPREPARSE   0x0010
#define	PLAYLIST_NO_REBUILD   0x0020
#define	PLAYLIST_END   -666
#define	PL_LOCK   playlist_Lock( p_playlist )
#define	PL_UNLOCK   playlist_Unlock( p_playlist )
#define	PL_ASSERT_LOCKED   playlist_AssertLocked( p_playlist )
#define	pl_Get(a)   pl_Get( VLC_OBJECT(a) )
#define	playlist_Play(p)   playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
#define	playlist_Pause(p)   playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked )
#define	playlist_Stop(p)   playlist_Control(p,PLAYLIST_STOP, pl_Unlocked )
#define	playlist_Next(p)   playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1)
#define	playlist_Prev(p)   playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1)
#define	playlist_Skip(p, i)   playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, (i) )
#define	AOUT_VOLUME_DEFAULT   256
#define	AOUT_VOLUME_MAX   512
#define	playlist_VolumeDown(a, b, c)   playlist_VolumeUp(a, -(b), c)
#define	pl_CurrentInput(a)   __pl_CurrentInput( VLC_OBJECT(a) )

Typedefs
typedef struct playlist_export_t	playlist_export_t

Enumerations
enum	playlist_item_flags_e {   PLAYLIST_SAVE_FLAG = 0x0001, PLAYLIST_SKIP_FLAG = 0x0002, PLAYLIST_DBL_FLAG = 0x0004, PLAYLIST_RO_FLAG = 0x0008,   PLAYLIST_REMOVE_FLAG = 0x0010, PLAYLIST_EXPANDED_FLAG = 0x0020, PLAYLIST_SUBITEM_STOP_FLAG = 0x0040 }
enum	playlist_status_t { PLAYLIST_STOPPED, PLAYLIST_RUNNING, PLAYLIST_PAUSED }
enum	{ SORT_RANDOM, NUM_SORT_FNS =SORT_RANDOM }
enum	{ ORDER_NORMAL = 0, ORDER_REVERSE = 1 }
enum	pl_locked_state { pl_Locked = true, pl_Unlocked = false }

Functions
VLC_API playlist_t *	pl_Get (vlc_object_t *)
VLC_API void	playlist_Lock (playlist_t *)
VLC_API void	playlist_Unlock (playlist_t *)
VLC_API void	playlist_AssertLocked (playlist_t *)
VLC_API void	playlist_Deactivate (playlist_t *)
VLC_API int	playlist_Control (playlist_t *p_playlist, int i_query, bool b_locked,...)
VLC_API input_thread_t *	playlist_CurrentInput (playlist_t *p_playlist) VLC_USED
VLC_API mtime_t	playlist_GetNodeDuration (playlist_item_t *)
VLC_API void	playlist_Clear (playlist_t *, bool)
VLC_API int	playlist_PreparseEnqueue (playlist_t *, input_item_t *)
VLC_API int	playlist_AskForArtEnqueue (playlist_t *, input_item_t *)
VLC_API int	playlist_TreeMove (playlist_t *, playlist_item_t *, playlist_item_t *, int)
VLC_API int	playlist_TreeMoveMany (playlist_t *, int, playlist_item_t **, playlist_item_t *, int)
VLC_API int	playlist_RecursiveNodeSort (playlist_t *, playlist_item_t *, int, int)
VLC_API playlist_item_t *	playlist_CurrentPlayingItem (playlist_t *) VLC_USED
VLC_API int	playlist_Status (playlist_t *)
VLC_API int	playlist_Export (playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type)
VLC_API int	playlist_Import (playlist_t *p_playlist, const char *psz_file)
VLC_API int	playlist_ServicesDiscoveryAdd (playlist_t *, const char *)
VLC_API int	playlist_ServicesDiscoveryRemove (playlist_t *, const char *)
VLC_API bool	playlist_IsServicesDiscoveryLoaded (playlist_t *, const char *) VLC_DEPRECATED
VLC_API int	playlist_ServicesDiscoveryControl (playlist_t *, const char *, int,...)
VLC_API int	playlist_DeleteFromInput (playlist_t *, input_item_t *, bool)
VLC_API int	playlist_Add (playlist_t *, const char *, const char *, int, int, bool, bool)
VLC_API int	playlist_AddExt (playlist_t *, const char *, const char *, int, int, mtime_t, int, const char *const *, unsigned, bool, bool)
VLC_API int	playlist_AddInput (playlist_t *, input_item_t *, int, int, bool, bool)
VLC_API playlist_item_t *	playlist_NodeAddInput (playlist_t *, input_item_t *, playlist_item_t *, int, int, bool)
VLC_API int	playlist_NodeAddCopy (playlist_t *, playlist_item_t *, playlist_item_t *, int)
VLC_API playlist_item_t *	playlist_ItemGetById (playlist_t *, int) VLC_USED
VLC_API playlist_item_t *	playlist_ItemGetByInput (playlist_t *, input_item_t *) VLC_USED
VLC_API int	playlist_LiveSearchUpdate (playlist_t *, playlist_item_t *, const char *, bool)
VLC_API playlist_item_t *	playlist_NodeCreate (playlist_t *, const char *, playlist_item_t *p_parent, int i_pos, int i_flags, input_item_t *)
VLC_API int	playlist_NodeAppend (playlist_t *, playlist_item_t *, playlist_item_t *)
VLC_API int	playlist_NodeInsert (playlist_t *, playlist_item_t *, playlist_item_t *, int)
VLC_API int	playlist_NodeRemoveItem (playlist_t *, playlist_item_t *, playlist_item_t *)
VLC_API playlist_item_t *	playlist_ChildSearchName (playlist_item_t *, const char *) VLC_USED
VLC_API int	playlist_NodeDelete (playlist_t *, playlist_item_t *, bool, bool)
VLC_API playlist_item_t *	playlist_GetNextLeaf (playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, bool b_ena, bool b_unplayed) VLC_USED
VLC_API playlist_item_t *	playlist_GetPrevLeaf (playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, bool b_ena, bool b_unplayed) VLC_USED
VLC_API audio_output_t *	playlist_GetAout (playlist_t *)
VLC_API float	playlist_VolumeGet (playlist_t *)
VLC_API int	playlist_VolumeSet (playlist_t *, float)
VLC_API int	playlist_VolumeUp (playlist_t *, int, float *)
VLC_API int	playlist_MuteSet (playlist_t *, bool)
VLC_API int	playlist_MuteGet (playlist_t *)
VLC_API void	playlist_EnableAudioFilter (playlist_t *, const char *, bool)

Detailed Description

This file contain structures and function prototypes related to the playlist in vlc