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  * Add an option to the media from an untrusted source.
 283  *
 284  * This option will be used to determine how the media_player will
 285  * read the media. This allows to use VLC's advanced
 286  * reading/streaming options on a per-media basis.
 287  *
 288  * The options are detailed in vlc --long-help, for instance "--sout-all"
 289  *
 290  * \param p_instance the instance
 291  * \param ppsz_options the options (as a string)
 292  * \param p_e an initialized exception pointer
 293  */
 294 VLC_PUBLIC_API void libvlc_media_add_option_untrusted(
 295                                    libvlc_media_t * p_md,
 296                                    const char * ppsz_options,
 297                                    libvlc_exception_t * p_e );
 298
 299
 300 /**
 301  * Retain a reference to a media descriptor object (libvlc_media_t). Use
 302  * libvlc_media_release() to decrement the reference count of a
 303  * media descriptor object.
 304  *
 305  * \param p_meta_desc a media descriptor object.
 306  */
 307 VLC_PUBLIC_API void libvlc_media_retain(
 308                                    libvlc_media_t *p_meta_desc );
 309
 310 /**
 311  * Decrement the reference count of a media descriptor object. If the
 312  * reference count is 0, then libvlc_media_release() will release the
 313  * media descriptor object. It will send out an libvlc_MediaFreed event
 314  * to all listeners. If the media descriptor object has been released it
 315  * should not be used again.
 316  *
 317  * \param p_meta_desc a media descriptor object.
 318  */
 319 VLC_PUBLIC_API void libvlc_media_release(
 320                                    libvlc_media_t *p_meta_desc );
 321
 322
 323 /**
 324  * Get the media resource locator (mrl) from a media descriptor object
 325  *
 326  * \param p_md a media descriptor object
 327  * \param p_e an initialized exception object
 328  * \return string with mrl of media descriptor object
 329  */
 330 VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md,
 331                                                        libvlc_exception_t * p_e );
 332
 333 /**
 334  * Duplicate a media descriptor object.
 335  *
 336  * \param p_meta_desc a media descriptor object.
 337  */
 338 VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t * );
 339
 340 /**
 341  * Read the meta of the media.
 342  *
 343  * \param p_meta_desc the media to read
 344  * \param e_meta_desc the meta to read
 345  * \param p_e an initialized exception pointer
 346  * \return the media's meta
 347  */
 348 VLC_PUBLIC_API char * libvlc_media_get_meta(
 349                                    libvlc_media_t *p_meta_desc,
 350                                    libvlc_meta_t e_meta,
 351                                    libvlc_exception_t *p_e );
 352 /**
 353  * Get current state of media descriptor object. Possible media states
 354  * are defined in libvlc_structures.c ( libvlc_NothingSpecial=0,
 355  * libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused,
 356  * libvlc_Stopped, libvlc_Ended,
 357  * libvlc_Error).
 358  *
 359  * @see libvlc_state_t
 360  * \param p_meta_desc a media descriptor object
 361  * \param p_e an initialized exception object
 362  * \return state of media descriptor object
 363  */
 364 VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state(
 365                                    libvlc_media_t *p_meta_desc,
 366                                    libvlc_exception_t *p_e );
 367
 368 /**
 369  * Get subitems of media descriptor object. This will increment
 370  * the reference count of supplied media descriptor object. Use
 371  * libvlc_media_list_release() to decrement the reference counting.
 372  *
 373  * \param p_md media descriptor object
 374  * \param p_e initalized exception object
 375  * \return list of media descriptor subitems or NULL
 376  */
 377 VLC_PUBLIC_API libvlc_media_list_t *
 378     libvlc_media_subitems( libvlc_media_t *p_md,
 379                                       libvlc_exception_t *p_e );
 380 /**
 381  * Get event manager from media descriptor object.
 382  * NOTE: this function doesn't increment reference counting.
 383  *
 384  * \param p_md a media descriptor object
 385  * \param p_e an initialized exception object
 386  * \return event manager object
 387  */
 388 VLC_PUBLIC_API libvlc_event_manager_t *
 389     libvlc_media_event_manager( libvlc_media_t * p_md,
 390                                            libvlc_exception_t * p_e );
 391
 392 /**
 393  * Get duration of media descriptor object item.
 394  *
 395  * \param p_md media descriptor object
 396  * \param p_e an initialized exception object
 397  * \return duration of media item
 398  */
 399 VLC_PUBLIC_API libvlc_time_t
 400    libvlc_media_get_duration( libvlc_media_t * p_md,
 401                                          libvlc_exception_t * p_e );
 402
 403 /**
 404  * Get preparsed status for media descriptor object.
 405  *
 406  * \param p_md media descriptor object
 407  * \param p_e an initialized exception object
 408  * \return true if media object has been preparsed otherwise it returns false
 409  */
 410 VLC_PUBLIC_API int
 411    libvlc_media_is_preparsed( libvlc_media_t * p_md,
 412                                          libvlc_exception_t * p_e );
 413
 414 /**
 415  * Sets media descriptor's user_data. user_data is specialized data
 416  * accessed by the host application, VLC.framework uses it as a pointer to
 417  * an native object that references a libvlc_media_t pointer
 418  *
 419  * \param p_md media descriptor object
 420  * \param p_new_user_data pointer to user data
 421  * \param p_e an initialized exception object
 422  */
 423 VLC_PUBLIC_API void
 424     libvlc_media_set_user_data( libvlc_media_t * p_md,
 425                                            void * p_new_user_data,
 426                                            libvlc_exception_t * p_e);
 427
 428 /**
 429  * Get media descriptor's user_data. user_data is specialized data
 430  * accessed by the host application, VLC.framework uses it as a pointer to
 431  * an native object that references a libvlc_media_t pointer
 432  *
 433  * \param p_md media descriptor object
 434  * \param p_e an initialized exception object
 435  */
 436 VLC_PUBLIC_API void *
 437     libvlc_media_get_user_data( libvlc_media_t * p_md,
 438                                            libvlc_exception_t * p_e);
 439
 440 /** @}*/
 441
 442 /*****************************************************************************
 443  * Media Player
 444  *****************************************************************************/
 445 /** \defgroup libvlc_media_player libvlc_media_player
 446  * \ingroup libvlc
 447  * LibVLC Media Player, object that let you play a media
 448  * in a custom drawable
 449  * @{
 450  */
 451
 452 /**
 453  * Create an empty Media Player object
 454  *
 455  * \param p_libvlc_instance the libvlc instance in which the Media Player
 456  *        should be created.
 457  * \param p_e an initialized exception pointer
 458  */
 459 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new( libvlc_instance_t *, libvlc_exception_t * );
 460
 461 /**
 462  * Create a Media Player object from a Media
 463  *
 464  * \param p_md the media. Afterwards the p_md can be safely
 465  *        destroyed.
 466  * \param p_e an initialized exception pointer
 467  */
 468 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new_from_media( libvlc_media_t *, libvlc_exception_t * );
 469
 470 /**
 471  * Release a media_player after use
 472  * Decrement the reference count of a media player object. If the
 473  * reference count is 0, then libvlc_media_player_release() will
 474  * release the media player object. If the media player object
 475  * has been released, then it should not be used again.
 476  *
 477  * \param p_mi the Media Player to free
 478  */
 479 VLC_PUBLIC_API void libvlc_media_player_release( libvlc_media_player_t * );
 480
 481 /**
 482  * Retain a reference to a media player object. Use
 483  * libvlc_media_player_release() to decrement reference count.
 484  *
 485  * \param p_mi media player object
 486  */
 487 VLC_PUBLIC_API void libvlc_media_player_retain( libvlc_media_player_t * );
 488
 489 /**
 490  * Set the media that will be used by the media_player. If any,
 491  * previous md will be released.
 492  *
 493  * \param p_mi the Media Player
 494  * \param p_md the Media. Afterwards the p_md can be safely
 495  *        destroyed.
 496  * \param p_e an initialized exception pointer
 497  */
 498 VLC_PUBLIC_API void libvlc_media_player_set_media( libvlc_media_player_t *, libvlc_media_t *, libvlc_exception_t * );
 499
 500 /**
 501  * Get the media used by the media_player.
 502  *
 503  * \param p_mi the Media Player
 504  * \param p_e an initialized exception pointer
 505  * \return the media associated with p_mi, or NULL if no
 506  *         media is associated
 507  */
 508 VLC_PUBLIC_API libvlc_media_t * libvlc_media_player_get_media( libvlc_media_player_t *, libvlc_exception_t * );
 509
 510 /**
 511  * Get the Event Manager from which the media player send event.
 512  *
 513  * \param p_mi the Media Player
 514  * \param p_e an initialized exception pointer
 515  * \return the event manager associated with p_mi
 516  */
 517 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_media_player_t *, libvlc_exception_t * );
 518
 519 /**
 520  * is_playing
 521  *
 522  * \param p_mi the Media Player
 523  * \param p_e an initialized exception pointer
 524  * \return 1 if the media player is playing, 0 otherwise
 525  */
 526 VLC_PUBLIC_API int libvlc_media_player_is_playing ( libvlc_media_player_t *, libvlc_exception_t * );
 527
 528 /**
 529  * Play
 530  *
 531  * \param p_mi the Media Player
 532  * \param p_e an initialized exception pointer
 533  */
 534 VLC_PUBLIC_API void libvlc_media_player_play ( libvlc_media_player_t *, libvlc_exception_t * );
 535
 536 /**
 537  * Pause
 538  *
 539  * \param p_mi the Media Player
 540  * \param p_e an initialized exception pointer
 541  */
 542 VLC_PUBLIC_API void libvlc_media_player_pause ( libvlc_media_player_t *, libvlc_exception_t * );
 543
 544 /**
 545  * Stop
 546  *
 547  * \param p_mi the Media Player
 548  * \param p_e an initialized exception pointer
 549  */
 550 VLC_PUBLIC_API void libvlc_media_player_stop ( libvlc_media_player_t *, libvlc_exception_t * );
 551
 552 /**
 553  * Set an X Window System drawable where the media player should render its
 554  * video output. If LibVLC was built without X11 output support, then this has
 555  * no effects.
 556  *
 557  * The specified identifier must correspond to an existing Input/Output class
 558  * X11 window. Pixmaps are <b>not</b> supported. The caller shall ensure that
 559  * the X11 server is the same as the one the VLC instance has been configured
 560  * with.
 561  * If XVideo is <b>not</b> used, it is assumed that the drawable has the
 562  * following properties in common with the default X11 screen: depth, scan line
 563  * pad, black pixel. This is a bug.
 564  *
 565  * \param p_mi the Media Player
 566  * \param drawable the ID of the X window
 567  * \param p_e an initialized exception pointer
 568  */
 569 VLC_PUBLIC_API void libvlc_media_player_set_xwindow ( libvlc_media_player_t *p_mi, uint32_t drawable, libvlc_exception_t *p_e );
 570
 571 /**
 572  * Set a Win32/Win64 API window handle (HWND) where the media player should
 573  * render its video output. If LibVLC was built without Win32/Win64 API output
 574  * support, then this has no effects.
 575  *
 576  * \param p_mi the Media Player
 577  * \param drawable windows handle of the drawable
 578  * \param p_e an initialized exception pointer
 579  */
 580 VLC_PUBLIC_API void libvlc_media_player_set_hwnd ( libvlc_media_player_t *p_mi, void *drawable, libvlc_exception_t *p_e );
 581
 582 /** \bug This might go away ... to be replaced by a broader system */
 583
 584 /**
 585  * Get the current movie length (in ms).
 586  *
 587  * \param p_mi the Media Player
 588  * \param p_e an initialized exception pointer
 589  * \return the movie length (in ms).
 590  */
 591 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length( libvlc_media_player_t *, libvlc_exception_t *);
 592
 593 /**
 594  * Get the current movie time (in ms).
 595  *
 596  * \param p_mi the Media Player
 597  * \param p_e an initialized exception pointer
 598  * \return the movie time (in ms).
 599  */
 600 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *, libvlc_exception_t *);
 601
 602 /**
 603  * Set the movie time (in ms).
 604  *
 605  * \param p_mi the Media Player
 606  * \param the movie time (in ms).
 607  * \param p_e an initialized exception pointer
 608  */
 609 VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *);
 610
 611 /**
 612  * Get movie position.
 613  *
 614  * \param p_mi the Media Player
 615  * \param p_e an initialized exception pointer
 616  * \return movie position
 617  */
 618 VLC_PUBLIC_API float libvlc_media_player_get_position( libvlc_media_player_t *, libvlc_exception_t *);
 619
 620 /**
 621  * Set movie position.
 622  *
 623  * \param p_mi the Media Player
 624  * \param p_e an initialized exception pointer
 625  * \return movie position
 626  */
 627 VLC_PUBLIC_API void libvlc_media_player_set_position( libvlc_media_player_t *, float, libvlc_exception_t *);
 628
 629 /**
 630  * Set movie chapter
 631  *
 632  * \param p_mi the Media Player
 633  * \param i_chapter chapter number to play
 634  * \param p_e an initialized exception pointer
 635  */
 636 VLC_PUBLIC_API void libvlc_media_player_set_chapter( libvlc_media_player_t *, int, libvlc_exception_t *);
 637
 638 /**
 639  * Get movie chapter
 640  *
 641  * \param p_mi the Media Player
 642  * \param p_e an initialized exception pointer
 643  * \return chapter number currently playing
 644  */
 645 VLC_PUBLIC_API int libvlc_media_player_get_chapter( libvlc_media_player_t *, libvlc_exception_t * );
 646
 647 /**
 648  * Get movie chapter count
 649  *
 650  * \param p_mi the Media Player
 651  * \param p_e an initialized exception pointer
 652  * \return number of chapters in movie
 653  */
 654 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *, libvlc_exception_t *);
 655 VLC_PUBLIC_API int libvlc_media_player_will_play        ( libvlc_media_player_t *, libvlc_exception_t *);
 656
 657 /**
 658  * Get title chapter count
 659  *
 660  * \param p_mi the Media Player
 661  * \param i_title title
 662  * \param p_e an initialized exception pointer
 663  * \return number of chapters in title
 664  */
 665 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count_for_title(
 666                        libvlc_media_player_t *, int, libvlc_exception_t *);
 667
 668 /**
 669  * Set movie title
 670  *
 671  * \param p_mi the Media Player
 672  * \param i_title title number to play
 673  * \param p_e an initialized exception pointer
 674  */
 675 VLC_PUBLIC_API void libvlc_media_player_set_title( libvlc_media_player_t *, int, libvlc_exception_t *);
 676
 677 /**
 678  * Get movie title
 679  *
 680  * \param p_mi the Media Player
 681  * \param p_e an initialized exception pointer
 682  * \return title number currently playing
 683  */
 684 VLC_PUBLIC_API int libvlc_media_player_get_title( libvlc_media_player_t *, libvlc_exception_t *);
 685
 686 /**
 687  * Get movie title count
 688  *
 689  * \param p_mi the Media Player
 690  * \param p_e an initialized exception pointer
 691  * \return title number count
 692  */
 693 VLC_PUBLIC_API int libvlc_media_player_get_title_count( libvlc_media_player_t *, libvlc_exception_t *);
 694
 695 /**
 696  * Set previous chapter
 697  *
 698  * \param p_mi the Media Player
 699  * \param p_e an initialized exception pointer
 700  */
 701 VLC_PUBLIC_API void libvlc_media_player_previous_chapter( libvlc_media_player_t *, libvlc_exception_t *);
 702
 703 /**
 704  * Set next chapter
 705  *
 706  * \param p_mi the Media Player
 707  * \param p_e an initialized exception pointer
 708  */
 709 VLC_PUBLIC_API void libvlc_media_player_next_chapter( libvlc_media_player_t *, libvlc_exception_t *);
 710
 711 /**
 712  * Get movie play rate
 713  *
 714  * \param p_mi the Media Player
 715  * \param p_e an initialized exception pointer
 716  * \return movie play rate
 717  */
 718 VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t *, libvlc_exception_t *);
 719
 720 /**
 721  * Set movie play rate
 722  *
 723  * \param p_mi the Media Player
 724  * \param movie play rate to set
 725  * \param p_e an initialized exception pointer
 726  */
 727 VLC_PUBLIC_API void libvlc_media_player_set_rate( libvlc_media_player_t *, float, libvlc_exception_t *);
 728
 729 /**
 730  * Get current movie state
 731  *
 732  * \param p_mi the Media Player
 733  * \param p_e an initialized exception pointer
 734  * \return current movie state as libvlc_state_t
 735  */
 736 VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *, libvlc_exception_t *);
 737
 738 /**
 739  * Get movie fps rate
 740  *
 741  * \param p_mi the Media Player
 742  * \param p_e an initialized exception pointer
 743  * \return frames per second (fps) for this playing movie
 744  */
 745 VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *, libvlc_exception_t *);
 746
 747 /** end bug */
 748
 749 /**
 750  * Does this media player have a video output?
 751  *
 752  * \param p_md the media player
 753  * \param p_e an initialized exception pointer
 754  */
 755 VLC_PUBLIC_API int  libvlc_media_player_has_vout( libvlc_media_player_t *, libvlc_exception_t *);
 756
 757 /**
 758  * Is this media player seekable?
 759  *
 760  * \param p_input the input
 761  * \param p_e an initialized exception pointer
 762  */
 763 VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
 764
 765 /**
 766  * Can this media player be paused?
 767  *
 768  * \param p_input the input
 769  * \param p_e an initialized exception pointer
 770  */
 771 VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
 772
 773 /**
 774  * Release (free) libvlc_track_description_t
 775  *
 776  * \param p_track_description the structure to release
 777  */
 778 VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t *p_track_description );
 779
 780 /** \defgroup libvlc_video libvlc_video
 781  * \ingroup libvlc_media_player
 782  * LibVLC Video handling
 783  * @{
 784  */
 785
 786 /**
 787  * Toggle fullscreen status on video output.
 788  *
 789  * \param p_mediaplayer the media player
 790  * \param p_e an initialized exception pointer
 791  */
 792 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
 793
 794 /**
 795  * Enable or disable fullscreen on a video output.
 796  *
 797  * \param p_mediaplayer the media player
 798  * \param b_fullscreen boolean for fullscreen status
 799  * \param p_e an initialized exception pointer
 800  */
 801 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *, int, libvlc_exception_t * );
 802
 803 /**
 804  * Get current fullscreen status.
 805  *
 806  * \param p_mediaplayer the media player
 807  * \param p_e an initialized exception pointer
 808  * \return the fullscreen status (boolean)
 809  */
 810 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
 811
 812 /**
 813  * Get current video height.
 814  *
 815  * \param p_mediaplayer the media player
 816  * \param p_e an initialized exception pointer
 817  * \return the video height
 818  */
 819 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_player_t *, libvlc_exception_t * );
 820
 821 /**
 822  * Get current video width.
 823  *
 824  * \param p_mediaplayer the media player
 825  * \param p_e an initialized exception pointer
 826  * \return the video width
 827  */
 828 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_player_t *, libvlc_exception_t * );
 829
 830 /**
 831  * Get current video aspect ratio.
 832  *
 833  * \param p_mediaplayer the media player
 834  * \param p_e an initialized exception pointer
 835  * \return the video aspect ratio
 836  */
 837 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *, libvlc_exception_t * );
 838
 839 /**
 840  * Set new video aspect ratio.
 841  *
 842  * \param p_mediaplayer the media player
 843  * \param psz_aspect new video aspect-ratio
 844  * \param p_e an initialized exception pointer
 845  */
 846 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *, char *, libvlc_exception_t * );
 847
 848 /**
 849  * Get current video subtitle.
 850  *
 851  * \param p_mediaplayer the media player
 852  * \param p_e an initialized exception pointer
 853  * \return the video subtitle selected
 854  */
 855 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *, libvlc_exception_t * );
 856
 857 /**
 858  * Get the number of available video subtitles.
 859  *
 860  * \param p_mediaplayer the media player
 861  * \param p_e an initialized exception pointer
 862  * \return the number of available video subtitles
 863  */
 864 VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t *, libvlc_exception_t * );
 865
 866 /**
 867  * Get the description of available video subtitles.
 868  *
 869  * \param p_mediaplayer the media player
 870  * \param p_e an initialized exception pointer
 871  * \return list containing description of available video subtitles
 872  */
 873 VLC_PUBLIC_API libvlc_track_description_t *
 874         libvlc_video_get_spu_description( libvlc_media_player_t *, libvlc_exception_t * );
 875
 876 /**
 877  * Set new video subtitle.
 878  *
 879  * \param p_mediaplayer the media player
 880  * \param i_spu new video subtitle to select
 881  * \param p_e an initialized exception pointer
 882  */
 883 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_player_t *, int , libvlc_exception_t * );
 884
 885 /**
 886  * Set new video subtitle file.
 887  *
 888  * \param p_mediaplayer the media player
 889  * \param psz_subtitle new video subtitle file
 890  * \param p_e an initialized exception pointer
 891  * \return the success status (boolean)
 892  */
 893 VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *, char *, libvlc_exception_t * );
 894
 895 /**
 896  * Get the description of available titles.
 897  *
 898  * \param p_mediaplayer the media player
 899  * \param p_e an initialized exception pointer
 900  * \return list containing description of available titles
 901  */
 902 VLC_PUBLIC_API libvlc_track_description_t *
 903         libvlc_video_get_title_description( libvlc_media_player_t *, libvlc_exception_t * );
 904
 905 /**
 906  * Get the description of available chapters for specific title.
 907  *
 908  * \param p_mediaplayer the media player
 909  * \param i_title selected title
 910  * \param p_e an initialized exception pointer
 911  * \return list containing description of available chapter for title i_title
 912  */
 913 VLC_PUBLIC_API libvlc_track_description_t *
 914         libvlc_video_get_chapter_description( libvlc_media_player_t *, int, libvlc_exception_t * );
 915
 916 /**
 917  * Get current crop filter geometry.
 918  *
 919  * \param p_mediaplayer the media player
 920  * \param p_e an initialized exception pointer
 921  * \return the crop filter geometry
 922  */
 923 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *, libvlc_exception_t * );
 924
 925 /**
 926  * Set new crop filter geometry.
 927  *
 928  * \param p_mediaplayer the media player
 929  * \param psz_geometry new crop filter geometry
 930  * \param p_e an initialized exception pointer
 931  */
 932 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_player_t *, char *, libvlc_exception_t * );
 933
 934 /**
 935  * Toggle teletext transparent status on video output.
 936  *
 937  * \param p_mediaplayer the media player
 938  * \param p_e an initialized exception pointer
 939  */
 940 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *, libvlc_exception_t * );
 941
 942 /**
 943  * Get current teletext page requested.
 944  *
 945  * \param p_mediaplayer the media player
 946  * \param p_e an initialized exception pointer
 947  * \return the current teletext page requested.
 948  */
 949 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *, libvlc_exception_t * );
 950
 951 /**
 952  * Set new teletext page to retrieve.
 953  *
 954  * \param p_mediaplayer the media player
 955  * \param i_page teletex page number requested
 956  * \param p_e an initialized exception pointer
 957  */
 958 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_player_t *, int, libvlc_exception_t * );
 959
 960 /**
 961  * Get number of available video tracks.
 962  *
 963  * \param p_mi media player
 964  * \param p_e an initialized exception
 965  * \return the number of available video tracks (int)
 966  */
 967 VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_t *,  libvlc_exception_t * );
 968
 969 /**
 970  * Get the description of available video tracks.
 971  *
 972  * \param p_mi media player
 973  * \param p_e an initialized exception
 974  * \return list with description of available video tracks
 975  */
 976 VLC_PUBLIC_API libvlc_track_description_t *
 977         libvlc_video_get_track_description( libvlc_media_player_t *,  libvlc_exception_t * );
 978
 979 /**
 980  * Get current video track.
 981  *
 982  * \param p_mi media player
 983  * \param p_e an initialized exception pointer
 984  * \return the video track (int)
 985  */
 986 VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t *, libvlc_exception_t * );
 987
 988 /**
 989  * Set video track.
 990  *
 991  * \param p_mi media player
 992  * \param i_track the track (int)
 993  * \param p_e an initialized exception pointer
 994  */
 995 VLC_PUBLIC_API void libvlc_video_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
 996
 997 /**
 998  * Take a snapshot of the current video window.
 999  *
1000  * If i_width AND i_height is 0, original size is used.
1001  * If i_width XOR i_height is 0, original aspect-ratio is preserved.
1002  *
1003  * \param p_mediaplayer the media player
1004  * \param psz_filepath the path where to save the screenshot to
1005  * \param i_width the snapshot's width
1006  * \param i_height the snapshot's height
1007  * \param p_e an initialized exception pointer
1008  */
1009 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_player_t *, char *,unsigned int, unsigned int, libvlc_exception_t * );
1010
1011 /**
1012  * Resize the current video output window.
1013  *
1014  * \param p_instance libvlc instance
1015  * \param width new width for video output window
1016  * \param height new height for video output window
1017  * \param p_e an initialized exception pointer
1018  * \return the success status (boolean)
1019  */
1020 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_player_t *, int, int, libvlc_exception_t *);
1021
1022 /**
1023  * Tell windowless video output to redraw rectangular area (MacOS X only).
1024  *
1025  * \param p_instance libvlc instance
1026  * \param area coordinates within video drawable
1027  * \param p_e an initialized exception pointer
1028  */
1029 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_player_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
1030
1031 /**
1032  * Set the default video output size.
1033  *
1034  * This setting will be used as default for all video outputs.
1035  *
1036  * \param p_instance libvlc instance
1037  * \param width new width for video drawable
1038  * \param height new height for video drawable
1039  * \param p_e an initialized exception pointer
1040  */
1041 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
1042
1043 /**
1044  * Set the default video output viewport for a windowless video output
1045  * (MacOS X only).
1046  *
1047  * This setting will be used as default for all video outputs.
1048  *
1049  * \param p_instance libvlc instance
1050  * \param view coordinates within video drawable
1051  * \param clip coordinates within video drawable
1052  * \param p_e an initialized exception pointer
1053  */
1054 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
1055
1056 /** @} video */
1057
1058 /** \defgroup libvlc_audio libvlc_audio
1059  * \ingroup libvlc_media_player
1060  * LibVLC Audio handling
1061  * @{
1062  */
1063
1064 /**
1065  * Audio device types
1066  */
1067 typedef enum libvlc_audio_output_device_types_t {
1068     libvlc_AudioOutputDevice_Error  = -1,
1069     libvlc_AudioOutputDevice_Mono   =  1,
1070     libvlc_AudioOutputDevice_Stereo =  2,
1071     libvlc_AudioOutputDevice_2F2R   =  4,
1072     libvlc_AudioOutputDevice_3F2R   =  5,
1073     libvlc_AudioOutputDevice_5_1    =  6,
1074     libvlc_AudioOutputDevice_6_1    =  7,
1075     libvlc_AudioOutputDevice_7_1    =  8,
1076     libvlc_AudioOutputDevice_SPDIF  = 10
1077 } libvlc_audio_output_device_types_t;
1078
1079 /**
1080  * Audio channels
1081  */
1082 typedef enum libvlc_audio_output_channel_t {
1083     libvlc_AudioChannel_Error   = -1,
1084     libvlc_AudioChannel_Stereo  =  1,
1085     libvlc_AudioChannel_RStereo =  2,
1086     libvlc_AudioChannel_Left    =  3,
1087     libvlc_AudioChannel_Right   =  4,
1088     libvlc_AudioChannel_Dolbys  =  5
1089 } libvlc_audio_output_channel_t;
1090
1091
1092 /**
1093  * Get the list of available audio outputs
1094  *
1095  * \param p_instance libvlc instance
1096  * \param p_e an initialized exception pointer
1097  * \return list of available audio outputs, at the end free it with
1098 *          \see libvlc_audio_output_list_release \see libvlc_audio_output_t
1099  */
1100 VLC_PUBLIC_API libvlc_audio_output_t *
1101         libvlc_audio_output_list_get( libvlc_instance_t *,
1102                                       libvlc_exception_t * );
1103
1104 /**
1105  * Free the list of available audio outputs
1106  *
1107  * \param p_list list with audio outputs for release
1108  */
1109 VLC_PUBLIC_API void libvlc_audio_output_list_release( libvlc_audio_output_t * );
1110
1111 /**
1112  * Set the audio output.
1113  * Change will be applied after stop and play.
1114  *
1115  * \param p_instance libvlc instance
1116  * \param psz_name name of audio output,
1117  *               use psz_name of \see libvlc_audio_output_t
1118  * \return true if function succeded
1119  */
1120 VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_instance_t *,
1121                                             const char * );
1122
1123 /**
1124  * Get count of devices for audio output, these devices are hardware oriented
1125  * like analor or digital output of sound card
1126  *
1127  * \param p_instance libvlc instance
1128  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1129  * \return number of devices
1130  */
1131 VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_t *,
1132                                                      const char * );
1133
1134 /**
1135  * Get long name of device, if not available short name given
1136  *
1137  * \param p_instance libvlc instance
1138  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1139  * \param i_device device index
1140  * \return long name of device
1141  */
1142 VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_t *,
1143                                                            const char *,
1144                                                            int );
1145
1146 /**
1147  * Get id name of device
1148  *
1149  * \param p_instance libvlc instance
1150  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1151  * \param i_device device index
1152  * \return id name of device, use for setting device, need to be free after use
1153  */
1154 VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *,
1155                                                      const char *,
1156                                                      int );
1157
1158 /**
1159  * Set device for using
1160  *
1161  * \param p_instance libvlc instance
1162  * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1163  * \param psz_device_id device
1164  */
1165 VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_instance_t *,
1166                                                     const char *,
1167                                                     const char * );
1168
1169 /**
1170  * Get current audio device type. Device type describes something like
1171  * character of output sound - stereo sound, 2.1, 5.1 etc
1172  *
1173  * \param p_instance vlc instance
1174  * \param p_e an initialized exception pointer
1175  * \return the audio devices type \see libvlc_audio_output_device_types_t
1176  */
1177 VLC_PUBLIC_API int libvlc_audio_output_get_device_type(
1178         libvlc_instance_t *, libvlc_exception_t * );
1179
1180 /**
1181  * Set current audio device type.
1182  *
1183  * \param p_instance vlc instance
1184  * \param device_type the audio device type,
1185           according to \see libvlc_audio_output_device_types_t
1186  * \param p_e an initialized exception pointer
1187  */
1188 VLC_PUBLIC_API void libvlc_audio_output_set_device_type( libvlc_instance_t *,
1189                                                          int,
1190                                                          libvlc_exception_t * );
1191
1192
1193 /**
1194  * Toggle mute status.
1195  *
1196  * \param p_instance libvlc instance
1197  * \param p_e an initialized exception pointer
1198  */
1199 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
1200
1201 /**
1202  * Get current mute status.
1203  *
1204  * \param p_instance libvlc instance
1205  * \param p_e an initialized exception pointer
1206  * \return the mute status (boolean)
1207  */
1208 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
1209
1210 /**
1211  * Set mute status.
1212  *
1213  * \param p_instance libvlc instance
1214  * \param status If status is true then mute, otherwise unmute
1215  * \param p_e an initialized exception pointer
1216  */
1217 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, int , libvlc_exception_t * );
1218
1219 /**
1220  * Get current audio level.
1221  *
1222  * \param p_instance libvlc instance
1223  * \param p_e an initialized exception pointer
1224  * \return the audio level (int)
1225  */
1226 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
1227
1228 /**
1229  * Set current audio level.
1230  *
1231  * \param p_instance libvlc instance
1232  * \param i_volume the volume (int)
1233  * \param p_e an initialized exception pointer
1234  */
1235 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
1236
1237 /**
1238  * Get number of available audio tracks.
1239  *
1240  * \param p_mi media player
1241  * \param p_e an initialized exception
1242  * \return the number of available audio tracks (int)
1243  */
1244 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *,  libvlc_exception_t * );
1245
1246  /**
1247  * Get the description of available audio tracks.
1248  *
1249  * \param p_mi media player
1250  * \param p_e an initialized exception
1251  * \return list with description of available audio tracks
1252  */
1253 VLC_PUBLIC_API libvlc_track_description_t *
1254         libvlc_audio_get_track_description( libvlc_media_player_t *,  libvlc_exception_t * );
1255
1256 /**
1257  * Get current audio track.
1258  *
1259  * \param p_mi media player
1260  * \param p_e an initialized exception pointer
1261  * \return the audio track (int)
1262  */
1263 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *, libvlc_exception_t * );
1264
1265 /**
1266  * Set current audio track.
1267  *
1268  * \param p_mi media player
1269  * \param i_track the track (int)
1270  * \param p_e an initialized exception pointer
1271  */
1272 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
1273
1274 /**
1275  * Get current audio channel.
1276  *
1277  * \param p_instance vlc instance
1278  * \param p_e an initialized exception pointer
1279  * \return the audio channel \see libvlc_audio_output_channel_t
1280  */
1281 VLC_PUBLIC_API int
1282     libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
1283
1284 /**
1285  * Set current audio channel.
1286  *
1287  * \param p_instance vlc instance
1288  * \param channel the audio channel, \see libvlc_audio_output_channel_t
1289  * \param p_e an initialized exception pointer
1290  */
1291 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *,
1292                                               int,
1293                                               libvlc_exception_t * );
1294
1295 /** @} audio */
1296
1297 /** @} media_player */
1298
1299 /*****************************************************************************
1300  * Event handling
1301  *****************************************************************************/
1302
1303 /** \defgroup libvlc_event libvlc_event
1304  * \ingroup libvlc_core
1305  * LibVLC Events
1306  * @{
1307  */
1308
1309 /**
1310  * Register for an event notification.
1311  *
1312  * \param p_event_manager the event manager to which you want to attach to.
1313  *        Generally it is obtained by vlc_my_object_event_manager() where
1314  *        my_object is the object you want to listen to.
1315  * \param i_event_type the desired event to which we want to listen
1316  * \param f_callback the function to call when i_event_type occurs
1317  * \param user_data user provided data to carry with the event
1318  * \param p_e an initialized exception pointer
1319  */
1320 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
1321                                          libvlc_event_type_t i_event_type,
1322                                          libvlc_callback_t f_callback,
1323                                          void *user_data,
1324                                          libvlc_exception_t *p_e );
1325
1326 /**
1327  * Unregister an event notification.
1328  *
1329  * \param p_event_manager the event manager
1330  * \param i_event_type the desired event to which we want to unregister
1331  * \param f_callback the function to call when i_event_type occurs
1332  * \param p_user_data user provided data to carry with the event
1333  * \param p_e an initialized exception pointer
1334  */
1335 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
1336                                          libvlc_event_type_t i_event_type,
1337                                          libvlc_callback_t f_callback,
1338                                          void *p_user_data,
1339                                          libvlc_exception_t *p_e );
1340
1341 /**
1342  * Get an event's type name.
1343  *
1344  * \param i_event_type the desired event
1345  */
1346 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
1347
1348 /** @} */
1349
1350 /*****************************************************************************
1351  * Media Library
1352  *****************************************************************************/
1353 /** \defgroup libvlc_media_library libvlc_media_library
1354  * \ingroup libvlc
1355  * LibVLC Media Library
1356  * @{
1357  */
1358 VLC_PUBLIC_API libvlc_media_library_t *
1359     libvlc_media_library_new( libvlc_instance_t * p_inst,
1360                               libvlc_exception_t * p_e );
1361
1362 /**
1363  * Release media library object. This functions decrements the
1364  * reference count of the media library object. If it reaches 0,
1365  * then the object will be released.
1366  *
1367  * \param p_mlib media library object
1368  */
1369 VLC_PUBLIC_API void
1370     libvlc_media_library_release( libvlc_media_library_t * p_mlib );
1371
1372 /**
1373  * Retain a reference to a media library object. This function will
1374  * increment the reference counting for this object. Use
1375  * libvlc_media_library_release() to decrement the reference count.
1376  *
1377  * \param p_mlib media library object
1378  */
1379 VLC_PUBLIC_API void
1380     libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
1381
1382 /**
1383  * Load media library.
1384  *
1385  * \param p_mlib media library object
1386  * \param p_e an initialized exception object.
1387  */
1388 VLC_PUBLIC_API void
1389     libvlc_media_library_load( libvlc_media_library_t * p_mlib,
1390                                libvlc_exception_t * p_e );
1391
1392 /**
1393  * Save media library.
1394  *
1395  * \param p_mlib media library object
1396  * \param p_e an initialized exception object.
1397  */
1398 VLC_PUBLIC_API void
1399     libvlc_media_library_save( libvlc_media_library_t * p_mlib,
1400                                libvlc_exception_t * p_e );
1401
1402 /**
1403  * Get media library subitems.
1404  *
1405  * \param p_mlib media library object
1406  * \param p_e an initialized exception object.
1407  * \return media list subitems
1408  */
1409 VLC_PUBLIC_API libvlc_media_list_t *
1410     libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
1411                                      libvlc_exception_t * p_e );
1412
1413
1414 /** @} */
1415
1416
1417 /*****************************************************************************
1418  * Services/Media Discovery
1419  *****************************************************************************/
1420 /** \defgroup libvlc_media_discoverer libvlc_media_discoverer
1421  * \ingroup libvlc
1422  * LibVLC Media Discoverer
1423  * @{
1424  */
1425
1426 /**
1427  * Discover media service by name.
1428  *
1429  * \param p_inst libvlc instance
1430  * \param psz_name service name
1431  * \param p_e an initialized exception object
1432  * \return media discover object
1433  */
1434 VLC_PUBLIC_API libvlc_media_discoverer_t *
1435 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
1436                                        const char * psz_name,
1437                                        libvlc_exception_t * p_e );
1438
1439 /**
1440  * Release media discover object. If the reference count reaches 0, then
1441  * the object will be released.
1442  *
1443  * \param p_mdis media service discover object
1444  */
1445 VLC_PUBLIC_API void   libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
1446
1447 /**
1448  * Get media service discover object its localized name.
1449  *
1450  * \param media discover object
1451  * \return localized name
1452  */
1453 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
1454
1455 /**
1456  * Get media service discover media list.
1457  *
1458  * \param p_mdis media service discover object
1459  * \return list of media items
1460  */
1461 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
1462
1463 /**
1464  * Get event manager from media service discover object.
1465  *
1466  * \param p_mdis media service discover object
1467  * \return event manager object.
1468  */
1469 VLC_PUBLIC_API libvlc_event_manager_t *
1470         libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis );
1471
1472 /**
1473  * Query if media service discover object is running.
1474  *
1475  * \param p_mdis media service discover object
1476  * \return true if running, false if not
1477  */
1478 VLC_PUBLIC_API int
1479         libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis );
1480
1481 /**@} */
1482
1483
1484 /*****************************************************************************
1485  * Message log handling
1486  *****************************************************************************/
1487
1488 /** \defgroup libvlc_log libvlc_log
1489  * \ingroup libvlc_core
1490  * LibVLC Message Logging
1491  * @{
1492  */
1493
1494 /**
1495  * Return the VLC messaging verbosity level.
1496  *
1497  * \param p_instance libvlc instance
1498  * \param p_e an initialized exception pointer
1499  * \return verbosity level for messages
1500  */
1501 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
1502                                                   libvlc_exception_t *p_e );
1503
1504 /**
1505  * Set the VLC messaging verbosity level.
1506  *
1507  * \param p_instance libvlc log instance
1508  * \param level log level
1509  * \param p_e an initialized exception pointer
1510  */
1511 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
1512                                               libvlc_exception_t *p_e );
1513
1514 /**
1515  * Open a VLC message log instance.
1516  *
1517  * \param p_instance libvlc instance
1518  * \param p_e an initialized exception pointer
1519  * \return log message instance
1520  */
1521 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
1522
1523 /**
1524  * Close a VLC message log instance.
1525  *
1526  * \param p_log libvlc log instance
1527  * \param p_e an initialized exception pointer
1528  */
1529 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
1530
1531 /**
1532  * Returns the number of messages in a log instance.
1533  *
1534  * \param p_log libvlc log instance
1535  * \param p_e an initialized exception pointer
1536  * \return number of log messages
1537  */
1538 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
1539
1540 /**
1541  * Clear a log instance.
1542  *
1543  * All messages in the log are removed. The log should be cleared on a
1544  * regular basis to avoid clogging.
1545  *
1546  * \param p_log libvlc log instance
1547  * \param p_e an initialized exception pointer
1548  */
1549 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
1550
1551 /**
1552  * Allocate and returns a new iterator to messages in log.
1553  *
1554  * \param p_log libvlc log instance
1555  * \param p_e an initialized exception pointer
1556  * \return log iterator object
1557  */
1558 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
1559
1560 /**
1561  * Release a previoulsy allocated iterator.
1562  *
1563  * \param p_iter libvlc log iterator
1564  * \param p_e an initialized exception pointer
1565  */
1566 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1567
1568 /**
1569  * Return whether log iterator has more messages.
1570  *
1571  * \param p_iter libvlc log iterator
1572  * \param p_e an initialized exception pointer
1573  * \return true if iterator has more message objects, else false
1574  */
1575 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1576
1577 /**
1578  * Return the next log message.
1579  *
1580  * The message contents must not be freed
1581  *
1582  * \param p_iter libvlc log iterator
1583  * \param p_buffer log buffer
1584  * \param p_e an initialized exception pointer
1585  * \return log message object
1586  */
1587 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
1588                                                                libvlc_log_message_t *p_buffer,
1589                                                                libvlc_exception_t *p_e );
1590
1591 /** @} */
1592
1593 # ifdef __cplusplus
1594 }
1595 # endif
1596
1597 #endif /* <vlc/libvlc.h> */