11c4fb94b692b391167d6ddde9b44ea5cf6b1d70
[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 libvlc_drawable_t
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 the drawable where the media player should render its video output
554  *
555  * \param p_mi the Media Player
556  * \param drawable the libvlc_drawable_t where the media player
557  *        should render its video
558  * \param p_e an initialized exception pointer
559  */
560 VLC_PUBLIC_API void libvlc_media_player_set_drawable ( libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t * );
561
562 /**
563  * Get the drawable where the media player should render its video output
564  *
565  * \param p_mi the Media Player
566  * \param p_e an initialized exception pointer
567  * \return the libvlc_drawable_t where the media player
568  *         should render its video
569  */
570 VLC_PUBLIC_API libvlc_drawable_t
571                     libvlc_media_player_get_drawable ( libvlc_media_player_t *, libvlc_exception_t * );
572
573 /** \bug This might go away ... to be replaced by a broader system */
574
575 /**
576  * Get the current movie length (in ms).
577  *
578  * \param p_mi the Media Player
579  * \param p_e an initialized exception pointer
580  * \return the movie length (in ms).
581  */
582 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length( libvlc_media_player_t *, libvlc_exception_t *);
583
584 /**
585  * Get the current movie time (in ms).
586  *
587  * \param p_mi the Media Player
588  * \param p_e an initialized exception pointer
589  * \return the movie time (in ms).
590  */
591 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *, libvlc_exception_t *);
592
593 /**
594  * Set the movie time (in ms).
595  *
596  * \param p_mi the Media Player
597  * \param the movie time (in ms).
598  * \param p_e an initialized exception pointer
599  */
600 VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *);
601
602 /**
603  * Get movie position.
604  *
605  * \param p_mi the Media Player
606  * \param p_e an initialized exception pointer
607  * \return movie position
608  */
609 VLC_PUBLIC_API float libvlc_media_player_get_position( libvlc_media_player_t *, libvlc_exception_t *);
610
611 /**
612  * Set movie position.
613  *
614  * \param p_mi the Media Player
615  * \param p_e an initialized exception pointer
616  * \return movie position
617  */
618 VLC_PUBLIC_API void libvlc_media_player_set_position( libvlc_media_player_t *, float, libvlc_exception_t *);
619
620 /**
621  * Set movie chapter
622  *
623  * \param p_mi the Media Player
624  * \param i_chapter chapter number to play
625  * \param p_e an initialized exception pointer
626  */
627 VLC_PUBLIC_API void libvlc_media_player_set_chapter( libvlc_media_player_t *, int, libvlc_exception_t *);
628
629 /**
630  * Get movie chapter
631  *
632  * \param p_mi the Media Player
633  * \param p_e an initialized exception pointer
634  * \return chapter number currently playing
635  */
636 VLC_PUBLIC_API int libvlc_media_player_get_chapter( libvlc_media_player_t *, libvlc_exception_t * );
637
638 /**
639  * Get movie chapter count
640  *
641  * \param p_mi the Media Player
642  * \param p_e an initialized exception pointer
643  * \return number of chapters in movie
644  */
645 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *, libvlc_exception_t *);
646 VLC_PUBLIC_API int libvlc_media_player_will_play        ( libvlc_media_player_t *, libvlc_exception_t *);
647
648 /**
649  * Get title chapter count
650  *
651  * \param p_mi the Media Player
652  * \param i_title title
653  * \param p_e an initialized exception pointer
654  * \return number of chapters in title
655  */
656 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count_for_title(
657                        libvlc_media_player_t *, int, libvlc_exception_t *);
658
659 /**
660  * Set movie title
661  *
662  * \param p_mi the Media Player
663  * \param i_title title number to play
664  * \param p_e an initialized exception pointer
665  */
666 VLC_PUBLIC_API void libvlc_media_player_set_title( libvlc_media_player_t *, int, libvlc_exception_t *);
667
668 /**
669  * Get movie title
670  *
671  * \param p_mi the Media Player
672  * \param p_e an initialized exception pointer
673  * \return title number currently playing
674  */
675 VLC_PUBLIC_API int libvlc_media_player_get_title( libvlc_media_player_t *, libvlc_exception_t *);
676
677 /**
678  * Get movie title count
679  *
680  * \param p_mi the Media Player
681  * \param p_e an initialized exception pointer
682  * \return title number count
683  */
684 VLC_PUBLIC_API int libvlc_media_player_get_title_count( libvlc_media_player_t *, libvlc_exception_t *);
685
686 /**
687  * Set previous chapter
688  *
689  * \param p_mi the Media Player
690  * \param p_e an initialized exception pointer
691  */
692 VLC_PUBLIC_API void libvlc_media_player_previous_chapter( libvlc_media_player_t *, libvlc_exception_t *);
693
694 /**
695  * Set next chapter
696  *
697  * \param p_mi the Media Player
698  * \param p_e an initialized exception pointer
699  */
700 VLC_PUBLIC_API void libvlc_media_player_next_chapter( libvlc_media_player_t *, libvlc_exception_t *);
701
702 /**
703  * Get movie play rate
704  *
705  * \param p_mi the Media Player
706  * \param p_e an initialized exception pointer
707  * \return movie play rate
708  */
709 VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t *, libvlc_exception_t *);
710
711 /**
712  * Set movie play rate
713  *
714  * \param p_mi the Media Player
715  * \param movie play rate to set
716  * \param p_e an initialized exception pointer
717  */
718 VLC_PUBLIC_API void libvlc_media_player_set_rate( libvlc_media_player_t *, float, libvlc_exception_t *);
719
720 /**
721  * Get current movie state
722  *
723  * \param p_mi the Media Player
724  * \param p_e an initialized exception pointer
725  * \return current movie state as libvlc_state_t
726  */
727 VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *, libvlc_exception_t *);
728
729 /**
730  * Get movie fps rate
731  *
732  * \param p_mi the Media Player
733  * \param p_e an initialized exception pointer
734  * \return frames per second (fps) for this playing movie
735  */
736 VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *, libvlc_exception_t *);
737
738 /** end bug */
739
740 /**
741  * Does this media player have a video output?
742  *
743  * \param p_md the media player
744  * \param p_e an initialized exception pointer
745  */
746 VLC_PUBLIC_API int  libvlc_media_player_has_vout( libvlc_media_player_t *, libvlc_exception_t *);
747
748 /**
749  * Is this media player seekable?
750  *
751  * \param p_input the input
752  * \param p_e an initialized exception pointer
753  */
754 VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
755
756 /**
757  * Can this media player be paused?
758  *
759  * \param p_input the input
760  * \param p_e an initialized exception pointer
761  */
762 VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
763
764 /**
765  * Release (free) libvlc_track_description_t
766  *
767  * \param p_track_description the structure to release
768  */
769 VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t *p_track_description );
770
771 /** \defgroup libvlc_video libvlc_video
772  * \ingroup libvlc_media_player
773  * LibVLC Video handling
774  * @{
775  */
776
777 /**
778  * Toggle fullscreen status on video output.
779  *
780  * \param p_mediaplayer the media player
781  * \param p_e an initialized exception pointer
782  */
783 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
784
785 /**
786  * Enable or disable fullscreen on a video output.
787  *
788  * \param p_mediaplayer the media player
789  * \param b_fullscreen boolean for fullscreen status
790  * \param p_e an initialized exception pointer
791  */
792 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *, int, libvlc_exception_t * );
793
794 /**
795  * Get current fullscreen status.
796  *
797  * \param p_mediaplayer the media player
798  * \param p_e an initialized exception pointer
799  * \return the fullscreen status (boolean)
800  */
801 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
802
803 /**
804  * Get current video height.
805  *
806  * \param p_mediaplayer the media player
807  * \param p_e an initialized exception pointer
808  * \return the video height
809  */
810 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_player_t *, libvlc_exception_t * );
811
812 /**
813  * Get current video width.
814  *
815  * \param p_mediaplayer the media player
816  * \param p_e an initialized exception pointer
817  * \return the video width
818  */
819 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_player_t *, libvlc_exception_t * );
820
821 /**
822  * Get current video aspect ratio.
823  *
824  * \param p_mediaplayer the media player
825  * \param p_e an initialized exception pointer
826  * \return the video aspect ratio
827  */
828 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *, libvlc_exception_t * );
829
830 /**
831  * Set new video aspect ratio.
832  *
833  * \param p_mediaplayer the media player
834  * \param psz_aspect new video aspect-ratio
835  * \param p_e an initialized exception pointer
836  */
837 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *, char *, libvlc_exception_t * );
838
839 /**
840  * Get current video subtitle.
841  *
842  * \param p_mediaplayer the media player
843  * \param p_e an initialized exception pointer
844  * \return the video subtitle selected
845  */
846 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *, libvlc_exception_t * );
847
848 /**
849  * Get the number of available video subtitles.
850  *
851  * \param p_mediaplayer the media player
852  * \param p_e an initialized exception pointer
853  * \return the number of available video subtitles
854  */
855 VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t *, libvlc_exception_t * );
856
857 /**
858  * Get the description of available video subtitles.
859  *
860  * \param p_mediaplayer the media player
861  * \param p_e an initialized exception pointer
862  * \return list containing description of available video subtitles
863  */
864 VLC_PUBLIC_API libvlc_track_description_t *
865         libvlc_video_get_spu_description( libvlc_media_player_t *, libvlc_exception_t * );
866
867 /**
868  * Set new video subtitle.
869  *
870  * \param p_mediaplayer the media player
871  * \param i_spu new video subtitle to select
872  * \param p_e an initialized exception pointer
873  */
874 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_player_t *, int , libvlc_exception_t * );
875
876 /**
877  * Set new video subtitle file.
878  *
879  * \param p_mediaplayer the media player
880  * \param psz_subtitle new video subtitle file
881  * \param p_e an initialized exception pointer
882  * \return the success status (boolean)
883  */
884 VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *, char *, libvlc_exception_t * );
885
886 /**
887  * Get the description of available titles.
888  *
889  * \param p_mediaplayer the media player
890  * \param p_e an initialized exception pointer
891  * \return list containing description of available titles
892  */
893 VLC_PUBLIC_API libvlc_track_description_t *
894         libvlc_video_get_title_description( libvlc_media_player_t *, libvlc_exception_t * );
895
896 /**
897  * Get the description of available chapters for specific title.
898  *
899  * \param p_mediaplayer the media player
900  * \param i_title selected title
901  * \param p_e an initialized exception pointer
902  * \return list containing description of available chapter for title i_title
903  */
904 VLC_PUBLIC_API libvlc_track_description_t *
905         libvlc_video_get_chapter_description( libvlc_media_player_t *, int, libvlc_exception_t * );
906
907 /**
908  * Get current crop filter geometry.
909  *
910  * \param p_mediaplayer the media player
911  * \param p_e an initialized exception pointer
912  * \return the crop filter geometry
913  */
914 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *, libvlc_exception_t * );
915
916 /**
917  * Set new crop filter geometry.
918  *
919  * \param p_mediaplayer the media player
920  * \param psz_geometry new crop filter geometry
921  * \param p_e an initialized exception pointer
922  */
923 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_player_t *, char *, libvlc_exception_t * );
924
925 /**
926  * Toggle teletext transparent status on video output.
927  *
928  * \param p_mediaplayer the media player
929  * \param p_e an initialized exception pointer
930  */
931 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *, libvlc_exception_t * );
932
933 /**
934  * Get current teletext page requested.
935  *
936  * \param p_mediaplayer the media player
937  * \param p_e an initialized exception pointer
938  * \return the current teletext page requested.
939  */
940 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *, libvlc_exception_t * );
941
942 /**
943  * Set new teletext page to retrieve.
944  *
945  * \param p_mediaplayer the media player
946  * \param i_page teletex page number requested
947  * \param p_e an initialized exception pointer
948  */
949 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_player_t *, int, libvlc_exception_t * );
950
951 /**
952  * Get number of available video tracks.
953  *
954  * \param p_mi media player
955  * \param p_e an initialized exception
956  * \return the number of available video tracks (int)
957  */
958 VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_t *,  libvlc_exception_t * );
959
960 /**
961  * Get the description of available video tracks.
962  *
963  * \param p_mi media player
964  * \param p_e an initialized exception
965  * \return list with description of available video tracks
966  */
967 VLC_PUBLIC_API libvlc_track_description_t *
968         libvlc_video_get_track_description( libvlc_media_player_t *,  libvlc_exception_t * );
969
970 /**
971  * Get current video track.
972  *
973  * \param p_mi media player
974  * \param p_e an initialized exception pointer
975  * \return the video track (int)
976  */
977 VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t *, libvlc_exception_t * );
978
979 /**
980  * Set video track.
981  *
982  * \param p_mi media player
983  * \param i_track the track (int)
984  * \param p_e an initialized exception pointer
985  */
986 VLC_PUBLIC_API void libvlc_video_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
987
988 /**
989  * Take a snapshot of the current video window.
990  *
991  * If i_width AND i_height is 0, original size is used.
992  * If i_width XOR i_height is 0, original aspect-ratio is preserved.
993  *
994  * \param p_mediaplayer the media player
995  * \param psz_filepath the path where to save the screenshot to
996  * \param i_width the snapshot's width
997  * \param i_height the snapshot's height
998  * \param p_e an initialized exception pointer
999  */
1000 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_player_t *, char *,unsigned int, unsigned int, libvlc_exception_t * );
1001
1002 /**
1003  * Resize the current video output window.
1004  *
1005  * \param p_instance libvlc instance
1006  * \param width new width for video output window
1007  * \param height new height for video output window
1008  * \param p_e an initialized exception pointer
1009  * \return the success status (boolean)
1010  */
1011 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_player_t *, int, int, libvlc_exception_t *);
1012
1013 /**
1014  * Change the parent for the current the video output.
1015  *
1016  * \param p_instance libvlc instance
1017  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
1018  * \param p_e an initialized exception pointer
1019  * \return the success status (boolean)
1020  */
1021 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t * );
1022
1023 /**
1024  * Tell windowless video output to redraw rectangular area (MacOS X only).
1025  *
1026  * \param p_instance libvlc instance
1027  * \param area coordinates within video drawable
1028  * \param p_e an initialized exception pointer
1029  */
1030 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_player_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
1031
1032 /**
1033  * Set the default video output size.
1034  *
1035  * This setting will be used as default for all video outputs.
1036  *
1037  * \param p_instance libvlc instance
1038  * \param width new width for video drawable
1039  * \param height new height for video drawable
1040  * \param p_e an initialized exception pointer
1041  */
1042 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
1043
1044 /**
1045  * Set the default video output viewport for a windowless video output
1046  * (MacOS X only).
1047  *
1048  * This setting will be used as default for all video outputs.
1049  *
1050  * \param p_instance libvlc instance
1051  * \param view coordinates within video drawable
1052  * \param clip coordinates within video drawable
1053  * \param p_e an initialized exception pointer
1054  */
1055 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
1056
1057 /** @} video */
1058
1059 /** \defgroup libvlc_audio libvlc_audio
1060  * \ingroup libvlc_media_player
1061  * LibVLC Audio handling
1062  * @{
1063  */
1064
1065 /**
1066  * Audio device types
1067  */
1068 typedef enum libvlc_audio_output_device_types_t {
1069     libvlc_AudioOutputDevice_Error  = -1,
1070     libvlc_AudioOutputDevice_Mono   =  1,
1071     libvlc_AudioOutputDevice_Stereo =  2,
1072     libvlc_AudioOutputDevice_2F2R   =  4,
1073     libvlc_AudioOutputDevice_3F2R   =  5,
1074     libvlc_AudioOutputDevice_5_1    =  6,
1075     libvlc_AudioOutputDevice_6_1    =  7,
1076     libvlc_AudioOutputDevice_7_1    =  8,
1077     libvlc_AudioOutputDevice_SPDIF  = 10
1078 } libvlc_audio_output_device_types_t;
1079
1080 /**
1081  * Audio channels
1082  */
1083 typedef enum libvlc_audio_output_channel_t {
1084     libvlc_AudioChannel_Error   = -1,
1085     libvlc_AudioChannel_Stereo  =  1,
1086     libvlc_AudioChannel_RStereo =  2,
1087     libvlc_AudioChannel_Left    =  3,
1088     libvlc_AudioChannel_Right   =  4,
1089     libvlc_AudioChannel_Dolbys  =  5
1090 } libvlc_audio_output_channel_t;
1091
1092
1093 /**
1094  * Get the list of available audio outputs
1095  *
1096  * \param p_instance libvlc instance
1097  * \param p_e an initialized exception pointer
1098  * \return list of available audio outputs, at the end free it with
1099 *          \see libvlc_audio_output_list_release \see libvlc_audio_output_t
1100  */
1101 VLC_PUBLIC_API libvlc_audio_output_t *
1102         libvlc_audio_output_list_get( libvlc_instance_t *,
1103                                       libvlc_exception_t * );
1104
1105 /**
1106  * Free the list of available audio outputs
1107  *
1108  * \param p_list list with audio outputs for release
1109  */
1110 VLC_PUBLIC_API void libvlc_audio_output_list_release( libvlc_audio_output_t * );
1111
1112 /**
1113  * Set the audio output.
1114  * Change will be applied after stop and play.
1115  *
1116  * \param p_instance libvlc instance
1117  * \param psz_name name of audio output,
1118  *               use psz_name of \see libvlc_audio_output_t
1119  * \return true if function succeded
1120  */
1121 VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_instance_t *,
1122                                             const char * );
1123
1124 /**
1125  * Get count of devices for audio output, these devices are hardware oriented
1126  * like analor or digital output of sound card
1127  *
1128  * \param p_instance libvlc instance
1129  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1130  * \return number of devices
1131  */
1132 VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_t *,
1133                                                      const char * );
1134
1135 /**
1136  * Get long name of device, if not available short name given
1137  *
1138  * \param p_instance libvlc instance
1139  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1140  * \param i_device device index
1141  * \return long name of device
1142  */
1143 VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_t *,
1144                                                            const char *,
1145                                                            int );
1146
1147 /**
1148  * Get id name of device
1149  *
1150  * \param p_instance libvlc instance
1151  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1152  * \param i_device device index
1153  * \return id name of device, use for setting device, need to be free after use
1154  */
1155 VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *,
1156                                                      const char *,
1157                                                      int );
1158
1159 /**
1160  * Set device for using
1161  *
1162  * \param p_instance libvlc instance
1163  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1164  * \param psz_device_id device
1165  */
1166 VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_instance_t *,
1167                                                     const char *,
1168                                                     const char * );
1169
1170 /**
1171  * Get current audio device type. Device type describes something like
1172  * character of output sound - stereo sound, 2.1, 5.1 etc
1173  *
1174  * \param p_instance vlc instance
1175  * \param p_e an initialized exception pointer
1176  * \return the audio devices type \see libvlc_audio_output_device_types_t
1177  */
1178 VLC_PUBLIC_API int libvlc_audio_output_get_device_type(
1179         libvlc_instance_t *, libvlc_exception_t * );
1180
1181 /**
1182  * Set current audio device type.
1183  *
1184  * \param p_instance vlc instance
1185  * \param device_type the audio device type,
1186           according to \see libvlc_audio_output_device_types_t
1187  * \param p_e an initialized exception pointer
1188  */
1189 VLC_PUBLIC_API void libvlc_audio_output_set_device_type( libvlc_instance_t *,
1190                                                          int,
1191                                                          libvlc_exception_t * );
1192
1193
1194 /**
1195  * Toggle mute status.
1196  *
1197  * \param p_instance libvlc instance
1198  * \param p_e an initialized exception pointer
1199  */
1200 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
1201
1202 /**
1203  * Get current mute status.
1204  *
1205  * \param p_instance libvlc instance
1206  * \param p_e an initialized exception pointer
1207  * \return the mute status (boolean)
1208  */
1209 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
1210
1211 /**
1212  * Set mute status.
1213  *
1214  * \param p_instance libvlc instance
1215  * \param status If status is true then mute, otherwise unmute
1216  * \param p_e an initialized exception pointer
1217  */
1218 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, int , libvlc_exception_t * );
1219
1220 /**
1221  * Get current audio level.
1222  *
1223  * \param p_instance libvlc instance
1224  * \param p_e an initialized exception pointer
1225  * \return the audio level (int)
1226  */
1227 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
1228
1229 /**
1230  * Set current audio level.
1231  *
1232  * \param p_instance libvlc instance
1233  * \param i_volume the volume (int)
1234  * \param p_e an initialized exception pointer
1235  */
1236 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
1237
1238 /**
1239  * Get number of available audio tracks.
1240  *
1241  * \param p_mi media player
1242  * \param p_e an initialized exception
1243  * \return the number of available audio tracks (int)
1244  */
1245 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *,  libvlc_exception_t * );
1246
1247  /**
1248  * Get the description of available audio tracks.
1249  *
1250  * \param p_mi media player
1251  * \param p_e an initialized exception
1252  * \return list with description of available audio tracks
1253  */
1254 VLC_PUBLIC_API libvlc_track_description_t *
1255         libvlc_audio_get_track_description( libvlc_media_player_t *,  libvlc_exception_t * );
1256
1257 /**
1258  * Get current audio track.
1259  *
1260  * \param p_mi media player
1261  * \param p_e an initialized exception pointer
1262  * \return the audio track (int)
1263  */
1264 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *, libvlc_exception_t * );
1265
1266 /**
1267  * Set current audio track.
1268  *
1269  * \param p_mi media player
1270  * \param i_track the track (int)
1271  * \param p_e an initialized exception pointer
1272  */
1273 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
1274
1275 /**
1276  * Get current audio channel.
1277  *
1278  * \param p_instance vlc instance
1279  * \param p_e an initialized exception pointer
1280  * \return the audio channel \see libvlc_audio_output_channel_t
1281  */
1282 VLC_PUBLIC_API int
1283     libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
1284
1285 /**
1286  * Set current audio channel.
1287  *
1288  * \param p_instance vlc instance
1289  * \param channel the audio channel, \see libvlc_audio_output_channel_t
1290  * \param p_e an initialized exception pointer
1291  */
1292 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *,
1293                                               int,
1294                                               libvlc_exception_t * );
1295
1296 /** @} audio */
1297
1298 /** @} media_player */
1299
1300 /*****************************************************************************
1301  * Event handling
1302  *****************************************************************************/
1303
1304 /** \defgroup libvlc_event libvlc_event
1305  * \ingroup libvlc_core
1306  * LibVLC Events
1307  * @{
1308  */
1309
1310 /**
1311  * Register for an event notification.
1312  *
1313  * \param p_event_manager the event manager to which you want to attach to.
1314  *        Generally it is obtained by vlc_my_object_event_manager() where
1315  *        my_object is the object you want to listen to.
1316  * \param i_event_type the desired event to which we want to listen
1317  * \param f_callback the function to call when i_event_type occurs
1318  * \param user_data user provided data to carry with the event
1319  * \param p_e an initialized exception pointer
1320  */
1321 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
1322                                          libvlc_event_type_t i_event_type,
1323                                          libvlc_callback_t f_callback,
1324                                          void *user_data,
1325                                          libvlc_exception_t *p_e );
1326
1327 /**
1328  * Unregister an event notification.
1329  *
1330  * \param p_event_manager the event manager
1331  * \param i_event_type the desired event to which we want to unregister
1332  * \param f_callback the function to call when i_event_type occurs
1333  * \param p_user_data user provided data to carry with the event
1334  * \param p_e an initialized exception pointer
1335  */
1336 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
1337                                          libvlc_event_type_t i_event_type,
1338                                          libvlc_callback_t f_callback,
1339                                          void *p_user_data,
1340                                          libvlc_exception_t *p_e );
1341
1342 /**
1343  * Get an event's type name.
1344  *
1345  * \param i_event_type the desired event
1346  */
1347 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
1348
1349 /** @} */
1350
1351 /*****************************************************************************
1352  * Media Library
1353  *****************************************************************************/
1354 /** \defgroup libvlc_media_library libvlc_media_library
1355  * \ingroup libvlc
1356  * LibVLC Media Library
1357  * @{
1358  */
1359 VLC_PUBLIC_API libvlc_media_library_t *
1360     libvlc_media_library_new( libvlc_instance_t * p_inst,
1361                               libvlc_exception_t * p_e );
1362
1363 /**
1364  * Release media library object. This functions decrements the
1365  * reference count of the media library object. If it reaches 0,
1366  * then the object will be released.
1367  *
1368  * \param p_mlib media library object
1369  */
1370 VLC_PUBLIC_API void
1371     libvlc_media_library_release( libvlc_media_library_t * p_mlib );
1372
1373 /**
1374  * Retain a reference to a media library object. This function will
1375  * increment the reference counting for this object. Use
1376  * libvlc_media_library_release() to decrement the reference count.
1377  *
1378  * \param p_mlib media library object
1379  */
1380 VLC_PUBLIC_API void
1381     libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
1382
1383 /**
1384  * Load media library.
1385  *
1386  * \param p_mlib media library object
1387  * \param p_e an initialized exception object.
1388  */
1389 VLC_PUBLIC_API void
1390     libvlc_media_library_load( libvlc_media_library_t * p_mlib,
1391                                libvlc_exception_t * p_e );
1392
1393 /**
1394  * Save 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_save( libvlc_media_library_t * p_mlib,
1401                                libvlc_exception_t * p_e );
1402
1403 /**
1404  * Get media library subitems.
1405  *
1406  * \param p_mlib media library object
1407  * \param p_e an initialized exception object.
1408  * \return media list subitems
1409  */
1410 VLC_PUBLIC_API libvlc_media_list_t *
1411     libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
1412                                      libvlc_exception_t * p_e );
1413
1414
1415 /** @} */
1416
1417
1418 /*****************************************************************************
1419  * Services/Media Discovery
1420  *****************************************************************************/
1421 /** \defgroup libvlc_media_discoverer libvlc_media_discoverer
1422  * \ingroup libvlc
1423  * LibVLC Media Discoverer
1424  * @{
1425  */
1426
1427 /**
1428  * Discover media service by name.
1429  *
1430  * \param p_inst libvlc instance
1431  * \param psz_name service name
1432  * \param p_e an initialized exception object
1433  * \return media discover object
1434  */
1435 VLC_PUBLIC_API libvlc_media_discoverer_t *
1436 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
1437                                        const char * psz_name,
1438                                        libvlc_exception_t * p_e );
1439
1440 /**
1441  * Release media discover object. If the reference count reaches 0, then
1442  * the object will be released.
1443  *
1444  * \param p_mdis media service discover object
1445  */
1446 VLC_PUBLIC_API void   libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
1447
1448 /**
1449  * Get media service discover object its localized name.
1450  *
1451  * \param media discover object
1452  * \return localized name
1453  */
1454 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
1455
1456 /**
1457  * Get media service discover media list.
1458  *
1459  * \param p_mdis media service discover object
1460  * \return list of media items
1461  */
1462 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
1463
1464 /**
1465  * Get event manager from media service discover object.
1466  *
1467  * \param p_mdis media service discover object
1468  * \return event manager object.
1469  */
1470 VLC_PUBLIC_API libvlc_event_manager_t *
1471         libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis );
1472
1473 /**
1474  * Query if media service discover object is running.
1475  *
1476  * \param p_mdis media service discover object
1477  * \return true if running, false if not
1478  */
1479 VLC_PUBLIC_API int
1480         libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis );
1481
1482 /**@} */
1483
1484
1485 /*****************************************************************************
1486  * Message log handling
1487  *****************************************************************************/
1488
1489 /** \defgroup libvlc_log libvlc_log
1490  * \ingroup libvlc_core
1491  * LibVLC Message Logging
1492  * @{
1493  */
1494
1495 /**
1496  * Return the VLC messaging verbosity level.
1497  *
1498  * \param p_instance libvlc instance
1499  * \param p_e an initialized exception pointer
1500  * \return verbosity level for messages
1501  */
1502 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
1503                                                   libvlc_exception_t *p_e );
1504
1505 /**
1506  * Set the VLC messaging verbosity level.
1507  *
1508  * \param p_instance libvlc log instance
1509  * \param level log level
1510  * \param p_e an initialized exception pointer
1511  */
1512 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
1513                                               libvlc_exception_t *p_e );
1514
1515 /**
1516  * Open a VLC message log instance.
1517  *
1518  * \param p_instance libvlc instance
1519  * \param p_e an initialized exception pointer
1520  * \return log message instance
1521  */
1522 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
1523
1524 /**
1525  * Close a VLC message log instance.
1526  *
1527  * \param p_log libvlc log instance
1528  * \param p_e an initialized exception pointer
1529  */
1530 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
1531
1532 /**
1533  * Returns the number of messages in a log instance.
1534  *
1535  * \param p_log libvlc log instance
1536  * \param p_e an initialized exception pointer
1537  * \return number of log messages
1538  */
1539 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
1540
1541 /**
1542  * Clear a log instance.
1543  *
1544  * All messages in the log are removed. The log should be cleared on a
1545  * regular basis to avoid clogging.
1546  *
1547  * \param p_log libvlc log instance
1548  * \param p_e an initialized exception pointer
1549  */
1550 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
1551
1552 /**
1553  * Allocate and returns a new iterator to messages in log.
1554  *
1555  * \param p_log libvlc log instance
1556  * \param p_e an initialized exception pointer
1557  * \return log iterator object
1558  */
1559 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
1560
1561 /**
1562  * Release a previoulsy allocated iterator.
1563  *
1564  * \param p_iter libvlc log iterator
1565  * \param p_e an initialized exception pointer
1566  */
1567 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1568
1569 /**
1570  * Return whether log iterator has more messages.
1571  *
1572  * \param p_iter libvlc log iterator
1573  * \param p_e an initialized exception pointer
1574  * \return true if iterator has more message objects, else false
1575  */
1576 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1577
1578 /**
1579  * Return the next log message.
1580  *
1581  * The message contents must not be freed
1582  *
1583  * \param p_iter libvlc log iterator
1584  * \param p_buffer log buffer
1585  * \param p_e an initialized exception pointer
1586  * \return log message object
1587  */
1588 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
1589                                                                libvlc_log_message_t *p_buffer,
1590                                                                libvlc_exception_t *p_e );
1591
1592 /** @} */
1593
1594 # ifdef __cplusplus
1595 }
1596 # endif
1597
1598 #endif /* <vlc/libvlc.h> */