git.sesse.net Git - vlc/blob - 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 int         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  * Dynamic Media List
 505  *****************************************************************************/
 506 /** defgroup libvlc_media_list MediaList
 507  * \ingroup libvlc
 508  * LibVLC Media List
 509  * @{ */
 510
 511 VLC_PUBLIC_API libvlc_dynamic_media_list_t *
 512     libvlc_dynamic_media_list_new(  libvlc_media_list_t * p_mlist,
 513                                     libvlc_tag_query_t * p_query,
 514                                     libvlc_tag_t tag,
 515                                     libvlc_exception_t * p_e );
 516 VLC_PUBLIC_API void
 517     libvlc_dynamic_media_list_release( libvlc_dynamic_media_list_t * p_dmlist );
 518
 519 VLC_PUBLIC_API void
 520     libvlc_dynamic_media_list_retain( libvlc_dynamic_media_list_t * p_dmlist );
 521
 522 libvlc_media_list_t *
 523     libvlc_dynamic_media_list_media_list( libvlc_dynamic_media_list_t * p_dmlist,
 524                                           libvlc_exception_t * p_e );
 525
 526 /** @} */
 527
 528 /*****************************************************************************
 529  * Media Library
 530  *****************************************************************************/
 531 /** defgroup libvlc_media_library Media Library
 532  * \ingroup libvlc
 533  * LibVLC Media Library
 534  * @{
 535  */
 536 VLC_PUBLIC_API libvlc_media_library_t *
 537     libvlc_media_library_new( libvlc_instance_t * p_inst,
 538                               libvlc_exception_t * p_e );
 539 VLC_PUBLIC_API void
 540     libvlc_media_library_release( libvlc_media_library_t * p_mlib );
 541 VLC_PUBLIC_API void
 542     libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
 543
 544
 545 VLC_PUBLIC_API void
 546     libvlc_media_library_load( libvlc_media_library_t * p_mlib,
 547                                libvlc_exception_t * p_e );
 548
 549 VLC_PUBLIC_API void
 550     libvlc_media_library_save( libvlc_media_library_t * p_mlib,
 551                                libvlc_exception_t * p_e );
 552
 553 VLC_PUBLIC_API libvlc_media_list_t *
 554     libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
 555                                      libvlc_exception_t * p_e );
 556
 557
 558 /** @} */
 559
 560 /*****************************************************************************
 561  * Media List Player
 562  *****************************************************************************/
 563 /** defgroup libvlc_media_list_player MediaListPlayer
 564  * \ingroup libvlc
 565  * LibVLC Media List Player
 566  * @{
 567  */
 568 VLC_PUBLIC_API libvlc_media_list_player_t *
 569     libvlc_media_list_player_new( libvlc_instance_t * p_instance,
 570                                   libvlc_exception_t * p_e );
 571 VLC_PUBLIC_API void
 572     libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
 573
 574 VLC_PUBLIC_API void
 575     libvlc_media_list_player_set_media_instance(
 576                                      libvlc_media_list_player_t * p_mlp,
 577                                      libvlc_media_instance_t * p_mi,
 578                                      libvlc_exception_t * p_e );
 579
 580 VLC_PUBLIC_API void
 581     libvlc_media_list_player_set_media_list(
 582                                      libvlc_media_list_player_t * p_mlp,
 583                                      libvlc_media_list_t * p_mlist,
 584                                      libvlc_exception_t * p_e );
 585
 586 VLC_PUBLIC_API void
 587     libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
 588                                    libvlc_exception_t * p_e );
 589
 590 VLC_PUBLIC_API void
 591     libvlc_media_list_player_play_item_at_index(
 592                                    libvlc_media_list_player_t * p_mlp,
 593                                    int i_index,
 594                                    libvlc_exception_t * p_e );
 595
 596 VLC_PUBLIC_API void
 597     libvlc_media_list_player_play_item(
 598                                    libvlc_media_list_player_t * p_mlp,
 599                                    libvlc_media_descriptor_t * p_md,
 600                                    libvlc_exception_t * p_e );
 601
 602 VLC_PUBLIC_API void
 603     libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
 604                                    libvlc_exception_t * p_e );
 605 VLC_PUBLIC_API void
 606     libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
 607                                    libvlc_exception_t * p_e );
 608
 609 /** @} */
 610
 611 /** defgroup libvlc_video Video
 612  * \ingroup libvlc
 613  * LibVLC Video handling
 614  * @{
 615  */
 616
 617 /**
 618  * Does this input have a video output ?
 619  * \param p_input the input
 620  * \param p_exception an initialized exception
 621  */
 622 VLC_PUBLIC_API vlc_bool_t  libvlc_input_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
 623 VLC_PUBLIC_API float       libvlc_input_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
 624
 625 /**
 626  * Toggle fullscreen status on video output
 627  * \param p_input the input
 628  * \param p_exception an initialized exception
 629  */
 630 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
 631
 632 /**
 633  * Enable or disable fullscreen on a video output
 634  * \param p_input the input
 635  * \param b_fullscreen boolean for fullscreen status
 636  * \param p_exception an initialized exception
 637  */
 638 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_instance_t *, int, libvlc_exception_t * );
 639
 640 /**
 641  * Get current fullscreen status
 642  * \param p_input the input
 643  * \param p_exception an initialized exception
 644  * \return the fullscreen status (boolean)
 645  */
 646 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
 647
 648 /**
 649  * Get current video height
 650  * \param p_input the input
 651  * \param p_exception an initialized exception
 652  * \return the video height
 653  */
 654 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_instance_t *, libvlc_exception_t * );
 655
 656 /**
 657  * Get current video width
 658  * \param p_input the input
 659  * \param p_exception an initialized exception
 660  * \return the video width
 661  */
 662 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_instance_t *, libvlc_exception_t * );
 663
 664 /**
 665  * Get current video aspect ratio
 666  * \param p_input the input
 667  * \param p_exception an initialized exception
 668  * \return the video aspect ratio
 669  */
 670 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_instance_t *, libvlc_exception_t * );
 671
 672 /**
 673  * Set new video aspect ratio
 674  * \param p_input the input
 675  * \param psz_aspect new video aspect-ratio
 676  * \param p_exception an initialized exception
 677  */
 678 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_instance_t *, char *, libvlc_exception_t * );
 679
 680 /**
 681  * Get current video subtitle
 682  * \param p_input the input
 683  * \param p_exception an initialized exception
 684  * \return the video subtitle selected
 685  */
 686 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_instance_t *, libvlc_exception_t * );
 687
 688 /**
 689  * Set new video subtitle
 690  * \param p_input the input
 691  * \param i_spu new video subtitle to select
 692  * \param p_exception an initialized exception
 693  */
 694 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_instance_t *, int , libvlc_exception_t * );
 695
 696 /**
 697  * Get current crop filter geometry
 698  * \param p_input the input
 699  * \param p_exception an initialized exception
 700  * \return the crop filter geometry
 701  */
 702 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_instance_t *, libvlc_exception_t * );
 703
 704 /**
 705  * Set new crop filter geometry
 706  * \param p_input the input
 707  * \param psz_geometry new crop filter geometry
 708  * \param p_exception an initialized exception
 709  */
 710 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_instance_t *, char *, libvlc_exception_t * );
 711
 712 /**
 713  * Get current teletext page requested.
 714  * \param p_input the input
 715  * \param p_exception an initialized exception
 716  * \return the current teletext page requested.
 717  */
 718 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
 719
 720 /**
 721  * Set new teletext page to retrieve
 722  * \param p_input the input
 723  * \param i_page teletex page number requested
 724  * \param p_exception an initialized exception
 725  */
 726 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_instance_t *, int, libvlc_exception_t * );
 727
 728 /**
 729  * Take a snapshot of the current video window
 730  * \param p_input the input
 731  * \param psz_filepath the path where to save the screenshot to
 732  * \param p_exception an initialized exception
 733  */
 734 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_instance_t *, char *, libvlc_exception_t * );
 735
 736 VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *);
 737
 738 /**
 739  * Resize the current video output window
 740  * \param p_instance libvlc instance
 741  * \param width new width for video output window
 742  * \param height new height for video output window
 743  * \param p_exception an initialized exception
 744  * \return the success status (boolean)
 745  */
 746 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *);
 747
 748 /**
 749  * change the parent for the current the video output
 750  * \param p_instance libvlc instance
 751  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
 752  * \param p_exception an initialized exception
 753  * \return the success status (boolean)
 754  */
 755 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
 756
 757 /**
 758  * Tell windowless video output to redraw rectangular area (MacOS X only)
 759  * \param p_instance libvlc instance
 760  * \param area coordinates within video drawable
 761  * \param p_exception an initialized exception
 762  */
 763 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
 764
 765 /**
 766  * Set the default video output parent
 767  *  this settings will be used as default for all video outputs
 768  * \param p_instance libvlc instance
 769  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
 770  * \param p_exception an initialized exception
 771  */
 772 VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
 773
 774 /**
 775  * Set the default video output parent
 776  *  this settings will be used as default for all video outputs
 777  * \param p_instance libvlc instance
 778  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
 779  * \param p_exception an initialized exception
 780  */
 781 VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
 782
 783 /**
 784  * Set the default video output size
 785  *  this settings will be used as default for all video outputs
 786  * \param p_instance libvlc instance
 787  * \param width new width for video drawable
 788  * \param height new height for video drawable
 789  * \param p_exception an initialized exception
 790  */
 791 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
 792
 793 /**
 794  * Set the default video output viewport for a windowless video output (MacOS X only)
 795  *  this settings will be used as default for all video outputs
 796  * \param p_instance libvlc instance
 797  * \param view coordinates within video drawable
 798  * \param clip coordinates within video drawable
 799  * \param p_exception an initialized exception
 800  */
 801 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
 802
 803 /** @} */
 804
 805 /** defgroup libvlc_audio Audio
 806  * \ingroup libvlc
 807  * LibVLC Audio handling
 808  * @{
 809  */
 810
 811 /**
 812  * Toggle mute status
 813  * \param p_instance libvlc instance
 814  * \param p_exception an initialized exception
 815  * \return void
 816  */
 817 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
 818
 819 /**
 820  * Get current mute status
 821  * \param p_instance libvlc instance
 822  * \param p_exception an initialized exception
 823  * \return the mute status (boolean)
 824  */
 825 VLC_PUBLIC_API vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
 826
 827 /**
 828  * Set mute status
 829  * \param p_instance libvlc instance
 830  * \param status If status is VLC_TRUE then mute, otherwise unmute
 831  * \param p_exception an initialized exception
 832  * \return void
 833  */
 834 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * );
 835
 836 /**
 837  * Get current audio level
 838  * \param p_instance libvlc instance
 839  * \param p_exception an initialized exception
 840  * \return the audio level (int)
 841  */
 842 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
 843
 844 /**
 845  * Set current audio level
 846  * \param p_instance libvlc instance
 847  * \param i_volume the volume (int)
 848  * \param p_exception an initialized exception
 849  */
 850 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
 851
 852 /**
 853 +  * Get current audio track
 854 +  * \param p_input input instance
 855 +  * \param p_exception an initialized exception
 856 +  * \return the audio track (int)
 857 +  */
 858 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_instance_t *, libvlc_exception_t * );
 859
 860 /**
 861  * Set current audio track
 862  * \param p_input input instance
 863  * \param i_track the track (int)
 864  * \param p_exception an initialized exception
 865  */
 866 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_instance_t *, int, libvlc_exception_t * );
 867
 868 /**
 869  * Get current audio channel
 870  * \param p_instance input instance
 871  * \param p_exception an initialized exception
 872  * \return the audio channel (int)
 873  */
 874 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
 875
 876 /**
 877  * Set current audio channel
 878  * \param p_instance input instance
 879  * \param i_channel the audio channel (int)
 880  * \param p_exception an initialized exception
 881  */
 882 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * );
 883
 884 /** @} */
 885
 886 /*****************************************************************************
 887  * Services/Media Discovery
 888  *****************************************************************************/
 889 /** defgroup libvlc_media_discoverer Media Discoverer
 890  * \ingroup libvlc
 891  * LibVLC Media Discoverer
 892  * @{
 893  */
 894
 895 VLC_PUBLIC_API libvlc_media_discoverer_t *
 896 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
 897                                        const char * psz_name,
 898                                        libvlc_exception_t * p_e );
 899 VLC_PUBLIC_API void   libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
 900 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
 901
 902 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
 903
 904 /**@} */
 905
 906 /*****************************************************************************
 907  * VLM
 908  *****************************************************************************/
 909 /** defgroup libvlc_vlm VLM
 910  * \ingroup libvlc
 911  * LibVLC VLM
 912  * @{
 913  */
 914
 915 /**
 916  * Add a broadcast, with one input
 917  * \param p_instance the instance
 918  * \param psz_name the name of the new broadcast
 919  * \param psz_input the input MRL
 920  * \param psz_output the output MRL (the parameter to the "sout" variable)
 921  * \param i_options number of additional options
 922  * \param ppsz_options additional options
 923  * \param b_enabled boolean for enabling the new broadcast
 924  * \param b_loop Should this broadcast be played in loop ?
 925  * \param p_exception an initialized exception
 926  */
 927 VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
 928                                               int, char **, int, int, libvlc_exception_t * );
 929
 930 /**
 931  * Delete a media (vod or broadcast)
 932  * \param p_instance the instance
 933  * \param psz_name the media to delete
 934  * \param p_exception an initialized exception
 935  */
 936 VLC_PUBLIC_API void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
 937
 938 /**
 939  * Enable or disable a media (vod or broadcast)
 940  * \param p_instance the instance
 941  * \param psz_name the media to work on
 942  * \param b_enabled the new status
 943  * \param p_exception an initialized exception
 944  */
 945 VLC_PUBLIC_API void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
 946                                             libvlc_exception_t *);
 947
 948 /**
 949  * Set the output for a media
 950  * \param p_instance the instance
 951  * \param psz_name the media to work on
 952  * \param psz_output the output MRL (the parameter to the "sout" variable)
 953  * \param p_exception an initialized exception
 954  */
 955 VLC_PUBLIC_API void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
 956                                            libvlc_exception_t *);
 957
 958 /**
 959  * Set a media's input MRL. This will delete all existing inputs and
 960  * add the specified one.
 961  * \param p_instance the instance
 962  * \param psz_name the media to work on
 963  * \param psz_input the input MRL
 964  * \param p_exception an initialized exception
 965  */
 966 VLC_PUBLIC_API void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
 967                                           libvlc_exception_t *);
 968
 969 /**
 970  * Add a media's input MRL. This will add the specified one.
 971  * \param p_instance the instance
 972  * \param psz_name the media to work on
 973  * \param psz_input the input MRL
 974  * \param p_exception an initialized exception
 975  */
 976 VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, char *, char *,
 977                                           libvlc_exception_t *p_exception );
 978 /**
 979  * Set output for a media
 980  * \param p_instance the instance
 981  * \param psz_name the media to work on
 982  * \param b_loop the new status
 983  * \param p_exception an initialized exception
 984  */
 985 VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
 986                                          libvlc_exception_t *);
 987
 988 /**
 989  * Edit the parameters of a media. This will delete all existing inputs and
 990  * add the specified one.
 991  * \param p_instance the instance
 992  * \param psz_name the name of the new broadcast
 993  * \param psz_input the input MRL
 994  * \param psz_output the output MRL (the parameter to the "sout" variable)
 995  * \param i_options number of additional options
 996  * \param ppsz_options additional options
 997  * \param b_enabled boolean for enabling the new broadcast
 998  * \param b_loop Should this broadcast be played in loop ?
 999  * \param p_exception an initialized exception
1000  */
1001 VLC_PUBLIC_API void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
1002                                              int, char **, int, int, libvlc_exception_t * );
1003
1004 /**
1005  * Plays the named broadcast.
1006  * \param p_instance the instance
1007  * \param psz_name the name of the broadcast
1008  * \param p_exception an initialized exception
1009  */
1010 VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1011
1012 /**
1013  * Stops the named broadcast.
1014  * \param p_instance the instance
1015  * \param psz_name the name of the broadcast
1016  * \param p_exception an initialized exception
1017  */
1018 VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1019
1020 /**
1021  * Pauses the named broadcast.
1022  * \param p_instance the instance
1023  * \param psz_name the name of the broadcast
1024  * \param p_exception an initialized exception
1025  */
1026 VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1027
1028 /**
1029  * Seeks in the named broadcast.
1030  * \param p_instance the instance
1031  * \param psz_name the name of the broadcast
1032  * \param f_percentage the percentage to seek to
1033  * \param p_exception an initialized exception
1034  */
1035 VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
1036                                            float, libvlc_exception_t * );
1037
1038 /**
1039  * Return information of the named broadcast.
1040  * \param p_instance the instance
1041  * \param psz_name the name of the broadcast
1042  * \param p_exception an initialized exception
1043  */
1044 VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1045
1046 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
1047 returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \
1048                         char *, int , libvlc_exception_t * );
1049
1050 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1);
1051 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time, int, Integer, -1);
1052 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length, int, Integer, -1);
1053 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate, int, Integer, -1);
1054 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title, int, Integer, 0);
1055 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter, int, Integer, 0);
1056 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
1057
1058 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
1059
1060 /** @} */
1061
1062 /*****************************************************************************
1063  * Message log handling
1064  *****************************************************************************/
1065
1066 /** defgroup libvlc_log Log
1067  * \ingroup libvlc
1068  * LibVLC Message Logging
1069  * @{
1070  */
1071
1072 /**
1073  * Returns the VLC messaging verbosity level
1074  * \param p_instance libvlc instance
1075  * \param exception an initialized exception pointer
1076  */
1077 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
1078                                                   libvlc_exception_t *p_e );
1079
1080 /**
1081  * Set the VLC messaging verbosity level
1082  * \param p_log libvlc log instance
1083  * \param exception an initialized exception pointer
1084  */
1085 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
1086                                               libvlc_exception_t *p_e );
1087
1088 /**
1089  * Open an instance to VLC message log
1090  * \param p_instance libvlc instance
1091  * \param exception an initialized exception pointer
1092  */
1093 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( const libvlc_instance_t *, libvlc_exception_t *);
1094
1095 /**
1096  * Close an instance of VLC message log
1097  * \param p_log libvlc log instance
1098  * \param exception an initialized exception pointer
1099  */
1100 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
1101
1102 /**
1103  * Returns the number of messages in log
1104  * \param p_log libvlc log instance
1105  * \param exception an initialized exception pointer
1106  */
1107 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
1108
1109 /**
1110  * Clear all messages in log
1111  *  the log should be cleared on a regular basis to avoid clogging
1112  * \param p_log libvlc log instance
1113  * \param exception an initialized exception pointer
1114  */
1115 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
1116
1117 /**
1118  * Allocate and returns a new iterator to messages in log
1119  * \param p_log libvlc log instance
1120  * \param exception an initialized exception pointer
1121  */
1122 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
1123
1124 /**
1125  * Releases a previoulsy allocated iterator
1126  * \param p_log libvlc log iterator
1127  * \param exception an initialized exception pointer
1128  */
1129 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1130
1131 /**
1132  * Returns whether log iterator has more messages
1133  * \param p_log libvlc log iterator
1134  * \param exception an initialized exception pointer
1135  */
1136 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1137
1138 /**
1139  * Returns next log message
1140  *   the content of message must not be freed
1141  * \param p_log libvlc log iterator
1142  * \param exception an initialized exception pointer
1143  */
1144 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
1145                                                                struct libvlc_log_message_t *buffer,
1146                                                                libvlc_exception_t *p_e );
1147
1148 /** @} */
1149
1150 /*****************************************************************************
1151  * Event handling
1152  *****************************************************************************/
1153
1154 /** defgroup libvlc_callbacks Callbacks
1155  * \ingroup libvlc
1156  * LibVLC Events
1157  * @{
1158  */
1159
1160 /**
1161  * Register for an event notification
1162  * \param p_event_manager the event manager to which you want to attach to
1163  * Generally it is obtained by vlc_my_object_event_manager() where my_object
1164  * Is the object you want to listen to.
1165  * \param i_event_type the desired event to which we want to listen
1166  * \param f_callback the function to call when i_event_type occurs
1167  * \param user_data user provided data to carry with the event
1168  * \param p_e an initialized exception pointer
1169  */
1170 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
1171                                          libvlc_event_type_t i_event_type,
1172                                          libvlc_callback_t f_callback,
1173                                          void *user_data,
1174                                          libvlc_exception_t *p_e );
1175
1176 /**
1177  * Unregister an event notification
1178  * \param p_event_manager the event manager
1179  * \param i_event_type the desired event to which we want to unregister
1180  * \param f_callback the function to call when i_event_type occurs
1181  * \param p_e an initialized exception pointer
1182  */
1183 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
1184                                          libvlc_event_type_t i_event_type,
1185                                          libvlc_callback_t f_callback,
1186                                          void *p_user_data,
1187                                          libvlc_exception_t *p_e );
1188
1189 /**
1190  * Get an event type name
1191  * \param i_event_type the desired event
1192  */
1193 #define libvlc_event_type_name(a) #a
1194
1195 /** @} */
1196
1197
1198 # ifdef __cplusplus
1199 }
1200 # endif
1201
1202 #endif /* <vlc/libvlc.h> */