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