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 an empty Media Instance object
 309  * \param p_libvlc_instance the libvlc instance in which the Media Instance
 310  * should be (not used for now).
 311  */
 312 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new( libvlc_instance_t *, libvlc_exception_t * );
 313
 314 /** Create a Media Instance object from a Media Descriptor
 315  * \param p_md the media descriptor. Afterwards the p_md can safely be
 316  * destroyed.
 317  */
 318 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new_from_media_descriptor( libvlc_media_descriptor_t *, libvlc_exception_t * );
 319
 320 /** Destroy a Media Instance object (going private)
 321  * \param p_mi the Media Instance to free
 322  */
 323 VLC_PUBLIC_API void libvlc_media_instance_destroy( libvlc_media_instance_t * );
 324
 325 /** Release a media_instance after use
 326  * \param p_mi the Media Instance to free
 327  */
 328 VLC_PUBLIC_API void libvlc_media_instance_release( libvlc_media_instance_t * );
 329
 330 /** Set the media descriptor that will be used by the media_instance. If any,
 331  * previous md will be released.
 332  * \param p_mi the Media Instance
 333  * \param p_md the Media Descriptor. Afterwards the p_md can safely be
 334  * destroyed.
 335  */
 336 VLC_PUBLIC_API void libvlc_media_instance_set_media_descriptor( libvlc_media_instance_t *, libvlc_media_descriptor_t *, libvlc_exception_t * );
 337
 338 /** Get the media descriptor used by the media_instance (if any). A copy of
 339  * the md is returned. NULL is returned if no media instance is associated.
 340  * \param p_mi the Media Instance
 341  * \param p_md the Media Descriptor. Afterwards the p_md can safely be
 342  * destroyed.
 343  */
 344 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_instance_get_media_descriptor( libvlc_media_instance_t *, libvlc_exception_t * );
 345
 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
 350 /// \bug This might go away ... to be replaced by a broader system
 351 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_length     ( libvlc_media_instance_t *, libvlc_exception_t *);
 352 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_time       ( libvlc_media_instance_t *, libvlc_exception_t *);
 353 VLC_PUBLIC_API void        libvlc_media_instance_set_time       ( libvlc_media_instance_t *, vlc_int64_t, libvlc_exception_t *);
 354 VLC_PUBLIC_API float       libvlc_media_instance_get_position   ( libvlc_media_instance_t *, libvlc_exception_t *);
 355 VLC_PUBLIC_API void        libvlc_media_instance_set_position   ( libvlc_media_instance_t *, float, libvlc_exception_t *);
 356 VLC_PUBLIC_API vlc_bool_t  libvlc_media_instance_will_play      ( libvlc_media_instance_t *, libvlc_exception_t *);
 357 VLC_PUBLIC_API float       libvlc_media_instance_get_rate       ( libvlc_media_instance_t *, libvlc_exception_t *);
 358 VLC_PUBLIC_API void        libvlc_media_instance_set_rate       ( libvlc_media_instance_t *, float, libvlc_exception_t *);
 359 VLC_PUBLIC_API int         libvlc_media_instance_get_state      ( libvlc_media_instance_t *, libvlc_exception_t *);
 360
 361 /**
 362  * Does this input have a video output ?
 363  * \param p_input the input
 364  * \param p_exception an initialized exception
 365  */
 366 VLC_PUBLIC_API vlc_bool_t  libvlc_media_instance_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
 367 VLC_PUBLIC_API float       libvlc_media_instance_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
 368
 369
 370 /** @} */
 371
 372 /** defgroup libvlc_video Video
 373  * \ingroup libvlc
 374  * LibVLC Video handling
 375  * @{
 376  */
 377
 378 /**
 379  * Does this input have a video output ?
 380  * \param p_input the input
 381  * \param p_exception an initialized exception
 382  */
 383 VLC_PUBLIC_API vlc_bool_t  libvlc_input_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
 384 VLC_PUBLIC_API float       libvlc_input_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
 385
 386 /**
 387  * Toggle fullscreen status on video output
 388  * \param p_input the input
 389  * \param p_exception an initialized exception
 390  */
 391 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
 392
 393 /**
 394  * Enable or disable fullscreen on a video output
 395  * \param p_input the input
 396  * \param b_fullscreen boolean for fullscreen status
 397  * \param p_exception an initialized exception
 398  */
 399 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_instance_t *, int, libvlc_exception_t * );
 400
 401 /**
 402  * Get current fullscreen status
 403  * \param p_input the input
 404  * \param p_exception an initialized exception
 405  * \return the fullscreen status (boolean)
 406  */
 407 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
 408
 409 /**
 410  * Get current video height
 411  * \param p_input the input
 412  * \param p_exception an initialized exception
 413  * \return the video height
 414  */
 415 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_instance_t *, libvlc_exception_t * );
 416
 417 /**
 418  * Get current video width
 419  * \param p_input the input
 420  * \param p_exception an initialized exception
 421  * \return the video width
 422  */
 423 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_instance_t *, libvlc_exception_t * );
 424
 425 /**
 426  * Get current video aspect ratio
 427  * \param p_input the input
 428  * \param p_exception an initialized exception
 429  * \return the video aspect ratio
 430  */
 431 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_instance_t *, libvlc_exception_t * );
 432
 433 /**
 434  * Set new video aspect ratio
 435  * \param p_input the input
 436  * \param psz_aspect new video aspect-ratio
 437  * \param p_exception an initialized exception
 438  */
 439 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_instance_t *, char *, libvlc_exception_t * );
 440
 441 /**
 442  * Get current video subtitle
 443  * \param p_input the input
 444  * \param p_exception an initialized exception
 445  * \return the video subtitle selected
 446  */
 447 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_instance_t *, libvlc_exception_t * );
 448
 449 /**
 450  * Set new video subtitle
 451  * \param p_input the input
 452  * \param i_spu new video subtitle to select
 453  * \param p_exception an initialized exception
 454  */
 455 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_instance_t *, int , libvlc_exception_t * );
 456
 457 /**
 458  * Get current crop filter geometry
 459  * \param p_input the input
 460  * \param p_exception an initialized exception
 461  * \return the crop filter geometry
 462  */
 463 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_instance_t *, libvlc_exception_t * );
 464
 465 /**
 466  * Set new crop filter geometry
 467  * \param p_input the input
 468  * \param psz_geometry new crop filter geometry
 469  * \param p_exception an initialized exception
 470  */
 471 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_instance_t *, char *, libvlc_exception_t * );
 472
 473 /**
 474  * Take a snapshot of the current video window
 475  * \param p_input the input
 476  * \param psz_filepath the path where to save the screenshot to
 477  * \param p_exception an initialized exception
 478  */
 479 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_instance_t *, char *, libvlc_exception_t * );
 480
 481 VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *);
 482
 483 /**
 484  * Resize the current video output window
 485  * \param p_instance libvlc instance
 486  * \param width new width for video output window
 487  * \param height new height for video output window
 488  * \param p_exception an initialized exception
 489  * \return the success status (boolean)
 490  */
 491 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *);
 492
 493 /**
 494  * change the parent for the current the video output
 495  * \param p_instance libvlc instance
 496  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
 497  * \param p_exception an initialized exception
 498  * \return the success status (boolean)
 499  */
 500 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
 501
 502 /**
 503  * Tell windowless video output to redraw rectangular area (MacOS X only)
 504  * \param p_instance libvlc instance
 505  * \param area coordinates within video drawable
 506  * \param p_exception an initialized exception
 507  */
 508 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
 509
 510 /**
 511  * Set the default video output parent
 512  *  this settings will be used as default for all video outputs
 513  * \param p_instance libvlc instance
 514  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
 515  * \param p_exception an initialized exception
 516  */
 517 VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
 518
 519 /**
 520  * Set the default video output parent
 521  *  this settings will be used as default for all video outputs
 522  * \param p_instance libvlc instance
 523  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
 524  * \param p_exception an initialized exception
 525  */
 526 VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
 527
 528 /**
 529  * Set the default video output size
 530  *  this settings will be used as default for all video outputs
 531  * \param p_instance libvlc instance
 532  * \param width new width for video drawable
 533  * \param height new height for video drawable
 534  * \param p_exception an initialized exception
 535  */
 536 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
 537
 538 /**
 539  * Set the default video output viewport for a windowless video output (MacOS X only)
 540  *  this settings will be used as default for all video outputs
 541  * \param p_instance libvlc instance
 542  * \param view coordinates within video drawable
 543  * \param clip coordinates within video drawable
 544  * \param p_exception an initialized exception
 545  */
 546 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
 547
 548 /** @} */
 549
 550 /**
 551  * defgroup libvlc_vlm VLM
 552  * \ingroup libvlc
 553  * LibVLC VLM handling
 554  * @{
 555  */
 556
 557 /** defgroup libvlc_audio Audio
 558  * \ingroup libvlc
 559  * LibVLC Audio handling
 560  * @{
 561  */
 562
 563 /**
 564  * Toggle mute status
 565  * \param p_instance libvlc instance
 566  * \param p_exception an initialized exception
 567  * \return void
 568  */
 569 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
 570
 571 /**
 572  * Get current mute status
 573  * \param p_instance libvlc instance
 574  * \param p_exception an initialized exception
 575  * \return the mute status (boolean)
 576  */
 577 VLC_PUBLIC_API vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
 578
 579 /**
 580  * Set mute status
 581  * \param p_instance libvlc instance
 582  * \param status If status is VLC_TRUE then mute, otherwise unmute
 583  * \param p_exception an initialized exception
 584  * \return void
 585  */
 586 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * );
 587
 588 /**
 589  * Get current audio level
 590  * \param p_instance libvlc instance
 591  * \param p_exception an initialized exception
 592  * \return the audio level (int)
 593  */
 594 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
 595
 596 /**
 597  * Set current audio level
 598  * \param p_instance libvlc instance
 599  * \param i_volume the volume (int)
 600  * \param p_exception an initialized exception
 601  */
 602 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
 603
 604 /**
 605 +  * Get current audio track
 606 +  * \param p_input input instance
 607 +  * \param p_exception an initialized exception
 608 +  * \return the audio track (int)
 609 +  */
 610 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_instance_t *, libvlc_exception_t * );
 611
 612 /**
 613  * Set current audio track
 614  * \param p_input input instance
 615  * \param i_track the track (int)
 616  * \param p_exception an initialized exception
 617  */
 618 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_instance_t *, int, libvlc_exception_t * );
 619
 620 /**
 621  * Get current audio channel
 622  * \param p_instance input instance
 623  * \param p_exception an initialized exception
 624  * \return the audio channel (int)
 625  */
 626 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
 627
 628 /**
 629  * Set current audio channel
 630  * \param p_instance input instance
 631  * \param i_channel the audio channel (int)
 632  * \param p_exception an initialized exception
 633  */
 634 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * );
 635
 636 /** @} */
 637
 638
 639 /**
 640  * Add a broadcast, with one input
 641  * \param p_instance the instance
 642  * \param psz_name the name of the new broadcast
 643  * \param psz_input the input MRL
 644  * \param psz_output the output MRL (the parameter to the "sout" variable)
 645  * \param i_options number of additional options
 646  * \param ppsz_options additional options
 647  * \param b_enabled boolean for enabling the new broadcast
 648  * \param b_loop Should this broadcast be played in loop ?
 649  * \param p_exception an initialized exception
 650  */
 651 VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
 652                                               int, char **, int, int, libvlc_exception_t * );
 653
 654 /**
 655  * Delete a media (vod or broadcast)
 656  * \param p_instance the instance
 657  * \param psz_name the media to delete
 658  * \param p_exception an initialized exception
 659  */
 660 VLC_PUBLIC_API void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
 661
 662 /**
 663  * Enable or disable a media (vod or broadcast)
 664  * \param p_instance the instance
 665  * \param psz_name the media to work on
 666  * \param b_enabled the new status
 667  * \param p_exception an initialized exception
 668  */
 669 VLC_PUBLIC_API void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
 670                                             libvlc_exception_t *);
 671
 672 /**
 673  * Set the output for a media
 674  * \param p_instance the instance
 675  * \param psz_name the media to work on
 676  * \param psz_output the output MRL (the parameter to the "sout" variable)
 677  * \param p_exception an initialized exception
 678  */
 679 VLC_PUBLIC_API void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
 680                                            libvlc_exception_t *);
 681
 682 /**
 683  * Set a media's input MRL. This will delete all existing inputs and
 684  * add the specified one.
 685  * \param p_instance the instance
 686  * \param psz_name the media to work on
 687  * \param psz_input the input MRL
 688  * \param p_exception an initialized exception
 689  */
 690 VLC_PUBLIC_API void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
 691                                           libvlc_exception_t *);
 692
 693 /**
 694  * Add a media's input MRL. This will add the specified one.
 695  * \param p_instance the instance
 696  * \param psz_name the media to work on
 697  * \param psz_input the input MRL
 698  * \param p_exception an initialized exception
 699  */
 700 VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, char *, char *,
 701                                           libvlc_exception_t *p_exception );
 702 /**
 703  * Set output for a media
 704  * \param p_instance the instance
 705  * \param psz_name the media to work on
 706  * \param b_loop the new status
 707  * \param p_exception an initialized exception
 708  */
 709 VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
 710                                          libvlc_exception_t *);
 711
 712 /**
 713  * Edit the parameters of a media. This will delete all existing inputs and
 714  * add the specified one.
 715  * \param p_instance the instance
 716  * \param psz_name the name of the new broadcast
 717  * \param psz_input the input MRL
 718  * \param psz_output the output MRL (the parameter to the "sout" variable)
 719  * \param i_options number of additional options
 720  * \param ppsz_options additional options
 721  * \param b_enabled boolean for enabling the new broadcast
 722  * \param b_loop Should this broadcast be played in loop ?
 723  * \param p_exception an initialized exception
 724  */
 725 VLC_PUBLIC_API void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
 726                                              int, char **, int, int, libvlc_exception_t * );
 727
 728 /**
 729  * Plays the named broadcast.
 730  * \param p_instance the instance
 731  * \param psz_name the name of the broadcast
 732  * \param p_exception an initialized exception
 733  */
 734 VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
 735
 736 /**
 737  * Stops the named broadcast.
 738  * \param p_instance the instance
 739  * \param psz_name the name of the broadcast
 740  * \param p_exception an initialized exception
 741  */
 742 VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
 743
 744 /**
 745  * Pauses the named broadcast.
 746  * \param p_instance the instance
 747  * \param psz_name the name of the broadcast
 748  * \param p_exception an initialized exception
 749  */
 750 VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
 751
 752 /**
 753  * Seeks in the named broadcast.
 754  * \param p_instance the instance
 755  * \param psz_name the name of the broadcast
 756  * \param f_percentage the percentage to seek to
 757  * \param p_exception an initialized exception
 758  */
 759 VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
 760                                            float, libvlc_exception_t * );
 761
 762 /**
 763  * Return information of the named broadcast.
 764  * \param p_instance the instance
 765  * \param psz_name the name of the broadcast
 766  * \param p_exception an initialized exception
 767  */
 768 VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
 769
 770 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
 771 returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \
 772                         char *, int , libvlc_exception_t * );
 773
 774 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1);
 775 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time, int, Integer, -1);
 776 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length, int, Integer, -1);
 777 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate, int, Integer, -1);
 778 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title, int, Integer, 0);
 779 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter, int, Integer, 0);
 780 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
 781
 782 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
 783
 784 /** @} */
 785 /** @} */
 786
 787 /*****************************************************************************
 788  * Message log handling
 789  *****************************************************************************/
 790
 791 /** defgroup libvlc_log Log
 792  * \ingroup libvlc
 793  * LibVLC Message Logging
 794  * @{
 795  */
 796
 797 /**
 798  * Returns the VLC messaging verbosity level
 799  * \param p_instance libvlc instance
 800  * \param exception an initialized exception pointer
 801  */
 802 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
 803                                                   libvlc_exception_t *p_e );
 804
 805 /**
 806  * Set the VLC messaging verbosity level
 807  * \param p_log libvlc log instance
 808  * \param exception an initialized exception pointer
 809  */
 810 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
 811                                               libvlc_exception_t *p_e );
 812
 813 /**
 814  * Open an instance to VLC message log
 815  * \param p_instance libvlc instance
 816  * \param exception an initialized exception pointer
 817  */
 818 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( const libvlc_instance_t *, libvlc_exception_t *);
 819
 820 /**
 821  * Close an instance of VLC message log
 822  * \param p_log libvlc log instance
 823  * \param exception an initialized exception pointer
 824  */
 825 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
 826
 827 /**
 828  * Returns the number of messages in log
 829  * \param p_log libvlc log instance
 830  * \param exception an initialized exception pointer
 831  */
 832 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
 833
 834 /**
 835  * Clear all messages in log
 836  *  the log should be cleared on a regular basis to avoid clogging
 837  * \param p_log libvlc log instance
 838  * \param exception an initialized exception pointer
 839  */
 840 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
 841
 842 /**
 843  * Allocate and returns a new iterator to messages in log
 844  * \param p_log libvlc log instance
 845  * \param exception an initialized exception pointer
 846  */
 847 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
 848
 849 /**
 850  * Releases a previoulsy allocated iterator
 851  * \param p_log libvlc log iterator
 852  * \param exception an initialized exception pointer
 853  */
 854 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
 855
 856 /**
 857  * Returns whether log iterator has more messages
 858  * \param p_log libvlc log iterator
 859  * \param exception an initialized exception pointer
 860  */
 861 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
 862
 863 /**
 864  * Returns next log message
 865  *   the content of message must not be freed
 866  * \param p_log libvlc log iterator
 867  * \param exception an initialized exception pointer
 868  */
 869 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
 870                                                                struct libvlc_log_message_t *buffer,
 871                                                                libvlc_exception_t *p_e );
 872
 873 /** @} */
 874
 875 /*****************************************************************************
 876  * Callbacks handling
 877  *****************************************************************************/
 878
 879 /** defgroup libvlc_callbacks Callbacks
 880  * \ingroup libvlc
 881  * LibVLC Event Callbacks
 882  * @{
 883  */
 884
 885 /**
 886  * Register for a callback notification
 887  * \param p_instance the libvlc instance
 888  * \param i_event_type the desired event mask to which we want to listen
 889  * \param f_callback the function to call when i_event_type occurs
 890  * \param user_data user provided data to carry with the event
 891  * \param p_e an initialized exception pointer
 892  */
 893 VLC_PUBLIC_API void libvlc_event_add_callback( libvlc_instance_t *p_instance,
 894                                                libvlc_event_type_t i_event_type,
 895                                                libvlc_callback_t f_callback,
 896                                                void *user_data,
 897                                                libvlc_exception_t *p_e );
 898
 899 /**
 900  * Unregister all callbacks notification from an instance
 901  * \param p_instance the libvlc instance
 902  * \param p_e an initialized exception pointer
 903  */
 904 VLC_PUBLIC_API void libvlc_event_remove_all_callbacks( libvlc_instance_t *p_instance,
 905                                                        libvlc_exception_t *p_e );
 906
 907 /**
 908  * Unregister a callback notification
 909  * \param p_instance the libvlc instance
 910  * \param i_event_type the desired event mask to which we want to unregister
 911  * \param f_callback the function to call when i_event_type occurs
 912  * \param p_e an initialized exception pointer
 913  */
 914 VLC_PUBLIC_API void libvlc_event_remove_callback( libvlc_instance_t *p_instance,
 915                                                   libvlc_event_type_t i_event_type,
 916                                                   libvlc_callback_t f_callback,
 917                                                   void *p_user_data,
 918                                                   libvlc_exception_t *p_e );
 919
 920 /** @} */
 921
 922
 923 # ifdef __cplusplus
 924 }
 925 # endif
 926
 927 #endif /* <vlc/libvlc.h> */