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