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 /*****************************************************************************
38 *****************************************************************************/
39 /** \defgroup libvlc_media_list libvlc_media_list
41 * LibVLC Media List, a media list holds multiple media descriptors
45 typedef struct libvlc_media_list_t libvlc_media_list_t;
46 typedef struct libvlc_media_list_view_t libvlc_media_list_view_t;
49 * Create an empty media list.
51 * \param p_libvlc libvlc instance
52 * \return empty media list, or NULL on error
54 VLC_PUBLIC_API libvlc_media_list_t *
55 libvlc_media_list_new( libvlc_instance_t * );
58 * Release media list created with libvlc_media_list_new().
60 * \param p_ml a media list created with libvlc_media_list_new()
63 libvlc_media_list_release( libvlc_media_list_t * );
66 * Retain reference to a media list
68 * \param p_ml a media list created with libvlc_media_list_new()
71 libvlc_media_list_retain( libvlc_media_list_t * );
73 VLC_DEPRECATED_API void
74 libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
76 libvlc_exception_t * p_e );
79 * Associate media instance with this media list instance.
80 * If another media instance was present it will be released.
81 * The libvlc_media_list_lock should NOT be held upon entering this function.
83 * \param p_ml a media list instance
84 * \param p_mi media instance to add
87 libvlc_media_list_set_media( libvlc_media_list_t *p_ml, libvlc_media_t *p_md );
90 * Get media instance from this media list instance. This action will increase
91 * the refcount on the media instance.
92 * The libvlc_media_list_lock should NOT be held upon entering this function.
94 * \param p_ml a media list instance
95 * \return media instance
97 VLC_PUBLIC_API libvlc_media_t *
98 libvlc_media_list_media( libvlc_media_list_t *p_ml );
101 * Add media instance to media list
102 * The libvlc_media_list_lock should be held upon entering this function.
104 * \param p_ml a media list instance
105 * \param p_mi a media instance
106 * \param p_e initialized exception object
109 libvlc_media_list_add_media( libvlc_media_list_t *,
111 libvlc_exception_t * );
114 * Insert media instance in media list on a position
115 * The libvlc_media_list_lock should be held upon entering this function.
117 * \param p_ml a media list instance
118 * \param p_mi a media instance
119 * \param i_pos position in array where to insert
120 * \param p_e initialized exception object
123 libvlc_media_list_insert_media( libvlc_media_list_t *,
126 libvlc_exception_t * );
128 * Remove media instance from media list on a position
129 * The libvlc_media_list_lock should be held upon entering this function.
131 * \param p_ml a media list instance
132 * \param i_pos position in array where to insert
133 * \param p_e initialized exception object
136 libvlc_media_list_remove_index( libvlc_media_list_t *, int,
137 libvlc_exception_t * );
140 * Get count on media list items
141 * The libvlc_media_list_lock should be held upon entering this function.
143 * \param p_ml a media list instance
144 * \return number of items in media list
147 libvlc_media_list_count( libvlc_media_list_t *p_ml );
150 * List media instance in media list at a position
151 * The libvlc_media_list_lock should be held upon entering this function.
153 * \param p_ml a media list instance
154 * \param i_pos position in array where to insert
155 * \param p_e initialized exception object
156 * \return media instance at position i_pos and libvlc_media_retain() has been called to increase the refcount on this object.
158 VLC_PUBLIC_API libvlc_media_t *
159 libvlc_media_list_item_at_index( libvlc_media_list_t *, int,
160 libvlc_exception_t * );
162 * Find index position of List media instance in media list.
163 * Warning: the function will return the first matched position.
164 * The libvlc_media_list_lock should be held upon entering this function.
166 * \param p_ml a media list instance
167 * \param p_mi media list instance
168 * \return position of media instance
171 libvlc_media_list_index_of_item( libvlc_media_list_t *p_ml,
172 libvlc_media_t *p_mi );
175 * This indicates if this media list is read-only from a user point of view
177 * \param p_ml media list instance
178 * \return 0 on readonly, 1 on readwrite
181 libvlc_media_list_is_readonly( libvlc_media_list_t * p_mlist );
184 * Get lock on media list items
186 * \param p_ml a media list instance
189 libvlc_media_list_lock( libvlc_media_list_t * );
192 * Release lock on media list items
193 * The libvlc_media_list_lock should be held upon entering this function.
195 * \param p_ml a media list instance
198 libvlc_media_list_unlock( libvlc_media_list_t * );
201 * Get a flat media list view of media list items
203 * \param p_ml a media list instance
204 * \param p_ex an excpetion instance
205 * \return flat media list view instance
207 VLC_PUBLIC_API libvlc_media_list_view_t *
208 libvlc_media_list_flat_view( libvlc_media_list_t *,
209 libvlc_exception_t * );
212 * Get a hierarchical media list view of media list items
214 * \param p_ml a media list instance
215 * \return hierarchical media list view instance
217 VLC_PUBLIC_API libvlc_media_list_view_t *
218 libvlc_media_list_hierarchical_view( libvlc_media_list_t * );
220 VLC_PUBLIC_API libvlc_media_list_view_t *
221 libvlc_media_list_hierarchical_node_view( libvlc_media_list_t * p_ml );
224 * Get libvlc_event_manager from this media list instance.
225 * The p_event_manager is immutable, so you don't have to hold the lock
227 * \param p_ml a media list instance
228 * \return libvlc_event_manager
230 VLC_PUBLIC_API libvlc_event_manager_t *
231 libvlc_media_list_event_manager( libvlc_media_list_t *p_ml );
239 #endif /* _LIBVLC_MEDIA_LIST_H */