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