libvlc_release(): removes unused exception
[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: vlc.h 13701 2005-12-12 17:58:56Z zorglub $
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
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
620 VLC_PUBLIC_API int
621     libvlc_media_list_view_index_of_item(  libvlc_media_list_view_t * p_mlv,
622                                            libvlc_media_descriptor_t * p_md,
623                                            libvlc_exception_t * p_e );
624
625 VLC_PUBLIC_API void
626     libvlc_media_list_view_insert_at_index(  libvlc_media_list_view_t * p_mlv,
627                                              libvlc_media_descriptor_t * p_md,
628                                              int index,
629                                              libvlc_exception_t * p_e );
630
631 VLC_PUBLIC_API void
632     libvlc_media_list_view_remove_at_index(  libvlc_media_list_view_t * p_mlv,
633                                              int index,
634                                              libvlc_exception_t * p_e );
635
636 VLC_PUBLIC_API void
637     libvlc_media_list_view_add_item(  libvlc_media_list_view_t * p_mlv,
638                                       libvlc_media_descriptor_t * p_md,
639                                       libvlc_exception_t * p_e );
640
641 VLC_PUBLIC_API libvlc_media_list_t *
642     libvlc_media_list_view_parent_media_list(  libvlc_media_list_view_t * p_mlv,
643                                                libvlc_exception_t * p_e );
644
645 /** @} */
646
647 /*****************************************************************************
648  * Dynamic Media List (Deprecated)
649  *****************************************************************************/
650 /** defgroup libvlc_media_list MediaList
651  * \ingroup libvlc
652  * LibVLC Media List
653  * @{ */
654
655 VLC_PUBLIC_API libvlc_dynamic_media_list_t *
656     libvlc_dynamic_media_list_new(  libvlc_media_list_t * p_mlist,
657                                     libvlc_tag_query_t * p_query,
658                                     libvlc_tag_t tag,
659                                     libvlc_exception_t * p_e );
660 VLC_PUBLIC_API void
661     libvlc_dynamic_media_list_release( libvlc_dynamic_media_list_t * p_dmlist );
662
663 VLC_PUBLIC_API void
664     libvlc_dynamic_media_list_retain( libvlc_dynamic_media_list_t * p_dmlist );
665
666 libvlc_media_list_t *
667     libvlc_dynamic_media_list_media_list( libvlc_dynamic_media_list_t * p_dmlist,
668                                           libvlc_exception_t * p_e );
669
670 /** @} */
671
672 /*****************************************************************************
673  * Media Library
674  *****************************************************************************/
675 /** defgroup libvlc_media_library Media Library
676  * \ingroup libvlc
677  * LibVLC Media Library
678  * @{
679  */
680 VLC_PUBLIC_API libvlc_media_library_t *
681     libvlc_media_library_new( libvlc_instance_t * p_inst,
682                               libvlc_exception_t * p_e );
683 VLC_PUBLIC_API void
684     libvlc_media_library_release( libvlc_media_library_t * p_mlib );
685 VLC_PUBLIC_API void
686     libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
687
688
689 VLC_PUBLIC_API void
690     libvlc_media_library_load( libvlc_media_library_t * p_mlib,
691                                libvlc_exception_t * p_e );
692
693 VLC_PUBLIC_API void
694     libvlc_media_library_save( libvlc_media_library_t * p_mlib,
695                                libvlc_exception_t * p_e );
696
697 VLC_PUBLIC_API libvlc_media_list_t *
698     libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
699                                      libvlc_exception_t * p_e );
700
701
702 /** @} */
703
704 /*****************************************************************************
705  * Media List Player
706  *****************************************************************************/
707 /** defgroup libvlc_media_list_player MediaListPlayer
708  * \ingroup libvlc
709  * LibVLC Media List Player
710  * @{
711  */
712 VLC_PUBLIC_API libvlc_media_list_player_t *
713     libvlc_media_list_player_new( libvlc_instance_t * p_instance,
714                                   libvlc_exception_t * p_e );
715 VLC_PUBLIC_API void
716     libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
717
718 VLC_PUBLIC_API void
719     libvlc_media_list_player_set_media_instance(
720                                      libvlc_media_list_player_t * p_mlp,
721                                      libvlc_media_instance_t * p_mi,
722                                      libvlc_exception_t * p_e );
723
724 VLC_PUBLIC_API void
725     libvlc_media_list_player_set_media_list(
726                                      libvlc_media_list_player_t * p_mlp,
727                                      libvlc_media_list_t * p_mlist,
728                                      libvlc_exception_t * p_e );
729
730 VLC_PUBLIC_API void
731     libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
732                                    libvlc_exception_t * p_e );
733
734 VLC_PUBLIC_API void
735     libvlc_media_list_player_pause( libvlc_media_list_player_t * p_mlp,
736                                    libvlc_exception_t * p_e );
737
738 VLC_PUBLIC_API vlc_bool_t
739     libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp,
740                                          libvlc_exception_t * p_e );
741
742 VLC_PUBLIC_API libvlc_state_t
743     libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp,
744                                         libvlc_exception_t * p_e );
745
746 VLC_PUBLIC_API void
747     libvlc_media_list_player_play_item_at_index(
748                                    libvlc_media_list_player_t * p_mlp,
749                                    int i_index,
750                                    libvlc_exception_t * p_e );
751
752 VLC_PUBLIC_API void
753     libvlc_media_list_player_play_item(
754                                    libvlc_media_list_player_t * p_mlp,
755                                    libvlc_media_descriptor_t * p_md,
756                                    libvlc_exception_t * p_e );
757
758 VLC_PUBLIC_API void
759     libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
760                                    libvlc_exception_t * p_e );
761 VLC_PUBLIC_API void
762     libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
763                                    libvlc_exception_t * p_e );
764
765 /** @} */
766
767 /** defgroup libvlc_video Video
768  * \ingroup libvlc
769  * LibVLC Video handling
770  * @{
771  */
772
773 /**
774  * Toggle fullscreen status on video output
775  * \param p_input the input
776  * \param p_exception an initialized exception
777  */
778 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
779
780 /**
781  * Enable or disable fullscreen on a video output
782  * \param p_input the input
783  * \param b_fullscreen boolean for fullscreen status
784  * \param p_exception an initialized exception
785  */
786 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_instance_t *, int, libvlc_exception_t * );
787
788 /**
789  * Get current fullscreen status
790  * \param p_input the input
791  * \param p_exception an initialized exception
792  * \return the fullscreen status (boolean)
793  */
794 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
795
796 /**
797  * Get current video height
798  * \param p_input the input
799  * \param p_exception an initialized exception
800  * \return the video height
801  */
802 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_instance_t *, libvlc_exception_t * );
803
804 /**
805  * Get current video width
806  * \param p_input the input
807  * \param p_exception an initialized exception
808  * \return the video width
809  */
810 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_instance_t *, libvlc_exception_t * );
811
812 /**
813  * Get current video aspect ratio
814  * \param p_input the input
815  * \param p_exception an initialized exception
816  * \return the video aspect ratio
817  */
818 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_instance_t *, libvlc_exception_t * );
819
820 /**
821  * Set new video aspect ratio
822  * \param p_input the input
823  * \param psz_aspect new video aspect-ratio
824  * \param p_exception an initialized exception
825  */
826 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_instance_t *, char *, libvlc_exception_t * );
827
828 /**
829  * Get current video subtitle
830  * \param p_input the input
831  * \param p_exception an initialized exception
832  * \return the video subtitle selected
833  */
834 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_instance_t *, libvlc_exception_t * );
835
836 /**
837  * Set new video subtitle
838  * \param p_input the input
839  * \param i_spu new video subtitle to select
840  * \param p_exception an initialized exception
841  */
842 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_instance_t *, int , libvlc_exception_t * );
843
844 /**
845  * Get current crop filter geometry
846  * \param p_input the input
847  * \param p_exception an initialized exception
848  * \return the crop filter geometry
849  */
850 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_instance_t *, libvlc_exception_t * );
851
852 /**
853  * Set new crop filter geometry
854  * \param p_input the input
855  * \param psz_geometry new crop filter geometry
856  * \param p_exception an initialized exception
857  */
858 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_instance_t *, char *, libvlc_exception_t * );
859
860 /**
861  * Toggle teletext transparent status on video output
862  * \param p_input the input
863  * \param p_exception an initialized exception
864  */
865 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
866
867 /**
868  * Get current teletext page requested.
869  * \param p_input the input
870  * \param p_exception an initialized exception
871  * \return the current teletext page requested.
872  */
873 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
874
875 /**
876  * Set new teletext page to retrieve
877  * \param p_input the input
878  * \param i_page teletex page number requested
879  * \param p_exception an initialized exception
880  */
881 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_instance_t *, int, libvlc_exception_t * );
882
883 /**
884  * Take a snapshot of the current video window
885  * If i_width AND i_height is 0, original size is used
886  * if i_width XOR i_height is 0, original aspect-ratio is preserved
887  * \param p_input the input
888  * \param psz_filepath the path where to save the screenshot to
889  * \param i_width the snapshot's width
890  * \param i_height the snapshot's height
891  * \param p_exception an initialized exception
892  */
893 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_instance_t *, char *,unsigned int, unsigned int, libvlc_exception_t * );
894
895 VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *);
896
897 /**
898  * Resize the current video output window
899  * \param p_instance libvlc instance
900  * \param width new width for video output window
901  * \param height new height for video output window
902  * \param p_exception an initialized exception
903  * \return the success status (boolean)
904  */
905 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *);
906
907 /**
908  * change the parent for the current the video output
909  * \param p_instance libvlc instance
910  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
911  * \param p_exception an initialized exception
912  * \return the success status (boolean)
913  */
914 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
915
916 /**
917  * Tell windowless video output to redraw rectangular area (MacOS X only)
918  * \param p_instance libvlc instance
919  * \param area coordinates within video drawable
920  * \param p_exception an initialized exception
921  */
922 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
923
924 /**
925  * Set the default video output parent
926  *  this settings will be used as default for all video outputs
927  * \param p_instance libvlc instance
928  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
929  * \param p_exception an initialized exception
930  */
931 VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
932
933 /**
934  * Set the default video output parent
935  *  this settings will be used as default for all video outputs
936  * \param p_instance libvlc instance
937  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
938  * \param p_exception an initialized exception
939  */
940 VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
941
942 /**
943  * Set the default video output size
944  *  this settings will be used as default for all video outputs
945  * \param p_instance libvlc instance
946  * \param width new width for video drawable
947  * \param height new height for video drawable
948  * \param p_exception an initialized exception
949  */
950 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
951
952 /**
953  * Set the default video output viewport for a windowless video output (MacOS X only)
954  *  this settings will be used as default for all video outputs
955  * \param p_instance libvlc instance
956  * \param view coordinates within video drawable
957  * \param clip coordinates within video drawable
958  * \param p_exception an initialized exception
959  */
960 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
961
962 /** @} */
963
964 /** defgroup libvlc_audio Audio
965  * \ingroup libvlc
966  * LibVLC Audio handling
967  * @{
968  */
969
970 /**
971  * Toggle mute status
972  * \param p_instance libvlc instance
973  * \param p_exception an initialized exception
974  * \return void
975  */
976 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
977
978 /**
979  * Get current mute status
980  * \param p_instance libvlc instance
981  * \param p_exception an initialized exception
982  * \return the mute status (boolean)
983  */
984 VLC_PUBLIC_API vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
985
986 /**
987  * Set mute status
988  * \param p_instance libvlc instance
989  * \param status If status is VLC_TRUE then mute, otherwise unmute
990  * \param p_exception an initialized exception
991  * \return void
992  */
993 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * );
994
995 /**
996  * Get current audio level
997  * \param p_instance libvlc instance
998  * \param p_exception an initialized exception
999  * \return the audio level (int)
1000  */
1001 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
1002
1003 /**
1004  * Set current audio level
1005  * \param p_instance libvlc instance
1006  * \param i_volume the volume (int)
1007  * \param p_exception an initialized exception
1008  */
1009 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
1010
1011 /**
1012  * Get number of available audio tracks
1013  * \param p_mi media instance
1014  * \param p_e an initialized exception
1015  * \return the number of available audio tracks (int)
1016  */
1017 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_instance_t *,  libvlc_exception_t * );
1018
1019 /**
1020 +  * Get current audio track
1021 +  * \param p_input input instance
1022 +  * \param p_exception an initialized exception
1023 +  * \return the audio track (int)
1024 +  */
1025 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_instance_t *, libvlc_exception_t * );
1026
1027 /**
1028  * Set current audio track
1029  * \param p_input input instance
1030  * \param i_track the track (int)
1031  * \param p_exception an initialized exception
1032  */
1033 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_instance_t *, int, libvlc_exception_t * );
1034
1035 /**
1036  * Get current audio channel
1037  * \param p_instance input instance
1038  * \param p_exception an initialized exception
1039  * \return the audio channel (int)
1040  */
1041 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
1042
1043 /**
1044  * Set current audio channel
1045  * \param p_instance input instance
1046  * \param i_channel the audio channel (int)
1047  * \param p_exception an initialized exception
1048  */
1049 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * );
1050
1051 /** @} */
1052
1053 /*****************************************************************************
1054  * Services/Media Discovery
1055  *****************************************************************************/
1056 /** defgroup libvlc_media_discoverer Media Discoverer
1057  * \ingroup libvlc
1058  * LibVLC Media Discoverer
1059  * @{
1060  */
1061
1062 VLC_PUBLIC_API libvlc_media_discoverer_t *
1063 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
1064                                        const char * psz_name,
1065                                        libvlc_exception_t * p_e );
1066 VLC_PUBLIC_API void   libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
1067 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
1068
1069 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
1070
1071 VLC_PUBLIC_API libvlc_event_manager_t *
1072         libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis );
1073
1074 VLC_PUBLIC_API vlc_bool_t
1075         libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis );
1076
1077 /**@} */
1078
1079 /*****************************************************************************
1080  * VLM
1081  *****************************************************************************/
1082 /** defgroup libvlc_vlm VLM
1083  * \ingroup libvlc
1084  * LibVLC VLM
1085  * @{
1086  */
1087
1088 /**
1089  * Add a broadcast, with one input
1090  * \param p_instance the instance
1091  * \param psz_name the name of the new broadcast
1092  * \param psz_input the input MRL
1093  * \param psz_output the output MRL (the parameter to the "sout" variable)
1094  * \param i_options number of additional options
1095  * \param ppsz_options additional options
1096  * \param b_enabled boolean for enabling the new broadcast
1097  * \param b_loop Should this broadcast be played in loop ?
1098  * \param p_exception an initialized exception
1099  */
1100 VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
1101                                               int, char **, int, int, libvlc_exception_t * );
1102
1103 /**
1104  * Delete a media (vod or broadcast)
1105  * \param p_instance the instance
1106  * \param psz_name the media to delete
1107  * \param p_exception an initialized exception
1108  */
1109 VLC_PUBLIC_API void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1110
1111 /**
1112  * Enable or disable a media (vod or broadcast)
1113  * \param p_instance the instance
1114  * \param psz_name the media to work on
1115  * \param b_enabled the new status
1116  * \param p_exception an initialized exception
1117  */
1118 VLC_PUBLIC_API void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
1119                                             libvlc_exception_t *);
1120
1121 /**
1122  * Set the output for a media
1123  * \param p_instance the instance
1124  * \param psz_name the media to work on
1125  * \param psz_output the output MRL (the parameter to the "sout" variable)
1126  * \param p_exception an initialized exception
1127  */
1128 VLC_PUBLIC_API void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
1129                                            libvlc_exception_t *);
1130
1131 /**
1132  * Set a media's input MRL. This will delete all existing inputs and
1133  * add the specified one.
1134  * \param p_instance the instance
1135  * \param psz_name the media to work on
1136  * \param psz_input the input MRL
1137  * \param p_exception an initialized exception
1138  */
1139 VLC_PUBLIC_API void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
1140                                           libvlc_exception_t *);
1141
1142 /**
1143  * Add a media's input MRL. This will add the specified one.
1144  * \param p_instance the instance
1145  * \param psz_name the media to work on
1146  * \param psz_input the input MRL
1147  * \param p_exception an initialized exception
1148  */
1149 VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, char *, char *,
1150                                           libvlc_exception_t *p_exception );
1151 /**
1152  * Set output for a media
1153  * \param p_instance the instance
1154  * \param psz_name the media to work on
1155  * \param b_loop the new status
1156  * \param p_exception an initialized exception
1157  */
1158 VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
1159                                          libvlc_exception_t *);
1160
1161 /**
1162  * Edit the parameters of a media. This will delete all existing inputs and
1163  * add the specified one.
1164  * \param p_instance the instance
1165  * \param psz_name the name of the new broadcast
1166  * \param psz_input the input MRL
1167  * \param psz_output the output MRL (the parameter to the "sout" variable)
1168  * \param i_options number of additional options
1169  * \param ppsz_options additional options
1170  * \param b_enabled boolean for enabling the new broadcast
1171  * \param b_loop Should this broadcast be played in loop ?
1172  * \param p_exception an initialized exception
1173  */
1174 VLC_PUBLIC_API void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
1175                                              int, char **, int, int, libvlc_exception_t * );
1176
1177 /**
1178  * Plays the named broadcast.
1179  * \param p_instance the instance
1180  * \param psz_name the name of the broadcast
1181  * \param p_exception an initialized exception
1182  */
1183 VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1184
1185 /**
1186  * Stops the named broadcast.
1187  * \param p_instance the instance
1188  * \param psz_name the name of the broadcast
1189  * \param p_exception an initialized exception
1190  */
1191 VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1192
1193 /**
1194  * Pauses the named broadcast.
1195  * \param p_instance the instance
1196  * \param psz_name the name of the broadcast
1197  * \param p_exception an initialized exception
1198  */
1199 VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1200
1201 /**
1202  * Seeks in the named broadcast.
1203  * \param p_instance the instance
1204  * \param psz_name the name of the broadcast
1205  * \param f_percentage the percentage to seek to
1206  * \param p_exception an initialized exception
1207  */
1208 VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
1209                                            float, libvlc_exception_t * );
1210
1211 /**
1212  * Return information of the named broadcast.
1213  * \param p_instance the instance
1214  * \param psz_name the name of the broadcast
1215  * \param p_exception an initialized exception
1216  */
1217 VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1218
1219 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
1220 returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \
1221                         char *, int , libvlc_exception_t * );
1222
1223 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1);
1224 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time, int, Integer, -1);
1225 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length, int, Integer, -1);
1226 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate, int, Integer, -1);
1227 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title, int, Integer, 0);
1228 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter, int, Integer, 0);
1229 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
1230
1231 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
1232
1233 /** @} */
1234
1235 /*****************************************************************************
1236  * Message log handling
1237  *****************************************************************************/
1238
1239 /** defgroup libvlc_log Log
1240  * \ingroup libvlc
1241  * LibVLC Message Logging
1242  * @{
1243  */
1244
1245 /**
1246  * Returns the VLC messaging verbosity level
1247  * \param p_instance libvlc instance
1248  * \param exception an initialized exception pointer
1249  */
1250 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
1251                                                   libvlc_exception_t *p_e );
1252
1253 /**
1254  * Set the VLC messaging verbosity level
1255  * \param p_log libvlc log instance
1256  * \param exception an initialized exception pointer
1257  */
1258 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
1259                                               libvlc_exception_t *p_e );
1260
1261 /**
1262  * Open an instance to VLC message log
1263  * \param p_instance libvlc instance
1264  * \param exception an initialized exception pointer
1265  */
1266 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
1267
1268 /**
1269  * Close an instance of VLC message log
1270  * \param p_log libvlc log instance
1271  * \param exception an initialized exception pointer
1272  */
1273 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
1274
1275 /**
1276  * Returns the number of messages in log
1277  * \param p_log libvlc log instance
1278  * \param exception an initialized exception pointer
1279  */
1280 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
1281
1282 /**
1283  * Clear all messages in log
1284  *  the log should be cleared on a regular basis to avoid clogging
1285  * \param p_log libvlc log instance
1286  * \param exception an initialized exception pointer
1287  */
1288 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
1289
1290 /**
1291  * Allocate and returns a new iterator to messages in log
1292  * \param p_log libvlc log instance
1293  * \param exception an initialized exception pointer
1294  */
1295 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
1296
1297 /**
1298  * Releases a previoulsy allocated iterator
1299  * \param p_log libvlc log iterator
1300  * \param exception an initialized exception pointer
1301  */
1302 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1303
1304 /**
1305  * Returns whether log iterator has more messages
1306  * \param p_log libvlc log iterator
1307  * \param exception an initialized exception pointer
1308  */
1309 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1310
1311 /**
1312  * Returns next log message
1313  *   the content of message must not be freed
1314  * \param p_log libvlc log iterator
1315  * \param exception an initialized exception pointer
1316  */
1317 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
1318                                                                struct libvlc_log_message_t *buffer,
1319                                                                libvlc_exception_t *p_e );
1320
1321 /** @} */
1322
1323 /*****************************************************************************
1324  * Event handling
1325  *****************************************************************************/
1326
1327 /** defgroup libvlc_callbacks Callbacks
1328  * \ingroup libvlc
1329  * LibVLC Events
1330  * @{
1331  */
1332
1333 /**
1334  * Register for an event notification
1335  * \param p_event_manager the event manager to which you want to attach to
1336  * Generally it is obtained by vlc_my_object_event_manager() where my_object
1337  * Is the object you want to listen to.
1338  * \param i_event_type the desired event to which we want to listen
1339  * \param f_callback the function to call when i_event_type occurs
1340  * \param user_data user provided data to carry with the event
1341  * \param p_e an initialized exception pointer
1342  */
1343 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
1344                                          libvlc_event_type_t i_event_type,
1345                                          libvlc_callback_t f_callback,
1346                                          void *user_data,
1347                                          libvlc_exception_t *p_e );
1348
1349 /**
1350  * Unregister an event notification
1351  * \param p_event_manager the event manager
1352  * \param i_event_type the desired event to which we want to unregister
1353  * \param f_callback the function to call when i_event_type occurs
1354  * \param p_e an initialized exception pointer
1355  */
1356 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
1357                                          libvlc_event_type_t i_event_type,
1358                                          libvlc_callback_t f_callback,
1359                                          void *p_user_data,
1360                                          libvlc_exception_t *p_e );
1361
1362 /**
1363  * Get an event type name
1364  * \param i_event_type the desired event
1365  */
1366 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
1367
1368 /** @} */
1369
1370
1371 # ifdef __cplusplus
1372 }
1373 # endif
1374
1375 #endif /* <vlc/libvlc.h> */