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 /**
 145  * Destroy a media descriptor object.
 146  * \param p_meta_desc the md to destroy
 147  */
 148 VLC_PUBLIC_API void libvlc_media_descriptor_destroy(
 149                                    libvlc_media_descriptor_t *p_meta_desc );
 150
 151 /**
 152  * Read the meta of the media descriptor.
 153  * \param p_meta_desc the media descriptor to read
 154  * \param p_meta_desc the meta to read
 155  */
 156 VLC_PUBLIC_API char * libvlc_media_descriptor_get_meta(
 157                                    libvlc_media_descriptor_t *p_meta_desc,
 158                                    libvlc_meta_t e_meta,
 159                                    libvlc_exception_t *p_e );
 160
 161 /** @}*/
 162
 163 /*****************************************************************************
 164  * Playlist
 165  *****************************************************************************/
 166 /** defgroup libvlc_playlist Playlist
 167  * \ingroup libvlc
 168  * LibVLC Playlist handling
 169  * @{
 170  */
 171
 172 /**
 173  * Set loop variable
 174  */
 175 VLC_PUBLIC_API void libvlc_playlist_loop( libvlc_instance_t* , vlc_bool_t,
 176                                           libvlc_exception_t * );
 177
 178 /**
 179  * Start playing. You can give some additionnal playlist item options
 180  * that will be added to the item before playing it.
 181  * \param p_instance the instance
 182  * \param i_id the item to play. If this is a negative number, the next
 183  * item will be selected. Else, the item with the given ID will be played
 184  * \param i_options the number of options to add to the item
 185  * \param ppsz_options the options to add to the item
 186  * \param p_exception an initialized exception
 187  */
 188 VLC_PUBLIC_API void libvlc_playlist_play( libvlc_instance_t*, int, int, char **,
 189                                           libvlc_exception_t * );
 190
 191 /**
 192  * Pause a running playlist, resume if it was stopped
 193  * \param p_instance the instance to pause
 194  * \param p_exception an initialized exception
 195  */
 196 VLC_PUBLIC_API void libvlc_playlist_pause( libvlc_instance_t *, libvlc_exception_t * );
 197
 198 /**
 199  * Checks if the playlist is running
 200  * \param p_instance the instance
 201  * \param p_exception an initialized exception
 202  * \return 0 if the playlist is stopped or paused, 1 if it is running
 203  */
 204 VLC_PUBLIC_API int libvlc_playlist_isplaying( libvlc_instance_t *, libvlc_exception_t * );
 205
 206 /**
 207  * Get the number of items in the playlist
 208  * \param p_instance the instance
 209  * \param p_exception an initialized exception
 210  * \return the number of items
 211  */
 212 VLC_PUBLIC_API int libvlc_playlist_items_count( libvlc_instance_t *, libvlc_exception_t * );
 213
 214 /**
 215  * Lock the playlist instance
 216  * \param p_instance the instance
 217  */
 218 VLC_PUBLIC_API void libvlc_playlist_lock( libvlc_instance_t * );
 219
 220 /**
 221  * Unlock the playlist instance
 222  * \param p_instance the instance
 223  */
 224 VLC_PUBLIC_API void libvlc_playlist_unlock( libvlc_instance_t * );
 225
 226 /**
 227  * Stop playing
 228  * \param p_instance the instance to stop
 229  * \param p_exception an initialized exception
 230  */
 231 VLC_PUBLIC_API void libvlc_playlist_stop( libvlc_instance_t *, libvlc_exception_t * );
 232
 233 /**
 234  * Go to next playlist item (starts playback if it was stopped)
 235  * \param p_instance the instance to use
 236  * \param p_exception an initialized exception
 237  */
 238 VLC_PUBLIC_API void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * );
 239
 240 /**
 241  * Go to previous playlist item (starts playback if it was stopped)
 242  * \param p_instance the instance to use
 243  * \param p_exception an initialized exception
 244  */
 245 VLC_PUBLIC_API void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * );
 246
 247 /**
 248  * Remove all playlist items
 249  * \param p_instance the instance
 250  * \param p_exception an initialized exception
 251  */
 252 VLC_PUBLIC_API void libvlc_playlist_clear( libvlc_instance_t *, libvlc_exception_t * );
 253
 254 /**
 255  * Add an item at the end of the playlist
 256  * If you need more advanced options, \see libvlc_playlist_add_extended
 257  * \param p_instance the instance
 258  * \param psz_uri the URI to open, using VLC format
 259  * \param psz_name a name that you might want to give or NULL
 260  * \return the identifier of the new item
 261  */
 262 VLC_PUBLIC_API int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *,
 263                                         libvlc_exception_t * );
 264
 265 /**
 266  * Add an item at the end of the playlist, with additional input options
 267  * \param p_instance the instance
 268  * \param psz_uri the URI to open, using VLC format
 269  * \param psz_name a name that you might want to give or NULL
 270  * \param i_options the number of options to add
 271  * \param ppsz_options strings representing the options to add
 272  * \param p_exception an initialized exception
 273  * \return the identifier of the new item
 274  */
 275 VLC_PUBLIC_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
 276                                                  const char *, int, const char **,
 277                                                  libvlc_exception_t * );
 278
 279 /**
 280  * Delete the playlist item with the given ID.
 281  * \param p_instance the instance
 282  * \param i_id the id to remove
 283  * \param p_exception an initialized exception
 284  * \return
 285  */
 286 VLC_PUBLIC_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
 287                                                 libvlc_exception_t * );
 288
 289 /* Get the input that is currently being played by the playlist
 290  * \param p_instance the instance to use
 291  * \param p_exception an initialized excecption
 292  * \return an input object
 293  */
 294 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_playlist_get_media_instance(
 295                                 libvlc_instance_t *, libvlc_exception_t * );
 296
 297 /** @}*/
 298
 299 /*****************************************************************************
 300  * Media Instance
 301  *****************************************************************************/
 302 /** defgroup libvlc_media_instance Media Instance
 303  * \ingroup libvlc
 304  * LibVLC Media Instance
 305  * @{
 306  */
 307
 308 /** Create a Media Instance object from a Media Descriptor
 309  * \param p_md the Media Descriptor from which the Media Instance should be
 310  * created. The p_md can then be destroyed if needed.
 311  */
 312 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new( libvlc_media_descriptor_t * );
 313
 314 /** Destroy a Media Instance object
 315  * \param p_mi the Media Instance to free
 316  */
 317 VLC_PUBLIC_API void libvlc_media_instance_destroy( libvlc_media_instance_t * );
 318
 319 /* Will be renamed to libvlc_media_instance_release */
 320 VLC_PUBLIC_API void libvlc_media_instance_destroy_and_detach( libvlc_media_instance_t * );
 321
 322 VLC_PUBLIC_API void libvlc_media_instance_play ( libvlc_media_instance_t *, libvlc_exception_t * );
 323 VLC_PUBLIC_API void libvlc_media_instance_pause ( libvlc_media_instance_t *, libvlc_exception_t * );
 324
 325 /// \bug This might go away ... to be replaced by a broader system
 326 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_length     ( libvlc_media_instance_t *, libvlc_exception_t *);
 327 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_time       ( libvlc_media_instance_t *, libvlc_exception_t *);
 328 VLC_PUBLIC_API void        libvlc_media_instance_set_time       ( libvlc_media_instance_t *, vlc_int64_t, libvlc_exception_t *);
 329 VLC_PUBLIC_API float       libvlc_media_instance_get_position   ( libvlc_media_instance_t *, libvlc_exception_t *);
 330 VLC_PUBLIC_API void        libvlc_media_instance_set_position   ( libvlc_media_instance_t *, float, libvlc_exception_t *);
 331 VLC_PUBLIC_API vlc_bool_t  libvlc_media_instance_will_play      ( libvlc_media_instance_t *, libvlc_exception_t *);
 332 VLC_PUBLIC_API float       libvlc_media_instance_get_rate       ( libvlc_media_instance_t *, libvlc_exception_t *);
 333 VLC_PUBLIC_API void        libvlc_media_instance_set_rate       ( libvlc_media_instance_t *, float, libvlc_exception_t *);
 334 VLC_PUBLIC_API int         libvlc_media_instance_get_state      ( libvlc_media_instance_t *, libvlc_exception_t *);
 335
 336 /**
 337  * Does this input have a video output ?
 338  * \param p_input the input
 339  * \param p_exception an initialized exception
 340  */
 341 VLC_PUBLIC_API vlc_bool_t  libvlc_media_instance_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
 342 VLC_PUBLIC_API float       libvlc_media_instance_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
 343
 344
 345 /** @} */
 346
 347 /** defgroup libvlc_video Video
 348  * \ingroup libvlc
 349  * LibVLC Video handling
 350  * @{
 351  */
 352
 353 /**
 354  * Does this input have a video output ?
 355  * \param p_input the input
 356  * \param p_exception an initialized exception
 357  */
 358 VLC_PUBLIC_API vlc_bool_t  libvlc_input_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
 359 VLC_PUBLIC_API float       libvlc_input_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
 360
 361 /**
 362  * Toggle fullscreen status on video output
 363  * \param p_input the input
 364  * \param p_exception an initialized exception
 365  */
 366 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
 367
 368 /**
 369  * Enable or disable fullscreen on a video output
 370  * \param p_input the input
 371  * \param b_fullscreen boolean for fullscreen status
 372  * \param p_exception an initialized exception
 373  */
 374 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_instance_t *, int, libvlc_exception_t * );
 375
 376 /**
 377  * Get current fullscreen status
 378  * \param p_input the input
 379  * \param p_exception an initialized exception
 380  * \return the fullscreen status (boolean)
 381  */
 382 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
 383
 384 /**
 385  * Get current video height
 386  * \param p_input the input
 387  * \param p_exception an initialized exception
 388  * \return the video height
 389  */
 390 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_instance_t *, libvlc_exception_t * );
 391
 392 /**
 393  * Get current video width
 394  * \param p_input the input
 395  * \param p_exception an initialized exception
 396  * \return the video width
 397  */
 398 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_instance_t *, libvlc_exception_t * );
 399
 400 /**
 401  * Get current video aspect ratio
 402  * \param p_input the input
 403  * \param p_exception an initialized exception
 404  * \return the video aspect ratio
 405  */
 406 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_instance_t *, libvlc_exception_t * );
 407
 408 /**
 409  * Set new video aspect ratio
 410  * \param p_input the input
 411  * \param psz_aspect new video aspect-ratio
 412  * \param p_exception an initialized exception
 413  */
 414 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_instance_t *, char *, libvlc_exception_t * );
 415
 416 /**
 417  * Get current video subtitle
 418  * \param p_input the input
 419  * \param p_exception an initialized exception
 420  * \return the video subtitle selected
 421  */
 422 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_instance_t *, libvlc_exception_t * );
 423
 424 /**
 425  * Set new video subtitle
 426  * \param p_input the input
 427  * \param i_spu new video subtitle to select
 428  * \param p_exception an initialized exception
 429  */
 430 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_instance_t *, int , libvlc_exception_t * );
 431
 432 /**
 433  * Get current crop filter geometry
 434  * \param p_input the input
 435  * \param p_exception an initialized exception
 436  * \return the crop filter geometry
 437  */
 438 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_instance_t *, libvlc_exception_t * );
 439
 440 /**
 441  * Set new crop filter geometry
 442  * \param p_input the input
 443  * \param psz_geometry new crop filter geometry
 444  * \param p_exception an initialized exception
 445  */
 446 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_instance_t *, char *, libvlc_exception_t * );
 447
 448 /**
 449  * Take a snapshot of the current video window
 450  * \param p_input the input
 451  * \param psz_filepath the path where to save the screenshot to
 452  * \param p_exception an initialized exception
 453  */
 454 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_instance_t *, char *, libvlc_exception_t * );
 455
 456 VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *);
 457
 458 /**
 459  * Resize the current video output window
 460  * \param p_instance libvlc instance
 461  * \param width new width for video output window
 462  * \param height new height for video output window
 463  * \param p_exception an initialized exception
 464  * \return the success status (boolean)
 465  */
 466 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *);
 467
 468 /**
 469  * change the parent for the current the video output
 470  * \param p_instance libvlc instance
 471  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
 472  * \param p_exception an initialized exception
 473  * \return the success status (boolean)
 474  */
 475 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
 476
 477 /**
 478  * Tell windowless video output to redraw rectangular area (MacOS X only)
 479  * \param p_instance libvlc instance
 480  * \param area coordinates within video drawable
 481  * \param p_exception an initialized exception
 482  */
 483 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
 484
 485 /**
 486  * Set the default video output parent
 487  *  this settings will be used as default for all video outputs
 488  * \param p_instance libvlc instance
 489  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
 490  * \param p_exception an initialized exception
 491  */
 492 VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
 493
 494 /**
 495  * Set the default video output parent
 496  *  this settings will be used as default for all video outputs
 497  * \param p_instance libvlc instance
 498  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
 499  * \param p_exception an initialized exception
 500  */
 501 VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
 502
 503 /**
 504  * Set the default video output size
 505  *  this settings will be used as default for all video outputs
 506  * \param p_instance libvlc instance
 507  * \param width new width for video drawable
 508  * \param height new height for video drawable
 509  * \param p_exception an initialized exception
 510  */
 511 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
 512
 513 /**
 514  * Set the default video output viewport for a windowless video output (MacOS X only)
 515  *  this settings will be used as default for all video outputs
 516  * \param p_instance libvlc instance
 517  * \param view coordinates within video drawable
 518  * \param clip coordinates within video drawable
 519  * \param p_exception an initialized exception
 520  */
 521 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
 522
 523 /** @} */
 524
 525 /**
 526  * defgroup libvlc_vlm VLM
 527  * \ingroup libvlc
 528  * LibVLC VLM handling
 529  * @{
 530  */
 531
 532 /** defgroup libvlc_audio Audio
 533  * \ingroup libvlc
 534  * LibVLC Audio handling
 535  * @{
 536  */
 537
 538 /**
 539  * Toggle mute status
 540  * \param p_instance libvlc instance
 541  * \param p_exception an initialized exception
 542  * \return void
 543  */
 544 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
 545
 546 /**
 547  * Get current mute status
 548  * \param p_instance libvlc instance
 549  * \param p_exception an initialized exception
 550  * \return the mute status (boolean)
 551  */
 552 VLC_PUBLIC_API vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
 553
 554 /**
 555  * Set mute status
 556  * \param p_instance libvlc instance
 557  * \param status If status is VLC_TRUE then mute, otherwise unmute
 558  * \param p_exception an initialized exception
 559  * \return void
 560  */
 561 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * );
 562
 563 /**
 564  * Get current audio level
 565  * \param p_instance libvlc instance
 566  * \param p_exception an initialized exception
 567  * \return the audio level (int)
 568  */
 569 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
 570
 571 /**
 572  * Set current audio level
 573  * \param p_instance libvlc instance
 574  * \param i_volume the volume (int)
 575  * \param p_exception an initialized exception
 576  */
 577 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
 578
 579 /**
 580 +  * Get current audio track
 581 +  * \param p_input input instance
 582 +  * \param p_exception an initialized exception
 583 +  * \return the audio track (int)
 584 +  */
 585 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_instance_t *, libvlc_exception_t * );
 586
 587 /**
 588  * Set current audio track
 589  * \param p_input input instance
 590  * \param i_track the track (int)
 591  * \param p_exception an initialized exception
 592  */
 593 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_instance_t *, int, libvlc_exception_t * );
 594
 595 /**
 596  * Get current audio channel
 597  * \param p_instance input instance
 598  * \param p_exception an initialized exception
 599  * \return the audio channel (int)
 600  */
 601 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
 602
 603 /**
 604  * Set current audio channel
 605  * \param p_instance input instance
 606  * \param i_channel the audio channel (int)
 607  * \param p_exception an initialized exception
 608  */
 609 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * );
 610
 611 /** @} */
 612
 613
 614 /**
 615  * Add a broadcast, with one input
 616  * \param p_instance the instance
 617  * \param psz_name the name of the new broadcast
 618  * \param psz_input the input MRL
 619  * \param psz_output the output MRL (the parameter to the "sout" variable)
 620  * \param i_options number of additional options
 621  * \param ppsz_options additional options
 622  * \param b_enabled boolean for enabling the new broadcast
 623  * \param b_loop Should this broadcast be played in loop ?
 624  * \param p_exception an initialized exception
 625  */
 626 VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
 627                                               int, char **, int, int, libvlc_exception_t * );
 628
 629 /**
 630  * Delete a media (vod or broadcast)
 631  * \param p_instance the instance
 632  * \param psz_name the media to delete
 633  * \param p_exception an initialized exception
 634  */
 635 VLC_PUBLIC_API void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
 636
 637 /**
 638  * Enable or disable a media (vod or broadcast)
 639  * \param p_instance the instance
 640  * \param psz_name the media to work on
 641  * \param b_enabled the new status
 642  * \param p_exception an initialized exception
 643  */
 644 VLC_PUBLIC_API void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
 645                                             libvlc_exception_t *);
 646
 647 /**
 648  * Set the output for a media
 649  * \param p_instance the instance
 650  * \param psz_name the media to work on
 651  * \param psz_output the output MRL (the parameter to the "sout" variable)
 652  * \param p_exception an initialized exception
 653  */
 654 VLC_PUBLIC_API void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
 655                                            libvlc_exception_t *);
 656
 657 /**
 658  * Set a media's input MRL. This will delete all existing inputs and
 659  * add the specified one.
 660  * \param p_instance the instance
 661  * \param psz_name the media to work on
 662  * \param psz_input the input MRL
 663  * \param p_exception an initialized exception
 664  */
 665 VLC_PUBLIC_API void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
 666                                           libvlc_exception_t *);
 667
 668 /**
 669  * Add a media's input MRL. This will add the specified one.
 670  * \param p_instance the instance
 671  * \param psz_name the media to work on
 672  * \param psz_input the input MRL
 673  * \param p_exception an initialized exception
 674  */
 675 VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, char *, char *,
 676                                           libvlc_exception_t *p_exception );
 677 /**
 678  * Set output for a media
 679  * \param p_instance the instance
 680  * \param psz_name the media to work on
 681  * \param b_loop the new status
 682  * \param p_exception an initialized exception
 683  */
 684 VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
 685                                          libvlc_exception_t *);
 686
 687 /**
 688  * Edit the parameters of a media. This will delete all existing inputs and
 689  * add the specified one.
 690  * \param p_instance the instance
 691  * \param psz_name the name of the new broadcast
 692  * \param psz_input the input MRL
 693  * \param psz_output the output MRL (the parameter to the "sout" variable)
 694  * \param i_options number of additional options
 695  * \param ppsz_options additional options
 696  * \param b_enabled boolean for enabling the new broadcast
 697  * \param b_loop Should this broadcast be played in loop ?
 698  * \param p_exception an initialized exception
 699  */
 700 VLC_PUBLIC_API void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
 701                                              int, char **, int, int, libvlc_exception_t * );
 702
 703 /**
 704  * Plays the named broadcast.
 705  * \param p_instance the instance
 706  * \param psz_name the name of the broadcast
 707  * \param p_exception an initialized exception
 708  */
 709 VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
 710
 711 /**
 712  * Stops the named broadcast.
 713  * \param p_instance the instance
 714  * \param psz_name the name of the broadcast
 715  * \param p_exception an initialized exception
 716  */
 717 VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
 718
 719 /**
 720  * Pauses the named broadcast.
 721  * \param p_instance the instance
 722  * \param psz_name the name of the broadcast
 723  * \param p_exception an initialized exception
 724  */
 725 VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
 726
 727 /**
 728  * Seeks in the named broadcast.
 729  * \param p_instance the instance
 730  * \param psz_name the name of the broadcast
 731  * \param f_percentage the percentage to seek to
 732  * \param p_exception an initialized exception
 733  */
 734 VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
 735                                            float, libvlc_exception_t * );
 736
 737 /**
 738  * Return information of the named broadcast.
 739  * \param p_instance the instance
 740  * \param psz_name the name of the broadcast
 741  * \param p_exception an initialized exception
 742  */
 743 VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
 744
 745 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
 746 returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \
 747                         char *, int , libvlc_exception_t * );
 748
 749 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1);
 750 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time, int, Integer, -1);
 751 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length, int, Integer, -1);
 752 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate, int, Integer, -1);
 753 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title, int, Integer, 0);
 754 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter, int, Integer, 0);
 755 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
 756
 757 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
 758
 759 /** @} */
 760 /** @} */
 761
 762 /*****************************************************************************
 763  * Message log handling
 764  *****************************************************************************/
 765
 766 /** defgroup libvlc_log Log
 767  * \ingroup libvlc
 768  * LibVLC Message Logging
 769  * @{
 770  */
 771
 772 /**
 773  * Returns the VLC messaging verbosity level
 774  * \param p_instance libvlc instance
 775  * \param exception an initialized exception pointer
 776  */
 777 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
 778                                                   libvlc_exception_t *p_e );
 779
 780 /**
 781  * Set the VLC messaging verbosity level
 782  * \param p_log libvlc log instance
 783  * \param exception an initialized exception pointer
 784  */
 785 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
 786                                               libvlc_exception_t *p_e );
 787
 788 /**
 789  * Open an instance to VLC message log
 790  * \param p_instance libvlc instance
 791  * \param exception an initialized exception pointer
 792  */
 793 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( const libvlc_instance_t *, libvlc_exception_t *);
 794
 795 /**
 796  * Close an instance of VLC message log
 797  * \param p_log libvlc log instance
 798  * \param exception an initialized exception pointer
 799  */
 800 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
 801
 802 /**
 803  * Returns the number of messages in log
 804  * \param p_log libvlc log instance
 805  * \param exception an initialized exception pointer
 806  */
 807 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
 808
 809 /**
 810  * Clear all messages in log
 811  *  the log should be cleared on a regular basis to avoid clogging
 812  * \param p_log libvlc log instance
 813  * \param exception an initialized exception pointer
 814  */
 815 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
 816
 817 /**
 818  * Allocate and returns a new iterator to messages in log
 819  * \param p_log libvlc log instance
 820  * \param exception an initialized exception pointer
 821  */
 822 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
 823
 824 /**
 825  * Releases a previoulsy allocated iterator
 826  * \param p_log libvlc log iterator
 827  * \param exception an initialized exception pointer
 828  */
 829 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
 830
 831 /**
 832  * Returns whether log iterator has more messages
 833  * \param p_log libvlc log iterator
 834  * \param exception an initialized exception pointer
 835  */
 836 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
 837
 838 /**
 839  * Returns next log message
 840  *   the content of message must not be freed
 841  * \param p_log libvlc log iterator
 842  * \param exception an initialized exception pointer
 843  */
 844 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
 845                                                                struct libvlc_log_message_t *buffer,
 846                                                                libvlc_exception_t *p_e );
 847
 848 /** @} */
 849
 850 /*****************************************************************************
 851  * Callbacks handling
 852  *****************************************************************************/
 853
 854 /** defgroup libvlc_callbacks Callbacks
 855  * \ingroup libvlc
 856  * LibVLC Event Callbacks
 857  * @{
 858  */
 859
 860 /**
 861  * Register for a callback notification
 862  * \param p_instance the libvlc instance
 863  * \param i_event_type the desired event mask to which we want to listen
 864  * \param f_callback the function to call when i_event_type occurs
 865  * \param user_data user provided data to carry with the event
 866  * \param p_e an initialized exception pointer
 867  */
 868 VLC_PUBLIC_API void libvlc_event_add_callback( libvlc_instance_t *p_instance,
 869                                                libvlc_event_type_t i_event_type,
 870                                                libvlc_callback_t f_callback,
 871                                                void *user_data,
 872                                                libvlc_exception_t *p_e );
 873
 874 /**
 875  * Unregister all callbacks notification from an instance
 876  * \param p_instance the libvlc instance
 877  * \param p_e an initialized exception pointer
 878  */
 879 VLC_PUBLIC_API void libvlc_event_remove_all_callbacks( libvlc_instance_t *p_instance,
 880                                                        libvlc_exception_t *p_e );
 881
 882 /**
 883  * Unregister a callback notification
 884  * \param p_instance the libvlc instance
 885  * \param i_event_type the desired event mask to which we want to unregister
 886  * \param f_callback the function to call when i_event_type occurs
 887  * \param p_e an initialized exception pointer
 888  */
 889 VLC_PUBLIC_API void libvlc_event_remove_callback( libvlc_instance_t *p_instance,
 890                                                   libvlc_event_type_t i_event_type,
 891                                                   libvlc_callback_t f_callback,
 892                                                   void *p_user_data,
 893                                                   libvlc_exception_t *p_e );
 894
 895 /** @} */
 896
 897
 898 # ifdef __cplusplus
 899 }
 900 # endif
 901
 902 #endif /* <vlc/libvlc.h> */