git.sesse.net Git - vlc/blob - include/vlc/libvlc.h

   1 /*****************************************************************************
   2  * libvlc.h:  libvlc external API
   3  *****************************************************************************
   4  * Copyright (C) 1998-2005 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *          Jean-Paul Saman <jpsaman@videolan.org>
   9  *          Pierre d'Herbemont <pdherbemont@videolan.org>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25
  26 /**
  27  * \file
  28  * This file defines libvlc external API
  29  */
  30
  31 /**
  32  * \defgroup libvlc libvlc
  33  * This is libvlc, the base library of the VLC program.
  34  *
  35  * @{
  36  */
  37
  38 #ifndef VLC_LIBVLC_H
  39 #define VLC_LIBVLC_H 1
  40
  41 #if defined (WIN32) && defined (DLL_EXPORT)
  42 # define VLC_PUBLIC_API __declspec(dllexport)
  43 #else
  44 # define VLC_PUBLIC_API
  45 #endif
  46
  47 #ifdef __LIBVLC__
  48 /* Avoid unuseful warnings from libvlc with our deprecated APIs */
  49 #   define VLC_DEPRECATED_API VLC_PUBLIC_API
  50 #elif defined(__GNUC__) && \
  51       (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
  52 # define VLC_DEPRECATED_API VLC_PUBLIC_API __attribute__((deprecated))
  53 #else
  54 # define VLC_DEPRECATED_API VLC_PUBLIC_API
  55 #endif
  56
  57 # ifdef __cplusplus
  58 extern "C" {
  59 # endif
  60
  61 /*****************************************************************************
  62  * Exception handling
  63  *****************************************************************************/
  64 /** \defgroup libvlc_exception libvlc_exception
  65  * \ingroup libvlc_core
  66  * LibVLC Exceptions handling
  67  * @{
  68  */
  69
  70 /**
  71  * Initialize an exception structure. This can be called several times to
  72  * reuse an exception structure.
  73  *
  74  * \param p_exception the exception to initialize
  75  */
  76 VLC_PUBLIC_API void libvlc_exception_init( libvlc_exception_t *p_exception );
  77
  78 /**
  79  * Has an exception been raised?
  80  *
  81  * \param p_exception the exception to query
  82  * \return 0 if the exception was raised, 1 otherwise
  83  */
  84 VLC_PUBLIC_API int
  85 libvlc_exception_raised( const libvlc_exception_t *p_exception );
  86
  87 /**
  88  * Raise an exception using a user-provided message.
  89  *
  90  * \param p_exception the exception to raise
  91  * \param psz_format the exception message format string
  92  * \param ... the format string arguments
  93  */
  94 VLC_PUBLIC_API void
  95 libvlc_exception_raise( libvlc_exception_t *p_exception,
  96                         const char *psz_format, ... );
  97
  98 /**
  99  * Clear an exception object so it can be reused.
 100  * The exception object must have be initialized.
 101  *
 102  * \param p_exception the exception to clear
 103  */
 104 VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
 105
 106 /**
 107  * Get an exception's message.
 108  *
 109  * \param p_exception the exception to query
 110  * \return the exception message or NULL if not applicable (exception not
 111  *         raised, for example)
 112  */
 113 VLC_PUBLIC_API const char *
 114 libvlc_exception_get_message( const libvlc_exception_t *p_exception );
 115
 116 /**@} */
 117
 118 /*****************************************************************************
 119  * Core handling
 120  *****************************************************************************/
 121
 122 /** \defgroup libvlc_core libvlc_core
 123  * \ingroup libvlc
 124  * LibVLC Core
 125  * @{
 126  */
 127
 128 /**
 129  * Create and initialize a libvlc instance.
 130  *
 131  * \param argc the number of arguments
 132  * \param argv command-line-type arguments. argv[0] must be the path of the
 133  *        calling program.
 134  * \param p_e an initialized exception pointer
 135  * \return the libvlc instance
 136  */
 137 VLC_PUBLIC_API libvlc_instance_t *
 138 libvlc_new( int , const char *const *, libvlc_exception_t *);
 139
 140 /**
 141  * Return a libvlc instance identifier for legacy APIs. Use of this
 142  * function is discouraged, you should convert your program to use the
 143  * new API.
 144  *
 145  * \param p_instance the instance
 146  * \return the instance identifier
 147  */
 148 VLC_PUBLIC_API int libvlc_get_vlc_id( libvlc_instance_t *p_instance );
 149
 150 /**
 151  * Decrement the reference count of a libvlc instance, and destroy it
 152  * if it reaches zero.
 153  *
 154  * \param p_instance the instance to destroy
 155  */
 156 VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * );
 157
 158 /**
 159  * Increments the reference count of a libvlc instance.
 160  * The initial reference count is 1 after libvlc_new() returns.
 161  *
 162  * \param p_instance the instance to reference
 163  */
 164 VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
 165
 166 /**
 167  * Try to start a user interface for the libvlc instance, and wait until the
 168  * user exits.
 169  *
 170  * \param p_instance the instance
 171  * \param name interface name, or NULL for default
 172  * \param p_exception an initialized exception pointer
 173  */
 174 VLC_PUBLIC_API
 175 void libvlc_add_intf( libvlc_instance_t *p_instance, const char *name,
 176                       libvlc_exception_t *p_exception );
 177
 178 /**
 179  * Waits until an interface causes the instance to exit.
 180  * You should start at least one interface first, using libvlc_add_intf().
 181  *
 182  * \param p_instance the instance
 183  */
 184 VLC_PUBLIC_API
 185 void libvlc_wait( libvlc_instance_t *p_instance );
 186
 187 /**
 188  * Retrieve libvlc version.
 189  *
 190  * Example: "0.9.0-git Grishenko"
 191  *
 192  * \return a string containing the libvlc version
 193  */
 194 VLC_PUBLIC_API const char * libvlc_get_version(void);
 195
 196 /**
 197  * Retrieve libvlc compiler version.
 198  *
 199  * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
 200  *
 201  * \return a string containing the libvlc compiler version
 202  */
 203 VLC_PUBLIC_API const char * libvlc_get_compiler(void);
 204
 205 /**
 206  * Retrieve libvlc changeset.
 207  *
 208  * Example: "aa9bce0bc4"
 209  *
 210  * \return a string containing the libvlc changeset
 211  */
 212 VLC_PUBLIC_API const char * libvlc_get_changeset(void);
 213
 214 struct vlc_object_t;
 215
 216 /**
 217  * Return the libvlc internal object, the main object that all other depend on.
 218  * Any of of this function should be considered an ugly hack and avoided at all
 219  * cost. E.g. you need to expose some functionality that is not provided by the
 220  * libvlc API directly with libvlccore.
 221  * Remember to release the object with vlc_object_release( obj* )
 222  *
 223  * \param p_instance the libvlc instance
 224  */
 225 VLC_PUBLIC_API struct vlc_object_t *libvlc_get_vlc_instance(libvlc_instance_t *);
 226
 227 /** @}*/
 228
 229 /*****************************************************************************
 230  * media
 231  *****************************************************************************/
 232 /** \defgroup libvlc_media libvlc_media
 233  * \ingroup libvlc
 234  * LibVLC Media
 235  * @{
 236  */
 237
 238 /**
 239  * Create a media with the given MRL.
 240  *
 241  * \param p_instance the instance
 242  * \param psz_mrl the MRL to read
 243  * \param p_e an initialized exception pointer
 244  * \return the newly created media
 245  */
 246 VLC_PUBLIC_API libvlc_media_t * libvlc_media_new(
 247                                    libvlc_instance_t *p_instance,
 248                                    const char * psz_mrl,
 249                                    libvlc_exception_t *p_e );
 250
 251 /**
 252  * Create a media as an empty node with the passed name.
 253  *
 254  * \param p_instance the instance
 255  * \param psz_name the name of the node
 256  * \param p_e an initialized exception pointer
 257  * \return the new empty media
 258  */
 259 VLC_PUBLIC_API libvlc_media_t * libvlc_media_new_as_node(
 260                                    libvlc_instance_t *p_instance,
 261                                    const char * psz_name,
 262                                    libvlc_exception_t *p_e );
 263
 264 /**
 265  * Add an option to the media.
 266  *
 267  * This option will be used to determine how the media_player will
 268  * read the media. This allows to use VLC's advanced
 269  * reading/streaming options on a per-media basis.
 270  *
 271  * The options are detailed in vlc --long-help, for instance "--sout-all"
 272  *
 273  * \param p_instance the instance
 274  * \param ppsz_options the options (as a string)
 275  * \param p_e an initialized exception pointer
 276  */
 277 VLC_PUBLIC_API void libvlc_media_add_option(
 278                                    libvlc_media_t * p_md,
 279                                    const char * ppsz_options,
 280                                    libvlc_exception_t * p_e );
 281
 282 /**
 283  * Retain a reference to a media descriptor object (libvlc_media_t). Use
 284  * libvlc_media_release() to decrement the reference count of a
 285  * media descriptor object.
 286  *
 287  * \param p_meta_desc a media descriptor object.
 288  */
 289 VLC_PUBLIC_API void libvlc_media_retain(
 290                                    libvlc_media_t *p_meta_desc );
 291
 292 /**
 293  * Decrement the reference count of a media descriptor object. If the
 294  * reference count is 0, then libvlc_media_release() will release the
 295  * media descriptor object. It will send out an libvlc_MediaFreed event
 296  * to all listeners. If the media descriptor object has been released it
 297  * should not be used again.
 298  *
 299  * \param p_meta_desc a media descriptor object.
 300  */
 301 VLC_PUBLIC_API void libvlc_media_release(
 302                                    libvlc_media_t *p_meta_desc );
 303
 304
 305 /**
 306  * Get the media resource locator (mrl) from a media descriptor object
 307  *
 308  * \param p_md a media descriptor object
 309  * \param p_e an initialized exception object
 310  * \return string with mrl of media descriptor object
 311  */
 312 VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md,
 313                                                        libvlc_exception_t * p_e );
 314
 315 /**
 316  * Duplicate a media descriptor object.
 317  *
 318  * \param p_meta_desc a media descriptor object.
 319  */
 320 VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t * );
 321
 322 /**
 323  * Read the meta of the media.
 324  *
 325  * \param p_meta_desc the media to read
 326  * \param e_meta_desc the meta to read
 327  * \param p_e an initialized exception pointer
 328  * \return the media's meta
 329  */
 330 VLC_PUBLIC_API char * libvlc_media_get_meta(
 331                                    libvlc_media_t *p_meta_desc,
 332                                    libvlc_meta_t e_meta,
 333                                    libvlc_exception_t *p_e );
 334 /**
 335  * Get current state of media descriptor object. Possible media states
 336  * are defined in libvlc_structures.c ( libvlc_NothingSpecial=0,
 337  * libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused,
 338  * libvlc_Stopped, libvlc_Ended,
 339  * libvlc_Error).
 340  *
 341  * @see libvlc_state_t
 342  * \param p_meta_desc a media descriptor object
 343  * \param p_e an initialized exception object
 344  * \return state of media descriptor object
 345  */
 346 VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state(
 347                                    libvlc_media_t *p_meta_desc,
 348                                    libvlc_exception_t *p_e );
 349
 350 /**
 351  * Get subitems of media descriptor object. This will increment
 352  * the reference count of supplied media descriptor object. Use
 353  * libvlc_media_list_release() to decrement the reference counting.
 354  *
 355  * \param p_md media descriptor object
 356  * \param p_e initalized exception object
 357  * \return list of media descriptor subitems or NULL
 358  */
 359 VLC_PUBLIC_API libvlc_media_list_t *
 360     libvlc_media_subitems( libvlc_media_t *p_md,
 361                                       libvlc_exception_t *p_e );
 362 /**
 363  * Get event manager from media descriptor object.
 364  * NOTE: this function doesn't increment reference counting.
 365  *
 366  * \param p_md a media descriptor object
 367  * \param p_e an initialized exception object
 368  * \return event manager object
 369  */
 370 VLC_PUBLIC_API libvlc_event_manager_t *
 371     libvlc_media_event_manager( libvlc_media_t * p_md,
 372                                            libvlc_exception_t * p_e );
 373
 374 /**
 375  * Get duration of media descriptor object item.
 376  *
 377  * \param p_md media descriptor object
 378  * \param p_e an initialized exception object
 379  * \return duration of media item
 380  */
 381 VLC_PUBLIC_API libvlc_time_t
 382    libvlc_media_get_duration( libvlc_media_t * p_md,
 383                                          libvlc_exception_t * p_e );
 384
 385 /**
 386  * Get preparsed status for media descriptor object.
 387  *
 388  * \param p_md media descriptor object
 389  * \param p_e an initialized exception object
 390  * \return true if media object has been preparsed otherwise it returns false
 391  */
 392 VLC_PUBLIC_API int
 393    libvlc_media_is_preparsed( libvlc_media_t * p_md,
 394                                          libvlc_exception_t * p_e );
 395
 396 /**
 397  * Sets media descriptor's user_data. user_data is specialized data
 398  * accessed by the host application, VLC.framework uses it as a pointer to
 399  * an native object that references a libvlc_media_t pointer
 400  *
 401  * \param p_md media descriptor object
 402  * \param p_new_user_data pointer to user data
 403  * \param p_e an initialized exception object
 404  */
 405 VLC_PUBLIC_API void
 406     libvlc_media_set_user_data( libvlc_media_t * p_md,
 407                                            void * p_new_user_data,
 408                                            libvlc_exception_t * p_e);
 409
 410 /**
 411  * Get media descriptor's user_data. user_data is specialized data
 412  * accessed by the host application, VLC.framework uses it as a pointer to
 413  * an native object that references a libvlc_media_t pointer
 414  *
 415  * \param p_md media descriptor object
 416  * \param p_e an initialized exception object
 417  */
 418 VLC_PUBLIC_API void *
 419     libvlc_media_get_user_data( libvlc_media_t * p_md,
 420                                            libvlc_exception_t * p_e);
 421
 422 /** @}*/
 423
 424 /*****************************************************************************
 425  * Media Player
 426  *****************************************************************************/
 427 /** \defgroup libvlc_media_player libvlc_media_player
 428  * \ingroup libvlc
 429  * LibVLC Media Player, object that let you play a media
 430  * in a libvlc_drawable_t
 431  * @{
 432  */
 433
 434 /**
 435  * Create an empty Media Player object
 436  *
 437  * \param p_libvlc_instance the libvlc instance in which the Media Player
 438  *        should be created.
 439  * \param p_e an initialized exception pointer
 440  */
 441 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new( libvlc_instance_t *, libvlc_exception_t * );
 442
 443 /**
 444  * Create a Media Player object from a Media
 445  *
 446  * \param p_md the media. Afterwards the p_md can be safely
 447  *        destroyed.
 448  * \param p_e an initialized exception pointer
 449  */
 450 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new_from_media( libvlc_media_t *, libvlc_exception_t * );
 451
 452 /**
 453  * Release a media_player after use
 454  * Decrement the reference count of a media player object. If the
 455  * reference count is 0, then libvlc_media_player_release() will
 456  * release the media player object. If the media player object
 457  * has been released, then it should not be used again.
 458  *
 459  * \param p_mi the Media Player to free
 460  */
 461 VLC_PUBLIC_API void libvlc_media_player_release( libvlc_media_player_t * );
 462
 463 /**
 464  * Retain a reference to a media player object. Use
 465  * libvlc_media_player_release() to decrement reference count.
 466  *
 467  * \param p_mi media player object
 468  */
 469 VLC_PUBLIC_API void libvlc_media_player_retain( libvlc_media_player_t * );
 470
 471 /**
 472  * Set the media that will be used by the media_player. If any,
 473  * previous md will be released.
 474  *
 475  * \param p_mi the Media Player
 476  * \param p_md the Media. Afterwards the p_md can be safely
 477  *        destroyed.
 478  * \param p_e an initialized exception pointer
 479  */
 480 VLC_PUBLIC_API void libvlc_media_player_set_media( libvlc_media_player_t *, libvlc_media_t *, libvlc_exception_t * );
 481
 482 /**
 483  * Get the media used by the media_player.
 484  *
 485  * \param p_mi the Media Player
 486  * \param p_e an initialized exception pointer
 487  * \return the media associated with p_mi, or NULL if no
 488  *         media is associated
 489  */
 490 VLC_PUBLIC_API libvlc_media_t * libvlc_media_player_get_media( libvlc_media_player_t *, libvlc_exception_t * );
 491
 492 /**
 493  * Get the Event Manager from which the media player send event.
 494  *
 495  * \param p_mi the Media Player
 496  * \param p_e an initialized exception pointer
 497  * \return the event manager associated with p_mi
 498  */
 499 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_media_player_t *, libvlc_exception_t * );
 500
 501 /**
 502  * is_playing
 503  *
 504  * \param p_mi the Media Player
 505  * \param p_e an initialized exception pointer
 506  * \return 1 if the media player is playing, 0 otherwise
 507  */
 508 VLC_PUBLIC_API int libvlc_media_player_is_playing ( libvlc_media_player_t *, libvlc_exception_t * );
 509
 510 /**
 511  * Play
 512  *
 513  * \param p_mi the Media Player
 514  * \param p_e an initialized exception pointer
 515  */
 516 VLC_PUBLIC_API void libvlc_media_player_play ( libvlc_media_player_t *, libvlc_exception_t * );
 517
 518 /**
 519  * Pause
 520  *
 521  * \param p_mi the Media Player
 522  * \param p_e an initialized exception pointer
 523  */
 524 VLC_PUBLIC_API void libvlc_media_player_pause ( libvlc_media_player_t *, libvlc_exception_t * );
 525
 526 /**
 527  * Stop
 528  *
 529  * \param p_mi the Media Player
 530  * \param p_e an initialized exception pointer
 531  */
 532 VLC_PUBLIC_API void libvlc_media_player_stop ( libvlc_media_player_t *, libvlc_exception_t * );
 533
 534 /**
 535  * Set the drawable where the media player should render its video output
 536  *
 537  * \param p_mi the Media Player
 538  * \param drawable the libvlc_drawable_t where the media player
 539  *        should render its video
 540  * \param p_e an initialized exception pointer
 541  */
 542 VLC_PUBLIC_API void libvlc_media_player_set_drawable ( libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t * );
 543
 544 /**
 545  * Get the drawable where the media player should render its video output
 546  *
 547  * \param p_mi the Media Player
 548  * \param p_e an initialized exception pointer
 549  * \return the libvlc_drawable_t where the media player
 550  *         should render its video
 551  */
 552 VLC_PUBLIC_API libvlc_drawable_t
 553                     libvlc_media_player_get_drawable ( libvlc_media_player_t *, libvlc_exception_t * );
 554
 555 /** \bug This might go away ... to be replaced by a broader system */
 556
 557 /**
 558  * Get the current movie length (in ms).
 559  *
 560  * \param p_mi the Media Player
 561  * \param p_e an initialized exception pointer
 562  * \return the movie length (in ms).
 563  */
 564 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length( libvlc_media_player_t *, libvlc_exception_t *);
 565
 566 /**
 567  * Get the current movie time (in ms).
 568  *
 569  * \param p_mi the Media Player
 570  * \param p_e an initialized exception pointer
 571  * \return the movie time (in ms).
 572  */
 573 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *, libvlc_exception_t *);
 574
 575 /**
 576  * Set the movie time (in ms).
 577  *
 578  * \param p_mi the Media Player
 579  * \param the movie time (in ms).
 580  * \param p_e an initialized exception pointer
 581  */
 582 VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *);
 583
 584 /**
 585  * Get movie position.
 586  *
 587  * \param p_mi the Media Player
 588  * \param p_e an initialized exception pointer
 589  * \return movie position
 590  */
 591 VLC_PUBLIC_API float libvlc_media_player_get_position( libvlc_media_player_t *, libvlc_exception_t *);
 592
 593 /**
 594  * Set movie position.
 595  *
 596  * \param p_mi the Media Player
 597  * \param p_e an initialized exception pointer
 598  * \return movie position
 599  */
 600 VLC_PUBLIC_API void libvlc_media_player_set_position( libvlc_media_player_t *, float, libvlc_exception_t *);
 601
 602 /**
 603  * Set movie chapter
 604  *
 605  * \param p_mi the Media Player
 606  * \param i_chapter chapter number to play
 607  * \param p_e an initialized exception pointer
 608  */
 609 VLC_PUBLIC_API void libvlc_media_player_set_chapter( libvlc_media_player_t *, int, libvlc_exception_t *);
 610
 611 /**
 612  * Get movie chapter
 613  *
 614  * \param p_mi the Media Player
 615  * \param p_e an initialized exception pointer
 616  * \return chapter number currently playing
 617  */
 618 VLC_PUBLIC_API int libvlc_media_player_get_chapter( libvlc_media_player_t *, libvlc_exception_t * );
 619
 620 /**
 621  * Get movie chapter count
 622  *
 623  * \param p_mi the Media Player
 624  * \param p_e an initialized exception pointer
 625  * \return number of chapters in movie
 626  */
 627 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *, libvlc_exception_t *);
 628 VLC_PUBLIC_API int libvlc_media_player_will_play        ( libvlc_media_player_t *, libvlc_exception_t *);
 629
 630 /**
 631  * Get title chapter count
 632  *
 633  * \param p_mi the Media Player
 634  * \param i_title title
 635  * \param p_e an initialized exception pointer
 636  * \return number of chapters in title
 637  */
 638 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count_for_title(
 639                        libvlc_media_player_t *, int, libvlc_exception_t *);
 640
 641 /**
 642  * Set movie title
 643  *
 644  * \param p_mi the Media Player
 645  * \param i_title title number to play
 646  * \param p_e an initialized exception pointer
 647  */
 648 VLC_PUBLIC_API void libvlc_media_player_set_title( libvlc_media_player_t *, int, libvlc_exception_t *);
 649
 650 /**
 651  * Get movie title
 652  *
 653  * \param p_mi the Media Player
 654  * \param p_e an initialized exception pointer
 655  * \return title number currently playing
 656  */
 657 VLC_PUBLIC_API int libvlc_media_player_get_title( libvlc_media_player_t *, libvlc_exception_t *);
 658
 659 /**
 660  * Get movie title count
 661  *
 662  * \param p_mi the Media Player
 663  * \param p_e an initialized exception pointer
 664  * \return title number count
 665  */
 666 VLC_PUBLIC_API int libvlc_media_player_get_title_count( libvlc_media_player_t *, libvlc_exception_t *);
 667
 668 /**
 669  * Set previous chapter
 670  *
 671  * \param p_mi the Media Player
 672  * \param p_e an initialized exception pointer
 673  */
 674 VLC_PUBLIC_API void libvlc_media_player_previous_chapter( libvlc_media_player_t *, libvlc_exception_t *);
 675
 676 /**
 677  * Set next chapter
 678  *
 679  * \param p_mi the Media Player
 680  * \param p_e an initialized exception pointer
 681  */
 682 VLC_PUBLIC_API void libvlc_media_player_next_chapter( libvlc_media_player_t *, libvlc_exception_t *);
 683
 684 /**
 685  * Get movie play rate
 686  *
 687  * \param p_mi the Media Player
 688  * \param p_e an initialized exception pointer
 689  * \return movie play rate
 690  */
 691 VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t *, libvlc_exception_t *);
 692
 693 /**
 694  * Set movie play rate
 695  *
 696  * \param p_mi the Media Player
 697  * \param movie play rate to set
 698  * \param p_e an initialized exception pointer
 699  */
 700 VLC_PUBLIC_API void libvlc_media_player_set_rate( libvlc_media_player_t *, float, libvlc_exception_t *);
 701
 702 /**
 703  * Get current movie state
 704  *
 705  * \param p_mi the Media Player
 706  * \param p_e an initialized exception pointer
 707  * \return current movie state as libvlc_state_t
 708  */
 709 VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *, libvlc_exception_t *);
 710
 711 /**
 712  * Get movie fps rate
 713  *
 714  * \param p_mi the Media Player
 715  * \param p_e an initialized exception pointer
 716  * \return frames per second (fps) for this playing movie
 717  */
 718 VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *, libvlc_exception_t *);
 719
 720 /** end bug */
 721
 722 /**
 723  * Does this media player have a video output?
 724  *
 725  * \param p_md the media player
 726  * \param p_e an initialized exception pointer
 727  */
 728 VLC_PUBLIC_API int  libvlc_media_player_has_vout( libvlc_media_player_t *, libvlc_exception_t *);
 729
 730 /**
 731  * Is this media player seekable?
 732  *
 733  * \param p_input the input
 734  * \param p_e an initialized exception pointer
 735  */
 736 VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
 737
 738 /**
 739  * Can this media player be paused?
 740  *
 741  * \param p_input the input
 742  * \param p_e an initialized exception pointer
 743  */
 744 VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
 745
 746 /**
 747  * Release (free) libvlc_track_description_t
 748  *
 749  * \param p_track_description the structure to release
 750  */
 751 VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t *p_track_description );
 752
 753 /** \defgroup libvlc_video libvlc_video
 754  * \ingroup libvlc_media_player
 755  * LibVLC Video handling
 756  * @{
 757  */
 758
 759 /**
 760  * Toggle fullscreen status on video output.
 761  *
 762  * \param p_mediaplayer the media player
 763  * \param p_e an initialized exception pointer
 764  */
 765 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
 766
 767 /**
 768  * Enable or disable fullscreen on a video output.
 769  *
 770  * \param p_mediaplayer the media player
 771  * \param b_fullscreen boolean for fullscreen status
 772  * \param p_e an initialized exception pointer
 773  */
 774 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *, int, libvlc_exception_t * );
 775
 776 /**
 777  * Get current fullscreen status.
 778  *
 779  * \param p_mediaplayer the media player
 780  * \param p_e an initialized exception pointer
 781  * \return the fullscreen status (boolean)
 782  */
 783 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
 784
 785 /**
 786  * Get current video height.
 787  *
 788  * \param p_mediaplayer the media player
 789  * \param p_e an initialized exception pointer
 790  * \return the video height
 791  */
 792 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_player_t *, libvlc_exception_t * );
 793
 794 /**
 795  * Get current video width.
 796  *
 797  * \param p_mediaplayer the media player
 798  * \param p_e an initialized exception pointer
 799  * \return the video width
 800  */
 801 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_player_t *, libvlc_exception_t * );
 802
 803 /**
 804  * Get current video aspect ratio.
 805  *
 806  * \param p_mediaplayer the media player
 807  * \param p_e an initialized exception pointer
 808  * \return the video aspect ratio
 809  */
 810 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *, libvlc_exception_t * );
 811
 812 /**
 813  * Set new video aspect ratio.
 814  *
 815  * \param p_mediaplayer the media player
 816  * \param psz_aspect new video aspect-ratio
 817  * \param p_e an initialized exception pointer
 818  */
 819 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *, char *, libvlc_exception_t * );
 820
 821 /**
 822  * Get current video subtitle.
 823  *
 824  * \param p_mediaplayer the media player
 825  * \param p_e an initialized exception pointer
 826  * \return the video subtitle selected
 827  */
 828 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *, libvlc_exception_t * );
 829
 830 /**
 831  * Get the number of available video subtitles.
 832  *
 833  * \param p_mediaplayer the media player
 834  * \param p_e an initialized exception pointer
 835  * \return the number of available video subtitles
 836  */
 837 VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t *, libvlc_exception_t * );
 838
 839 /**
 840  * Get the description of available video subtitles.
 841  *
 842  * \param p_mediaplayer the media player
 843  * \param p_e an initialized exception pointer
 844  * \return list containing description of available video subtitles
 845  */
 846 VLC_PUBLIC_API libvlc_track_description_t *
 847         libvlc_video_get_spu_description( libvlc_media_player_t *, libvlc_exception_t * );
 848
 849 /**
 850  * Set new video subtitle.
 851  *
 852  * \param p_mediaplayer the media player
 853  * \param i_spu new video subtitle to select
 854  * \param p_e an initialized exception pointer
 855  */
 856 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_player_t *, int , libvlc_exception_t * );
 857
 858 /**
 859  * Set new video subtitle file.
 860  *
 861  * \param p_mediaplayer the media player
 862  * \param psz_subtitle new video subtitle file
 863  * \param p_e an initialized exception pointer
 864  * \return the success status (boolean)
 865  */
 866 VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *, char *, libvlc_exception_t * );
 867
 868 /**
 869  * Get the description of available titles.
 870  *
 871  * \param p_mediaplayer the media player
 872  * \param p_e an initialized exception pointer
 873  * \return list containing description of available titles
 874  */
 875 VLC_PUBLIC_API libvlc_track_description_t *
 876         libvlc_video_get_title_description( libvlc_media_player_t *, libvlc_exception_t * );
 877
 878 /**
 879  * Get the description of available chapters for specific title.
 880  *
 881  * \param p_mediaplayer the media player
 882  * \param i_title selected title
 883  * \param p_e an initialized exception pointer
 884  * \return list containing description of available chapter for title i_title
 885  */
 886 VLC_PUBLIC_API libvlc_track_description_t *
 887         libvlc_video_get_chapter_description( libvlc_media_player_t *, int, libvlc_exception_t * );
 888
 889 /**
 890  * Get current crop filter geometry.
 891  *
 892  * \param p_mediaplayer the media player
 893  * \param p_e an initialized exception pointer
 894  * \return the crop filter geometry
 895  */
 896 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *, libvlc_exception_t * );
 897
 898 /**
 899  * Set new crop filter geometry.
 900  *
 901  * \param p_mediaplayer the media player
 902  * \param psz_geometry new crop filter geometry
 903  * \param p_e an initialized exception pointer
 904  */
 905 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_player_t *, char *, libvlc_exception_t * );
 906
 907 /**
 908  * Toggle teletext transparent status on video output.
 909  *
 910  * \param p_mediaplayer the media player
 911  * \param p_e an initialized exception pointer
 912  */
 913 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *, libvlc_exception_t * );
 914
 915 /**
 916  * Get current teletext page requested.
 917  *
 918  * \param p_mediaplayer the media player
 919  * \param p_e an initialized exception pointer
 920  * \return the current teletext page requested.
 921  */
 922 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *, libvlc_exception_t * );
 923
 924 /**
 925  * Set new teletext page to retrieve.
 926  *
 927  * \param p_mediaplayer the media player
 928  * \param i_page teletex page number requested
 929  * \param p_e an initialized exception pointer
 930  */
 931 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_player_t *, int, libvlc_exception_t * );
 932
 933 /**
 934  * Get number of available video tracks.
 935  *
 936  * \param p_mi media player
 937  * \param p_e an initialized exception
 938  * \return the number of available video tracks (int)
 939  */
 940 VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_t *,  libvlc_exception_t * );
 941
 942 /**
 943  * Get the description of available video tracks.
 944  *
 945  * \param p_mi media player
 946  * \param p_e an initialized exception
 947  * \return list with description of available video tracks
 948  */
 949 VLC_PUBLIC_API libvlc_track_description_t *
 950         libvlc_video_get_track_description( libvlc_media_player_t *,  libvlc_exception_t * );
 951
 952 /**
 953  * Get current video track.
 954  *
 955  * \param p_mi media player
 956  * \param p_e an initialized exception pointer
 957  * \return the video track (int)
 958  */
 959 VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t *, libvlc_exception_t * );
 960
 961 /**
 962  * Set video track.
 963  *
 964  * \param p_mi media player
 965  * \param i_track the track (int)
 966  * \param p_e an initialized exception pointer
 967  */
 968 VLC_PUBLIC_API void libvlc_video_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
 969
 970 /**
 971  * Take a snapshot of the current video window.
 972  *
 973  * If i_width AND i_height is 0, original size is used.
 974  * If i_width XOR i_height is 0, original aspect-ratio is preserved.
 975  *
 976  * \param p_mediaplayer the media player
 977  * \param psz_filepath the path where to save the screenshot to
 978  * \param i_width the snapshot's width
 979  * \param i_height the snapshot's height
 980  * \param p_e an initialized exception pointer
 981  */
 982 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_player_t *, char *,unsigned int, unsigned int, libvlc_exception_t * );
 983
 984 /**
 985  * Resize the current video output window.
 986  *
 987  * \param p_instance libvlc instance
 988  * \param width new width for video output window
 989  * \param height new height for video output window
 990  * \param p_e an initialized exception pointer
 991  * \return the success status (boolean)
 992  */
 993 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_player_t *, int, int, libvlc_exception_t *);
 994
 995 /**
 996  * Change the parent for the current the video output.
 997  *
 998  * \param p_instance libvlc instance
 999  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
1000  * \param p_e an initialized exception pointer
1001  * \return the success status (boolean)
1002  */
1003 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t * );
1004
1005 /**
1006  * Tell windowless video output to redraw rectangular area (MacOS X only).
1007  *
1008  * \param p_instance libvlc instance
1009  * \param area coordinates within video drawable
1010  * \param p_e an initialized exception pointer
1011  */
1012 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_player_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
1013
1014 /**
1015  * Set the default video output size.
1016  *
1017  * This setting will be used as default for all video outputs.
1018  *
1019  * \param p_instance libvlc instance
1020  * \param width new width for video drawable
1021  * \param height new height for video drawable
1022  * \param p_e an initialized exception pointer
1023  */
1024 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
1025
1026 /**
1027  * Set the default video output viewport for a windowless video output
1028  * (MacOS X only).
1029  *
1030  * This setting will be used as default for all video outputs.
1031  *
1032  * \param p_instance libvlc instance
1033  * \param view coordinates within video drawable
1034  * \param clip coordinates within video drawable
1035  * \param p_e an initialized exception pointer
1036  */
1037 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
1038
1039 /** @} video */
1040
1041 /** \defgroup libvlc_audio libvlc_audio
1042  * \ingroup libvlc_media_player
1043  * LibVLC Audio handling
1044  * @{
1045  */
1046
1047 /**
1048  * Audio device types
1049  */
1050 typedef enum libvlc_audio_output_device_types_t {
1051     libvlc_AudioOutputDevice_Error  = -1,
1052     libvlc_AudioOutputDevice_Mono   =  1,
1053     libvlc_AudioOutputDevice_Stereo =  2,
1054     libvlc_AudioOutputDevice_2F2R   =  4,
1055     libvlc_AudioOutputDevice_3F2R   =  5,
1056     libvlc_AudioOutputDevice_5_1    =  6,
1057     libvlc_AudioOutputDevice_6_1    =  7,
1058     libvlc_AudioOutputDevice_7_1    =  8,
1059     libvlc_AudioOutputDevice_SPDIF  = 10
1060 } libvlc_audio_output_device_types_t;
1061
1062 /**
1063  * Audio channels
1064  */
1065 typedef enum libvlc_audio_output_channel_t {
1066     libvlc_AudioChannel_Error   = -1,
1067     libvlc_AudioChannel_Stereo  =  1,
1068     libvlc_AudioChannel_RStereo =  2,
1069     libvlc_AudioChannel_Left    =  3,
1070     libvlc_AudioChannel_Right   =  4,
1071     libvlc_AudioChannel_Dolbys  =  5
1072 } libvlc_audio_output_channel_t;
1073
1074
1075 /**
1076  * Get the list of available audio outputs
1077  *
1078  * \param p_instance libvlc instance
1079  * \param p_e an initialized exception pointer
1080  * \return list of available audio outputs, at the end free it with
1081 *          \see libvlc_audio_output_list_release \see libvlc_audio_output_t
1082  */
1083 VLC_PUBLIC_API libvlc_audio_output_t *
1084         libvlc_audio_output_list_get( libvlc_instance_t *,
1085                                       libvlc_exception_t * );
1086
1087 /**
1088  * Free the list of available audio outputs
1089  *
1090  * \param p_list list with audio outputs for release
1091  */
1092 VLC_PUBLIC_API void libvlc_audio_output_list_release( libvlc_audio_output_t * );
1093
1094 /**
1095  * Set the audio output.
1096  * Change will be applied after stop and play.
1097  *
1098  * \param p_instance libvlc instance
1099  * \param psz_name name of audio output,
1100  *               use psz_name of \see libvlc_audio_output_t
1101  * \return true if function succeded
1102  */
1103 VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_instance_t *,
1104                                             const char * );
1105
1106 /**
1107  * Get count of devices for audio output, these devices are hardware oriented
1108  * like analor or digital output of sound card
1109  *
1110  * \param p_instance libvlc instance
1111  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1112  * \return number of devices
1113  */
1114 VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_t *,
1115                                                      const char * );
1116
1117 /**
1118  * Get long name of device, if not available short name given
1119  *
1120  * \param p_instance libvlc instance
1121  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1122  * \param i_device device index
1123  * \return long name of device
1124  */
1125 VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_t *,
1126                                                            const char *,
1127                                                            int );
1128
1129 /**
1130  * Get id name of device
1131  *
1132  * \param p_instance libvlc instance
1133  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1134  * \param i_device device index
1135  * \return id name of device, use for setting device, need to be free after use
1136  */
1137 VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *,
1138                                                      const char *,
1139                                                      int );
1140
1141 /**
1142  * Set device for using
1143  *
1144  * \param p_instance libvlc instance
1145  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1146  * \param psz_device_id device
1147  */
1148 VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_instance_t *,
1149                                                     const char *,
1150                                                     const char * );
1151
1152 /**
1153  * Get current audio device type. Device type describes something like
1154  * character of output sound - stereo sound, 2.1, 5.1 etc
1155  *
1156  * \param p_instance vlc instance
1157  * \param p_e an initialized exception pointer
1158  * \return the audio devices type \see libvlc_audio_output_device_types_t
1159  */
1160 VLC_PUBLIC_API int libvlc_audio_output_get_device_type(
1161         libvlc_instance_t *, libvlc_exception_t * );
1162
1163 /**
1164  * Set current audio device type.
1165  *
1166  * \param p_instance vlc instance
1167  * \param device_type the audio device type,
1168           according to \see libvlc_audio_output_device_types_t
1169  * \param p_e an initialized exception pointer
1170  */
1171 VLC_PUBLIC_API void libvlc_audio_output_set_device_type( libvlc_instance_t *,
1172                                                          int,
1173                                                          libvlc_exception_t * );
1174
1175
1176 /**
1177  * Toggle mute status.
1178  *
1179  * \param p_instance libvlc instance
1180  * \param p_e an initialized exception pointer
1181  */
1182 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
1183
1184 /**
1185  * Get current mute status.
1186  *
1187  * \param p_instance libvlc instance
1188  * \param p_e an initialized exception pointer
1189  * \return the mute status (boolean)
1190  */
1191 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
1192
1193 /**
1194  * Set mute status.
1195  *
1196  * \param p_instance libvlc instance
1197  * \param status If status is true then mute, otherwise unmute
1198  * \param p_e an initialized exception pointer
1199  */
1200 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, int , libvlc_exception_t * );
1201
1202 /**
1203  * Get current audio level.
1204  *
1205  * \param p_instance libvlc instance
1206  * \param p_e an initialized exception pointer
1207  * \return the audio level (int)
1208  */
1209 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
1210
1211 /**
1212  * Set current audio level.
1213  *
1214  * \param p_instance libvlc instance
1215  * \param i_volume the volume (int)
1216  * \param p_e an initialized exception pointer
1217  */
1218 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
1219
1220 /**
1221  * Get number of available audio tracks.
1222  *
1223  * \param p_mi media player
1224  * \param p_e an initialized exception
1225  * \return the number of available audio tracks (int)
1226  */
1227 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *,  libvlc_exception_t * );
1228
1229  /**
1230  * Get the description of available audio tracks.
1231  *
1232  * \param p_mi media player
1233  * \param p_e an initialized exception
1234  * \return list with description of available audio tracks
1235  */
1236 VLC_PUBLIC_API libvlc_track_description_t *
1237         libvlc_audio_get_track_description( libvlc_media_player_t *,  libvlc_exception_t * );
1238
1239 /**
1240  * Get current audio track.
1241  *
1242  * \param p_mi media player
1243  * \param p_e an initialized exception pointer
1244  * \return the audio track (int)
1245  */
1246 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *, libvlc_exception_t * );
1247
1248 /**
1249  * Set current audio track.
1250  *
1251  * \param p_mi media player
1252  * \param i_track the track (int)
1253  * \param p_e an initialized exception pointer
1254  */
1255 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
1256
1257 /**
1258  * Get current audio channel.
1259  *
1260  * \param p_instance vlc instance
1261  * \param p_e an initialized exception pointer
1262  * \return the audio channel \see libvlc_audio_output_channel_t
1263  */
1264 VLC_PUBLIC_API int
1265     libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
1266
1267 /**
1268  * Set current audio channel.
1269  *
1270  * \param p_instance vlc instance
1271  * \param channel the audio channel, \see libvlc_audio_output_channel_t
1272  * \param p_e an initialized exception pointer
1273  */
1274 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *,
1275                                               int,
1276                                               libvlc_exception_t * );
1277
1278 /** @} audio */
1279
1280 /** @} media_player */
1281
1282 /*****************************************************************************
1283  * Event handling
1284  *****************************************************************************/
1285
1286 /** \defgroup libvlc_event libvlc_event
1287  * \ingroup libvlc_core
1288  * LibVLC Events
1289  * @{
1290  */
1291
1292 /**
1293  * Register for an event notification.
1294  *
1295  * \param p_event_manager the event manager to which you want to attach to.
1296  *        Generally it is obtained by vlc_my_object_event_manager() where
1297  *        my_object is the object you want to listen to.
1298  * \param i_event_type the desired event to which we want to listen
1299  * \param f_callback the function to call when i_event_type occurs
1300  * \param user_data user provided data to carry with the event
1301  * \param p_e an initialized exception pointer
1302  */
1303 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
1304                                          libvlc_event_type_t i_event_type,
1305                                          libvlc_callback_t f_callback,
1306                                          void *user_data,
1307                                          libvlc_exception_t *p_e );
1308
1309 /**
1310  * Unregister an event notification.
1311  *
1312  * \param p_event_manager the event manager
1313  * \param i_event_type the desired event to which we want to unregister
1314  * \param f_callback the function to call when i_event_type occurs
1315  * \param p_user_data user provided data to carry with the event
1316  * \param p_e an initialized exception pointer
1317  */
1318 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
1319                                          libvlc_event_type_t i_event_type,
1320                                          libvlc_callback_t f_callback,
1321                                          void *p_user_data,
1322                                          libvlc_exception_t *p_e );
1323
1324 /**
1325  * Get an event's type name.
1326  *
1327  * \param i_event_type the desired event
1328  */
1329 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
1330
1331 /** @} */
1332
1333 /*****************************************************************************
1334  * Media Library
1335  *****************************************************************************/
1336 /** \defgroup libvlc_media_library libvlc_media_library
1337  * \ingroup libvlc
1338  * LibVLC Media Library
1339  * @{
1340  */
1341 VLC_PUBLIC_API libvlc_media_library_t *
1342     libvlc_media_library_new( libvlc_instance_t * p_inst,
1343                               libvlc_exception_t * p_e );
1344
1345 /**
1346  * Release media library object. This functions decrements the
1347  * reference count of the media library object. If it reaches 0,
1348  * then the object will be released.
1349  *
1350  * \param p_mlib media library object
1351  */
1352 VLC_PUBLIC_API void
1353     libvlc_media_library_release( libvlc_media_library_t * p_mlib );
1354
1355 /**
1356  * Retain a reference to a media library object. This function will
1357  * increment the reference counting for this object. Use
1358  * libvlc_media_library_release() to decrement the reference count.
1359  *
1360  * \param p_mlib media library object
1361  */
1362 VLC_PUBLIC_API void
1363     libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
1364
1365 /**
1366  * Load media library.
1367  *
1368  * \param p_mlib media library object
1369  * \param p_e an initialized exception object.
1370  */
1371 VLC_PUBLIC_API void
1372     libvlc_media_library_load( libvlc_media_library_t * p_mlib,
1373                                libvlc_exception_t * p_e );
1374
1375 /**
1376  * Save media library.
1377  *
1378  * \param p_mlib media library object
1379  * \param p_e an initialized exception object.
1380  */
1381 VLC_PUBLIC_API void
1382     libvlc_media_library_save( libvlc_media_library_t * p_mlib,
1383                                libvlc_exception_t * p_e );
1384
1385 /**
1386  * Get media library subitems.
1387  *
1388  * \param p_mlib media library object
1389  * \param p_e an initialized exception object.
1390  * \return media list subitems
1391  */
1392 VLC_PUBLIC_API libvlc_media_list_t *
1393     libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
1394                                      libvlc_exception_t * p_e );
1395
1396
1397 /** @} */
1398
1399
1400 /*****************************************************************************
1401  * Services/Media Discovery
1402  *****************************************************************************/
1403 /** \defgroup libvlc_media_discoverer libvlc_media_discoverer
1404  * \ingroup libvlc
1405  * LibVLC Media Discoverer
1406  * @{
1407  */
1408
1409 /**
1410  * Discover media service by name.
1411  *
1412  * \param p_inst libvlc instance
1413  * \param psz_name service name
1414  * \param p_e an initialized exception object
1415  * \return media discover object
1416  */
1417 VLC_PUBLIC_API libvlc_media_discoverer_t *
1418 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
1419                                        const char * psz_name,
1420                                        libvlc_exception_t * p_e );
1421
1422 /**
1423  * Release media discover object. If the reference count reaches 0, then
1424  * the object will be released.
1425  *
1426  * \param p_mdis media service discover object
1427  */
1428 VLC_PUBLIC_API void   libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
1429
1430 /**
1431  * Get media service discover object its localized name.
1432  *
1433  * \param media discover object
1434  * \return localized name
1435  */
1436 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
1437
1438 /**
1439  * Get media service discover media list.
1440  *
1441  * \param p_mdis media service discover object
1442  * \return list of media items
1443  */
1444 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
1445
1446 /**
1447  * Get event manager from media service discover object.
1448  *
1449  * \param p_mdis media service discover object
1450  * \return event manager object.
1451  */
1452 VLC_PUBLIC_API libvlc_event_manager_t *
1453         libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis );
1454
1455 /**
1456  * Query if media service discover object is running.
1457  *
1458  * \param p_mdis media service discover object
1459  * \return true if running, false if not
1460  */
1461 VLC_PUBLIC_API int
1462         libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis );
1463
1464 /**@} */
1465
1466
1467 /*****************************************************************************
1468  * Message log handling
1469  *****************************************************************************/
1470
1471 /** \defgroup libvlc_log libvlc_log
1472  * \ingroup libvlc_core
1473  * LibVLC Message Logging
1474  * @{
1475  */
1476
1477 /**
1478  * Return the VLC messaging verbosity level.
1479  *
1480  * \param p_instance libvlc instance
1481  * \param p_e an initialized exception pointer
1482  * \return verbosity level for messages
1483  */
1484 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
1485                                                   libvlc_exception_t *p_e );
1486
1487 /**
1488  * Set the VLC messaging verbosity level.
1489  *
1490  * \param p_instance libvlc log instance
1491  * \param level log level
1492  * \param p_e an initialized exception pointer
1493  */
1494 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
1495                                               libvlc_exception_t *p_e );
1496
1497 /**
1498  * Open a VLC message log instance.
1499  *
1500  * \param p_instance libvlc instance
1501  * \param p_e an initialized exception pointer
1502  * \return log message instance
1503  */
1504 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
1505
1506 /**
1507  * Close a VLC message log instance.
1508  *
1509  * \param p_log libvlc log instance
1510  * \param p_e an initialized exception pointer
1511  */
1512 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
1513
1514 /**
1515  * Returns the number of messages in a log instance.
1516  *
1517  * \param p_log libvlc log instance
1518  * \param p_e an initialized exception pointer
1519  * \return number of log messages
1520  */
1521 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
1522
1523 /**
1524  * Clear a log instance.
1525  *
1526  * All messages in the log are removed. The log should be cleared on a
1527  * regular basis to avoid clogging.
1528  *
1529  * \param p_log libvlc log instance
1530  * \param p_e an initialized exception pointer
1531  */
1532 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
1533
1534 /**
1535  * Allocate and returns a new iterator to messages in log.
1536  *
1537  * \param p_log libvlc log instance
1538  * \param p_e an initialized exception pointer
1539  * \return log iterator object
1540  */
1541 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
1542
1543 /**
1544  * Release a previoulsy allocated iterator.
1545  *
1546  * \param p_iter libvlc log iterator
1547  * \param p_e an initialized exception pointer
1548  */
1549 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1550
1551 /**
1552  * Return whether log iterator has more messages.
1553  *
1554  * \param p_iter libvlc log iterator
1555  * \param p_e an initialized exception pointer
1556  * \return true if iterator has more message objects, else false
1557  */
1558 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1559
1560 /**
1561  * Return the next log message.
1562  *
1563  * The message contents must not be freed
1564  *
1565  * \param p_iter libvlc log iterator
1566  * \param p_buffer log buffer
1567  * \param p_e an initialized exception pointer
1568  * \return log message object
1569  */
1570 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
1571                                                                libvlc_log_message_t *p_buffer,
1572                                                                libvlc_exception_t *p_e );
1573
1574 /** @} */
1575
1576 # ifdef __cplusplus
1577 }
1578 # endif
1579
1580 #endif /* <vlc/libvlc.h> */