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

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