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