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

   1 /*****************************************************************************
   2  * libvlc.h:  libvlc_* new external API
   3  *****************************************************************************
   4  * Copyright (C) 1998-2005 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *          Jean-Paul Saman <jpsaman _at_ m2x _dot_ nl>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /**
  26  * \defgroup libvlc Libvlc
  27  * This is libvlc, the base library of the VLC program.
  28  *
  29  * @{
  30  */
  31
  32
  33 #ifndef _LIBVLC_H
  34 #define _LIBVLC_H 1
  35
  36 #include <vlc/vlc.h>
  37 #include <vlc/libvlc_structures.h>
  38
  39 # ifdef __cplusplus
  40 extern "C" {
  41 # endif
  42
  43 /*****************************************************************************
  44  * Exception handling
  45  *****************************************************************************/
  46 /** defgroup libvlc_exception Exceptions
  47  * \ingroup libvlc
  48  * LibVLC Exceptions handling
  49  * @{
  50  */
  51
  52 /**
  53  * Initialize an exception structure. This can be called several times to
  54  * reuse an exception structure.
  55  *
  56  * \param p_exception the exception to initialize
  57  */
  58 VLC_PUBLIC_API void libvlc_exception_init( libvlc_exception_t *p_exception );
  59
  60 /**
  61  * Has an exception been raised?
  62  *
  63  * \param p_exception the exception to query
  64  * \return 0 if the exception was raised, 1 otherwise
  65  */
  66 VLC_PUBLIC_API int
  67 libvlc_exception_raised( const libvlc_exception_t *p_exception );
  68
  69 /**
  70  * Raise an exception using a user-provided message.
  71  *
  72  * \param p_exception the exception to raise
  73  * \param psz_message the exception message format string
  74  * \param ... the format string arguments
  75  */
  76 VLC_PUBLIC_API void
  77 libvlc_exception_raise( libvlc_exception_t *p_exception,
  78                         const char *psz_format, ... );
  79
  80 /**
  81  * Clear an exception object so it can be reused.
  82  * The exception object must have be initialized.
  83  *
  84  * \param p_exception the exception to clear
  85  */
  86 VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
  87
  88 /**
  89  * Get an exception's message.
  90  *
  91  * \param p_exception the exception to query
  92  * \return the exception message or NULL if not applicable (exception not
  93  *         raised, for example)
  94  */
  95 VLC_PUBLIC_API const char *
  96 libvlc_exception_get_message( const libvlc_exception_t *p_exception );
  97
  98 /**@} */
  99
 100 /*****************************************************************************
 101  * Core handling
 102  *****************************************************************************/
 103
 104 /** defgroup libvlc_core Core
 105  * \ingroup libvlc
 106  * LibVLC Core
 107  * @{
 108  */
 109
 110 /**
 111  * Create and initialize a libvlc instance.
 112  *
 113  * \param argc the number of arguments
 114  * \param argv command-line-type arguments. argv[0] must be the path of the
 115  *        calling program.
 116  * \param p_e an initialized exception pointer
 117  * \return the libvlc instance
 118  */
 119 VLC_PUBLIC_API libvlc_instance_t *
 120 libvlc_new( int , const char *const *, libvlc_exception_t *);
 121
 122 /**
 123  * Return a libvlc instance identifier for legacy APIs. Use of this
 124  * function is discouraged, you should convert your program to use the
 125  * new API.
 126  *
 127  * \param p_instance the instance
 128  * \return the instance identifier
 129  */
 130 VLC_PUBLIC_API int libvlc_get_vlc_id( libvlc_instance_t *p_instance );
 131
 132 /**
 133  * Decrement the reference count of a libvlc instance, and destroy it
 134  * if it reaches zero.
 135  *
 136  * \param p_instance the instance to destroy
 137  */
 138 VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * );
 139
 140 /**
 141  * Increments the reference count of a libvlc instance.
 142  * The initial reference count is 1 after libvlc_new() returns.
 143  *
 144  * \param p_instance the instance to reference
 145  */
 146 VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
 147
 148 /** @}*/
 149
 150 /*****************************************************************************
 151  * Media descriptor
 152  *****************************************************************************/
 153 /** defgroup libvlc_media_descriptor Media Descriptor
 154  * \ingroup libvlc
 155  * LibVLC Media Descriptor
 156  * @{
 157  */
 158
 159 /**
 160  * Create a media descriptor with the given MRL.
 161  *
 162  * \param p_instance the instance
 163  * \param psz_mrl the MRL to read
 164  * \param p_e an initialized exception pointer
 165  * \return the newly created media descriptor
 166  */
 167 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_new(
 168                                    libvlc_instance_t *p_instance,
 169                                    const char * psz_mrl,
 170                                    libvlc_exception_t *p_e );
 171
 172 /**
 173  * Create a media descriptor as an empty node with the passed name.
 174  *
 175  * \param p_instance the instance
 176  * \param psz_name the name of the node
 177  * \param p_e an initialized exception pointer
 178  * \return the new empty media descriptor
 179  */
 180 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_new_as_node(
 181                                    libvlc_instance_t *p_instance,
 182                                    const char * psz_name,
 183                                    libvlc_exception_t *p_e );
 184
 185 /**
 186  * Add an option to the media descriptor.
 187  *
 188  * This option will be used to determine how the media_instance will
 189  * read the media_descriptor. This allows to use VLC's advanced
 190  * reading/streaming options on a per-media basis.
 191  *
 192  * The options are detailed in vlc --long-help, for instance "--sout-all"
 193  *
 194  * \param p_instance the instance
 195  * \param psz_mrl the MRL to read
 196  * \param p_e an initialized exception pointer
 197  */
 198 VLC_PUBLIC_API void libvlc_media_descriptor_add_option(
 199                                    libvlc_media_descriptor_t * p_md,
 200                                    const char * ppsz_options,
 201                                    libvlc_exception_t * p_e );
 202
 203 VLC_PUBLIC_API void libvlc_media_descriptor_retain(
 204                                    libvlc_media_descriptor_t *p_meta_desc );
 205
 206 VLC_PUBLIC_API void libvlc_media_descriptor_release(
 207                                    libvlc_media_descriptor_t *p_meta_desc );
 208
 209 VLC_PUBLIC_API char * libvlc_media_descriptor_get_mrl( libvlc_media_descriptor_t * p_md,
 210                                                        libvlc_exception_t * p_e );
 211
 212 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_duplicate( libvlc_media_descriptor_t * );
 213
 214 /**
 215  * Read the meta of the media descriptor.
 216  *
 217  * \param p_meta_desc the media descriptor to read
 218  * \param p_meta_desc the meta to read
 219  * \param p_e an initialized exception pointer
 220  * \return the media descriptor's meta
 221  */
 222 VLC_PUBLIC_API char * libvlc_media_descriptor_get_meta(
 223                                    libvlc_media_descriptor_t *p_meta_desc,
 224                                    libvlc_meta_t e_meta,
 225                                    libvlc_exception_t *p_e );
 226
 227 VLC_PUBLIC_API libvlc_state_t libvlc_media_descriptor_get_state(
 228                                    libvlc_media_descriptor_t *p_meta_desc,
 229                                    libvlc_exception_t *p_e );
 230
 231 /* Tags */
 232 VLC_PUBLIC_API void libvlc_media_descriptor_add_tag( libvlc_media_descriptor_t *p_md,
 233                                                      const char * key,
 234                                                      const libvlc_tag_t tag,
 235                                                      libvlc_exception_t *p_e );
 236
 237 VLC_PUBLIC_API void libvlc_media_descriptor_remove_tag( libvlc_media_descriptor_t *p_md,
 238                                                          const char * key,
 239                                                          const libvlc_tag_t tag,
 240                                                          libvlc_exception_t *p_e );
 241
 242 VLC_PUBLIC_API int
 243     libvlc_media_descriptor_tags_count_for_key( libvlc_media_descriptor_t *p_md,
 244                                                 const char * key,
 245                                                 libvlc_exception_t *p_e );
 246
 247 VLC_PUBLIC_API libvlc_tag_t
 248     libvlc_media_descriptor_tag_at_index_for_key( libvlc_media_descriptor_t *p_md,
 249                                                   int i,
 250                                                   const char * key,
 251                                                   libvlc_exception_t *p_e );
 252
 253 VLC_PUBLIC_API libvlc_media_list_t *
 254     libvlc_media_descriptor_subitems( libvlc_media_descriptor_t *p_md,
 255                                       libvlc_exception_t *p_e );
 256
 257 VLC_PUBLIC_API libvlc_event_manager_t *
 258     libvlc_media_descriptor_event_manager( libvlc_media_descriptor_t * p_md,
 259                                            libvlc_exception_t * p_e );
 260
 261 VLC_PUBLIC_API libvlc_time_t
 262    libvlc_media_descriptor_get_duration( libvlc_media_descriptor_t * p_md,
 263                                          libvlc_exception_t * p_e );
 264
 265 VLC_PUBLIC_API int
 266    libvlc_media_descriptor_is_preparsed( libvlc_media_descriptor_t * p_md,
 267                                          libvlc_exception_t * p_e );
 268
 269 VLC_PUBLIC_API void
 270     libvlc_media_descriptor_set_user_data( libvlc_media_descriptor_t * p_md,
 271                                            void * p_new_user_data,
 272                                            libvlc_exception_t * p_e);
 273 VLC_PUBLIC_API void *
 274     libvlc_media_descriptor_get_user_data( libvlc_media_descriptor_t * p_md,
 275                                            libvlc_exception_t * p_e);
 276
 277 /** @}*/
 278
 279 /*****************************************************************************
 280  * Playlist
 281  *****************************************************************************/
 282 /** defgroup libvlc_playlist Playlist
 283  * \ingroup libvlc
 284  * LibVLC Playlist handling
 285  * @{
 286  */
 287
 288 /**
 289  * Set the playlist's loop attribute. If set, the playlist runs continuously
 290  * and wraps around when it reaches the end.
 291  *
 292  * \param p_instance the playlist instance
 293  * \param loop the loop attribute. 1 sets looping, 0 disables it
 294  * \param p_e an initialized exception pointer
 295  */
 296 VLC_DEPRECATED_API void libvlc_playlist_loop( libvlc_instance_t* , int,
 297                                           libvlc_exception_t * );
 298
 299 /**
 300  * Start playing.
 301  *
 302  * Additionnal playlist item options can be specified for addition to the
 303  * item before it is played.
 304  *
 305  * \param p_instance the playlist instance
 306  * \param i_id the item to play. If this is a negative number, the next
 307  *        item will be selected. Otherwise, the item with the given ID will be
 308  *        played
 309  * \param i_options the number of options to add to the item
 310  * \param ppsz_options the options to add to the item
 311  * \param p_e an initialized exception pointer
 312  */
 313 VLC_DEPRECATED_API void libvlc_playlist_play( libvlc_instance_t*, int, int,
 314                                           char **, libvlc_exception_t * );
 315
 316 /**
 317  * Toggle the playlist's pause status.
 318  *
 319  * If the playlist was running, it is paused. If it was paused, it is resumed.
 320  *
 321  * \param p_instance the playlist instance to pause
 322  * \param p_e an initialized exception pointer
 323  */
 324 VLC_DEPRECATED_API void libvlc_playlist_pause( libvlc_instance_t *,
 325                                            libvlc_exception_t * );
 326
 327 /**
 328  * Checks whether the playlist is running
 329  *
 330  * \param p_instance the playlist instance
 331  * \param p_e an initialized exception pointer
 332  * \return 0 if the playlist is stopped or paused, 1 if it is running
 333  */
 334 VLC_DEPRECATED_API int libvlc_playlist_isplaying( libvlc_instance_t *,
 335                                               libvlc_exception_t * );
 336
 337 /**
 338  * Get the number of items in the playlist
 339  *
 340  * \param p_instance the playlist instance
 341  * \param p_e an initialized exception pointer
 342  * \return the number of items
 343  */
 344 VLC_DEPRECATED_API int libvlc_playlist_items_count( libvlc_instance_t *,
 345                                                 libvlc_exception_t * );
 346
 347 /**
 348  * Lock the playlist.
 349  *
 350  * \param p_instance the playlist instance
 351  */
 352 VLC_DEPRECATED_API void libvlc_playlist_lock( libvlc_instance_t * );
 353
 354 /**
 355  * Unlock the playlist.
 356  *
 357  * \param p_instance the playlist instance
 358  */
 359 VLC_DEPRECATED_API void libvlc_playlist_unlock( libvlc_instance_t * );
 360
 361 /**
 362  * Stop playing.
 363  *
 364  * \param p_instance the playlist instance to stop
 365  * \param p_e an initialized exception pointer
 366  */
 367 VLC_DEPRECATED_API void libvlc_playlist_stop( libvlc_instance_t *,
 368                                           libvlc_exception_t * );
 369
 370 /**
 371  * Go to the next playlist item. If the playlist was stopped, playback
 372  * is started.
 373  *
 374  * \param p_instance the playlist instance
 375  * \param p_e an initialized exception pointer
 376  */
 377 VLC_DEPRECATED_API void libvlc_playlist_next( libvlc_instance_t *,
 378                                           libvlc_exception_t * );
 379
 380 /**
 381  * Go to the previous playlist item. If the playlist was stopped, playback
 382  * is started.
 383  *
 384  * \param p_instance the playlist instance
 385  * \param p_e an initialized exception pointer
 386  */
 387 VLC_DEPRECATED_API void libvlc_playlist_prev( libvlc_instance_t *,
 388                                           libvlc_exception_t * );
 389
 390 /**
 391  * Empty a playlist. All items in the playlist are removed.
 392  *
 393  * \param p_instance the playlist instance
 394  * \param p_e an initialized exception pointer
 395  */
 396 VLC_DEPRECATED_API void libvlc_playlist_clear( libvlc_instance_t *,
 397                                            libvlc_exception_t * );
 398
 399 /**
 400  * Append an item to the playlist. The item is added at the end. If more
 401  * advanced options are required, \see libvlc_playlist_add_extended instead.
 402  *
 403  * \param p_instance the playlist instance
 404  * \param psz_uri the URI to open, using VLC format
 405  * \param psz_name a name that you might want to give or NULL
 406  * \param p_e an initialized exception pointer
 407  * \return the identifier of the new item
 408  */
 409 VLC_DEPRECATED_API int libvlc_playlist_add( libvlc_instance_t *, const char *,
 410                                         const char *, libvlc_exception_t * );
 411
 412 /**
 413  * Append an item to the playlist. The item is added at the end, with
 414  * additional input options.
 415  *
 416  * \param p_instance the playlist instance
 417  * \param psz_uri the URI to open, using VLC format
 418  * \param psz_name a name that you might want to give or NULL
 419  * \param i_options the number of options to add
 420  * \param ppsz_options strings representing the options to add
 421  * \param p_e an initialized exception pointer
 422  * \return the identifier of the new item
 423  */
 424 VLC_DEPRECATED_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
 425                                                  const char *, int, const char **,
 426                                                  libvlc_exception_t * );
 427
 428 /**
 429  * Delete the playlist item with the given ID.
 430  *
 431  * \param p_instance the playlist instance
 432  * \param i_id the id to remove
 433  * \param p_e an initialized exception pointer
 434  * \return 0 in case of success, a non-zero value otherwise
 435  */
 436 VLC_DEPRECATED_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
 437                                                 libvlc_exception_t * );
 438
 439 /** Get the input that is currently being played by the playlist.
 440  *
 441  * \param p_instance the playlist instance to use
 442  * \param p_e an initialized exception pointern
 443  * \return a media instance object
 444  */
 445 VLC_DEPRECATED_API libvlc_media_instance_t * libvlc_playlist_get_media_instance(
 446                                 libvlc_instance_t *, libvlc_exception_t * );
 447
 448 /** @}*/
 449
 450 /*****************************************************************************
 451  * Media Instance
 452  *****************************************************************************/
 453 /** defgroup libvlc_media_instance Media Instance
 454  * \ingroup libvlc
 455  * LibVLC Media Instance
 456  * @{
 457  */
 458
 459 /** Create an empty Media Instance object
 460  *
 461  * \param p_libvlc_instance the libvlc instance in which the Media Instance
 462  *        should be (unused for now).
 463  * \param p_e an initialized exception pointer
 464  */
 465 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new( libvlc_instance_t *, libvlc_exception_t * );
 466
 467 /** Create a Media Instance object from a Media Descriptor
 468  * \param p_md the media descriptor. Afterwards the p_md can be safely
 469  *        destroyed.
 470  * \param p_e an initialized exception pointer
 471  */
 472 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new_from_media_descriptor( libvlc_media_descriptor_t *, libvlc_exception_t * );
 473
 474 /** Release a media_instance after use
 475  * \param p_mi the Media Instance to free
 476  */
 477 VLC_PUBLIC_API void libvlc_media_instance_release( libvlc_media_instance_t * );
 478 VLC_PUBLIC_API void libvlc_media_instance_retain( libvlc_media_instance_t * );
 479
 480 /** Set the media descriptor that will be used by the media_instance. If any,
 481  * previous md will be released.
 482  *
 483  * \param p_mi the Media Instance
 484  * \param p_md the Media Descriptor. Afterwards the p_md can be safely
 485  *        destroyed.
 486  * \param p_e an initialized exception pointer
 487  */
 488 VLC_PUBLIC_API void libvlc_media_instance_set_media_descriptor( libvlc_media_instance_t *, libvlc_media_descriptor_t *, libvlc_exception_t * );
 489
 490 /** Get the media descriptor used by the media_instance (if any). A copy of
 491  * the md is returned. NULL is returned if no media instance is associated.
 492  *
 493  * \param p_mi the Media Instance
 494  * \param p_e an initialized exception pointer
 495  */
 496 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_instance_get_media_descriptor( libvlc_media_instance_t *, libvlc_exception_t * );
 497
 498 /** Get the Event Manager from which the media instance send event.
 499  *
 500  * \param p_mi the Media Instance
 501  * \param p_e an initialized exception pointer
 502  */
 503 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_instance_event_manager ( libvlc_media_instance_t *, libvlc_exception_t * );
 504
 505 VLC_PUBLIC_API void libvlc_media_instance_play ( libvlc_media_instance_t *, libvlc_exception_t * );
 506 VLC_PUBLIC_API void libvlc_media_instance_pause ( libvlc_media_instance_t *, libvlc_exception_t * );
 507 VLC_PUBLIC_API void libvlc_media_instance_stop ( libvlc_media_instance_t *, libvlc_exception_t * );
 508
 509 VLC_PUBLIC_API void libvlc_media_instance_set_drawable ( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
 510 VLC_PUBLIC_API libvlc_drawable_t
 511                     libvlc_media_instance_get_drawable ( libvlc_media_instance_t *, libvlc_exception_t * );
 512
 513 /** \bug This might go away ... to be replaced by a broader system */
 514 VLC_PUBLIC_API libvlc_time_t libvlc_media_instance_get_length     ( libvlc_media_instance_t *, libvlc_exception_t *);
 515 VLC_PUBLIC_API libvlc_time_t libvlc_media_instance_get_time       ( libvlc_media_instance_t *, libvlc_exception_t *);
 516 VLC_PUBLIC_API void          libvlc_media_instance_set_time       ( libvlc_media_instance_t *, libvlc_time_t, libvlc_exception_t *);
 517 VLC_PUBLIC_API float         libvlc_media_instance_get_position   ( libvlc_media_instance_t *, libvlc_exception_t *);
 518 VLC_PUBLIC_API void          libvlc_media_instance_set_position   ( libvlc_media_instance_t *, float, libvlc_exception_t *);
 519 VLC_PUBLIC_API void          libvlc_media_instance_set_chapter    ( libvlc_media_instance_t *, int, libvlc_exception_t *);
 520 VLC_PUBLIC_API int           libvlc_media_instance_get_chapter    (libvlc_media_instance_t *, libvlc_exception_t *);
 521 VLC_PUBLIC_API int           libvlc_media_instance_get_chapter_count( libvlc_media_instance_t *, libvlc_exception_t *);
 522 VLC_PUBLIC_API int    libvlc_media_instance_will_play      ( libvlc_media_instance_t *, libvlc_exception_t *);
 523 VLC_PUBLIC_API float         libvlc_media_instance_get_rate       ( libvlc_media_instance_t *, libvlc_exception_t *);
 524 VLC_PUBLIC_API void          libvlc_media_instance_set_rate       ( libvlc_media_instance_t *, float, libvlc_exception_t *);
 525 VLC_PUBLIC_API libvlc_state_t libvlc_media_instance_get_state   ( libvlc_media_instance_t *, libvlc_exception_t *);
 526
 527 /**
 528  * Does this input have a video output?
 529  *
 530  * \param p_input the input
 531  * \param p_e an initialized exception pointer
 532  */
 533 VLC_PUBLIC_API int  libvlc_media_instance_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
 534 VLC_PUBLIC_API float       libvlc_media_instance_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
 535
 536 VLC_PUBLIC_API int libvlc_media_instance_is_seekable(
 537                                  libvlc_media_instance_t *p_mi,
 538                                  libvlc_exception_t *p_e );
 539
 540 VLC_PUBLIC_API int libvlc_media_instance_can_pause(
 541                                  libvlc_media_instance_t *p_mi,
 542                                  libvlc_exception_t *p_e );
 543
 544 /** @} */
 545
 546 /*****************************************************************************
 547  * Tag Query
 548  *****************************************************************************/
 549 /** defgroup libvlc_tag_query Tag Query
 550  * \ingroup libvlc
 551  * LibVLC Tag query
 552  * @{
 553  */
 554 VLC_PUBLIC_API libvlc_tag_query_t *
 555     libvlc_tag_query_new( libvlc_instance_t *, libvlc_exception_t * );
 556
 557 VLC_PUBLIC_API void
 558     libvlc_tag_query_release( libvlc_tag_query_t * );
 559
 560 VLC_PUBLIC_API void
 561     libvlc_tag_query_retain( libvlc_tag_query_t * );
 562
 563 VLC_PUBLIC_API void
 564     libvlc_tag_query_set_match_tag_and_key( libvlc_tag_query_t * p_q,
 565                                             libvlc_tag_t tag,
 566                                             char * psz_tag_key,
 567                                             libvlc_exception_t * );
 568
 569 VLC_PUBLIC_API int
 570     libvlc_tag_query_match( libvlc_tag_query_t *, libvlc_media_descriptor_t *,
 571                             libvlc_exception_t * );
 572
 573 /** @} */
 574
 575 /*****************************************************************************
 576  * Media List
 577  *****************************************************************************/
 578 /** defgroup libvlc_media_list MediaList
 579  * \ingroup libvlc
 580  * LibVLC Media List
 581  * @{
 582  */
 583 VLC_PUBLIC_API libvlc_media_list_t *
 584     libvlc_media_list_new( libvlc_instance_t *, libvlc_exception_t * );
 585
 586 VLC_PUBLIC_API void
 587     libvlc_media_list_release( libvlc_media_list_t * );
 588
 589 VLC_PUBLIC_API void
 590     libvlc_media_list_retain( libvlc_media_list_t * );
 591
 592 VLC_PUBLIC_API void
 593     libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
 594                                         const char * psz_uri,
 595                                         libvlc_exception_t * p_e );
 596
 597 VLC_PUBLIC_API void
 598     libvlc_media_list_set_media_descriptor( libvlc_media_list_t *,
 599                                             libvlc_media_descriptor_t *,
 600                                             libvlc_exception_t *);
 601
 602 VLC_PUBLIC_API libvlc_media_descriptor_t *
 603     libvlc_media_list_media_descriptor( libvlc_media_list_t *,
 604                                         libvlc_exception_t *);
 605
 606 VLC_PUBLIC_API void
 607     libvlc_media_list_add_media_descriptor( libvlc_media_list_t *,
 608                                             libvlc_media_descriptor_t *,
 609                                             libvlc_exception_t * );
 610 VLC_PUBLIC_API void
 611     libvlc_media_list_insert_media_descriptor( libvlc_media_list_t *,
 612                                                libvlc_media_descriptor_t *,
 613                                                int,
 614                                                libvlc_exception_t * );
 615 VLC_PUBLIC_API void
 616     libvlc_media_list_remove_index( libvlc_media_list_t *, int,
 617                                     libvlc_exception_t * );
 618
 619 VLC_PUBLIC_API int
 620     libvlc_media_list_count( libvlc_media_list_t * p_mlist,
 621                              libvlc_exception_t * p_e );
 622
 623 VLC_PUBLIC_API libvlc_media_descriptor_t *
 624     libvlc_media_list_item_at_index( libvlc_media_list_t *, int,
 625                                      libvlc_exception_t * );
 626 VLC_PUBLIC_API int
 627     libvlc_media_list_index_of_item( libvlc_media_list_t *,
 628                                      libvlc_media_descriptor_t *,
 629                                      libvlc_exception_t * );
 630
 631 /* This indicates if this media list is read-only from a user point of view */
 632 VLC_PUBLIC_API int
 633     libvlc_media_list_is_readonly( libvlc_media_list_t * p_mlist );
 634
 635 VLC_PUBLIC_API void
 636     libvlc_media_list_lock( libvlc_media_list_t * );
 637 VLC_PUBLIC_API void
 638     libvlc_media_list_unlock( libvlc_media_list_t * );
 639
 640 VLC_PUBLIC_API libvlc_media_list_view_t *
 641     libvlc_media_list_flat_view( libvlc_media_list_t *,
 642                                  libvlc_exception_t * );
 643
 644 VLC_PUBLIC_API libvlc_media_list_view_t *
 645     libvlc_media_list_hierarchical_view( libvlc_media_list_t *,
 646                                          libvlc_exception_t * );
 647
 648 VLC_PUBLIC_API libvlc_media_list_view_t *
 649     libvlc_media_list_hierarchical_node_view( libvlc_media_list_t *,
 650                                               libvlc_exception_t * );
 651
 652 VLC_PUBLIC_API libvlc_event_manager_t *
 653     libvlc_media_list_event_manager( libvlc_media_list_t *,
 654                                      libvlc_exception_t * );
 655 /** @} */
 656
 657
 658 /*****************************************************************************
 659  * Media List View
 660  *****************************************************************************/
 661 /** defgroup libvlc_media_list_view MediaListView
 662  * \ingroup libvlc
 663  * LibVLC Media List View
 664  * @{ */
 665
 666 VLC_PUBLIC_API void
 667     libvlc_media_list_view_retain( libvlc_media_list_view_t * p_mlv );
 668
 669 VLC_PUBLIC_API void
 670     libvlc_media_list_view_release( libvlc_media_list_view_t * p_mlv );
 671
 672 VLC_PUBLIC_API libvlc_event_manager_t *
 673     libvlc_media_list_view_event_manager(  libvlc_media_list_view_t * p_mlv );
 674
 675 VLC_PUBLIC_API int
 676     libvlc_media_list_view_count(  libvlc_media_list_view_t * p_mlv,
 677                                    libvlc_exception_t * p_e );
 678
 679 VLC_PUBLIC_API libvlc_media_descriptor_t *
 680     libvlc_media_list_view_item_at_index(  libvlc_media_list_view_t * p_mlv,
 681                                            int index,
 682                                            libvlc_exception_t * p_e );
 683
 684 VLC_PUBLIC_API libvlc_media_list_view_t *
 685     libvlc_media_list_view_children_at_index(  libvlc_media_list_view_t * p_mlv,
 686                                            int index,
 687                                            libvlc_exception_t * p_e );
 688
 689 VLC_PUBLIC_API libvlc_media_list_view_t *
 690     libvlc_media_list_view_children_for_item(  libvlc_media_list_view_t * p_mlv,
 691                                            libvlc_media_descriptor_t * p_md,
 692                                            libvlc_exception_t * p_e );
 693
 694
 695 VLC_PUBLIC_API int
 696     libvlc_media_list_view_index_of_item(  libvlc_media_list_view_t * p_mlv,
 697                                            libvlc_media_descriptor_t * p_md,
 698                                            libvlc_exception_t * p_e );
 699
 700 VLC_PUBLIC_API void
 701     libvlc_media_list_view_insert_at_index(  libvlc_media_list_view_t * p_mlv,
 702                                              libvlc_media_descriptor_t * p_md,
 703                                              int index,
 704                                              libvlc_exception_t * p_e );
 705
 706 VLC_PUBLIC_API void
 707     libvlc_media_list_view_remove_at_index(  libvlc_media_list_view_t * p_mlv,
 708                                              int index,
 709                                              libvlc_exception_t * p_e );
 710
 711 VLC_PUBLIC_API void
 712     libvlc_media_list_view_add_item(  libvlc_media_list_view_t * p_mlv,
 713                                       libvlc_media_descriptor_t * p_md,
 714                                       libvlc_exception_t * p_e );
 715
 716 VLC_PUBLIC_API libvlc_media_list_t *
 717     libvlc_media_list_view_parent_media_list(  libvlc_media_list_view_t * p_mlv,
 718                                                libvlc_exception_t * p_e );
 719
 720 /** @} */
 721
 722 /*****************************************************************************
 723  * Dynamic Media List (Deprecated)
 724  *****************************************************************************/
 725 /** defgroup libvlc_media_list MediaList
 726  * \ingroup libvlc
 727  * LibVLC Media List
 728  * @{ */
 729
 730 VLC_DEPRECATED_API libvlc_dynamic_media_list_t *
 731     libvlc_dynamic_media_list_new(  libvlc_media_list_t * p_mlist,
 732                                     libvlc_tag_query_t * p_query,
 733                                     libvlc_tag_t tag,
 734                                     libvlc_exception_t * p_e );
 735 VLC_DEPRECATED_API void
 736     libvlc_dynamic_media_list_release( libvlc_dynamic_media_list_t * p_dmlist );
 737
 738 VLC_DEPRECATED_API void
 739     libvlc_dynamic_media_list_retain( libvlc_dynamic_media_list_t * p_dmlist );
 740
 741 VLC_DEPRECATED_API libvlc_media_list_t *
 742     libvlc_dynamic_media_list_media_list( libvlc_dynamic_media_list_t * p_dmlist,
 743                                           libvlc_exception_t * p_e );
 744
 745 /** @} */
 746
 747 /*****************************************************************************
 748  * Media Library
 749  *****************************************************************************/
 750 /** defgroup libvlc_media_library Media Library
 751  * \ingroup libvlc
 752  * LibVLC Media Library
 753  * @{
 754  */
 755 VLC_PUBLIC_API libvlc_media_library_t *
 756     libvlc_media_library_new( libvlc_instance_t * p_inst,
 757                               libvlc_exception_t * p_e );
 758 VLC_PUBLIC_API void
 759     libvlc_media_library_release( libvlc_media_library_t * p_mlib );
 760 VLC_PUBLIC_API void
 761     libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
 762
 763
 764 VLC_PUBLIC_API void
 765     libvlc_media_library_load( libvlc_media_library_t * p_mlib,
 766                                libvlc_exception_t * p_e );
 767
 768 VLC_PUBLIC_API void
 769     libvlc_media_library_save( libvlc_media_library_t * p_mlib,
 770                                libvlc_exception_t * p_e );
 771
 772 VLC_PUBLIC_API libvlc_media_list_t *
 773     libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
 774                                      libvlc_exception_t * p_e );
 775
 776
 777 /** @} */
 778
 779 /*****************************************************************************
 780  * Media List Player
 781  *****************************************************************************/
 782 /** defgroup libvlc_media_list_player MediaListPlayer
 783  * \ingroup libvlc
 784  * LibVLC Media List Player
 785  * @{
 786  */
 787 VLC_PUBLIC_API libvlc_media_list_player_t *
 788     libvlc_media_list_player_new( libvlc_instance_t * p_instance,
 789                                   libvlc_exception_t * p_e );
 790 VLC_PUBLIC_API void
 791     libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
 792
 793 VLC_PUBLIC_API void
 794     libvlc_media_list_player_set_media_instance(
 795                                      libvlc_media_list_player_t * p_mlp,
 796                                      libvlc_media_instance_t * p_mi,
 797                                      libvlc_exception_t * p_e );
 798
 799 VLC_PUBLIC_API void
 800     libvlc_media_list_player_set_media_list(
 801                                      libvlc_media_list_player_t * p_mlp,
 802                                      libvlc_media_list_t * p_mlist,
 803                                      libvlc_exception_t * p_e );
 804
 805 VLC_PUBLIC_API void
 806     libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
 807                                    libvlc_exception_t * p_e );
 808
 809 VLC_PUBLIC_API void
 810     libvlc_media_list_player_pause( libvlc_media_list_player_t * p_mlp,
 811                                    libvlc_exception_t * p_e );
 812
 813 VLC_PUBLIC_API int
 814     libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp,
 815                                          libvlc_exception_t * p_e );
 816
 817 VLC_PUBLIC_API libvlc_state_t
 818     libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp,
 819                                         libvlc_exception_t * p_e );
 820
 821 VLC_PUBLIC_API void
 822     libvlc_media_list_player_play_item_at_index(
 823                                    libvlc_media_list_player_t * p_mlp,
 824                                    int i_index,
 825                                    libvlc_exception_t * p_e );
 826
 827 VLC_PUBLIC_API void
 828     libvlc_media_list_player_play_item(
 829                                    libvlc_media_list_player_t * p_mlp,
 830                                    libvlc_media_descriptor_t * p_md,
 831                                    libvlc_exception_t * p_e );
 832
 833 VLC_PUBLIC_API void
 834     libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
 835                                    libvlc_exception_t * p_e );
 836 VLC_PUBLIC_API void
 837     libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
 838                                    libvlc_exception_t * p_e );
 839
 840 /** @} */
 841
 842 /** defgroup libvlc_video Video
 843  * \ingroup libvlc
 844  * LibVLC Video handling
 845  * @{
 846  */
 847
 848 /**
 849  * Toggle fullscreen status on video output.
 850  *
 851  * \param p_input the input
 852  * \param p_e an initialized exception pointer
 853  */
 854 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
 855
 856 /**
 857  * Enable or disable fullscreen on a video output.
 858  *
 859  * \param p_input the input
 860  * \param b_fullscreen boolean for fullscreen status
 861  * \param p_e an initialized exception pointer
 862  */
 863 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_instance_t *, int, libvlc_exception_t * );
 864
 865 /**
 866  * Get current fullscreen status.
 867  *
 868  * \param p_input the input
 869  * \param p_e an initialized exception pointer
 870  * \return the fullscreen status (boolean)
 871  */
 872 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
 873
 874 /**
 875  * Get current video height.
 876  *
 877  * \param p_input the input
 878  * \param p_e an initialized exception pointer
 879  * \return the video height
 880  */
 881 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_instance_t *, libvlc_exception_t * );
 882
 883 /**
 884  * Get current video width.
 885  *
 886  * \param p_input the input
 887  * \param p_e an initialized exception pointer
 888  * \return the video width
 889  */
 890 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_instance_t *, libvlc_exception_t * );
 891
 892 /**
 893  * Get current video aspect ratio.
 894  *
 895  * \param p_input the input
 896  * \param p_e an initialized exception pointer
 897  * \return the video aspect ratio
 898  */
 899 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_instance_t *, libvlc_exception_t * );
 900
 901 /**
 902  * Set new video aspect ratio.
 903  *
 904  * \param p_input the input
 905  * \param psz_aspect new video aspect-ratio
 906  * \param p_e an initialized exception pointer
 907  */
 908 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_instance_t *, char *, libvlc_exception_t * );
 909
 910 /**
 911  * Get current video subtitle.
 912  *
 913  * \param p_input the input
 914  * \param p_e an initialized exception pointer
 915  * \return the video subtitle selected
 916  */
 917 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_instance_t *, libvlc_exception_t * );
 918
 919 /**
 920  * Set new video subtitle.
 921  *
 922  * \param p_input the input
 923  * \param i_spu new video subtitle to select
 924  * \param p_e an initialized exception pointer
 925  */
 926 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_instance_t *, int , libvlc_exception_t * );
 927
 928 /**
 929  * Get current crop filter geometry.
 930  *
 931  * \param p_input the input
 932  * \param p_e an initialized exception pointer
 933  * \return the crop filter geometry
 934  */
 935 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_instance_t *, libvlc_exception_t * );
 936
 937 /**
 938  * Set new crop filter geometry.
 939  *
 940  * \param p_input the input
 941  * \param psz_geometry new crop filter geometry
 942  * \param p_e an initialized exception pointer
 943  */
 944 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_instance_t *, char *, libvlc_exception_t * );
 945
 946 /**
 947  * Toggle teletext transparent status on video output.
 948  *
 949  * \param p_input the input
 950  * \param p_e an initialized exception pointer
 951  */
 952 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
 953
 954 /**
 955  * Get current teletext page requested.
 956  *
 957  * \param p_input the input
 958  * \param p_e an initialized exception pointer
 959  * \return the current teletext page requested.
 960  */
 961 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
 962
 963 /**
 964  * Set new teletext page to retrieve.
 965  *
 966  * \param p_input the input
 967  * \param i_page teletex page number requested
 968  * \param p_e an initialized exception pointer
 969  */
 970 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_instance_t *, int, libvlc_exception_t * );
 971
 972 /**
 973  * Take a snapshot of the current video window.
 974  *
 975  * If i_width AND i_height is 0, original size is used.
 976  * If i_width XOR i_height is 0, original aspect-ratio is preserved.
 977  *
 978  * \param p_input the input
 979  * \param psz_filepath the path where to save the screenshot to
 980  * \param i_width the snapshot's width
 981  * \param i_height the snapshot's height
 982  * \param p_e an initialized exception pointer
 983  */
 984 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_instance_t *, char *,unsigned int, unsigned int, libvlc_exception_t * );
 985
 986 VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *);
 987
 988 /**
 989  * Resize the current video output window.
 990  *
 991  * \param p_instance libvlc instance
 992  * \param width new width for video output window
 993  * \param height new height for video output window
 994  * \param p_e an initialized exception pointer
 995  * \return the success status (boolean)
 996  */
 997 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *);
 998
 999 /**
1000  * Change the parent for the current the video output.
1001  *
1002  * \param p_instance libvlc instance
1003  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
1004  * \param p_e an initialized exception pointer
1005  * \return the success status (boolean)
1006  */
1007 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
1008
1009 /**
1010  * Tell windowless video output to redraw rectangular area (MacOS X only).
1011  *
1012  * \param p_instance libvlc instance
1013  * \param area coordinates within video drawable
1014  * \param p_e an initialized exception pointer
1015  */
1016 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
1017
1018 /**
1019  * Set the default video output's parent.
1020  *
1021  * This setting will be used as default for all video outputs.
1022  *
1023  * \param p_instance libvlc instance
1024  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
1025  * \param p_e an initialized exception pointer
1026  */
1027 VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
1028
1029 /**
1030  * Set the default video output parent.
1031  *
1032  * This setting will be used as default for all video outputs.
1033  *
1034  * \param p_instance libvlc instance
1035  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
1036  * \param p_e an initialized exception pointer
1037  */
1038 VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
1039
1040 /**
1041  * Set the default video output size.
1042  *
1043  * This setting will be used as default for all video outputs.
1044  *
1045  * \param p_instance libvlc instance
1046  * \param width new width for video drawable
1047  * \param height new height for video drawable
1048  * \param p_e an initialized exception pointer
1049  */
1050 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
1051
1052 /**
1053  * Set the default video output viewport for a windowless video output
1054  * (MacOS X only).
1055  *
1056  * This setting will be used as default for all video outputs.
1057  *
1058  * \param p_instance libvlc instance
1059  * \param view coordinates within video drawable
1060  * \param clip coordinates within video drawable
1061  * \param p_e an initialized exception pointer
1062  */
1063 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
1064
1065 /** @} */
1066
1067 /** defgroup libvlc_audio Audio
1068  * \ingroup libvlc
1069  * LibVLC Audio handling
1070  * @{
1071  */
1072
1073 /**
1074  * Toggle mute status.
1075  *
1076  * \param p_instance libvlc instance
1077  * \param p_e an initialized exception pointer
1078  */
1079 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
1080
1081 /**
1082  * Get current mute status.
1083  *
1084  * \param p_instance libvlc instance
1085  * \param p_e an initialized exception pointer
1086  * \return the mute status (boolean)
1087  */
1088 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
1089
1090 /**
1091  * Set mute status.
1092  *
1093  * \param p_instance libvlc instance
1094  * \param status If status is VLC_TRUE then mute, otherwise unmute
1095  * \param p_e an initialized exception pointer
1096  */
1097 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, int , libvlc_exception_t * );
1098
1099 /**
1100  * Get current audio level.
1101  *
1102  * \param p_instance libvlc instance
1103  * \param p_e an initialized exception pointer
1104  * \return the audio level (int)
1105  */
1106 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
1107
1108 /**
1109  * Set current audio level.
1110  *
1111  * \param p_instance libvlc instance
1112  * \param i_volume the volume (int)
1113  * \param p_e an initialized exception pointer
1114  */
1115 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
1116
1117 /**
1118  * Get number of available audio tracks.
1119  *
1120  * \param p_mi media instance
1121  * \param p_e an initialized exception
1122  * \return the number of available audio tracks (int)
1123  */
1124 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_instance_t *,  libvlc_exception_t * );
1125
1126 /**
1127  * Get current audio track.
1128  *
1129  * \param p_input input instance
1130  * \param p_e an initialized exception pointer
1131  * \return the audio track (int)
1132  */
1133 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_instance_t *, libvlc_exception_t * );
1134
1135 /**
1136  * Set current audio track.
1137  *
1138  * \param p_input input instance
1139  * \param i_track the track (int)
1140  * \param p_e an initialized exception pointer
1141  */
1142 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_instance_t *, int, libvlc_exception_t * );
1143
1144 /**
1145  * Get current audio channel.
1146  *
1147  * \param p_instance input instance
1148  * \param p_e an initialized exception pointer
1149  * \return the audio channel (int)
1150  */
1151 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
1152
1153 /**
1154  * Set current audio channel.
1155  *
1156  * \param p_instance input instance
1157  * \param i_channel the audio channel (int)
1158  * \param p_e an initialized exception pointer
1159  */
1160 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * );
1161
1162 /** @} */
1163
1164 /*****************************************************************************
1165  * Services/Media Discovery
1166  *****************************************************************************/
1167 /** defgroup libvlc_media_discoverer Media Discoverer
1168  * \ingroup libvlc
1169  * LibVLC Media Discoverer
1170  * @{
1171  */
1172
1173 VLC_PUBLIC_API libvlc_media_discoverer_t *
1174 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
1175                                        const char * psz_name,
1176                                        libvlc_exception_t * p_e );
1177 VLC_PUBLIC_API void   libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
1178 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
1179
1180 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
1181
1182 VLC_PUBLIC_API libvlc_event_manager_t *
1183         libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis );
1184
1185 VLC_PUBLIC_API int
1186         libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis );
1187
1188 /**@} */
1189
1190 /*****************************************************************************
1191  * VLM
1192  *****************************************************************************/
1193 /** defgroup libvlc_vlm VLM
1194  * \ingroup libvlc
1195  * LibVLC VLM
1196  * @{
1197  */
1198
1199 /**
1200  * Add a broadcast, with one input.
1201  *
1202  * \param p_instance the instance
1203  * \param psz_name the name of the new broadcast
1204  * \param psz_input the input MRL
1205  * \param psz_output the output MRL (the parameter to the "sout" variable)
1206  * \param i_options number of additional options
1207  * \param ppsz_options additional options
1208  * \param b_enabled boolean for enabling the new broadcast
1209  * \param b_loop Should this broadcast be played in loop ?
1210  * \param p_e an initialized exception pointer
1211  */
1212 VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
1213                                               int, char **, int, int, libvlc_exception_t * );
1214
1215 /**
1216  * Delete a media (VOD or broadcast).
1217  *
1218  * \param p_instance the instance
1219  * \param psz_name the media to delete
1220  * \param p_e an initialized exception pointer
1221  */
1222 VLC_PUBLIC_API void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1223
1224 /**
1225  * Enable or disable a media (VOD or broadcast).
1226  *
1227  * \param p_instance the instance
1228  * \param psz_name the media to work on
1229  * \param b_enabled the new status
1230  * \param p_e an initialized exception pointer
1231  */
1232 VLC_PUBLIC_API void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
1233                                             libvlc_exception_t *);
1234
1235 /**
1236  * Set the output for a media.
1237  *
1238  * \param p_instance the instance
1239  * \param psz_name the media to work on
1240  * \param psz_output the output MRL (the parameter to the "sout" variable)
1241  * \param p_e an initialized exception pointer
1242  */
1243 VLC_PUBLIC_API void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
1244                                            libvlc_exception_t *);
1245
1246 /**
1247  * Set a media's input MRL. This will delete all existing inputs and
1248  * add the specified one.
1249  *
1250  * \param p_instance the instance
1251  * \param psz_name the media to work on
1252  * \param psz_input the input MRL
1253  * \param p_e an initialized exception pointer
1254  */
1255 VLC_PUBLIC_API void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
1256                                           libvlc_exception_t *);
1257
1258 /**
1259  * Add a media's input MRL. This will add the specified one.
1260  *
1261  * \param p_instance the instance
1262  * \param psz_name the media to work on
1263  * \param psz_input the input MRL
1264  * \param p_e an initialized exception pointer
1265  */
1266 VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, char *, char *,
1267                                           libvlc_exception_t *p_exception );
1268 /**
1269  * Set a media's loop status.
1270  *
1271  * \param p_instance the instance
1272  * \param psz_name the media to work on
1273  * \param b_loop the new status
1274  * \param p_e an initialized exception pointer
1275  */
1276 VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
1277                                          libvlc_exception_t *);
1278
1279 /**
1280  * Edit the parameters of a media. This will delete all existing inputs and
1281  * add the specified one.
1282  *
1283  * \param p_instance the instance
1284  * \param psz_name the name of the new broadcast
1285  * \param psz_input the input MRL
1286  * \param psz_output the output MRL (the parameter to the "sout" variable)
1287  * \param i_options number of additional options
1288  * \param ppsz_options additional options
1289  * \param b_enabled boolean for enabling the new broadcast
1290  * \param b_loop Should this broadcast be played in loop ?
1291  * \param p_e an initialized exception pointer
1292  */
1293 VLC_PUBLIC_API void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
1294                                              int, char **, int, int, libvlc_exception_t * );
1295
1296 /**
1297  * Play the named broadcast.
1298  *
1299  * \param p_instance the instance
1300  * \param psz_name the name of the broadcast
1301  * \param p_e an initialized exception pointer
1302  */
1303 VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1304
1305 /**
1306  * Stop the named broadcast.
1307  *
1308  * \param p_instance the instance
1309  * \param psz_name the name of the broadcast
1310  * \param p_e an initialized exception pointer
1311  */
1312 VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1313
1314 /**
1315  * Pause the named broadcast.
1316  *
1317  * \param p_instance the instance
1318  * \param psz_name the name of the broadcast
1319  * \param p_e an initialized exception pointer
1320  */
1321 VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1322
1323 /**
1324  * Seek in the named broadcast.
1325  *
1326  * \param p_instance the instance
1327  * \param psz_name the name of the broadcast
1328  * \param f_percentage the percentage to seek to
1329  * \param p_e an initialized exception pointer
1330  */
1331 VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
1332                                            float, libvlc_exception_t * );
1333
1334 /**
1335  * Return information about the named broadcast.
1336  *
1337  * \param p_instance the instance
1338  * \param psz_name the name of the broadcast
1339  * \param p_e an initialized exception pointer
1340  */
1341 VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1342
1343 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
1344 returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \
1345                         char *, int , libvlc_exception_t * );
1346
1347 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1);
1348 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time, int, Integer, -1);
1349 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length, int, Integer, -1);
1350 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate, int, Integer, -1);
1351 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title, int, Integer, 0);
1352 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter, int, Integer, 0);
1353 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
1354
1355 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
1356
1357 /** @} */
1358
1359 /*****************************************************************************
1360  * Message log handling
1361  *****************************************************************************/
1362
1363 /** defgroup libvlc_log Log
1364  * \ingroup libvlc
1365  * LibVLC Message Logging
1366  * @{
1367  */
1368
1369 /**
1370  * Return the VLC messaging verbosity level.
1371  *
1372  * \param p_instance libvlc instance
1373  * \param exception an initialized exception pointer
1374  */
1375 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
1376                                                   libvlc_exception_t *p_e );
1377
1378 /**
1379  * Set the VLC messaging verbosity level.
1380  *
1381  * \param p_log libvlc log instance
1382  * \param exception an initialized exception pointer
1383  */
1384 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
1385                                               libvlc_exception_t *p_e );
1386
1387 /**
1388  * Open a VLC message log instance.
1389  *
1390  * \param p_instance libvlc instance
1391  * \param exception an initialized exception pointer
1392  */
1393 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
1394
1395 /**
1396  * Close a VLC message log instance.
1397  *
1398  * \param p_log libvlc log instance
1399  * \param exception an initialized exception pointer
1400  */
1401 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
1402
1403 /**
1404  * Returns the number of messages in a log instance.
1405  *
1406  * \param p_log libvlc log instance
1407  * \param exception an initialized exception pointer
1408  */
1409 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
1410
1411 /**
1412  * Clear a log instance.
1413  *
1414  * All messages in the log are removed. The log should be cleared on a
1415  * regular basis to avoid clogging.
1416  *
1417  * \param p_log libvlc log instance
1418  * \param exception an initialized exception pointer
1419  */
1420 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
1421
1422 /**
1423  * Allocate and returns a new iterator to messages in log.
1424  *
1425  * \param p_log libvlc log instance
1426  * \param exception an initialized exception pointer
1427  */
1428 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
1429
1430 /**
1431  * Release a previoulsy allocated iterator.
1432  *
1433  * \param p_log libvlc log iterator
1434  * \param exception an initialized exception pointer
1435  */
1436 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1437
1438 /**
1439  * Return whether log iterator has more messages.
1440  *
1441  * \param p_log libvlc log iterator
1442  * \param exception an initialized exception pointer
1443  */
1444 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1445
1446 /**
1447  * Return the next log message.
1448  *
1449  * The message contents must not be freed
1450  *
1451  * \param p_log libvlc log iterator
1452  * \param exception an initialized exception pointer
1453  */
1454 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
1455                                                                struct libvlc_log_message_t *buffer,
1456                                                                libvlc_exception_t *p_e );
1457
1458 /** @} */
1459
1460 /*****************************************************************************
1461  * Event handling
1462  *****************************************************************************/
1463
1464 /** defgroup libvlc_callbacks Callbacks
1465  * \ingroup libvlc
1466  * LibVLC Events
1467  * @{
1468  */
1469
1470 /**
1471  * Register for an event notification.
1472  *
1473  * \param p_event_manager the event manager to which you want to attach to.
1474  *        Generally it is obtained by vlc_my_object_event_manager() where
1475  *        my_object is the object you want to listen to.
1476  * \param i_event_type the desired event to which we want to listen
1477  * \param f_callback the function to call when i_event_type occurs
1478  * \param user_data user provided data to carry with the event
1479  * \param p_e an initialized exception pointer
1480  */
1481 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
1482                                          libvlc_event_type_t i_event_type,
1483                                          libvlc_callback_t f_callback,
1484                                          void *user_data,
1485                                          libvlc_exception_t *p_e );
1486
1487 /**
1488  * Unregister an event notification.
1489  *
1490  * \param p_event_manager the event manager
1491  * \param i_event_type the desired event to which we want to unregister
1492  * \param f_callback the function to call when i_event_type occurs
1493  * \param p_e an initialized exception pointer
1494  */
1495 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
1496                                          libvlc_event_type_t i_event_type,
1497                                          libvlc_callback_t f_callback,
1498                                          void *p_user_data,
1499                                          libvlc_exception_t *p_e );
1500
1501 /**
1502  * Get an event's type name.
1503  *
1504  * \param i_event_type the desired event
1505  */
1506 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
1507
1508 /** @} */
1509
1510
1511 # ifdef __cplusplus
1512 }
1513 # endif
1514
1515 #endif /* <vlc/libvlc.h> */