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