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