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 libvlc_exception_raised( libvlc_exception_t *p_exception );
  65
  66 /**
  67  * Raise an exception
  68  * \param p_exception the exception to raise
  69  * \param psz_message the exception message
  70  */
  71 VLC_PUBLIC_API void libvlc_exception_raise( libvlc_exception_t *p_exception, const char *psz_format, ... );
  72
  73 /**
  74  * Clear an exception object so it can be reused.
  75  * The exception object must be initialized
  76  * \param p_exception the exception to clear
  77  */
  78 VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
  79
  80 /**
  81  * Get exception message
  82  * \param p_exception the exception to query
  83  * \return the exception message or NULL if not applicable (exception not raised
  84  * for example)
  85  */
  86 VLC_PUBLIC_API char* libvlc_exception_get_message( libvlc_exception_t *p_exception );
  87
  88 /**@} */
  89
  90 /*****************************************************************************
  91  * Core handling
  92  *****************************************************************************/
  93
  94 /** defgroup libvlc_core Core
  95  * \ingroup libvlc
  96  * LibVLC Core
  97  * @{
  98  */
  99
 100 /**
 101  * Create an initialized libvlc instance
 102  * \param argc the number of arguments
 103  * \param argv command-line-type arguments
 104  * \param exception an initialized exception pointer
 105  */
 106 VLC_PUBLIC_API libvlc_instance_t * libvlc_new( int , char **, libvlc_exception_t *);
 107
 108 /**
 109  * Returns a libvlc instance identifier for legacy APIs. Use of this
 110  * function is discouraged, you should convert your program to use the
 111  * new API.
 112  * \param p_instance the instance
 113  */
 114 VLC_PUBLIC_API int libvlc_get_vlc_id( libvlc_instance_t *p_instance );
 115
 116 /**
 117  * Destroy a libvlc instance.
 118  * \param p_instance the instance to destroy
 119  */
 120 VLC_PUBLIC_API void libvlc_destroy( libvlc_instance_t *, libvlc_exception_t * );
 121
 122 /** @}*/
 123
 124
 125 /*****************************************************************************
 126  * Media descriptor
 127  *****************************************************************************/
 128 /** defgroup libvlc_media_descriptor Media Descriptor
 129  * \ingroup libvlc
 130  * LibVLC Media Descriptor
 131  * @{
 132  */
 133
 134 /**
 135  * Create a media descriptor with the given mrl.
 136  * \param p_instance the instance
 137  * \param psz_mrl the mrl to read
 138  */
 139 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_new(
 140                                    libvlc_instance_t *p_instance,
 141                                    const char * psz_mrl,
 142                                    libvlc_exception_t *p_e );
 143
 144 VLC_PUBLIC_API void libvlc_media_descriptor_retain(
 145                                    libvlc_media_descriptor_t *p_meta_desc );
 146
 147 VLC_PUBLIC_API void libvlc_media_descriptor_release(
 148                                    libvlc_media_descriptor_t *p_meta_desc );
 149
 150 VLC_PUBLIC_API char * libvlc_media_descriptor_get_mrl( libvlc_media_descriptor_t * p_md,
 151                                                        libvlc_exception_t * p_e );
 152
 153 /**
 154  * Read the meta of the media descriptor.
 155  * \param p_meta_desc the media descriptor to read
 156  * \param p_meta_desc the meta to read
 157  */
 158 VLC_PUBLIC_API char * libvlc_media_descriptor_get_meta(
 159                                    libvlc_media_descriptor_t *p_meta_desc,
 160                                    libvlc_meta_t e_meta,
 161                                    libvlc_exception_t *p_e );
 162
 163 /** @}*/
 164
 165 /*****************************************************************************
 166  * Playlist
 167  *****************************************************************************/
 168 /** defgroup libvlc_playlist Playlist
 169  * \ingroup libvlc
 170  * LibVLC Playlist handling
 171  * @{
 172  */
 173
 174 /**
 175  * Set loop variable
 176  */
 177 VLC_PUBLIC_API void libvlc_playlist_loop( libvlc_instance_t* , vlc_bool_t,
 178                                           libvlc_exception_t * );
 179
 180 /**
 181  * Start playing. You can give some additionnal playlist item options
 182  * that will be added to the item before playing it.
 183  * \param p_instance the instance
 184  * \param i_id the item to play. If this is a negative number, the next
 185  * item will be selected. Else, the item with the given ID will be played
 186  * \param i_options the number of options to add to the item
 187  * \param ppsz_options the options to add to the item
 188  * \param p_exception an initialized exception
 189  */
 190 VLC_PUBLIC_API void libvlc_playlist_play( libvlc_instance_t*, int, int, char **,
 191                                           libvlc_exception_t * );
 192
 193 /**
 194  * Pause a running playlist, resume if it was stopped
 195  * \param p_instance the instance to pause
 196  * \param p_exception an initialized exception
 197  */
 198 VLC_PUBLIC_API void libvlc_playlist_pause( libvlc_instance_t *, libvlc_exception_t * );
 199
 200 /**
 201  * Checks if the playlist is running
 202  * \param p_instance the instance
 203  * \param p_exception an initialized exception
 204  * \return 0 if the playlist is stopped or paused, 1 if it is running
 205  */
 206 VLC_PUBLIC_API int libvlc_playlist_isplaying( libvlc_instance_t *, libvlc_exception_t * );
 207
 208 /**
 209  * Get the number of items in the playlist
 210  * \param p_instance the instance
 211  * \param p_exception an initialized exception
 212  * \return the number of items
 213  */
 214 VLC_PUBLIC_API int libvlc_playlist_items_count( libvlc_instance_t *, libvlc_exception_t * );
 215
 216 /**
 217  * Lock the playlist instance
 218  * \param p_instance the instance
 219  */
 220 VLC_PUBLIC_API void libvlc_playlist_lock( libvlc_instance_t * );
 221
 222 /**
 223  * Unlock the playlist instance
 224  * \param p_instance the instance
 225  */
 226 VLC_PUBLIC_API void libvlc_playlist_unlock( libvlc_instance_t * );
 227
 228 /**
 229  * Stop playing
 230  * \param p_instance the instance to stop
 231  * \param p_exception an initialized exception
 232  */
 233 VLC_PUBLIC_API void libvlc_playlist_stop( libvlc_instance_t *, libvlc_exception_t * );
 234
 235 /**
 236  * Go to next playlist item (starts playback if it was stopped)
 237  * \param p_instance the instance to use
 238  * \param p_exception an initialized exception
 239  */
 240 VLC_PUBLIC_API void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * );
 241
 242 /**
 243  * Go to previous playlist item (starts playback if it was stopped)
 244  * \param p_instance the instance to use
 245  * \param p_exception an initialized exception
 246  */
 247 VLC_PUBLIC_API void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * );
 248
 249 /**
 250  * Remove all playlist items
 251  * \param p_instance the instance
 252  * \param p_exception an initialized exception
 253  */
 254 VLC_PUBLIC_API void libvlc_playlist_clear( libvlc_instance_t *, libvlc_exception_t * );
 255
 256 /**
 257  * Add an item at the end of the playlist
 258  * If you need more advanced options, \see libvlc_playlist_add_extended
 259  * \param p_instance the instance
 260  * \param psz_uri the URI to open, using VLC format
 261  * \param psz_name a name that you might want to give or NULL
 262  * \return the identifier of the new item
 263  */
 264 VLC_PUBLIC_API int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *,
 265                                         libvlc_exception_t * );
 266
 267 /**
 268  * Add an item at the end of the playlist, with additional input options
 269  * \param p_instance the instance
 270  * \param psz_uri the URI to open, using VLC format
 271  * \param psz_name a name that you might want to give or NULL
 272  * \param i_options the number of options to add
 273  * \param ppsz_options strings representing the options to add
 274  * \param p_exception an initialized exception
 275  * \return the identifier of the new item
 276  */
 277 VLC_PUBLIC_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
 278                                                  const char *, int, const char **,
 279                                                  libvlc_exception_t * );
 280
 281 /**
 282  * Delete the playlist item with the given ID.
 283  * \param p_instance the instance
 284  * \param i_id the id to remove
 285  * \param p_exception an initialized exception
 286  * \return
 287  */
 288 VLC_PUBLIC_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
 289                                                 libvlc_exception_t * );
 290
 291 /* Get the input that is currently being played by the playlist
 292  * \param p_instance the instance to use
 293  * \param p_exception an initialized excecption
 294  * \return an input object
 295  */
 296 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_playlist_get_media_instance(
 297                                 libvlc_instance_t *, libvlc_exception_t * );
 298
 299 /** @}*/
 300
 301 /*****************************************************************************
 302  * Media Instance
 303  *****************************************************************************/
 304 /** defgroup libvlc_media_instance Media Instance
 305  * \ingroup libvlc
 306  * LibVLC Media Instance
 307  * @{
 308  */
 309
 310 /** Create an empty Media Instance object
 311  * \param p_libvlc_instance the libvlc instance in which the Media Instance
 312  * should be (not used for now).
 313  */
 314 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new( libvlc_instance_t *, libvlc_exception_t * );
 315
 316 /** Create a Media Instance object from a Media Descriptor
 317  * \param p_md the media descriptor. Afterwards the p_md can safely be
 318  * destroyed.
 319  */
 320 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new_from_media_descriptor( libvlc_media_descriptor_t *, libvlc_exception_t * );
 321
 322 /** Release a media_instance after use
 323  * \param p_mi the Media Instance to free
 324  */
 325 VLC_PUBLIC_API void libvlc_media_instance_release( libvlc_media_instance_t * );
 326 VLC_PUBLIC_API void libvlc_media_instance_retain( libvlc_media_instance_t * );
 327
 328 /** Set the media descriptor that will be used by the media_instance. If any,
 329  * previous md will be released.
 330  * \param p_mi the Media Instance
 331  * \param p_md the Media Descriptor. Afterwards the p_md can safely be
 332  * destroyed.
 333  */
 334 VLC_PUBLIC_API void libvlc_media_instance_set_media_descriptor( libvlc_media_instance_t *, libvlc_media_descriptor_t *, libvlc_exception_t * );
 335
 336 /** Get the media descriptor used by the media_instance (if any). A copy of
 337  * the md is returned. NULL is returned if no media instance is associated.
 338  * \param p_mi the Media Instance
 339  */
 340 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_instance_get_media_descriptor( libvlc_media_instance_t *, libvlc_exception_t * );
 341
 342 /** Get the Event Manager from which the media instance send event.
 343  * \param p_mi the Media Instance
 344  */
 345 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_instance_event_manager ( libvlc_media_instance_t *, libvlc_exception_t * );
 346
 347 VLC_PUBLIC_API void libvlc_media_instance_play ( libvlc_media_instance_t *, libvlc_exception_t * );
 348 VLC_PUBLIC_API void libvlc_media_instance_pause ( libvlc_media_instance_t *, libvlc_exception_t * );
 349 VLC_PUBLIC_API void libvlc_media_instance_stop ( libvlc_media_instance_t *, libvlc_exception_t * );
 350
 351 VLC_PUBLIC_API void libvlc_media_instance_set_drawable ( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
 352
 353 /// \bug This might go away ... to be replaced by a broader system
 354 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_length     ( libvlc_media_instance_t *, libvlc_exception_t *);
 355 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_time       ( libvlc_media_instance_t *, libvlc_exception_t *);
 356 VLC_PUBLIC_API void        libvlc_media_instance_set_time       ( libvlc_media_instance_t *, vlc_int64_t, libvlc_exception_t *);
 357 VLC_PUBLIC_API float       libvlc_media_instance_get_position   ( libvlc_media_instance_t *, libvlc_exception_t *);
 358 VLC_PUBLIC_API void        libvlc_media_instance_set_position   ( libvlc_media_instance_t *, float, libvlc_exception_t *);
 359 VLC_PUBLIC_API vlc_bool_t  libvlc_media_instance_will_play      ( libvlc_media_instance_t *, libvlc_exception_t *);
 360 VLC_PUBLIC_API float       libvlc_media_instance_get_rate       ( libvlc_media_instance_t *, libvlc_exception_t *);
 361 VLC_PUBLIC_API void        libvlc_media_instance_set_rate       ( libvlc_media_instance_t *, float, libvlc_exception_t *);
 362 VLC_PUBLIC_API int         libvlc_media_instance_get_state      ( libvlc_media_instance_t *, libvlc_exception_t *);
 363
 364 /**
 365  * Does this input have a video output ?
 366  * \param p_input the input
 367  * \param p_exception an initialized exception
 368  */
 369 VLC_PUBLIC_API vlc_bool_t  libvlc_media_instance_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
 370 VLC_PUBLIC_API float       libvlc_media_instance_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
 371
 372
 373 /** @} */
 374
 375 /*****************************************************************************
 376  * Tag Query
 377  *****************************************************************************/
 378 /** defgroup libvlc_tag_query Tag Query
 379  * \ingroup libvlc
 380  * LibVLC Tag query
 381  * @{
 382  */
 383 VLC_PUBLIC_API libvlc_tag_query_t *
 384     libvlc_tag_query_new( libvlc_instance_t *, libvlc_exception_t * );
 385
 386 VLC_PUBLIC_API void
 387     libvlc_tag_query_release( libvlc_tag_query_t * );
 388
 389 VLC_PUBLIC_API void
 390     libvlc_tag_query_retain( libvlc_tag_query_t * );
 391
 392 VLC_PUBLIC_API vlc_bool_t
 393     libvlc_tag_query_match( libvlc_tag_query_t *, libvlc_media_descriptor_t *,
 394                             libvlc_exception_t * );
 395
 396 /** @} */
 397
 398 /*****************************************************************************
 399  * Media List
 400  *****************************************************************************/
 401 /** defgroup libvlc_media_list MediaList
 402  * \ingroup libvlc
 403  * LibVLC Media List
 404  * @{
 405  */
 406 VLC_PUBLIC_API libvlc_media_list_t *
 407     libvlc_media_list_new( libvlc_instance_t *, libvlc_exception_t * );
 408
 409 VLC_PUBLIC_API void
 410     libvlc_media_list_release( libvlc_media_list_t * );
 411
 412 VLC_PUBLIC_API void
 413     libvlc_media_list_retain( libvlc_media_list_t * );
 414
 415 VLC_PUBLIC_API void
 416     libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
 417                                         const char * psz_uri,
 418                                         libvlc_exception_t * p_e );
 419
 420 VLC_PUBLIC_API void
 421     libvlc_media_list_set_name( libvlc_media_list_t *,
 422                                 const char * psz_name,
 423                                 libvlc_exception_t *);
 424
 425 VLC_PUBLIC_API char *
 426     libvlc_media_list_name( libvlc_media_list_t *,
 427                             libvlc_exception_t *);
 428
 429 VLC_PUBLIC_API void
 430     libvlc_media_list_add_media_descriptor( libvlc_media_list_t *,
 431                                             libvlc_media_descriptor_t *,
 432                                             libvlc_exception_t * );
 433 VLC_PUBLIC_API void
 434     libvlc_media_list_insert_media_descriptor( libvlc_media_list_t *,
 435                                                libvlc_media_descriptor_t *,
 436                                                int,
 437                                                libvlc_exception_t * );
 438 VLC_PUBLIC_API void
 439     libvlc_media_list_remove_index( libvlc_media_list_t *, int,
 440                                     libvlc_exception_t * );
 441
 442 VLC_PUBLIC_API int
 443     libvlc_media_list_count( libvlc_media_list_t * p_mlist,
 444                              libvlc_exception_t * p_e );
 445
 446 VLC_PUBLIC_API libvlc_media_descriptor_t *
 447     libvlc_media_list_item_at_index( libvlc_media_list_t *, int,
 448                                      libvlc_exception_t * );
 449 VLC_PUBLIC_API int
 450     libvlc_media_list_index_of_item( libvlc_media_list_t *,
 451                                      libvlc_media_descriptor_t *,
 452                                      libvlc_exception_t * );
 453
 454 VLC_PUBLIC_API void
 455     libvlc_media_list_lock( libvlc_media_list_t * );
 456 VLC_PUBLIC_API void
 457     libvlc_media_list_unlock( libvlc_media_list_t * );
 458
 459 VLC_PUBLIC_API libvlc_event_manager_t *
 460     libvlc_media_list_event_manager( libvlc_media_list_t *,
 461                                     libvlc_exception_t * );
 462
 463 VLC_PUBLIC_API libvlc_media_list_t *
 464     libvlc_media_list_dynamic_sublist( libvlc_media_list_t *,
 465                                        libvlc_tag_query_t *,
 466                                        libvlc_exception_t * );
 467
 468 /** @} */
 469
 470 /*****************************************************************************
 471  * Media List
 472  *****************************************************************************/
 473 /** defgroup libvlc_media_library Media Library
 474  * \ingroup libvlc
 475  * LibVLC Media Library
 476  * @{
 477  */
 478 VLC_PUBLIC_API libvlc_media_library_t *
 479     libvlc_media_library_new( libvlc_instance_t * p_inst,
 480                               libvlc_exception_t * p_e );
 481 VLC_PUBLIC_API void
 482     libvlc_media_library_release( libvlc_media_library_t * p_mlib );
 483 VLC_PUBLIC_API void
 484     libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
 485
 486
 487 VLC_PUBLIC_API void
 488     libvlc_media_library_load( libvlc_media_library_t * p_mlib,
 489                                libvlc_exception_t * p_e );
 490
 491 VLC_PUBLIC_API void
 492     libvlc_media_library_save( libvlc_media_library_t * p_mlib,
 493                                libvlc_exception_t * p_e );
 494
 495 VLC_PUBLIC_API libvlc_media_list_t *
 496     libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
 497                                      libvlc_exception_t * p_e );
 498
 499
 500 /** @} */
 501
 502 /*****************************************************************************
 503  * Media List Player
 504  *****************************************************************************/
 505 /** defgroup libvlc_media_list_player MediaListPlayer
 506  * \ingroup libvlc
 507  * LibVLC Media List Player
 508  * @{
 509  */
 510 VLC_PUBLIC_API libvlc_media_list_player_t *
 511     libvlc_media_list_player_new( libvlc_instance_t * p_instance,
 512                                   libvlc_exception_t * p_e );
 513 VLC_PUBLIC_API void
 514     libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
 515
 516 VLC_PUBLIC_API void
 517     libvlc_media_list_player_set_media_instance(
 518                                      libvlc_media_list_player_t * p_mlp,
 519                                      libvlc_media_instance_t * p_mi,
 520                                      libvlc_exception_t * p_e );
 521
 522 VLC_PUBLIC_API void
 523     libvlc_media_list_player_set_media_list(
 524                                      libvlc_media_list_player_t * p_mlp,
 525                                      libvlc_media_list_t * p_mlist,
 526                                      libvlc_exception_t * p_e );
 527
 528 VLC_PUBLIC_API void
 529     libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
 530                                    libvlc_exception_t * p_e );
 531
 532 VLC_PUBLIC_API void
 533     libvlc_media_list_player_play_item_at_index(
 534                                    libvlc_media_list_player_t * p_mlp,
 535                                    int i_index,
 536                                    libvlc_exception_t * p_e );
 537
 538 VLC_PUBLIC_API void
 539     libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
 540                                    libvlc_exception_t * p_e );
 541 VLC_PUBLIC_API void
 542     libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
 543                                    libvlc_exception_t * p_e );
 544
 545 /** @} */
 546
 547 /** defgroup libvlc_video Video
 548  * \ingroup libvlc
 549  * LibVLC Video handling
 550  * @{
 551  */
 552
 553 /**
 554  * Does this input have a video output ?
 555  * \param p_input the input
 556  * \param p_exception an initialized exception
 557  */
 558 VLC_PUBLIC_API vlc_bool_t  libvlc_input_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
 559 VLC_PUBLIC_API float       libvlc_input_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
 560
 561 /**
 562  * Toggle fullscreen status on video output
 563  * \param p_input the input
 564  * \param p_exception an initialized exception
 565  */
 566 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
 567
 568 /**
 569  * Enable or disable fullscreen on a video output
 570  * \param p_input the input
 571  * \param b_fullscreen boolean for fullscreen status
 572  * \param p_exception an initialized exception
 573  */
 574 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_instance_t *, int, libvlc_exception_t * );
 575
 576 /**
 577  * Get current fullscreen status
 578  * \param p_input the input
 579  * \param p_exception an initialized exception
 580  * \return the fullscreen status (boolean)
 581  */
 582 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
 583
 584 /**
 585  * Get current video height
 586  * \param p_input the input
 587  * \param p_exception an initialized exception
 588  * \return the video height
 589  */
 590 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_instance_t *, libvlc_exception_t * );
 591
 592 /**
 593  * Get current video width
 594  * \param p_input the input
 595  * \param p_exception an initialized exception
 596  * \return the video width
 597  */
 598 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_instance_t *, libvlc_exception_t * );
 599
 600 /**
 601  * Get current video aspect ratio
 602  * \param p_input the input
 603  * \param p_exception an initialized exception
 604  * \return the video aspect ratio
 605  */
 606 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_instance_t *, libvlc_exception_t * );
 607
 608 /**
 609  * Set new video aspect ratio
 610  * \param p_input the input
 611  * \param psz_aspect new video aspect-ratio
 612  * \param p_exception an initialized exception
 613  */
 614 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_instance_t *, char *, libvlc_exception_t * );
 615
 616 /**
 617  * Get current video subtitle
 618  * \param p_input the input
 619  * \param p_exception an initialized exception
 620  * \return the video subtitle selected
 621  */
 622 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_instance_t *, libvlc_exception_t * );
 623
 624 /**
 625  * Set new video subtitle
 626  * \param p_input the input
 627  * \param i_spu new video subtitle to select
 628  * \param p_exception an initialized exception
 629  */
 630 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_instance_t *, int , libvlc_exception_t * );
 631
 632 /**
 633  * Get current crop filter geometry
 634  * \param p_input the input
 635  * \param p_exception an initialized exception
 636  * \return the crop filter geometry
 637  */
 638 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_instance_t *, libvlc_exception_t * );
 639
 640 /**
 641  * Set new crop filter geometry
 642  * \param p_input the input
 643  * \param psz_geometry new crop filter geometry
 644  * \param p_exception an initialized exception
 645  */
 646 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_instance_t *, char *, libvlc_exception_t * );
 647
 648 /**
 649  * Get current teletext page requested.
 650  * \param p_input the input
 651  * \param p_exception an initialized exception
 652  * \return the current teletext page requested.
 653  */
 654 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
 655
 656 /**
 657  * Set new teletext page to retrieve
 658  * \param p_input the input
 659  * \param i_page teletex page number requested
 660  * \param p_exception an initialized exception
 661  */
 662 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_instance_t *, int, libvlc_exception_t * );
 663
 664 /**
 665  * Take a snapshot of the current video window
 666  * \param p_input the input
 667  * \param psz_filepath the path where to save the screenshot to
 668  * \param p_exception an initialized exception
 669  */
 670 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_instance_t *, char *, libvlc_exception_t * );
 671
 672 VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *);
 673
 674 /**
 675  * Resize the current video output window
 676  * \param p_instance libvlc instance
 677  * \param width new width for video output window
 678  * \param height new height for video output window
 679  * \param p_exception an initialized exception
 680  * \return the success status (boolean)
 681  */
 682 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *);
 683
 684 /**
 685  * change the parent for the current the video output
 686  * \param p_instance libvlc instance
 687  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
 688  * \param p_exception an initialized exception
 689  * \return the success status (boolean)
 690  */
 691 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
 692
 693 /**
 694  * Tell windowless video output to redraw rectangular area (MacOS X only)
 695  * \param p_instance libvlc instance
 696  * \param area coordinates within video drawable
 697  * \param p_exception an initialized exception
 698  */
 699 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
 700
 701 /**
 702  * Set the default video output parent
 703  *  this settings will be used as default for all video outputs
 704  * \param p_instance libvlc instance
 705  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
 706  * \param p_exception an initialized exception
 707  */
 708 VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
 709
 710 /**
 711  * Set the default video output parent
 712  *  this settings will be used as default for all video outputs
 713  * \param p_instance libvlc instance
 714  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
 715  * \param p_exception an initialized exception
 716  */
 717 VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
 718
 719 /**
 720  * Set the default video output size
 721  *  this settings will be used as default for all video outputs
 722  * \param p_instance libvlc instance
 723  * \param width new width for video drawable
 724  * \param height new height for video drawable
 725  * \param p_exception an initialized exception
 726  */
 727 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
 728
 729 /**
 730  * Set the default video output viewport for a windowless video output (MacOS X only)
 731  *  this settings will be used as default for all video outputs
 732  * \param p_instance libvlc instance
 733  * \param view coordinates within video drawable
 734  * \param clip coordinates within video drawable
 735  * \param p_exception an initialized exception
 736  */
 737 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
 738
 739 /** @} */
 740
 741 /** defgroup libvlc_audio Audio
 742  * \ingroup libvlc
 743  * LibVLC Audio handling
 744  * @{
 745  */
 746
 747 /**
 748  * Toggle mute status
 749  * \param p_instance libvlc instance
 750  * \param p_exception an initialized exception
 751  * \return void
 752  */
 753 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
 754
 755 /**
 756  * Get current mute status
 757  * \param p_instance libvlc instance
 758  * \param p_exception an initialized exception
 759  * \return the mute status (boolean)
 760  */
 761 VLC_PUBLIC_API vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
 762
 763 /**
 764  * Set mute status
 765  * \param p_instance libvlc instance
 766  * \param status If status is VLC_TRUE then mute, otherwise unmute
 767  * \param p_exception an initialized exception
 768  * \return void
 769  */
 770 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * );
 771
 772 /**
 773  * Get current audio level
 774  * \param p_instance libvlc instance
 775  * \param p_exception an initialized exception
 776  * \return the audio level (int)
 777  */
 778 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
 779
 780 /**
 781  * Set current audio level
 782  * \param p_instance libvlc instance
 783  * \param i_volume the volume (int)
 784  * \param p_exception an initialized exception
 785  */
 786 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
 787
 788 /**
 789 +  * Get current audio track
 790 +  * \param p_input input instance
 791 +  * \param p_exception an initialized exception
 792 +  * \return the audio track (int)
 793 +  */
 794 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_instance_t *, libvlc_exception_t * );
 795
 796 /**
 797  * Set current audio track
 798  * \param p_input input instance
 799  * \param i_track the track (int)
 800  * \param p_exception an initialized exception
 801  */
 802 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_instance_t *, int, libvlc_exception_t * );
 803
 804 /**
 805  * Get current audio channel
 806  * \param p_instance input instance
 807  * \param p_exception an initialized exception
 808  * \return the audio channel (int)
 809  */
 810 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
 811
 812 /**
 813  * Set current audio channel
 814  * \param p_instance input instance
 815  * \param i_channel the audio channel (int)
 816  * \param p_exception an initialized exception
 817  */
 818 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * );
 819
 820 /** @} */
 821
 822 /*****************************************************************************
 823  * Services/Media Discovery
 824  *****************************************************************************/
 825 /** defgroup libvlc_media_discoverer Media Discoverer
 826  * \ingroup libvlc
 827  * LibVLC Media Discoverer
 828  * @{
 829  */
 830
 831 VLC_PUBLIC_API libvlc_media_discoverer_t *
 832 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
 833                                        const char * psz_name,
 834                                        libvlc_exception_t * p_e );
 835 VLC_PUBLIC_API void   libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
 836 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
 837
 838 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( );
 839
 840 /**@} */
 841
 842 /*****************************************************************************
 843  * VLM
 844  *****************************************************************************/
 845 /** defgroup libvlc_vlm VLM
 846  * \ingroup libvlc
 847  * LibVLC VLM
 848  * @{
 849  */
 850
 851 /**
 852  * Add a broadcast, with one input
 853  * \param p_instance the instance
 854  * \param psz_name the name of the new broadcast
 855  * \param psz_input the input MRL
 856  * \param psz_output the output MRL (the parameter to the "sout" variable)
 857  * \param i_options number of additional options
 858  * \param ppsz_options additional options
 859  * \param b_enabled boolean for enabling the new broadcast
 860  * \param b_loop Should this broadcast be played in loop ?
 861  * \param p_exception an initialized exception
 862  */
 863 VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
 864                                               int, char **, int, int, libvlc_exception_t * );
 865
 866 /**
 867  * Delete a media (vod or broadcast)
 868  * \param p_instance the instance
 869  * \param psz_name the media to delete
 870  * \param p_exception an initialized exception
 871  */
 872 VLC_PUBLIC_API void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
 873
 874 /**
 875  * Enable or disable a media (vod or broadcast)
 876  * \param p_instance the instance
 877  * \param psz_name the media to work on
 878  * \param b_enabled the new status
 879  * \param p_exception an initialized exception
 880  */
 881 VLC_PUBLIC_API void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
 882                                             libvlc_exception_t *);
 883
 884 /**
 885  * Set the output for a media
 886  * \param p_instance the instance
 887  * \param psz_name the media to work on
 888  * \param psz_output the output MRL (the parameter to the "sout" variable)
 889  * \param p_exception an initialized exception
 890  */
 891 VLC_PUBLIC_API void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
 892                                            libvlc_exception_t *);
 893
 894 /**
 895  * Set a media's input MRL. This will delete all existing inputs and
 896  * add the specified one.
 897  * \param p_instance the instance
 898  * \param psz_name the media to work on
 899  * \param psz_input the input MRL
 900  * \param p_exception an initialized exception
 901  */
 902 VLC_PUBLIC_API void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
 903                                           libvlc_exception_t *);
 904
 905 /**
 906  * Add a media's input MRL. This will add the specified one.
 907  * \param p_instance the instance
 908  * \param psz_name the media to work on
 909  * \param psz_input the input MRL
 910  * \param p_exception an initialized exception
 911  */
 912 VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, char *, char *,
 913                                           libvlc_exception_t *p_exception );
 914 /**
 915  * Set output for a media
 916  * \param p_instance the instance
 917  * \param psz_name the media to work on
 918  * \param b_loop the new status
 919  * \param p_exception an initialized exception
 920  */
 921 VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
 922                                          libvlc_exception_t *);
 923
 924 /**
 925  * Edit the parameters of a media. This will delete all existing inputs and
 926  * add the specified one.
 927  * \param p_instance the instance
 928  * \param psz_name the name of the new broadcast
 929  * \param psz_input the input MRL
 930  * \param psz_output the output MRL (the parameter to the "sout" variable)
 931  * \param i_options number of additional options
 932  * \param ppsz_options additional options
 933  * \param b_enabled boolean for enabling the new broadcast
 934  * \param b_loop Should this broadcast be played in loop ?
 935  * \param p_exception an initialized exception
 936  */
 937 VLC_PUBLIC_API void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
 938                                              int, char **, int, int, libvlc_exception_t * );
 939
 940 /**
 941  * Plays the named broadcast.
 942  * \param p_instance the instance
 943  * \param psz_name the name of the broadcast
 944  * \param p_exception an initialized exception
 945  */
 946 VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
 947
 948 /**
 949  * Stops the named broadcast.
 950  * \param p_instance the instance
 951  * \param psz_name the name of the broadcast
 952  * \param p_exception an initialized exception
 953  */
 954 VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
 955
 956 /**
 957  * Pauses the named broadcast.
 958  * \param p_instance the instance
 959  * \param psz_name the name of the broadcast
 960  * \param p_exception an initialized exception
 961  */
 962 VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
 963
 964 /**
 965  * Seeks in the named broadcast.
 966  * \param p_instance the instance
 967  * \param psz_name the name of the broadcast
 968  * \param f_percentage the percentage to seek to
 969  * \param p_exception an initialized exception
 970  */
 971 VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
 972                                            float, libvlc_exception_t * );
 973
 974 /**
 975  * Return information of the named broadcast.
 976  * \param p_instance the instance
 977  * \param psz_name the name of the broadcast
 978  * \param p_exception an initialized exception
 979  */
 980 VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
 981
 982 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
 983 returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \
 984                         char *, int , libvlc_exception_t * );
 985
 986 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1);
 987 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time, int, Integer, -1);
 988 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length, int, Integer, -1);
 989 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate, int, Integer, -1);
 990 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title, int, Integer, 0);
 991 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter, int, Integer, 0);
 992 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
 993
 994 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
 995
 996 /** @} */
 997
 998 /*****************************************************************************
 999  * Message log handling
1000  *****************************************************************************/
1001
1002 /** defgroup libvlc_log Log
1003  * \ingroup libvlc
1004  * LibVLC Message Logging
1005  * @{
1006  */
1007
1008 /**
1009  * Returns the VLC messaging verbosity level
1010  * \param p_instance libvlc instance
1011  * \param exception an initialized exception pointer
1012  */
1013 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
1014                                                   libvlc_exception_t *p_e );
1015
1016 /**
1017  * Set the VLC messaging verbosity level
1018  * \param p_log libvlc log instance
1019  * \param exception an initialized exception pointer
1020  */
1021 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
1022                                               libvlc_exception_t *p_e );
1023
1024 /**
1025  * Open an instance to VLC message log
1026  * \param p_instance libvlc instance
1027  * \param exception an initialized exception pointer
1028  */
1029 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( const libvlc_instance_t *, libvlc_exception_t *);
1030
1031 /**
1032  * Close an instance of VLC message log
1033  * \param p_log libvlc log instance
1034  * \param exception an initialized exception pointer
1035  */
1036 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
1037
1038 /**
1039  * Returns the number of messages in log
1040  * \param p_log libvlc log instance
1041  * \param exception an initialized exception pointer
1042  */
1043 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
1044
1045 /**
1046  * Clear all messages in log
1047  *  the log should be cleared on a regular basis to avoid clogging
1048  * \param p_log libvlc log instance
1049  * \param exception an initialized exception pointer
1050  */
1051 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
1052
1053 /**
1054  * Allocate and returns a new iterator to messages in log
1055  * \param p_log libvlc log instance
1056  * \param exception an initialized exception pointer
1057  */
1058 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
1059
1060 /**
1061  * Releases a previoulsy allocated iterator
1062  * \param p_log libvlc log iterator
1063  * \param exception an initialized exception pointer
1064  */
1065 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1066
1067 /**
1068  * Returns whether log iterator has more messages
1069  * \param p_log libvlc log iterator
1070  * \param exception an initialized exception pointer
1071  */
1072 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1073
1074 /**
1075  * Returns next log message
1076  *   the content of message must not be freed
1077  * \param p_log libvlc log iterator
1078  * \param exception an initialized exception pointer
1079  */
1080 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
1081                                                                struct libvlc_log_message_t *buffer,
1082                                                                libvlc_exception_t *p_e );
1083
1084 /** @} */
1085
1086 /*****************************************************************************
1087  * Event handling
1088  *****************************************************************************/
1089
1090 /** defgroup libvlc_callbacks Callbacks
1091  * \ingroup libvlc
1092  * LibVLC Events
1093  * @{
1094  */
1095
1096 /**
1097  * Register for an event notification
1098  * \param p_event_manager the event manager to which you want to attach to
1099  * Generally it is obtained by vlc_my_object_event_manager() where my_object
1100  * Is the object you want to listen to.
1101  * \param i_event_type the desired event to which we want to listen
1102  * \param f_callback the function to call when i_event_type occurs
1103  * \param user_data user provided data to carry with the event
1104  * \param p_e an initialized exception pointer
1105  */
1106 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
1107                                          libvlc_event_type_t i_event_type,
1108                                          libvlc_callback_t f_callback,
1109                                          void *user_data,
1110                                          libvlc_exception_t *p_e );
1111
1112 /**
1113  * Unregister an event notification
1114  * \param p_event_manager the event manager
1115  * \param i_event_type the desired event to which we want to unregister
1116  * \param f_callback the function to call when i_event_type occurs
1117  * \param p_e an initialized exception pointer
1118  */
1119 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
1120                                          libvlc_event_type_t i_event_type,
1121                                          libvlc_callback_t f_callback,
1122                                          void *p_user_data,
1123                                          libvlc_exception_t *p_e );
1124
1125
1126 /**
1127  * Get an event type name
1128  * \param i_event_type the desired event
1129  */
1130 #define libvlc_event_type_name(a) #a
1131
1132 /** @} */
1133
1134
1135 # ifdef __cplusplus
1136 }
1137 # endif
1138
1139 #endif /* <vlc/libvlc.h> */