X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_playlist.h;h=fc2b8089865178e0d2d7f31fdc1afa5b6c72324b;hb=7cba3abbd08c96099b52630912e21d3e24ec91e7;hp=b93f128139ae54fd5b44984c16f75bd1e2eb3b11;hpb=4ca1e354903dcaa4452ceda2378d3a56e228b28f;p=vlc diff --git a/include/vlc_playlist.h b/include/vlc_playlist.h index b93f128139..fc2b808986 100644 --- a/include/vlc_playlist.h +++ b/include/vlc_playlist.h @@ -114,6 +114,21 @@ TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t); * To delete an item, use playlist_DeleteFromInput( input_id ) which will * remove all occurrences of the input in both trees * + * + * The playlist defines the following event variables: + * + * - "item-change": It will contains the input_item_t->i_id of a changed input + * item monitored by the playlist. + * * - "item-current": It will contains a input_item_t->i_id of the current + * item being played. + * + * - "playlist-item-append": It will contains a pointer to a playlist_add_t. + * - "playlist-item-deleted": It will contains the playlist_item_t->i_id of a deleted + * playlist_item_t. + * + * XXX Be really carefull, playlist_item_t->i_id and input_item_t->i_id are not + * the same. Yes, the situation is pretty bad. + * * @{ */ @@ -173,9 +188,8 @@ struct playlist_t /** Helper to add an item */ struct playlist_add_t { - int i_node; - int i_item; - int i_position; + int i_node; /**< Playist id of the parent node */ + int i_item; /**< Playist id of the playlist_item_t */ }; enum @@ -274,9 +288,7 @@ VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *, bool VLC_EXPORT( int, playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) ); VLC_EXPORT( int, playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) ); -VLC_EXPORT( int, playlist_CurrentId, ( playlist_t * ) ); VLC_EXPORT( playlist_item_t *, playlist_CurrentPlayingItem, ( playlist_t * ) ); -VLC_EXPORT( bool, playlist_IsPlaying, ( playlist_t * ) ); VLC_EXPORT( int, playlist_Status, ( playlist_t * ) ); /** @@ -309,35 +321,18 @@ VLC_EXPORT( bool, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char * Item management ********************************************************/ -/*************************** Item creation **************************/ - -VLC_EXPORT( playlist_item_t* , playlist_ItemNewWithType, ( playlist_t *,const char *,const char *, int , const char *const *, int, int) ); - -/** Create a new item, without adding it to the playlist - * \param p_obj a vlc object (anyone will do) - * \param psz_uri the mrl of the item - * \param psz_name a text giving a name or description of the item - * \return the new item or NULL on failure - */ -#define playlist_ItemNew( a , b, c ) \ - playlist_ItemNewWithType( VLC_OBJECT(a) , b , c, 0, NULL, -1, 0 ) - - /*************************** Item deletion **************************/ VLC_EXPORT( int, playlist_DeleteFromInput, ( playlist_t *, int, bool ) ); /******************** Item addition ********************/ VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char *, int, int, bool, bool ) ); -VLC_EXPORT( int, playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char *const *,int, bool, bool ) ); +VLC_EXPORT( int, playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, int, const char *const *, unsigned, bool, bool ) ); VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *, int, int, bool, bool ) ); VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, int*, int*, bool ) ); -/********************** Misc item operations **********************/ -VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *, bool) ); - /********************************** Item search *************************/ -VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int, bool ) ); -VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t *, bool ) ); +VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int ) ); +VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) ); VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInputId, (playlist_t *, int, playlist_item_t *) ); VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) ); @@ -345,8 +340,6 @@ VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, co /******************************************************** * Tree management ********************************************************/ -VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) ); - /* Node management */ VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_flags, input_item_t * ) ); VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) ); @@ -354,8 +347,7 @@ VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_it VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) ); VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) ); VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, bool , bool ) ); -VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, bool ) ); -VLC_EXPORT( void, playlist_NodesPairCreate, (playlist_t *, const char *, playlist_item_t **, playlist_item_t **, bool ) ); + VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) ); VLC_EXPORT( 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_EXPORT( 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 ) );