control: Remove dynamic_media_list_*.
[vlc.git] / include / vlc / libvlc.h
1 /*****************************************************************************
2  * libvlc.h:  libvlc_* new external API
3  *****************************************************************************
4  * Copyright (C) 1998-2005 the VideoLAN team
5  * $Id$
6  *
7  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
8  *          Jean-Paul Saman <jpsaman _at_ m2x _dot_ nl>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 /**
26  * \defgroup libvlc Libvlc
27  * This is libvlc, the base library of the VLC program.
28  *
29  * @{
30  */
31
32
33 #ifndef _LIBVLC_H
34 #define _LIBVLC_H 1
35
36 #include <vlc/vlc.h>
37 #include <vlc/libvlc_structures.h>
38
39 # ifdef __cplusplus
40 extern "C" {
41 # endif
42
43 /*****************************************************************************
44  * Exception handling
45  *****************************************************************************/
46 /** defgroup libvlc_exception Exceptions
47  * \ingroup libvlc
48  * LibVLC Exceptions handling
49  * @{
50  */
51
52 /**
53  * Initialize an exception structure. This can be called several times to
54  * reuse an exception structure.
55  *
56  * \param p_exception the exception to initialize
57  */
58 VLC_PUBLIC_API void libvlc_exception_init( libvlc_exception_t *p_exception );
59
60 /**
61  * Has an exception been raised?
62  *
63  * \param p_exception the exception to query
64  * \return 0 if the exception was raised, 1 otherwise
65  */
66 VLC_PUBLIC_API int
67 libvlc_exception_raised( const libvlc_exception_t *p_exception );
68
69 /**
70  * Raise an exception using a user-provided message.
71  *
72  * \param p_exception the exception to raise
73  * \param psz_message the exception message format string
74  * \param ... the format string arguments
75  */
76 VLC_PUBLIC_API void
77 libvlc_exception_raise( libvlc_exception_t *p_exception,
78                         const char *psz_format, ... );
79
80 /**
81  * Clear an exception object so it can be reused.
82  * The exception object must have be initialized.
83  *
84  * \param p_exception the exception to clear
85  */
86 VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
87
88 /**
89  * Get an exception's message.
90  *
91  * \param p_exception the exception to query
92  * \return the exception message or NULL if not applicable (exception not
93  *         raised, for example)
94  */
95 VLC_PUBLIC_API const char *
96 libvlc_exception_get_message( const libvlc_exception_t *p_exception );
97
98 /**@} */
99
100 /*****************************************************************************
101  * Core handling
102  *****************************************************************************/
103
104 /** defgroup libvlc_core Core
105  * \ingroup libvlc
106  * LibVLC Core
107  * @{
108  */
109
110 /**
111  * Create and initialize a libvlc instance.
112  *
113  * \param argc the number of arguments
114  * \param argv command-line-type arguments. argv[0] must be the path of the
115  *        calling program.
116  * \param p_e an initialized exception pointer
117  * \return the libvlc instance
118  */
119 VLC_PUBLIC_API libvlc_instance_t *
120 libvlc_new( int , const char *const *, libvlc_exception_t *);
121
122 /**
123  * Return a libvlc instance identifier for legacy APIs. Use of this
124  * function is discouraged, you should convert your program to use the
125  * new API.
126  *
127  * \param p_instance the instance
128  * \return the instance identifier
129  */
130 VLC_PUBLIC_API int libvlc_get_vlc_id( libvlc_instance_t *p_instance );
131
132 /**
133  * Decrement the reference count of a libvlc instance, and destroy it
134  * if it reaches zero.
135  *
136  * \param p_instance the instance to destroy
137  */
138 VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * );
139
140 /**
141  * Increments the reference count of a libvlc instance.
142  * The initial reference count is 1 after libvlc_new() returns.
143  *
144  * \param p_instance the instance to reference
145  */
146 VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
147
148 /** @}*/
149
150 /*****************************************************************************
151  * Media descriptor
152  *****************************************************************************/
153 /** defgroup libvlc_media_descriptor Media Descriptor
154  * \ingroup libvlc
155  * LibVLC Media Descriptor
156  * @{
157  */
158
159 /**
160  * Create a media descriptor with the given MRL.
161  *
162  * \param p_instance the instance
163  * \param psz_mrl the MRL to read
164  * \param p_e an initialized exception pointer
165  * \return the newly created media descriptor
166  */
167 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_new(
168                                    libvlc_instance_t *p_instance,
169                                    const char * psz_mrl,
170                                    libvlc_exception_t *p_e );
171
172 /**
173  * Create a media descriptor as an empty node with the passed name.
174  *
175  * \param p_instance the instance
176  * \param psz_name the name of the node
177  * \param p_e an initialized exception pointer
178  * \return the new empty media descriptor
179  */
180 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_new_as_node(
181                                    libvlc_instance_t *p_instance,
182                                    const char * psz_name,
183                                    libvlc_exception_t *p_e );
184
185 /**
186  * Add an option to the media descriptor.
187  *
188  * This option will be used to determine how the media_instance will
189  * read the media_descriptor. This allows to use VLC's advanced
190  * reading/streaming options on a per-media basis.
191  *
192  * The options are detailed in vlc --long-help, for instance "--sout-all"
193  *
194  * \param p_instance the instance
195  * \param psz_mrl the MRL to read
196  * \param p_e an initialized exception pointer
197  */
198 VLC_PUBLIC_API void libvlc_media_descriptor_add_option(
199                                    libvlc_media_descriptor_t * p_md,
200                                    const char * ppsz_options,
201                                    libvlc_exception_t * p_e );
202
203 VLC_PUBLIC_API void libvlc_media_descriptor_retain(
204                                    libvlc_media_descriptor_t *p_meta_desc );
205
206 VLC_PUBLIC_API void libvlc_media_descriptor_release(
207                                    libvlc_media_descriptor_t *p_meta_desc );
208
209 VLC_PUBLIC_API char * libvlc_media_descriptor_get_mrl( libvlc_media_descriptor_t * p_md,
210                                                        libvlc_exception_t * p_e );
211
212 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_duplicate( libvlc_media_descriptor_t * );
213
214 /**
215  * Read the meta of the media descriptor.
216  *
217  * \param p_meta_desc the media descriptor to read
218  * \param p_meta_desc the meta to read
219  * \param p_e an initialized exception pointer
220  * \return the media descriptor's meta
221  */
222 VLC_PUBLIC_API char * libvlc_media_descriptor_get_meta(
223                                    libvlc_media_descriptor_t *p_meta_desc,
224                                    libvlc_meta_t e_meta,
225                                    libvlc_exception_t *p_e );
226
227 VLC_PUBLIC_API libvlc_state_t libvlc_media_descriptor_get_state(
228                                    libvlc_media_descriptor_t *p_meta_desc,
229                                    libvlc_exception_t *p_e );
230
231 /* Tags */
232 VLC_PUBLIC_API void libvlc_media_descriptor_add_tag( libvlc_media_descriptor_t *p_md,
233                                                      const char * key,
234                                                      const libvlc_tag_t tag,
235                                                      libvlc_exception_t *p_e );
236
237 VLC_PUBLIC_API void libvlc_media_descriptor_remove_tag( libvlc_media_descriptor_t *p_md,
238                                                          const char * key,
239                                                          const libvlc_tag_t tag,
240                                                          libvlc_exception_t *p_e );
241
242 VLC_PUBLIC_API int
243     libvlc_media_descriptor_tags_count_for_key( libvlc_media_descriptor_t *p_md,
244                                                 const char * key,
245                                                 libvlc_exception_t *p_e );
246
247 VLC_PUBLIC_API libvlc_tag_t
248     libvlc_media_descriptor_tag_at_index_for_key( libvlc_media_descriptor_t *p_md,
249                                                   int i,
250                                                   const char * key,
251                                                   libvlc_exception_t *p_e );
252
253 VLC_PUBLIC_API libvlc_media_list_t *
254     libvlc_media_descriptor_subitems( libvlc_media_descriptor_t *p_md,
255                                       libvlc_exception_t *p_e );
256
257 VLC_PUBLIC_API libvlc_event_manager_t *
258     libvlc_media_descriptor_event_manager( libvlc_media_descriptor_t * p_md,
259                                            libvlc_exception_t * p_e );
260
261 VLC_PUBLIC_API libvlc_time_t
262    libvlc_media_descriptor_get_duration( libvlc_media_descriptor_t * p_md,
263                                          libvlc_exception_t * p_e );
264
265 VLC_PUBLIC_API int
266    libvlc_media_descriptor_is_preparsed( libvlc_media_descriptor_t * p_md,
267                                          libvlc_exception_t * p_e );
268
269 VLC_PUBLIC_API void
270     libvlc_media_descriptor_set_user_data( libvlc_media_descriptor_t * p_md,
271                                            void * p_new_user_data,
272                                            libvlc_exception_t * p_e);
273 VLC_PUBLIC_API void *
274     libvlc_media_descriptor_get_user_data( libvlc_media_descriptor_t * p_md,
275                                            libvlc_exception_t * p_e);
276
277 /** @}*/
278
279 /*****************************************************************************
280  * Playlist
281  *****************************************************************************/
282 /** defgroup libvlc_playlist Playlist
283  * \ingroup libvlc
284  * LibVLC Playlist handling
285  * @{
286  */
287
288 /**
289  * Set the playlist's loop attribute. If set, the playlist runs continuously
290  * and wraps around when it reaches the end.
291  *
292  * \param p_instance the playlist instance
293  * \param loop the loop attribute. 1 sets looping, 0 disables it
294  * \param p_e an initialized exception pointer
295  */
296 VLC_DEPRECATED_API void libvlc_playlist_loop( libvlc_instance_t* , int,
297                                           libvlc_exception_t * );
298
299 /**
300  * Start playing.
301  *
302  * Additionnal playlist item options can be specified for addition to the
303  * item before it is played.
304  *
305  * \param p_instance the playlist instance
306  * \param i_id the item to play. If this is a negative number, the next
307  *        item will be selected. Otherwise, the item with the given ID will be
308  *        played
309  * \param i_options the number of options to add to the item
310  * \param ppsz_options the options to add to the item
311  * \param p_e an initialized exception pointer
312  */
313 VLC_DEPRECATED_API void libvlc_playlist_play( libvlc_instance_t*, int, int,
314                                           char **, libvlc_exception_t * );
315
316 /**
317  * Toggle the playlist's pause status.
318  *
319  * If the playlist was running, it is paused. If it was paused, it is resumed.
320  *
321  * \param p_instance the playlist instance to pause
322  * \param p_e an initialized exception pointer
323  */
324 VLC_DEPRECATED_API void libvlc_playlist_pause( libvlc_instance_t *,
325                                            libvlc_exception_t * );
326
327 /**
328  * Checks whether the playlist is running
329  *
330  * \param p_instance the playlist instance
331  * \param p_e an initialized exception pointer
332  * \return 0 if the playlist is stopped or paused, 1 if it is running
333  */
334 VLC_DEPRECATED_API int libvlc_playlist_isplaying( libvlc_instance_t *,
335                                               libvlc_exception_t * );
336
337 /**
338  * Get the number of items in the playlist
339  *
340  * \param p_instance the playlist instance
341  * \param p_e an initialized exception pointer
342  * \return the number of items
343  */
344 VLC_DEPRECATED_API int libvlc_playlist_items_count( libvlc_instance_t *,
345                                                 libvlc_exception_t * );
346
347 /**
348  * Lock the playlist.
349  *
350  * \param p_instance the playlist instance
351  */
352 VLC_DEPRECATED_API void libvlc_playlist_lock( libvlc_instance_t * );
353
354 /**
355  * Unlock the playlist.
356  *
357  * \param p_instance the playlist instance
358  */
359 VLC_DEPRECATED_API void libvlc_playlist_unlock( libvlc_instance_t * );
360
361 /**
362  * Stop playing.
363  *
364  * \param p_instance the playlist instance to stop
365  * \param p_e an initialized exception pointer
366  */
367 VLC_DEPRECATED_API void libvlc_playlist_stop( libvlc_instance_t *,
368                                           libvlc_exception_t * );
369
370 /**
371  * Go to the next playlist item. If the playlist was stopped, playback
372  * is started.
373  *
374  * \param p_instance the playlist instance
375  * \param p_e an initialized exception pointer
376  */
377 VLC_DEPRECATED_API void libvlc_playlist_next( libvlc_instance_t *,
378                                           libvlc_exception_t * );
379
380 /**
381  * Go to the previous playlist item. If the playlist was stopped, playback
382  * is started.
383  *
384  * \param p_instance the playlist instance
385  * \param p_e an initialized exception pointer
386  */
387 VLC_DEPRECATED_API void libvlc_playlist_prev( libvlc_instance_t *,
388                                           libvlc_exception_t * );
389
390 /**
391  * Empty a playlist. All items in the playlist are removed.
392  *
393  * \param p_instance the playlist instance
394  * \param p_e an initialized exception pointer
395  */
396 VLC_DEPRECATED_API void libvlc_playlist_clear( libvlc_instance_t *,
397                                            libvlc_exception_t * );
398
399 /**
400  * Append an item to the playlist. The item is added at the end. If more
401  * advanced options are required, \see libvlc_playlist_add_extended instead.
402  *
403  * \param p_instance the playlist instance
404  * \param psz_uri the URI to open, using VLC format
405  * \param psz_name a name that you might want to give or NULL
406  * \param p_e an initialized exception pointer
407  * \return the identifier of the new item
408  */
409 VLC_DEPRECATED_API int libvlc_playlist_add( libvlc_instance_t *, const char *,
410                                         const char *, libvlc_exception_t * );
411
412 /**
413  * Append an item to the playlist. The item is added at the end, with
414  * additional input options.
415  *
416  * \param p_instance the playlist instance
417  * \param psz_uri the URI to open, using VLC format
418  * \param psz_name a name that you might want to give or NULL
419  * \param i_options the number of options to add
420  * \param ppsz_options strings representing the options to add
421  * \param p_e an initialized exception pointer
422  * \return the identifier of the new item
423  */
424 VLC_DEPRECATED_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
425                                                  const char *, int, const char **,
426                                                  libvlc_exception_t * );
427
428 /**
429  * Delete the playlist item with the given ID.
430  *
431  * \param p_instance the playlist instance
432  * \param i_id the id to remove
433  * \param p_e an initialized exception pointer
434  * \return 0 in case of success, a non-zero value otherwise
435  */
436 VLC_DEPRECATED_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
437                                                 libvlc_exception_t * );
438
439 /** Get the input that is currently being played by the playlist.
440  *
441  * \param p_instance the playlist instance to use
442  * \param p_e an initialized exception pointern
443  * \return a media instance object
444  */
445 VLC_DEPRECATED_API libvlc_media_instance_t * libvlc_playlist_get_media_instance(
446                                 libvlc_instance_t *, libvlc_exception_t * );
447
448 /** @}*/
449
450 /*****************************************************************************
451  * Media Instance
452  *****************************************************************************/
453 /** defgroup libvlc_media_instance Media Instance
454  * \ingroup libvlc
455  * LibVLC Media Instance
456  * @{
457  */
458
459 /** Create an empty Media Instance object
460  *
461  * \param p_libvlc_instance the libvlc instance in which the Media Instance
462  *        should be (unused for now).
463  * \param p_e an initialized exception pointer
464  */
465 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new( libvlc_instance_t *, libvlc_exception_t * );
466
467 /** Create a Media Instance object from a Media Descriptor
468  * \param p_md the media descriptor. Afterwards the p_md can be safely
469  *        destroyed.
470  * \param p_e an initialized exception pointer
471  */
472 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new_from_media_descriptor( libvlc_media_descriptor_t *, libvlc_exception_t * );
473
474 /** Release a media_instance after use
475  * \param p_mi the Media Instance to free
476  */
477 VLC_PUBLIC_API void libvlc_media_instance_release( libvlc_media_instance_t * );
478 VLC_PUBLIC_API void libvlc_media_instance_retain( libvlc_media_instance_t * );
479
480 /** Set the media descriptor that will be used by the media_instance. If any,
481  * previous md will be released.
482  *
483  * \param p_mi the Media Instance
484  * \param p_md the Media Descriptor. Afterwards the p_md can be safely
485  *        destroyed.
486  * \param p_e an initialized exception pointer
487  */
488 VLC_PUBLIC_API void libvlc_media_instance_set_media_descriptor( libvlc_media_instance_t *, libvlc_media_descriptor_t *, libvlc_exception_t * );
489
490 /** Get the media descriptor used by the media_instance (if any). A copy of
491  * the md is returned. NULL is returned if no media instance is associated.
492  *
493  * \param p_mi the Media Instance
494  * \param p_e an initialized exception pointer
495  */
496 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_instance_get_media_descriptor( libvlc_media_instance_t *, libvlc_exception_t * );
497
498 /** Get the Event Manager from which the media instance send event.
499  *
500  * \param p_mi the Media Instance
501  * \param p_e an initialized exception pointer
502  */
503 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_instance_event_manager ( libvlc_media_instance_t *, libvlc_exception_t * );
504
505 VLC_PUBLIC_API void libvlc_media_instance_play ( libvlc_media_instance_t *, libvlc_exception_t * );
506 VLC_PUBLIC_API void libvlc_media_instance_pause ( libvlc_media_instance_t *, libvlc_exception_t * );
507 VLC_PUBLIC_API void libvlc_media_instance_stop ( libvlc_media_instance_t *, libvlc_exception_t * );
508
509 VLC_PUBLIC_API void libvlc_media_instance_set_drawable ( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
510 VLC_PUBLIC_API libvlc_drawable_t
511                     libvlc_media_instance_get_drawable ( libvlc_media_instance_t *, libvlc_exception_t * );
512
513 /** \bug This might go away ... to be replaced by a broader system */
514 VLC_PUBLIC_API libvlc_time_t libvlc_media_instance_get_length     ( libvlc_media_instance_t *, libvlc_exception_t *);
515 VLC_PUBLIC_API libvlc_time_t libvlc_media_instance_get_time       ( libvlc_media_instance_t *, libvlc_exception_t *);
516 VLC_PUBLIC_API void          libvlc_media_instance_set_time       ( libvlc_media_instance_t *, libvlc_time_t, libvlc_exception_t *);
517 VLC_PUBLIC_API float         libvlc_media_instance_get_position   ( libvlc_media_instance_t *, libvlc_exception_t *);
518 VLC_PUBLIC_API void          libvlc_media_instance_set_position   ( libvlc_media_instance_t *, float, libvlc_exception_t *);
519 VLC_PUBLIC_API void          libvlc_media_instance_set_chapter    ( libvlc_media_instance_t *, int, libvlc_exception_t *);
520 VLC_PUBLIC_API int           libvlc_media_instance_get_chapter    (libvlc_media_instance_t *, libvlc_exception_t *);
521 VLC_PUBLIC_API int           libvlc_media_instance_get_chapter_count( libvlc_media_instance_t *, libvlc_exception_t *);
522 VLC_PUBLIC_API int    libvlc_media_instance_will_play      ( libvlc_media_instance_t *, libvlc_exception_t *);
523 VLC_PUBLIC_API float         libvlc_media_instance_get_rate       ( libvlc_media_instance_t *, libvlc_exception_t *);
524 VLC_PUBLIC_API void          libvlc_media_instance_set_rate       ( libvlc_media_instance_t *, float, libvlc_exception_t *);
525 VLC_PUBLIC_API libvlc_state_t libvlc_media_instance_get_state   ( libvlc_media_instance_t *, libvlc_exception_t *);
526
527 /**
528  * Does this input have a video output?
529  *
530  * \param p_input the input
531  * \param p_e an initialized exception pointer
532  */
533 VLC_PUBLIC_API int  libvlc_media_instance_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
534 VLC_PUBLIC_API float       libvlc_media_instance_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
535
536 VLC_PUBLIC_API int libvlc_media_instance_is_seekable(
537                                  libvlc_media_instance_t *p_mi,
538                                  libvlc_exception_t *p_e );
539
540 VLC_PUBLIC_API int libvlc_media_instance_can_pause(
541                                  libvlc_media_instance_t *p_mi,
542                                  libvlc_exception_t *p_e );
543
544 /** @} */
545
546 /*****************************************************************************
547  * Media List
548  *****************************************************************************/
549 /** defgroup libvlc_media_list MediaList
550  * \ingroup libvlc
551  * LibVLC Media List
552  * @{
553  */
554 VLC_PUBLIC_API libvlc_media_list_t *
555     libvlc_media_list_new( libvlc_instance_t *, libvlc_exception_t * );
556
557 VLC_PUBLIC_API void
558     libvlc_media_list_release( libvlc_media_list_t * );
559
560 VLC_PUBLIC_API void
561     libvlc_media_list_retain( libvlc_media_list_t * );
562
563 VLC_PUBLIC_API void
564     libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
565                                         const char * psz_uri,
566                                         libvlc_exception_t * p_e );
567
568 VLC_PUBLIC_API void
569     libvlc_media_list_set_media_descriptor( libvlc_media_list_t *,
570                                             libvlc_media_descriptor_t *,
571                                             libvlc_exception_t *);
572
573 VLC_PUBLIC_API libvlc_media_descriptor_t *
574     libvlc_media_list_media_descriptor( libvlc_media_list_t *,
575                                         libvlc_exception_t *);
576
577 VLC_PUBLIC_API void
578     libvlc_media_list_add_media_descriptor( libvlc_media_list_t *,
579                                             libvlc_media_descriptor_t *,
580                                             libvlc_exception_t * );
581 VLC_PUBLIC_API void
582     libvlc_media_list_insert_media_descriptor( libvlc_media_list_t *,
583                                                libvlc_media_descriptor_t *,
584                                                int,
585                                                libvlc_exception_t * );
586 VLC_PUBLIC_API void
587     libvlc_media_list_remove_index( libvlc_media_list_t *, int,
588                                     libvlc_exception_t * );
589
590 VLC_PUBLIC_API int
591     libvlc_media_list_count( libvlc_media_list_t * p_mlist,
592                              libvlc_exception_t * p_e );
593
594 VLC_PUBLIC_API libvlc_media_descriptor_t *
595     libvlc_media_list_item_at_index( libvlc_media_list_t *, int,
596                                      libvlc_exception_t * );
597 VLC_PUBLIC_API int
598     libvlc_media_list_index_of_item( libvlc_media_list_t *,
599                                      libvlc_media_descriptor_t *,
600                                      libvlc_exception_t * );
601
602 /* This indicates if this media list is read-only from a user point of view */
603 VLC_PUBLIC_API int
604     libvlc_media_list_is_readonly( libvlc_media_list_t * p_mlist );
605
606 VLC_PUBLIC_API void
607     libvlc_media_list_lock( libvlc_media_list_t * );
608 VLC_PUBLIC_API void
609     libvlc_media_list_unlock( libvlc_media_list_t * );
610
611 VLC_PUBLIC_API libvlc_media_list_view_t *
612     libvlc_media_list_flat_view( libvlc_media_list_t *,
613                                  libvlc_exception_t * );
614
615 VLC_PUBLIC_API libvlc_media_list_view_t *
616     libvlc_media_list_hierarchical_view( libvlc_media_list_t *,
617                                          libvlc_exception_t * );
618
619 VLC_PUBLIC_API libvlc_media_list_view_t *
620     libvlc_media_list_hierarchical_node_view( libvlc_media_list_t *,
621                                               libvlc_exception_t * );
622
623 VLC_PUBLIC_API libvlc_event_manager_t *
624     libvlc_media_list_event_manager( libvlc_media_list_t *,
625                                      libvlc_exception_t * );
626 /** @} */
627
628
629 /*****************************************************************************
630  * Media List View
631  *****************************************************************************/
632 /** defgroup libvlc_media_list_view MediaListView
633  * \ingroup libvlc
634  * LibVLC Media List View
635  * @{ */
636
637 VLC_PUBLIC_API void
638     libvlc_media_list_view_retain( libvlc_media_list_view_t * p_mlv );
639
640 VLC_PUBLIC_API void
641     libvlc_media_list_view_release( libvlc_media_list_view_t * p_mlv );
642
643 VLC_PUBLIC_API libvlc_event_manager_t *
644     libvlc_media_list_view_event_manager(  libvlc_media_list_view_t * p_mlv );
645
646 VLC_PUBLIC_API int
647     libvlc_media_list_view_count(  libvlc_media_list_view_t * p_mlv,
648                                    libvlc_exception_t * p_e );
649
650 VLC_PUBLIC_API libvlc_media_descriptor_t *
651     libvlc_media_list_view_item_at_index(  libvlc_media_list_view_t * p_mlv,
652                                            int index,
653                                            libvlc_exception_t * p_e );
654
655 VLC_PUBLIC_API libvlc_media_list_view_t *
656     libvlc_media_list_view_children_at_index(  libvlc_media_list_view_t * p_mlv,
657                                            int index,
658                                            libvlc_exception_t * p_e );
659
660 VLC_PUBLIC_API libvlc_media_list_view_t *
661     libvlc_media_list_view_children_for_item(  libvlc_media_list_view_t * p_mlv,
662                                            libvlc_media_descriptor_t * p_md,
663                                            libvlc_exception_t * p_e );
664
665
666 VLC_PUBLIC_API int
667     libvlc_media_list_view_index_of_item(  libvlc_media_list_view_t * p_mlv,
668                                            libvlc_media_descriptor_t * p_md,
669                                            libvlc_exception_t * p_e );
670
671 VLC_PUBLIC_API void
672     libvlc_media_list_view_insert_at_index(  libvlc_media_list_view_t * p_mlv,
673                                              libvlc_media_descriptor_t * p_md,
674                                              int index,
675                                              libvlc_exception_t * p_e );
676
677 VLC_PUBLIC_API void
678     libvlc_media_list_view_remove_at_index(  libvlc_media_list_view_t * p_mlv,
679                                              int index,
680                                              libvlc_exception_t * p_e );
681
682 VLC_PUBLIC_API void
683     libvlc_media_list_view_add_item(  libvlc_media_list_view_t * p_mlv,
684                                       libvlc_media_descriptor_t * p_md,
685                                       libvlc_exception_t * p_e );
686
687 VLC_PUBLIC_API libvlc_media_list_t *
688     libvlc_media_list_view_parent_media_list(  libvlc_media_list_view_t * p_mlv,
689                                                libvlc_exception_t * p_e );
690
691 /** @} */
692
693 /*****************************************************************************
694  * Media Library
695  *****************************************************************************/
696 /** defgroup libvlc_media_library Media Library
697  * \ingroup libvlc
698  * LibVLC Media Library
699  * @{
700  */
701 VLC_PUBLIC_API libvlc_media_library_t *
702     libvlc_media_library_new( libvlc_instance_t * p_inst,
703                               libvlc_exception_t * p_e );
704 VLC_PUBLIC_API void
705     libvlc_media_library_release( libvlc_media_library_t * p_mlib );
706 VLC_PUBLIC_API void
707     libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
708
709
710 VLC_PUBLIC_API void
711     libvlc_media_library_load( libvlc_media_library_t * p_mlib,
712                                libvlc_exception_t * p_e );
713
714 VLC_PUBLIC_API void
715     libvlc_media_library_save( libvlc_media_library_t * p_mlib,
716                                libvlc_exception_t * p_e );
717
718 VLC_PUBLIC_API libvlc_media_list_t *
719     libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
720                                      libvlc_exception_t * p_e );
721
722
723 /** @} */
724
725 /*****************************************************************************
726  * Media List Player
727  *****************************************************************************/
728 /** defgroup libvlc_media_list_player MediaListPlayer
729  * \ingroup libvlc
730  * LibVLC Media List Player
731  * @{
732  */
733 VLC_PUBLIC_API libvlc_media_list_player_t *
734     libvlc_media_list_player_new( libvlc_instance_t * p_instance,
735                                   libvlc_exception_t * p_e );
736 VLC_PUBLIC_API void
737     libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
738
739 VLC_PUBLIC_API void
740     libvlc_media_list_player_set_media_instance(
741                                      libvlc_media_list_player_t * p_mlp,
742                                      libvlc_media_instance_t * p_mi,
743                                      libvlc_exception_t * p_e );
744
745 VLC_PUBLIC_API void
746     libvlc_media_list_player_set_media_list(
747                                      libvlc_media_list_player_t * p_mlp,
748                                      libvlc_media_list_t * p_mlist,
749                                      libvlc_exception_t * p_e );
750
751 VLC_PUBLIC_API void
752     libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
753                                    libvlc_exception_t * p_e );
754
755 VLC_PUBLIC_API void
756     libvlc_media_list_player_pause( libvlc_media_list_player_t * p_mlp,
757                                    libvlc_exception_t * p_e );
758
759 VLC_PUBLIC_API int
760     libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp,
761                                          libvlc_exception_t * p_e );
762
763 VLC_PUBLIC_API libvlc_state_t
764     libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp,
765                                         libvlc_exception_t * p_e );
766
767 VLC_PUBLIC_API void
768     libvlc_media_list_player_play_item_at_index(
769                                    libvlc_media_list_player_t * p_mlp,
770                                    int i_index,
771                                    libvlc_exception_t * p_e );
772
773 VLC_PUBLIC_API void
774     libvlc_media_list_player_play_item(
775                                    libvlc_media_list_player_t * p_mlp,
776                                    libvlc_media_descriptor_t * p_md,
777                                    libvlc_exception_t * p_e );
778
779 VLC_PUBLIC_API void
780     libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
781                                    libvlc_exception_t * p_e );
782 VLC_PUBLIC_API void
783     libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
784                                    libvlc_exception_t * p_e );
785
786 /** @} */
787
788 /** defgroup libvlc_video Video
789  * \ingroup libvlc
790  * LibVLC Video handling
791  * @{
792  */
793
794 /**
795  * Toggle fullscreen status on video output.
796  *
797  * \param p_input the input
798  * \param p_e an initialized exception pointer
799  */
800 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
801
802 /**
803  * Enable or disable fullscreen on a video output.
804  *
805  * \param p_input the input
806  * \param b_fullscreen boolean for fullscreen status
807  * \param p_e an initialized exception pointer
808  */
809 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_instance_t *, int, libvlc_exception_t * );
810
811 /**
812  * Get current fullscreen status.
813  *
814  * \param p_input the input
815  * \param p_e an initialized exception pointer
816  * \return the fullscreen status (boolean)
817  */
818 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
819
820 /**
821  * Get current video height.
822  *
823  * \param p_input the input
824  * \param p_e an initialized exception pointer
825  * \return the video height
826  */
827 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_instance_t *, libvlc_exception_t * );
828
829 /**
830  * Get current video width.
831  *
832  * \param p_input the input
833  * \param p_e an initialized exception pointer
834  * \return the video width
835  */
836 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_instance_t *, libvlc_exception_t * );
837
838 /**
839  * Get current video aspect ratio.
840  *
841  * \param p_input the input
842  * \param p_e an initialized exception pointer
843  * \return the video aspect ratio
844  */
845 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_instance_t *, libvlc_exception_t * );
846
847 /**
848  * Set new video aspect ratio.
849  *
850  * \param p_input the input
851  * \param psz_aspect new video aspect-ratio
852  * \param p_e an initialized exception pointer
853  */
854 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_instance_t *, char *, libvlc_exception_t * );
855
856 /**
857  * Get current video subtitle.
858  *
859  * \param p_input the input
860  * \param p_e an initialized exception pointer
861  * \return the video subtitle selected
862  */
863 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_instance_t *, libvlc_exception_t * );
864
865 /**
866  * Set new video subtitle.
867  *
868  * \param p_input the input
869  * \param i_spu new video subtitle to select
870  * \param p_e an initialized exception pointer
871  */
872 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_instance_t *, int , libvlc_exception_t * );
873
874 /**
875  * Get current crop filter geometry.
876  *
877  * \param p_input the input
878  * \param p_e an initialized exception pointer
879  * \return the crop filter geometry
880  */
881 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_instance_t *, libvlc_exception_t * );
882
883 /**
884  * Set new crop filter geometry.
885  *
886  * \param p_input the input
887  * \param psz_geometry new crop filter geometry
888  * \param p_e an initialized exception pointer
889  */
890 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_instance_t *, char *, libvlc_exception_t * );
891
892 /**
893  * Toggle teletext transparent status on video output.
894  *
895  * \param p_input the input
896  * \param p_e an initialized exception pointer
897  */
898 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
899
900 /**
901  * Get current teletext page requested.
902  *
903  * \param p_input the input
904  * \param p_e an initialized exception pointer
905  * \return the current teletext page requested.
906  */
907 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
908
909 /**
910  * Set new teletext page to retrieve.
911  *
912  * \param p_input the input
913  * \param i_page teletex page number requested
914  * \param p_e an initialized exception pointer
915  */
916 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_instance_t *, int, libvlc_exception_t * );
917
918 /**
919  * Take a snapshot of the current video window.
920  *
921  * If i_width AND i_height is 0, original size is used.
922  * If i_width XOR i_height is 0, original aspect-ratio is preserved.
923  *
924  * \param p_input the input
925  * \param psz_filepath the path where to save the screenshot to
926  * \param i_width the snapshot's width
927  * \param i_height the snapshot's height
928  * \param p_e an initialized exception pointer
929  */
930 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_instance_t *, char *,unsigned int, unsigned int, libvlc_exception_t * );
931
932 VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *);
933
934 /**
935  * Resize the current video output window.
936  *
937  * \param p_instance libvlc instance
938  * \param width new width for video output window
939  * \param height new height for video output window
940  * \param p_e an initialized exception pointer
941  * \return the success status (boolean)
942  */
943 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *);
944
945 /**
946  * Change the parent for the current the video output.
947  *
948  * \param p_instance libvlc instance
949  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
950  * \param p_e an initialized exception pointer
951  * \return the success status (boolean)
952  */
953 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
954
955 /**
956  * Tell windowless video output to redraw rectangular area (MacOS X only).
957  *
958  * \param p_instance libvlc instance
959  * \param area coordinates within video drawable
960  * \param p_e an initialized exception pointer
961  */
962 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
963
964 /**
965  * Set the default video output's parent.
966  *
967  * This setting will be used as default for all video outputs.
968  *
969  * \param p_instance libvlc instance
970  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
971  * \param p_e an initialized exception pointer
972  */
973 VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
974
975 /**
976  * Set the default video output parent.
977  *
978  * This setting will be used as default for all video outputs.
979  *
980  * \param p_instance libvlc instance
981  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
982  * \param p_e an initialized exception pointer
983  */
984 VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
985
986 /**
987  * Set the default video output size.
988  *
989  * This setting will be used as default for all video outputs.
990  *
991  * \param p_instance libvlc instance
992  * \param width new width for video drawable
993  * \param height new height for video drawable
994  * \param p_e an initialized exception pointer
995  */
996 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
997
998 /**
999  * Set the default video output viewport for a windowless video output
1000  * (MacOS X only).
1001  *
1002  * This setting will be used as default for all video outputs.
1003  *
1004  * \param p_instance libvlc instance
1005  * \param view coordinates within video drawable
1006  * \param clip coordinates within video drawable
1007  * \param p_e an initialized exception pointer
1008  */
1009 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
1010
1011 /** @} */
1012
1013 /** defgroup libvlc_audio Audio
1014  * \ingroup libvlc
1015  * LibVLC Audio handling
1016  * @{
1017  */
1018
1019 /**
1020  * Toggle mute status.
1021  *
1022  * \param p_instance libvlc instance
1023  * \param p_e an initialized exception pointer
1024  */
1025 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
1026
1027 /**
1028  * Get current mute status.
1029  *
1030  * \param p_instance libvlc instance
1031  * \param p_e an initialized exception pointer
1032  * \return the mute status (boolean)
1033  */
1034 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
1035
1036 /**
1037  * Set mute status.
1038  *
1039  * \param p_instance libvlc instance
1040  * \param status If status is VLC_TRUE then mute, otherwise unmute
1041  * \param p_e an initialized exception pointer
1042  */
1043 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, int , libvlc_exception_t * );
1044
1045 /**
1046  * Get current audio level.
1047  *
1048  * \param p_instance libvlc instance
1049  * \param p_e an initialized exception pointer
1050  * \return the audio level (int)
1051  */
1052 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
1053
1054 /**
1055  * Set current audio level.
1056  *
1057  * \param p_instance libvlc instance
1058  * \param i_volume the volume (int)
1059  * \param p_e an initialized exception pointer
1060  */
1061 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
1062
1063 /**
1064  * Get number of available audio tracks.
1065  *
1066  * \param p_mi media instance
1067  * \param p_e an initialized exception
1068  * \return the number of available audio tracks (int)
1069  */
1070 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_instance_t *,  libvlc_exception_t * );
1071
1072 /**
1073  * Get current audio track.
1074  *
1075  * \param p_input input instance
1076  * \param p_e an initialized exception pointer
1077  * \return the audio track (int)
1078  */
1079 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_instance_t *, libvlc_exception_t * );
1080
1081 /**
1082  * Set current audio track.
1083  *
1084  * \param p_input input instance
1085  * \param i_track the track (int)
1086  * \param p_e an initialized exception pointer
1087  */
1088 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_instance_t *, int, libvlc_exception_t * );
1089
1090 /**
1091  * Get current audio channel.
1092  *
1093  * \param p_instance input instance
1094  * \param p_e an initialized exception pointer
1095  * \return the audio channel (int)
1096  */
1097 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
1098
1099 /**
1100  * Set current audio channel.
1101  *
1102  * \param p_instance input instance
1103  * \param i_channel the audio channel (int)
1104  * \param p_e an initialized exception pointer
1105  */
1106 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * );
1107
1108 /** @} */
1109
1110 /*****************************************************************************
1111  * Services/Media Discovery
1112  *****************************************************************************/
1113 /** defgroup libvlc_media_discoverer Media Discoverer
1114  * \ingroup libvlc
1115  * LibVLC Media Discoverer
1116  * @{
1117  */
1118
1119 VLC_PUBLIC_API libvlc_media_discoverer_t *
1120 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
1121                                        const char * psz_name,
1122                                        libvlc_exception_t * p_e );
1123 VLC_PUBLIC_API void   libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
1124 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
1125
1126 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
1127
1128 VLC_PUBLIC_API libvlc_event_manager_t *
1129         libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis );
1130
1131 VLC_PUBLIC_API int
1132         libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis );
1133
1134 /**@} */
1135
1136 /*****************************************************************************
1137  * VLM
1138  *****************************************************************************/
1139 /** defgroup libvlc_vlm VLM
1140  * \ingroup libvlc
1141  * LibVLC VLM
1142  * @{
1143  */
1144
1145 /**
1146  * Add a broadcast, with one input.
1147  *
1148  * \param p_instance the instance
1149  * \param psz_name the name of the new broadcast
1150  * \param psz_input the input MRL
1151  * \param psz_output the output MRL (the parameter to the "sout" variable)
1152  * \param i_options number of additional options
1153  * \param ppsz_options additional options
1154  * \param b_enabled boolean for enabling the new broadcast
1155  * \param b_loop Should this broadcast be played in loop ?
1156  * \param p_e an initialized exception pointer
1157  */
1158 VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
1159                                               int, char **, int, int, libvlc_exception_t * );
1160
1161 /**
1162  * Delete a media (VOD or broadcast).
1163  *
1164  * \param p_instance the instance
1165  * \param psz_name the media to delete
1166  * \param p_e an initialized exception pointer
1167  */
1168 VLC_PUBLIC_API void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1169
1170 /**
1171  * Enable or disable a media (VOD or broadcast).
1172  *
1173  * \param p_instance the instance
1174  * \param psz_name the media to work on
1175  * \param b_enabled the new status
1176  * \param p_e an initialized exception pointer
1177  */
1178 VLC_PUBLIC_API void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
1179                                             libvlc_exception_t *);
1180
1181 /**
1182  * Set the output for a media.
1183  *
1184  * \param p_instance the instance
1185  * \param psz_name the media to work on
1186  * \param psz_output the output MRL (the parameter to the "sout" variable)
1187  * \param p_e an initialized exception pointer
1188  */
1189 VLC_PUBLIC_API void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
1190                                            libvlc_exception_t *);
1191
1192 /**
1193  * Set a media's input MRL. This will delete all existing inputs and
1194  * add the specified one.
1195  *
1196  * \param p_instance the instance
1197  * \param psz_name the media to work on
1198  * \param psz_input the input MRL
1199  * \param p_e an initialized exception pointer
1200  */
1201 VLC_PUBLIC_API void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
1202                                           libvlc_exception_t *);
1203
1204 /**
1205  * Add a media's input MRL. This will add the specified one.
1206  *
1207  * \param p_instance the instance
1208  * \param psz_name the media to work on
1209  * \param psz_input the input MRL
1210  * \param p_e an initialized exception pointer
1211  */
1212 VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, char *, char *,
1213                                           libvlc_exception_t *p_exception );
1214 /**
1215  * Set a media's loop status.
1216  *
1217  * \param p_instance the instance
1218  * \param psz_name the media to work on
1219  * \param b_loop the new status
1220  * \param p_e an initialized exception pointer
1221  */
1222 VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
1223                                          libvlc_exception_t *);
1224
1225 /**
1226  * Edit the parameters of a media. This will delete all existing inputs and
1227  * add the specified one.
1228  *
1229  * \param p_instance the instance
1230  * \param psz_name the name of the new broadcast
1231  * \param psz_input the input MRL
1232  * \param psz_output the output MRL (the parameter to the "sout" variable)
1233  * \param i_options number of additional options
1234  * \param ppsz_options additional options
1235  * \param b_enabled boolean for enabling the new broadcast
1236  * \param b_loop Should this broadcast be played in loop ?
1237  * \param p_e an initialized exception pointer
1238  */
1239 VLC_PUBLIC_API void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
1240                                              int, char **, int, int, libvlc_exception_t * );
1241
1242 /**
1243  * Play the named broadcast.
1244  *
1245  * \param p_instance the instance
1246  * \param psz_name the name of the broadcast
1247  * \param p_e an initialized exception pointer
1248  */
1249 VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1250
1251 /**
1252  * Stop the named broadcast.
1253  *
1254  * \param p_instance the instance
1255  * \param psz_name the name of the broadcast
1256  * \param p_e an initialized exception pointer
1257  */
1258 VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1259
1260 /**
1261  * Pause the named broadcast.
1262  *
1263  * \param p_instance the instance
1264  * \param psz_name the name of the broadcast
1265  * \param p_e an initialized exception pointer
1266  */
1267 VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1268
1269 /**
1270  * Seek in the named broadcast.
1271  *
1272  * \param p_instance the instance
1273  * \param psz_name the name of the broadcast
1274  * \param f_percentage the percentage to seek to
1275  * \param p_e an initialized exception pointer
1276  */
1277 VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
1278                                            float, libvlc_exception_t * );
1279
1280 /**
1281  * Return information about the named broadcast.
1282  *
1283  * \param p_instance the instance
1284  * \param psz_name the name of the broadcast
1285  * \param p_e an initialized exception pointer
1286  */
1287 VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1288
1289 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
1290 returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \
1291                         char *, int , libvlc_exception_t * );
1292
1293 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1);
1294 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time, int, Integer, -1);
1295 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length, int, Integer, -1);
1296 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate, int, Integer, -1);
1297 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title, int, Integer, 0);
1298 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter, int, Integer, 0);
1299 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
1300
1301 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
1302
1303 /** @} */
1304
1305 /*****************************************************************************
1306  * Message log handling
1307  *****************************************************************************/
1308
1309 /** defgroup libvlc_log Log
1310  * \ingroup libvlc
1311  * LibVLC Message Logging
1312  * @{
1313  */
1314
1315 /**
1316  * Return the VLC messaging verbosity level.
1317  *
1318  * \param p_instance libvlc instance
1319  * \param exception an initialized exception pointer
1320  */
1321 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
1322                                                   libvlc_exception_t *p_e );
1323
1324 /**
1325  * Set the VLC messaging verbosity level.
1326  *
1327  * \param p_log libvlc log instance
1328  * \param exception an initialized exception pointer
1329  */
1330 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
1331                                               libvlc_exception_t *p_e );
1332
1333 /**
1334  * Open a VLC message log instance.
1335  *
1336  * \param p_instance libvlc instance
1337  * \param exception an initialized exception pointer
1338  */
1339 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
1340
1341 /**
1342  * Close a VLC message log instance.
1343  *
1344  * \param p_log libvlc log instance
1345  * \param exception an initialized exception pointer
1346  */
1347 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
1348
1349 /**
1350  * Returns the number of messages in a log instance.
1351  *
1352  * \param p_log libvlc log instance
1353  * \param exception an initialized exception pointer
1354  */
1355 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
1356
1357 /**
1358  * Clear a log instance.
1359  *
1360  * All messages in the log are removed. The log should be cleared on a
1361  * regular basis to avoid clogging.
1362  *
1363  * \param p_log libvlc log instance
1364  * \param exception an initialized exception pointer
1365  */
1366 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
1367
1368 /**
1369  * Allocate and returns a new iterator to messages in log.
1370  *
1371  * \param p_log libvlc log instance
1372  * \param exception an initialized exception pointer
1373  */
1374 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
1375
1376 /**
1377  * Release a previoulsy allocated iterator.
1378  *
1379  * \param p_log libvlc log iterator
1380  * \param exception an initialized exception pointer
1381  */
1382 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1383
1384 /**
1385  * Return whether log iterator has more messages.
1386  *
1387  * \param p_log libvlc log iterator
1388  * \param exception an initialized exception pointer
1389  */
1390 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1391
1392 /**
1393  * Return the next log message.
1394  *
1395  * The message contents must not be freed
1396  *
1397  * \param p_log libvlc log iterator
1398  * \param exception an initialized exception pointer
1399  */
1400 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
1401                                                                struct libvlc_log_message_t *buffer,
1402                                                                libvlc_exception_t *p_e );
1403
1404 /** @} */
1405
1406 /*****************************************************************************
1407  * Event handling
1408  *****************************************************************************/
1409
1410 /** defgroup libvlc_callbacks Callbacks
1411  * \ingroup libvlc
1412  * LibVLC Events
1413  * @{
1414  */
1415
1416 /**
1417  * Register for an event notification.
1418  *
1419  * \param p_event_manager the event manager to which you want to attach to.
1420  *        Generally it is obtained by vlc_my_object_event_manager() where
1421  *        my_object is the object you want to listen to.
1422  * \param i_event_type the desired event to which we want to listen
1423  * \param f_callback the function to call when i_event_type occurs
1424  * \param user_data user provided data to carry with the event
1425  * \param p_e an initialized exception pointer
1426  */
1427 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
1428                                          libvlc_event_type_t i_event_type,
1429                                          libvlc_callback_t f_callback,
1430                                          void *user_data,
1431                                          libvlc_exception_t *p_e );
1432
1433 /**
1434  * Unregister an event notification.
1435  *
1436  * \param p_event_manager the event manager
1437  * \param i_event_type the desired event to which we want to unregister
1438  * \param f_callback the function to call when i_event_type occurs
1439  * \param p_e an initialized exception pointer
1440  */
1441 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
1442                                          libvlc_event_type_t i_event_type,
1443                                          libvlc_callback_t f_callback,
1444                                          void *p_user_data,
1445                                          libvlc_exception_t *p_e );
1446
1447 /**
1448  * Get an event's type name.
1449  *
1450  * \param i_event_type the desired event
1451  */
1452 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
1453
1454 /** @} */
1455
1456
1457 # ifdef __cplusplus
1458 }
1459 # endif
1460
1461 #endif /* <vlc/libvlc.h> */