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