1 /*****************************************************************************
2 * libvlc_media_list.h: libvlc_media_list API
3 *****************************************************************************
4 * Copyright (C) 1998-2008 the VideoLAN team
7 * Authors: Pierre d'Herbemont
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 #ifndef LIBVLC_MEDIA_LIST_H
25 #define LIBVLC_MEDIA_LIST_H 1
29 * This file defines libvlc_media_list API
36 /** \defgroup libvlc_media_list LibVLC media list
38 * A LibVLC media list holds multiple @ref libvlc_media_t media descriptors.
42 typedef struct libvlc_media_list_t libvlc_media_list_t;
45 * Create an empty media list.
47 * \param p_instance libvlc instance
48 * \return empty media list, or NULL on error
50 VLC_PUBLIC_API libvlc_media_list_t *
51 libvlc_media_list_new( libvlc_instance_t *p_instance );
54 * Release media list created with libvlc_media_list_new().
56 * \param p_ml a media list created with libvlc_media_list_new()
59 libvlc_media_list_release( libvlc_media_list_t *p_ml );
62 * Retain reference to a media list
64 * \param p_ml a media list created with libvlc_media_list_new()
67 libvlc_media_list_retain( libvlc_media_list_t *p_ml );
69 VLC_DEPRECATED_API int
70 libvlc_media_list_add_file_content( libvlc_media_list_t * p_ml,
71 const char * psz_uri );
74 * Associate media instance with this media list instance.
75 * If another media instance was present it will be released.
76 * The libvlc_media_list_lock should NOT be held upon entering this function.
78 * \param p_ml a media list instance
79 * \param p_md media instance to add
82 libvlc_media_list_set_media( libvlc_media_list_t *p_ml, libvlc_media_t *p_md );
85 * Get media instance from this media list instance. This action will increase
86 * the refcount on the media instance.
87 * The libvlc_media_list_lock should NOT be held upon entering this function.
89 * \param p_ml a media list instance
90 * \return media instance
92 VLC_PUBLIC_API libvlc_media_t *
93 libvlc_media_list_media( libvlc_media_list_t *p_ml );
96 * Add media instance to media list
97 * The libvlc_media_list_lock should be held upon entering this function.
99 * \param p_ml a media list instance
100 * \param p_md a media instance
101 * \return 0 on success, -1 if the media list is read-only
104 libvlc_media_list_add_media( libvlc_media_list_t *p_ml, libvlc_media_t *p_md );
107 * Insert media instance in media list on a position
108 * The libvlc_media_list_lock should be held upon entering this function.
110 * \param p_ml a media list instance
111 * \param p_md a media instance
112 * \param i_pos position in array where to insert
113 * \return 0 on success, -1 if the media list si read-only
116 libvlc_media_list_insert_media( libvlc_media_list_t *p_ml,
117 libvlc_media_t *p_md, int i_pos );
120 * Remove media instance from media list on a position
121 * The libvlc_media_list_lock should be held upon entering this function.
123 * \param p_ml a media list instance
124 * \param i_pos position in array where to insert
125 * \return 0 on success, -1 if the list is read-only or the item was not found
128 libvlc_media_list_remove_index( libvlc_media_list_t *p_ml, int i_pos );
131 * Get count on media list items
132 * The libvlc_media_list_lock should be held upon entering this function.
134 * \param p_ml a media list instance
135 * \return number of items in media list
138 libvlc_media_list_count( libvlc_media_list_t *p_ml );
141 * List media instance in media list at a position
142 * The libvlc_media_list_lock should be held upon entering this function.
144 * \param p_ml a media list instance
145 * \param i_pos position in array where to insert
146 * \return media instance at position i_pos, or NULL if not found.
147 * In case of success, libvlc_media_retain() is called to increase the refcount
150 VLC_PUBLIC_API libvlc_media_t *
151 libvlc_media_list_item_at_index( libvlc_media_list_t *p_ml, int i_pos );
153 * Find index position of List media instance in media list.
154 * Warning: the function will return the first matched position.
155 * The libvlc_media_list_lock should be held upon entering this function.
157 * \param p_ml a media list instance
158 * \param p_md media list instance
159 * \return position of media instance
162 libvlc_media_list_index_of_item( libvlc_media_list_t *p_ml,
163 libvlc_media_t *p_md );
166 * This indicates if this media list is read-only from a user point of view
168 * \param p_ml media list instance
169 * \return 0 on readonly, 1 on readwrite
172 libvlc_media_list_is_readonly( libvlc_media_list_t * p_ml );
175 * Get lock on media list items
177 * \param p_ml a media list instance
180 libvlc_media_list_lock( libvlc_media_list_t *p_ml );
183 * Release lock on media list items
184 * The libvlc_media_list_lock should be held upon entering this function.
186 * \param p_ml a media list instance
189 libvlc_media_list_unlock( libvlc_media_list_t *p_ml );
192 * Get libvlc_event_manager from this media list instance.
193 * The p_event_manager is immutable, so you don't have to hold the lock
195 * \param p_ml a media list instance
196 * \return libvlc_event_manager
198 VLC_PUBLIC_API libvlc_event_manager_t *
199 libvlc_media_list_event_manager( libvlc_media_list_t *p_ml );
207 #endif /* _LIBVLC_MEDIA_LIST_H */