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