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 * \return 0 on success, -1 if the media list is read-only
109 libvlc_media_list_add_media( libvlc_media_list_t *, libvlc_media_t * );
112 * Insert media instance in media list on a position
113 * The libvlc_media_list_lock should be held upon entering this function.
115 * \param p_ml a media list instance
116 * \param p_mi a media instance
117 * \param i_pos position in array where to insert
118 * \return 0 on success, -1 if the media list si read-only
121 libvlc_media_list_insert_media( libvlc_media_list_t *,
122 libvlc_media_t *, int );
125 * Remove media instance from media list on a position
126 * The libvlc_media_list_lock should be held upon entering this function.
128 * \param p_ml a media list instance
129 * \param i_pos position in array where to insert
130 * \return 0 on success, -1 if the list is read-only or the item was not found
133 libvlc_media_list_remove_index( libvlc_media_list_t *, int );
136 * Get count on media list items
137 * The libvlc_media_list_lock should be held upon entering this function.
139 * \param p_ml a media list instance
140 * \return number of items in media list
143 libvlc_media_list_count( libvlc_media_list_t *p_ml );
146 * List media instance in media list at a position
147 * The libvlc_media_list_lock should be held upon entering this function.
149 * \param p_ml a media list instance
150 * \param i_pos position in array where to insert
151 * \return media instance at position i_pos, or NULL if not found.
152 * In case of success, libvlc_media_retain() is called to increase the refcount
155 VLC_PUBLIC_API libvlc_media_t *
156 libvlc_media_list_item_at_index( libvlc_media_list_t *, int );
158 * Find index position of List media instance in media list.
159 * Warning: the function will return the first matched position.
160 * The libvlc_media_list_lock should be held upon entering this function.
162 * \param p_ml a media list instance
163 * \param p_mi media list instance
164 * \return position of media instance
167 libvlc_media_list_index_of_item( libvlc_media_list_t *p_ml,
168 libvlc_media_t *p_mi );
171 * This indicates if this media list is read-only from a user point of view
173 * \param p_ml media list instance
174 * \return 0 on readonly, 1 on readwrite
177 libvlc_media_list_is_readonly( libvlc_media_list_t * p_mlist );
180 * Get lock on media list items
182 * \param p_ml a media list instance
185 libvlc_media_list_lock( libvlc_media_list_t * );
188 * Release lock on media list items
189 * The libvlc_media_list_lock should be held upon entering this function.
191 * \param p_ml a media list instance
194 libvlc_media_list_unlock( libvlc_media_list_t * );
197 * Get a flat media list view of media list items
199 * \param p_ml a media list instance
200 * \param p_ex an excpetion instance
201 * \return flat media list view instance
203 VLC_PUBLIC_API libvlc_media_list_view_t *
204 libvlc_media_list_flat_view( libvlc_media_list_t *,
205 libvlc_exception_t * );
208 * Get a hierarchical media list view of media list items
210 * \param p_ml a media list instance
211 * \return hierarchical media list view instance
213 VLC_PUBLIC_API libvlc_media_list_view_t *
214 libvlc_media_list_hierarchical_view( libvlc_media_list_t * );
216 VLC_PUBLIC_API libvlc_media_list_view_t *
217 libvlc_media_list_hierarchical_node_view( libvlc_media_list_t * p_ml );
220 * Get libvlc_event_manager from this media list instance.
221 * The p_event_manager is immutable, so you don't have to hold the lock
223 * \param p_ml a media list instance
224 * \return libvlc_event_manager
226 VLC_PUBLIC_API libvlc_event_manager_t *
227 libvlc_media_list_event_manager( libvlc_media_list_t *p_ml );
235 #endif /* _LIBVLC_MEDIA_LIST_H */