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