Deprecate libvlc_media_player_(g|s)et_drawable
[vlc.git] / include / vlc / libvlc.h
1 /*****************************************************************************
2  * libvlc.h:  libvlc external API
3  *****************************************************************************
4  * Copyright (C) 1998-2005 the VideoLAN team
5  * $Id$
6  *
7  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
8  *          Jean-Paul Saman <jpsaman@videolan.org>
9  *          Pierre d'Herbemont <pdherbemont@videolan.org>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24  *****************************************************************************/
25
26 /**
27  * \file
28  * This file defines libvlc external API
29  */
30
31 /**
32  * \defgroup libvlc libvlc
33  * This is libvlc, the base library of the VLC program.
34  *
35  * @{
36  */
37
38 #ifndef VLC_LIBVLC_H
39 #define VLC_LIBVLC_H 1
40
41 #if defined (WIN32) && defined (DLL_EXPORT)
42 # define VLC_PUBLIC_API __declspec(dllexport)
43 #else
44 # define VLC_PUBLIC_API
45 #endif
46
47 #ifdef __LIBVLC__
48 /* Avoid unuseful warnings from libvlc with our deprecated APIs */
49 #   define VLC_DEPRECATED_API VLC_PUBLIC_API
50 #elif defined(__GNUC__) && \
51       (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
52 # define VLC_DEPRECATED_API VLC_PUBLIC_API __attribute__((deprecated))
53 #else
54 # define VLC_DEPRECATED_API VLC_PUBLIC_API
55 #endif
56
57 # ifdef __cplusplus
58 extern "C" {
59 # endif
60
61 /*****************************************************************************
62  * Exception handling
63  *****************************************************************************/
64 /** \defgroup libvlc_exception libvlc_exception
65  * \ingroup libvlc_core
66  * LibVLC Exceptions handling
67  * @{
68  */
69
70 /**
71  * Initialize an exception structure. This can be called several times to
72  * reuse an exception structure.
73  *
74  * \param p_exception the exception to initialize
75  */
76 VLC_PUBLIC_API void libvlc_exception_init( libvlc_exception_t *p_exception );
77
78 /**
79  * Has an exception been raised?
80  *
81  * \param p_exception the exception to query
82  * \return 0 if the exception was raised, 1 otherwise
83  */
84 VLC_PUBLIC_API int
85 libvlc_exception_raised( const libvlc_exception_t *p_exception );
86
87 /**
88  * Raise an exception using a user-provided message.
89  *
90  * \param p_exception the exception to raise
91  * \param psz_format the exception message format string
92  * \param ... the format string arguments
93  */
94 VLC_PUBLIC_API void
95 libvlc_exception_raise( libvlc_exception_t *p_exception,
96                         const char *psz_format, ... );
97
98 /**
99  * Clear an exception object so it can be reused.
100  * The exception object must have be initialized.
101  *
102  * \param p_exception the exception to clear
103  */
104 VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
105
106 /**
107  * Get an exception's message.
108  *
109  * \param p_exception the exception to query
110  * \return the exception message or NULL if not applicable (exception not
111  *         raised, for example)
112  */
113 VLC_PUBLIC_API const char *
114 libvlc_exception_get_message( const libvlc_exception_t *p_exception );
115
116 /**@} */
117
118 /*****************************************************************************
119  * Core handling
120  *****************************************************************************/
121
122 /** \defgroup libvlc_core libvlc_core
123  * \ingroup libvlc
124  * LibVLC Core
125  * @{
126  */
127
128 /**
129  * Create and initialize a libvlc instance.
130  *
131  * \param argc the number of arguments
132  * \param argv command-line-type arguments. argv[0] must be the path of the
133  *        calling program.
134  * \param p_e an initialized exception pointer
135  * \return the libvlc instance
136  */
137 VLC_PUBLIC_API libvlc_instance_t *
138 libvlc_new( int , const char *const *, libvlc_exception_t *);
139
140 /**
141  * Return a libvlc instance identifier for legacy APIs. Use of this
142  * function is discouraged, you should convert your program to use the
143  * new API.
144  *
145  * \param p_instance the instance
146  * \return the instance identifier
147  */
148 VLC_PUBLIC_API int libvlc_get_vlc_id( libvlc_instance_t *p_instance );
149
150 /**
151  * Decrement the reference count of a libvlc instance, and destroy it
152  * if it reaches zero.
153  *
154  * \param p_instance the instance to destroy
155  */
156 VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * );
157
158 /**
159  * Increments the reference count of a libvlc instance.
160  * The initial reference count is 1 after libvlc_new() returns.
161  *
162  * \param p_instance the instance to reference
163  */
164 VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
165
166 /**
167  * Try to start a user interface for the libvlc instance, and wait until the
168  * user exits.
169  *
170  * \param p_instance the instance
171  * \param name interface name, or NULL for default
172  * \param p_exception an initialized exception pointer
173  */
174 VLC_PUBLIC_API
175 void libvlc_add_intf( libvlc_instance_t *p_instance, const char *name,
176                       libvlc_exception_t *p_exception );
177
178 /**
179  * Waits until an interface causes the instance to exit.
180  * You should start at least one interface first, using libvlc_add_intf().
181  *
182  * \param p_instance the instance
183  */
184 VLC_PUBLIC_API
185 void libvlc_wait( libvlc_instance_t *p_instance );
186
187 /**
188  * Retrieve libvlc version.
189  *
190  * Example: "0.9.0-git Grishenko"
191  *
192  * \return a string containing the libvlc version
193  */
194 VLC_PUBLIC_API const char * libvlc_get_version(void);
195
196 /**
197  * Retrieve libvlc compiler version.
198  *
199  * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
200  *
201  * \return a string containing the libvlc compiler version
202  */
203 VLC_PUBLIC_API const char * libvlc_get_compiler(void);
204
205 /**
206  * Retrieve libvlc changeset.
207  *
208  * Example: "aa9bce0bc4"
209  *
210  * \return a string containing the libvlc changeset
211  */
212 VLC_PUBLIC_API const char * libvlc_get_changeset(void);
213
214 struct vlc_object_t;
215
216 /**
217  * Return the libvlc internal object, the main object that all other depend on.
218  * Any of of this function should be considered an ugly hack and avoided at all
219  * cost. E.g. you need to expose some functionality that is not provided by the
220  * libvlc API directly with libvlccore.
221  * Remember to release the object with vlc_object_release( obj* )
222  *
223  * \param p_instance the libvlc instance
224  */
225 VLC_PUBLIC_API struct vlc_object_t *libvlc_get_vlc_instance(libvlc_instance_t *);
226
227 /** @}*/
228
229 /*****************************************************************************
230  * media
231  *****************************************************************************/
232 /** \defgroup libvlc_media libvlc_media
233  * \ingroup libvlc
234  * LibVLC Media
235  * @{
236  */
237
238 /**
239  * Create a media with the given MRL.
240  *
241  * \param p_instance the instance
242  * \param psz_mrl the MRL to read
243  * \param p_e an initialized exception pointer
244  * \return the newly created media
245  */
246 VLC_PUBLIC_API libvlc_media_t * libvlc_media_new(
247                                    libvlc_instance_t *p_instance,
248                                    const char * psz_mrl,
249                                    libvlc_exception_t *p_e );
250
251 /**
252  * Create a media as an empty node with the passed name.
253  *
254  * \param p_instance the instance
255  * \param psz_name the name of the node
256  * \param p_e an initialized exception pointer
257  * \return the new empty media
258  */
259 VLC_PUBLIC_API libvlc_media_t * libvlc_media_new_as_node(
260                                    libvlc_instance_t *p_instance,
261                                    const char * psz_name,
262                                    libvlc_exception_t *p_e );
263
264 /**
265  * Add an option to the media.
266  *
267  * This option will be used to determine how the media_player will
268  * read the media. This allows to use VLC's advanced
269  * reading/streaming options on a per-media basis.
270  *
271  * The options are detailed in vlc --long-help, for instance "--sout-all"
272  *
273  * \param p_instance the instance
274  * \param ppsz_options the options (as a string)
275  * \param p_e an initialized exception pointer
276  */
277 VLC_PUBLIC_API void libvlc_media_add_option(
278                                    libvlc_media_t * p_md,
279                                    const char * ppsz_options,
280                                    libvlc_exception_t * p_e );
281 /**
282  * Add an option to the media from an untrusted source.
283  *
284  * This option will be used to determine how the media_player will
285  * read the media. This allows to use VLC's advanced
286  * reading/streaming options on a per-media basis.
287  *
288  * The options are detailed in vlc --long-help, for instance "--sout-all"
289  *
290  * \param p_instance the instance
291  * \param ppsz_options the options (as a string)
292  * \param p_e an initialized exception pointer
293  */
294 VLC_PUBLIC_API void libvlc_media_add_option_untrusted(
295                                    libvlc_media_t * p_md,
296                                    const char * ppsz_options,
297                                    libvlc_exception_t * p_e );
298
299
300 /**
301  * Retain a reference to a media descriptor object (libvlc_media_t). Use
302  * libvlc_media_release() to decrement the reference count of a
303  * media descriptor object.
304  *
305  * \param p_meta_desc a media descriptor object.
306  */
307 VLC_PUBLIC_API void libvlc_media_retain(
308                                    libvlc_media_t *p_meta_desc );
309
310 /**
311  * Decrement the reference count of a media descriptor object. If the
312  * reference count is 0, then libvlc_media_release() will release the
313  * media descriptor object. It will send out an libvlc_MediaFreed event
314  * to all listeners. If the media descriptor object has been released it
315  * should not be used again.
316  *
317  * \param p_meta_desc a media descriptor object.
318  */
319 VLC_PUBLIC_API void libvlc_media_release(
320                                    libvlc_media_t *p_meta_desc );
321
322
323 /**
324  * Get the media resource locator (mrl) from a media descriptor object
325  *
326  * \param p_md a media descriptor object
327  * \param p_e an initialized exception object
328  * \return string with mrl of media descriptor object
329  */
330 VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md,
331                                                        libvlc_exception_t * p_e );
332
333 /**
334  * Duplicate a media descriptor object.
335  *
336  * \param p_meta_desc a media descriptor object.
337  */
338 VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t * );
339
340 /**
341  * Read the meta of the media.
342  *
343  * \param p_meta_desc the media to read
344  * \param e_meta_desc the meta to read
345  * \param p_e an initialized exception pointer
346  * \return the media's meta
347  */
348 VLC_PUBLIC_API char * libvlc_media_get_meta(
349                                    libvlc_media_t *p_meta_desc,
350                                    libvlc_meta_t e_meta,
351                                    libvlc_exception_t *p_e );
352 /**
353  * Get current state of media descriptor object. Possible media states
354  * are defined in libvlc_structures.c ( libvlc_NothingSpecial=0,
355  * libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused,
356  * libvlc_Stopped, libvlc_Ended,
357  * libvlc_Error).
358  *
359  * @see libvlc_state_t
360  * \param p_meta_desc a media descriptor object
361  * \param p_e an initialized exception object
362  * \return state of media descriptor object
363  */
364 VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state(
365                                    libvlc_media_t *p_meta_desc,
366                                    libvlc_exception_t *p_e );
367
368 /**
369  * Get subitems of media descriptor object. This will increment
370  * the reference count of supplied media descriptor object. Use
371  * libvlc_media_list_release() to decrement the reference counting.
372  *
373  * \param p_md media descriptor object
374  * \param p_e initalized exception object
375  * \return list of media descriptor subitems or NULL
376  */
377 VLC_PUBLIC_API libvlc_media_list_t *
378     libvlc_media_subitems( libvlc_media_t *p_md,
379                                       libvlc_exception_t *p_e );
380 /**
381  * Get event manager from media descriptor object.
382  * NOTE: this function doesn't increment reference counting.
383  *
384  * \param p_md a media descriptor object
385  * \param p_e an initialized exception object
386  * \return event manager object
387  */
388 VLC_PUBLIC_API libvlc_event_manager_t *
389     libvlc_media_event_manager( libvlc_media_t * p_md,
390                                            libvlc_exception_t * p_e );
391
392 /**
393  * Get duration of media descriptor object item.
394  *
395  * \param p_md media descriptor object
396  * \param p_e an initialized exception object
397  * \return duration of media item
398  */
399 VLC_PUBLIC_API libvlc_time_t
400    libvlc_media_get_duration( libvlc_media_t * p_md,
401                                          libvlc_exception_t * p_e );
402
403 /**
404  * Get preparsed status for media descriptor object.
405  *
406  * \param p_md media descriptor object
407  * \param p_e an initialized exception object
408  * \return true if media object has been preparsed otherwise it returns false
409  */
410 VLC_PUBLIC_API int
411    libvlc_media_is_preparsed( libvlc_media_t * p_md,
412                                          libvlc_exception_t * p_e );
413
414 /**
415  * Sets media descriptor's user_data. user_data is specialized data
416  * accessed by the host application, VLC.framework uses it as a pointer to
417  * an native object that references a libvlc_media_t pointer
418  *
419  * \param p_md media descriptor object
420  * \param p_new_user_data pointer to user data
421  * \param p_e an initialized exception object
422  */
423 VLC_PUBLIC_API void
424     libvlc_media_set_user_data( libvlc_media_t * p_md,
425                                            void * p_new_user_data,
426                                            libvlc_exception_t * p_e);
427
428 /**
429  * Get media descriptor's user_data. user_data is specialized data
430  * accessed by the host application, VLC.framework uses it as a pointer to
431  * an native object that references a libvlc_media_t pointer
432  *
433  * \param p_md media descriptor object
434  * \param p_e an initialized exception object
435  */
436 VLC_PUBLIC_API void *
437     libvlc_media_get_user_data( libvlc_media_t * p_md,
438                                            libvlc_exception_t * p_e);
439
440 /** @}*/
441
442 /*****************************************************************************
443  * Media Player
444  *****************************************************************************/
445 /** \defgroup libvlc_media_player libvlc_media_player
446  * \ingroup libvlc
447  * LibVLC Media Player, object that let you play a media
448  * in a custom drawable
449  * @{
450  */
451
452 /**
453  * Create an empty Media Player object
454  *
455  * \param p_libvlc_instance the libvlc instance in which the Media Player
456  *        should be created.
457  * \param p_e an initialized exception pointer
458  */
459 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new( libvlc_instance_t *, libvlc_exception_t * );
460
461 /**
462  * Create a Media Player object from a Media
463  *
464  * \param p_md the media. Afterwards the p_md can be safely
465  *        destroyed.
466  * \param p_e an initialized exception pointer
467  */
468 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new_from_media( libvlc_media_t *, libvlc_exception_t * );
469
470 /**
471  * Release a media_player after use
472  * Decrement the reference count of a media player object. If the
473  * reference count is 0, then libvlc_media_player_release() will
474  * release the media player object. If the media player object
475  * has been released, then it should not be used again.
476  *
477  * \param p_mi the Media Player to free
478  */
479 VLC_PUBLIC_API void libvlc_media_player_release( libvlc_media_player_t * );
480
481 /**
482  * Retain a reference to a media player object. Use
483  * libvlc_media_player_release() to decrement reference count.
484  *
485  * \param p_mi media player object
486  */
487 VLC_PUBLIC_API void libvlc_media_player_retain( libvlc_media_player_t * );
488
489 /**
490  * Set the media that will be used by the media_player. If any,
491  * previous md will be released.
492  *
493  * \param p_mi the Media Player
494  * \param p_md the Media. Afterwards the p_md can be safely
495  *        destroyed.
496  * \param p_e an initialized exception pointer
497  */
498 VLC_PUBLIC_API void libvlc_media_player_set_media( libvlc_media_player_t *, libvlc_media_t *, libvlc_exception_t * );
499
500 /**
501  * Get the media used by the media_player.
502  *
503  * \param p_mi the Media Player
504  * \param p_e an initialized exception pointer
505  * \return the media associated with p_mi, or NULL if no
506  *         media is associated
507  */
508 VLC_PUBLIC_API libvlc_media_t * libvlc_media_player_get_media( libvlc_media_player_t *, libvlc_exception_t * );
509
510 /**
511  * Get the Event Manager from which the media player send event.
512  *
513  * \param p_mi the Media Player
514  * \param p_e an initialized exception pointer
515  * \return the event manager associated with p_mi
516  */
517 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_media_player_t *, libvlc_exception_t * );
518
519 /**
520  * is_playing
521  *
522  * \param p_mi the Media Player
523  * \param p_e an initialized exception pointer
524  * \return 1 if the media player is playing, 0 otherwise
525  */
526 VLC_PUBLIC_API int libvlc_media_player_is_playing ( libvlc_media_player_t *, libvlc_exception_t * );
527
528 /**
529  * Play
530  *
531  * \param p_mi the Media Player
532  * \param p_e an initialized exception pointer
533  */
534 VLC_PUBLIC_API void libvlc_media_player_play ( libvlc_media_player_t *, libvlc_exception_t * );
535
536 /**
537  * Pause
538  *
539  * \param p_mi the Media Player
540  * \param p_e an initialized exception pointer
541  */
542 VLC_PUBLIC_API void libvlc_media_player_pause ( libvlc_media_player_t *, libvlc_exception_t * );
543
544 /**
545  * Stop
546  *
547  * \param p_mi the Media Player
548  * \param p_e an initialized exception pointer
549  */
550 VLC_PUBLIC_API void libvlc_media_player_stop ( libvlc_media_player_t *, libvlc_exception_t * );
551
552 /**
553  * Set an X Window System drawable where the media player should render its
554  * video output. If LibVLC was built without X11 output support, then this has
555  * no effects.
556  *
557  * The specified identifier must correspond to an existing Input/Output class
558  * X11 drawable. The caller shall ensure that the X11 server is the same as the
559  * one the VLC instance has been configured with.
560  * If XVideo is <b>not</b> supported or usable, it is assumed that the drawable
561  * has the following properties in common with the default X11 screen:
562  * depth, scan line pad, black pixel. This is a bug.
563  * Using a pixmap rather than a window might not work as VLC might try to
564  * get window properties and subscribe to window events.
565  *
566  * \param p_mi the Media Player
567  * \param drawable the ID of the X drawable
568  * \param p_e an initialized exception pointer
569  */
570 VLC_PUBLIC_API void libvlc_media_player_set_xid ( libvlc_media_player_t *p_mi, uint32_t drawable, libvlc_exception_t *p_e );
571
572 /**
573  * Set a Win32/Win64 API window handle (HWND) where the media player should
574  * render its video output. If LibVLC was built without Win32/Win64 API output
575  * support, then this has no effects.
576  *
577  * \param p_mi the Media Player
578  * \param drawable windows handle of the drawable
579  * \param p_e an initialized exception pointer
580  */
581 VLC_PUBLIC_API void libvlc_media_player_set_hwnd ( libvlc_media_player_t *p_mi, void *drawable, libvlc_exception_t *p_e );
582
583 /** \bug This might go away ... to be replaced by a broader system */
584
585 /**
586  * Get the current movie length (in ms).
587  *
588  * \param p_mi the Media Player
589  * \param p_e an initialized exception pointer
590  * \return the movie length (in ms).
591  */
592 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length( libvlc_media_player_t *, libvlc_exception_t *);
593
594 /**
595  * Get the current movie time (in ms).
596  *
597  * \param p_mi the Media Player
598  * \param p_e an initialized exception pointer
599  * \return the movie time (in ms).
600  */
601 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *, libvlc_exception_t *);
602
603 /**
604  * Set the movie time (in ms).
605  *
606  * \param p_mi the Media Player
607  * \param the movie time (in ms).
608  * \param p_e an initialized exception pointer
609  */
610 VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *);
611
612 /**
613  * Get movie position.
614  *
615  * \param p_mi the Media Player
616  * \param p_e an initialized exception pointer
617  * \return movie position
618  */
619 VLC_PUBLIC_API float libvlc_media_player_get_position( libvlc_media_player_t *, libvlc_exception_t *);
620
621 /**
622  * Set movie position.
623  *
624  * \param p_mi the Media Player
625  * \param p_e an initialized exception pointer
626  * \return movie position
627  */
628 VLC_PUBLIC_API void libvlc_media_player_set_position( libvlc_media_player_t *, float, libvlc_exception_t *);
629
630 /**
631  * Set movie chapter
632  *
633  * \param p_mi the Media Player
634  * \param i_chapter chapter number to play
635  * \param p_e an initialized exception pointer
636  */
637 VLC_PUBLIC_API void libvlc_media_player_set_chapter( libvlc_media_player_t *, int, libvlc_exception_t *);
638
639 /**
640  * Get movie chapter
641  *
642  * \param p_mi the Media Player
643  * \param p_e an initialized exception pointer
644  * \return chapter number currently playing
645  */
646 VLC_PUBLIC_API int libvlc_media_player_get_chapter( libvlc_media_player_t *, libvlc_exception_t * );
647
648 /**
649  * Get movie chapter count
650  *
651  * \param p_mi the Media Player
652  * \param p_e an initialized exception pointer
653  * \return number of chapters in movie
654  */
655 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *, libvlc_exception_t *);
656 VLC_PUBLIC_API int libvlc_media_player_will_play        ( libvlc_media_player_t *, libvlc_exception_t *);
657
658 /**
659  * Get title chapter count
660  *
661  * \param p_mi the Media Player
662  * \param i_title title
663  * \param p_e an initialized exception pointer
664  * \return number of chapters in title
665  */
666 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count_for_title(
667                        libvlc_media_player_t *, int, libvlc_exception_t *);
668
669 /**
670  * Set movie title
671  *
672  * \param p_mi the Media Player
673  * \param i_title title number to play
674  * \param p_e an initialized exception pointer
675  */
676 VLC_PUBLIC_API void libvlc_media_player_set_title( libvlc_media_player_t *, int, libvlc_exception_t *);
677
678 /**
679  * Get movie title
680  *
681  * \param p_mi the Media Player
682  * \param p_e an initialized exception pointer
683  * \return title number currently playing
684  */
685 VLC_PUBLIC_API int libvlc_media_player_get_title( libvlc_media_player_t *, libvlc_exception_t *);
686
687 /**
688  * Get movie title count
689  *
690  * \param p_mi the Media Player
691  * \param p_e an initialized exception pointer
692  * \return title number count
693  */
694 VLC_PUBLIC_API int libvlc_media_player_get_title_count( libvlc_media_player_t *, libvlc_exception_t *);
695
696 /**
697  * Set previous chapter
698  *
699  * \param p_mi the Media Player
700  * \param p_e an initialized exception pointer
701  */
702 VLC_PUBLIC_API void libvlc_media_player_previous_chapter( libvlc_media_player_t *, libvlc_exception_t *);
703
704 /**
705  * Set next chapter
706  *
707  * \param p_mi the Media Player
708  * \param p_e an initialized exception pointer
709  */
710 VLC_PUBLIC_API void libvlc_media_player_next_chapter( libvlc_media_player_t *, libvlc_exception_t *);
711
712 /**
713  * Get movie play rate
714  *
715  * \param p_mi the Media Player
716  * \param p_e an initialized exception pointer
717  * \return movie play rate
718  */
719 VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t *, libvlc_exception_t *);
720
721 /**
722  * Set movie play rate
723  *
724  * \param p_mi the Media Player
725  * \param movie play rate to set
726  * \param p_e an initialized exception pointer
727  */
728 VLC_PUBLIC_API void libvlc_media_player_set_rate( libvlc_media_player_t *, float, libvlc_exception_t *);
729
730 /**
731  * Get current movie state
732  *
733  * \param p_mi the Media Player
734  * \param p_e an initialized exception pointer
735  * \return current movie state as libvlc_state_t
736  */
737 VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *, libvlc_exception_t *);
738
739 /**
740  * Get movie fps rate
741  *
742  * \param p_mi the Media Player
743  * \param p_e an initialized exception pointer
744  * \return frames per second (fps) for this playing movie
745  */
746 VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *, libvlc_exception_t *);
747
748 /** end bug */
749
750 /**
751  * Does this media player have a video output?
752  *
753  * \param p_md the media player
754  * \param p_e an initialized exception pointer
755  */
756 VLC_PUBLIC_API int  libvlc_media_player_has_vout( libvlc_media_player_t *, libvlc_exception_t *);
757
758 /**
759  * Is this media player seekable?
760  *
761  * \param p_input the input
762  * \param p_e an initialized exception pointer
763  */
764 VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
765
766 /**
767  * Can this media player be paused?
768  *
769  * \param p_input the input
770  * \param p_e an initialized exception pointer
771  */
772 VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
773
774 /**
775  * Release (free) libvlc_track_description_t
776  *
777  * \param p_track_description the structure to release
778  */
779 VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t *p_track_description );
780
781 /** \defgroup libvlc_video libvlc_video
782  * \ingroup libvlc_media_player
783  * LibVLC Video handling
784  * @{
785  */
786
787 /**
788  * Toggle fullscreen status on video output.
789  *
790  * \param p_mediaplayer the media player
791  * \param p_e an initialized exception pointer
792  */
793 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
794
795 /**
796  * Enable or disable fullscreen on a video output.
797  *
798  * \param p_mediaplayer the media player
799  * \param b_fullscreen boolean for fullscreen status
800  * \param p_e an initialized exception pointer
801  */
802 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *, int, libvlc_exception_t * );
803
804 /**
805  * Get current fullscreen status.
806  *
807  * \param p_mediaplayer the media player
808  * \param p_e an initialized exception pointer
809  * \return the fullscreen status (boolean)
810  */
811 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
812
813 /**
814  * Get current video height.
815  *
816  * \param p_mediaplayer the media player
817  * \param p_e an initialized exception pointer
818  * \return the video height
819  */
820 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_player_t *, libvlc_exception_t * );
821
822 /**
823  * Get current video width.
824  *
825  * \param p_mediaplayer the media player
826  * \param p_e an initialized exception pointer
827  * \return the video width
828  */
829 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_player_t *, libvlc_exception_t * );
830
831 /**
832  * Get current video aspect ratio.
833  *
834  * \param p_mediaplayer the media player
835  * \param p_e an initialized exception pointer
836  * \return the video aspect ratio
837  */
838 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *, libvlc_exception_t * );
839
840 /**
841  * Set new video aspect ratio.
842  *
843  * \param p_mediaplayer the media player
844  * \param psz_aspect new video aspect-ratio
845  * \param p_e an initialized exception pointer
846  */
847 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *, char *, libvlc_exception_t * );
848
849 /**
850  * Get current video subtitle.
851  *
852  * \param p_mediaplayer the media player
853  * \param p_e an initialized exception pointer
854  * \return the video subtitle selected
855  */
856 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *, libvlc_exception_t * );
857
858 /**
859  * Get the number of available video subtitles.
860  *
861  * \param p_mediaplayer the media player
862  * \param p_e an initialized exception pointer
863  * \return the number of available video subtitles
864  */
865 VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t *, libvlc_exception_t * );
866
867 /**
868  * Get the description of available video subtitles.
869  *
870  * \param p_mediaplayer the media player
871  * \param p_e an initialized exception pointer
872  * \return list containing description of available video subtitles
873  */
874 VLC_PUBLIC_API libvlc_track_description_t *
875         libvlc_video_get_spu_description( libvlc_media_player_t *, libvlc_exception_t * );
876
877 /**
878  * Set new video subtitle.
879  *
880  * \param p_mediaplayer the media player
881  * \param i_spu new video subtitle to select
882  * \param p_e an initialized exception pointer
883  */
884 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_player_t *, int , libvlc_exception_t * );
885
886 /**
887  * Set new video subtitle file.
888  *
889  * \param p_mediaplayer the media player
890  * \param psz_subtitle new video subtitle file
891  * \param p_e an initialized exception pointer
892  * \return the success status (boolean)
893  */
894 VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *, char *, libvlc_exception_t * );
895
896 /**
897  * Get the description of available titles.
898  *
899  * \param p_mediaplayer the media player
900  * \param p_e an initialized exception pointer
901  * \return list containing description of available titles
902  */
903 VLC_PUBLIC_API libvlc_track_description_t *
904         libvlc_video_get_title_description( libvlc_media_player_t *, libvlc_exception_t * );
905
906 /**
907  * Get the description of available chapters for specific title.
908  *
909  * \param p_mediaplayer the media player
910  * \param i_title selected title
911  * \param p_e an initialized exception pointer
912  * \return list containing description of available chapter for title i_title
913  */
914 VLC_PUBLIC_API libvlc_track_description_t *
915         libvlc_video_get_chapter_description( libvlc_media_player_t *, int, libvlc_exception_t * );
916
917 /**
918  * Get current crop filter geometry.
919  *
920  * \param p_mediaplayer the media player
921  * \param p_e an initialized exception pointer
922  * \return the crop filter geometry
923  */
924 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *, libvlc_exception_t * );
925
926 /**
927  * Set new crop filter geometry.
928  *
929  * \param p_mediaplayer the media player
930  * \param psz_geometry new crop filter geometry
931  * \param p_e an initialized exception pointer
932  */
933 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_player_t *, char *, libvlc_exception_t * );
934
935 /**
936  * Toggle teletext transparent status on video output.
937  *
938  * \param p_mediaplayer the media player
939  * \param p_e an initialized exception pointer
940  */
941 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *, libvlc_exception_t * );
942
943 /**
944  * Get current teletext page requested.
945  *
946  * \param p_mediaplayer the media player
947  * \param p_e an initialized exception pointer
948  * \return the current teletext page requested.
949  */
950 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *, libvlc_exception_t * );
951
952 /**
953  * Set new teletext page to retrieve.
954  *
955  * \param p_mediaplayer the media player
956  * \param i_page teletex page number requested
957  * \param p_e an initialized exception pointer
958  */
959 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_player_t *, int, libvlc_exception_t * );
960
961 /**
962  * Get number of available video tracks.
963  *
964  * \param p_mi media player
965  * \param p_e an initialized exception
966  * \return the number of available video tracks (int)
967  */
968 VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_t *,  libvlc_exception_t * );
969
970 /**
971  * Get the description of available video tracks.
972  *
973  * \param p_mi media player
974  * \param p_e an initialized exception
975  * \return list with description of available video tracks
976  */
977 VLC_PUBLIC_API libvlc_track_description_t *
978         libvlc_video_get_track_description( libvlc_media_player_t *,  libvlc_exception_t * );
979
980 /**
981  * Get current video track.
982  *
983  * \param p_mi media player
984  * \param p_e an initialized exception pointer
985  * \return the video track (int)
986  */
987 VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t *, libvlc_exception_t * );
988
989 /**
990  * Set video track.
991  *
992  * \param p_mi media player
993  * \param i_track the track (int)
994  * \param p_e an initialized exception pointer
995  */
996 VLC_PUBLIC_API void libvlc_video_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
997
998 /**
999  * Take a snapshot of the current video window.
1000  *
1001  * If i_width AND i_height is 0, original size is used.
1002  * If i_width XOR i_height is 0, original aspect-ratio is preserved.
1003  *
1004  * \param p_mediaplayer the media player
1005  * \param psz_filepath the path where to save the screenshot to
1006  * \param i_width the snapshot's width
1007  * \param i_height the snapshot's height
1008  * \param p_e an initialized exception pointer
1009  */
1010 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_player_t *, char *,unsigned int, unsigned int, libvlc_exception_t * );
1011
1012 /**
1013  * Resize the current video output window.
1014  *
1015  * \param p_instance libvlc instance
1016  * \param width new width for video output window
1017  * \param height new height for video output window
1018  * \param p_e an initialized exception pointer
1019  * \return the success status (boolean)
1020  */
1021 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_player_t *, int, int, libvlc_exception_t *);
1022
1023 /**
1024  * Change the parent for the current the video output.
1025  *
1026  * \param p_instance libvlc instance
1027  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
1028  * \param p_e an initialized exception pointer
1029  * \return the success status (boolean)
1030  */
1031 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t * );
1032
1033 /**
1034  * Tell windowless video output to redraw rectangular area (MacOS X only).
1035  *
1036  * \param p_instance libvlc instance
1037  * \param area coordinates within video drawable
1038  * \param p_e an initialized exception pointer
1039  */
1040 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_player_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
1041
1042 /**
1043  * Set the default video output size.
1044  *
1045  * This setting will be used as default for all video outputs.
1046  *
1047  * \param p_instance libvlc instance
1048  * \param width new width for video drawable
1049  * \param height new height for video drawable
1050  * \param p_e an initialized exception pointer
1051  */
1052 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
1053
1054 /**
1055  * Set the default video output viewport for a windowless video output
1056  * (MacOS X only).
1057  *
1058  * This setting will be used as default for all video outputs.
1059  *
1060  * \param p_instance libvlc instance
1061  * \param view coordinates within video drawable
1062  * \param clip coordinates within video drawable
1063  * \param p_e an initialized exception pointer
1064  */
1065 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
1066
1067 /** @} video */
1068
1069 /** \defgroup libvlc_audio libvlc_audio
1070  * \ingroup libvlc_media_player
1071  * LibVLC Audio handling
1072  * @{
1073  */
1074
1075 /**
1076  * Audio device types
1077  */
1078 typedef enum libvlc_audio_output_device_types_t {
1079     libvlc_AudioOutputDevice_Error  = -1,
1080     libvlc_AudioOutputDevice_Mono   =  1,
1081     libvlc_AudioOutputDevice_Stereo =  2,
1082     libvlc_AudioOutputDevice_2F2R   =  4,
1083     libvlc_AudioOutputDevice_3F2R   =  5,
1084     libvlc_AudioOutputDevice_5_1    =  6,
1085     libvlc_AudioOutputDevice_6_1    =  7,
1086     libvlc_AudioOutputDevice_7_1    =  8,
1087     libvlc_AudioOutputDevice_SPDIF  = 10
1088 } libvlc_audio_output_device_types_t;
1089
1090 /**
1091  * Audio channels
1092  */
1093 typedef enum libvlc_audio_output_channel_t {
1094     libvlc_AudioChannel_Error   = -1,
1095     libvlc_AudioChannel_Stereo  =  1,
1096     libvlc_AudioChannel_RStereo =  2,
1097     libvlc_AudioChannel_Left    =  3,
1098     libvlc_AudioChannel_Right   =  4,
1099     libvlc_AudioChannel_Dolbys  =  5
1100 } libvlc_audio_output_channel_t;
1101
1102
1103 /**
1104  * Get the list of available audio outputs
1105  *
1106  * \param p_instance libvlc instance
1107  * \param p_e an initialized exception pointer
1108  * \return list of available audio outputs, at the end free it with
1109 *          \see libvlc_audio_output_list_release \see libvlc_audio_output_t
1110  */
1111 VLC_PUBLIC_API libvlc_audio_output_t *
1112         libvlc_audio_output_list_get( libvlc_instance_t *,
1113                                       libvlc_exception_t * );
1114
1115 /**
1116  * Free the list of available audio outputs
1117  *
1118  * \param p_list list with audio outputs for release
1119  */
1120 VLC_PUBLIC_API void libvlc_audio_output_list_release( libvlc_audio_output_t * );
1121
1122 /**
1123  * Set the audio output.
1124  * Change will be applied after stop and play.
1125  *
1126  * \param p_instance libvlc instance
1127  * \param psz_name name of audio output,
1128  *               use psz_name of \see libvlc_audio_output_t
1129  * \return true if function succeded
1130  */
1131 VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_instance_t *,
1132                                             const char * );
1133
1134 /**
1135  * Get count of devices for audio output, these devices are hardware oriented
1136  * like analor or digital output of sound card
1137  *
1138  * \param p_instance libvlc instance
1139  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1140  * \return number of devices
1141  */
1142 VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_t *,
1143                                                      const char * );
1144
1145 /**
1146  * Get long name of device, if not available short name given
1147  *
1148  * \param p_instance libvlc instance
1149  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1150  * \param i_device device index
1151  * \return long name of device
1152  */
1153 VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_t *,
1154                                                            const char *,
1155                                                            int );
1156
1157 /**
1158  * Get id name of device
1159  *
1160  * \param p_instance libvlc instance
1161  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1162  * \param i_device device index
1163  * \return id name of device, use for setting device, need to be free after use
1164  */
1165 VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *,
1166                                                      const char *,
1167                                                      int );
1168
1169 /**
1170  * Set device for using
1171  *
1172  * \param p_instance libvlc instance
1173  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1174  * \param psz_device_id device
1175  */
1176 VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_instance_t *,
1177                                                     const char *,
1178                                                     const char * );
1179
1180 /**
1181  * Get current audio device type. Device type describes something like
1182  * character of output sound - stereo sound, 2.1, 5.1 etc
1183  *
1184  * \param p_instance vlc instance
1185  * \param p_e an initialized exception pointer
1186  * \return the audio devices type \see libvlc_audio_output_device_types_t
1187  */
1188 VLC_PUBLIC_API int libvlc_audio_output_get_device_type(
1189         libvlc_instance_t *, libvlc_exception_t * );
1190
1191 /**
1192  * Set current audio device type.
1193  *
1194  * \param p_instance vlc instance
1195  * \param device_type the audio device type,
1196           according to \see libvlc_audio_output_device_types_t
1197  * \param p_e an initialized exception pointer
1198  */
1199 VLC_PUBLIC_API void libvlc_audio_output_set_device_type( libvlc_instance_t *,
1200                                                          int,
1201                                                          libvlc_exception_t * );
1202
1203
1204 /**
1205  * Toggle mute status.
1206  *
1207  * \param p_instance libvlc instance
1208  * \param p_e an initialized exception pointer
1209  */
1210 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
1211
1212 /**
1213  * Get current mute status.
1214  *
1215  * \param p_instance libvlc instance
1216  * \param p_e an initialized exception pointer
1217  * \return the mute status (boolean)
1218  */
1219 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
1220
1221 /**
1222  * Set mute status.
1223  *
1224  * \param p_instance libvlc instance
1225  * \param status If status is true then mute, otherwise unmute
1226  * \param p_e an initialized exception pointer
1227  */
1228 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, int , libvlc_exception_t * );
1229
1230 /**
1231  * Get current audio level.
1232  *
1233  * \param p_instance libvlc instance
1234  * \param p_e an initialized exception pointer
1235  * \return the audio level (int)
1236  */
1237 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
1238
1239 /**
1240  * Set current audio level.
1241  *
1242  * \param p_instance libvlc instance
1243  * \param i_volume the volume (int)
1244  * \param p_e an initialized exception pointer
1245  */
1246 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
1247
1248 /**
1249  * Get number of available audio tracks.
1250  *
1251  * \param p_mi media player
1252  * \param p_e an initialized exception
1253  * \return the number of available audio tracks (int)
1254  */
1255 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *,  libvlc_exception_t * );
1256
1257  /**
1258  * Get the description of available audio tracks.
1259  *
1260  * \param p_mi media player
1261  * \param p_e an initialized exception
1262  * \return list with description of available audio tracks
1263  */
1264 VLC_PUBLIC_API libvlc_track_description_t *
1265         libvlc_audio_get_track_description( libvlc_media_player_t *,  libvlc_exception_t * );
1266
1267 /**
1268  * Get current audio track.
1269  *
1270  * \param p_mi media player
1271  * \param p_e an initialized exception pointer
1272  * \return the audio track (int)
1273  */
1274 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *, libvlc_exception_t * );
1275
1276 /**
1277  * Set current audio track.
1278  *
1279  * \param p_mi media player
1280  * \param i_track the track (int)
1281  * \param p_e an initialized exception pointer
1282  */
1283 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
1284
1285 /**
1286  * Get current audio channel.
1287  *
1288  * \param p_instance vlc instance
1289  * \param p_e an initialized exception pointer
1290  * \return the audio channel \see libvlc_audio_output_channel_t
1291  */
1292 VLC_PUBLIC_API int
1293     libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
1294
1295 /**
1296  * Set current audio channel.
1297  *
1298  * \param p_instance vlc instance
1299  * \param channel the audio channel, \see libvlc_audio_output_channel_t
1300  * \param p_e an initialized exception pointer
1301  */
1302 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *,
1303                                               int,
1304                                               libvlc_exception_t * );
1305
1306 /** @} audio */
1307
1308 /** @} media_player */
1309
1310 /*****************************************************************************
1311  * Event handling
1312  *****************************************************************************/
1313
1314 /** \defgroup libvlc_event libvlc_event
1315  * \ingroup libvlc_core
1316  * LibVLC Events
1317  * @{
1318  */
1319
1320 /**
1321  * Register for an event notification.
1322  *
1323  * \param p_event_manager the event manager to which you want to attach to.
1324  *        Generally it is obtained by vlc_my_object_event_manager() where
1325  *        my_object is the object you want to listen to.
1326  * \param i_event_type the desired event to which we want to listen
1327  * \param f_callback the function to call when i_event_type occurs
1328  * \param user_data user provided data to carry with the event
1329  * \param p_e an initialized exception pointer
1330  */
1331 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
1332                                          libvlc_event_type_t i_event_type,
1333                                          libvlc_callback_t f_callback,
1334                                          void *user_data,
1335                                          libvlc_exception_t *p_e );
1336
1337 /**
1338  * Unregister an event notification.
1339  *
1340  * \param p_event_manager the event manager
1341  * \param i_event_type the desired event to which we want to unregister
1342  * \param f_callback the function to call when i_event_type occurs
1343  * \param p_user_data user provided data to carry with the event
1344  * \param p_e an initialized exception pointer
1345  */
1346 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
1347                                          libvlc_event_type_t i_event_type,
1348                                          libvlc_callback_t f_callback,
1349                                          void *p_user_data,
1350                                          libvlc_exception_t *p_e );
1351
1352 /**
1353  * Get an event's type name.
1354  *
1355  * \param i_event_type the desired event
1356  */
1357 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
1358
1359 /** @} */
1360
1361 /*****************************************************************************
1362  * Media Library
1363  *****************************************************************************/
1364 /** \defgroup libvlc_media_library libvlc_media_library
1365  * \ingroup libvlc
1366  * LibVLC Media Library
1367  * @{
1368  */
1369 VLC_PUBLIC_API libvlc_media_library_t *
1370     libvlc_media_library_new( libvlc_instance_t * p_inst,
1371                               libvlc_exception_t * p_e );
1372
1373 /**
1374  * Release media library object. This functions decrements the
1375  * reference count of the media library object. If it reaches 0,
1376  * then the object will be released.
1377  *
1378  * \param p_mlib media library object
1379  */
1380 VLC_PUBLIC_API void
1381     libvlc_media_library_release( libvlc_media_library_t * p_mlib );
1382
1383 /**
1384  * Retain a reference to a media library object. This function will
1385  * increment the reference counting for this object. Use
1386  * libvlc_media_library_release() to decrement the reference count.
1387  *
1388  * \param p_mlib media library object
1389  */
1390 VLC_PUBLIC_API void
1391     libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
1392
1393 /**
1394  * Load media library.
1395  *
1396  * \param p_mlib media library object
1397  * \param p_e an initialized exception object.
1398  */
1399 VLC_PUBLIC_API void
1400     libvlc_media_library_load( libvlc_media_library_t * p_mlib,
1401                                libvlc_exception_t * p_e );
1402
1403 /**
1404  * Save media library.
1405  *
1406  * \param p_mlib media library object
1407  * \param p_e an initialized exception object.
1408  */
1409 VLC_PUBLIC_API void
1410     libvlc_media_library_save( libvlc_media_library_t * p_mlib,
1411                                libvlc_exception_t * p_e );
1412
1413 /**
1414  * Get media library subitems.
1415  *
1416  * \param p_mlib media library object
1417  * \param p_e an initialized exception object.
1418  * \return media list subitems
1419  */
1420 VLC_PUBLIC_API libvlc_media_list_t *
1421     libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
1422                                      libvlc_exception_t * p_e );
1423
1424
1425 /** @} */
1426
1427
1428 /*****************************************************************************
1429  * Services/Media Discovery
1430  *****************************************************************************/
1431 /** \defgroup libvlc_media_discoverer libvlc_media_discoverer
1432  * \ingroup libvlc
1433  * LibVLC Media Discoverer
1434  * @{
1435  */
1436
1437 /**
1438  * Discover media service by name.
1439  *
1440  * \param p_inst libvlc instance
1441  * \param psz_name service name
1442  * \param p_e an initialized exception object
1443  * \return media discover object
1444  */
1445 VLC_PUBLIC_API libvlc_media_discoverer_t *
1446 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
1447                                        const char * psz_name,
1448                                        libvlc_exception_t * p_e );
1449
1450 /**
1451  * Release media discover object. If the reference count reaches 0, then
1452  * the object will be released.
1453  *
1454  * \param p_mdis media service discover object
1455  */
1456 VLC_PUBLIC_API void   libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
1457
1458 /**
1459  * Get media service discover object its localized name.
1460  *
1461  * \param media discover object
1462  * \return localized name
1463  */
1464 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
1465
1466 /**
1467  * Get media service discover media list.
1468  *
1469  * \param p_mdis media service discover object
1470  * \return list of media items
1471  */
1472 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
1473
1474 /**
1475  * Get event manager from media service discover object.
1476  *
1477  * \param p_mdis media service discover object
1478  * \return event manager object.
1479  */
1480 VLC_PUBLIC_API libvlc_event_manager_t *
1481         libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis );
1482
1483 /**
1484  * Query if media service discover object is running.
1485  *
1486  * \param p_mdis media service discover object
1487  * \return true if running, false if not
1488  */
1489 VLC_PUBLIC_API int
1490         libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis );
1491
1492 /**@} */
1493
1494
1495 /*****************************************************************************
1496  * Message log handling
1497  *****************************************************************************/
1498
1499 /** \defgroup libvlc_log libvlc_log
1500  * \ingroup libvlc_core
1501  * LibVLC Message Logging
1502  * @{
1503  */
1504
1505 /**
1506  * Return the VLC messaging verbosity level.
1507  *
1508  * \param p_instance libvlc instance
1509  * \param p_e an initialized exception pointer
1510  * \return verbosity level for messages
1511  */
1512 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
1513                                                   libvlc_exception_t *p_e );
1514
1515 /**
1516  * Set the VLC messaging verbosity level.
1517  *
1518  * \param p_instance libvlc log instance
1519  * \param level log level
1520  * \param p_e an initialized exception pointer
1521  */
1522 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
1523                                               libvlc_exception_t *p_e );
1524
1525 /**
1526  * Open a VLC message log instance.
1527  *
1528  * \param p_instance libvlc instance
1529  * \param p_e an initialized exception pointer
1530  * \return log message instance
1531  */
1532 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
1533
1534 /**
1535  * Close a VLC message log instance.
1536  *
1537  * \param p_log libvlc log instance
1538  * \param p_e an initialized exception pointer
1539  */
1540 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
1541
1542 /**
1543  * Returns the number of messages in a log instance.
1544  *
1545  * \param p_log libvlc log instance
1546  * \param p_e an initialized exception pointer
1547  * \return number of log messages
1548  */
1549 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
1550
1551 /**
1552  * Clear a log instance.
1553  *
1554  * All messages in the log are removed. The log should be cleared on a
1555  * regular basis to avoid clogging.
1556  *
1557  * \param p_log libvlc log instance
1558  * \param p_e an initialized exception pointer
1559  */
1560 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
1561
1562 /**
1563  * Allocate and returns a new iterator to messages in log.
1564  *
1565  * \param p_log libvlc log instance
1566  * \param p_e an initialized exception pointer
1567  * \return log iterator object
1568  */
1569 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
1570
1571 /**
1572  * Release a previoulsy allocated iterator.
1573  *
1574  * \param p_iter libvlc log iterator
1575  * \param p_e an initialized exception pointer
1576  */
1577 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1578
1579 /**
1580  * Return whether log iterator has more messages.
1581  *
1582  * \param p_iter libvlc log iterator
1583  * \param p_e an initialized exception pointer
1584  * \return true if iterator has more message objects, else false
1585  */
1586 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1587
1588 /**
1589  * Return the next log message.
1590  *
1591  * The message contents must not be freed
1592  *
1593  * \param p_iter libvlc log iterator
1594  * \param p_buffer log buffer
1595  * \param p_e an initialized exception pointer
1596  * \return log message object
1597  */
1598 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
1599                                                                libvlc_log_message_t *p_buffer,
1600                                                                libvlc_exception_t *p_e );
1601
1602 /** @} */
1603
1604 # ifdef __cplusplus
1605 }
1606 # endif
1607
1608 #endif /* <vlc/libvlc.h> */