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  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /**
  25  * \defgroup libvlc Libvlc
  26  * This is libvlc, the base library of the VLC program.
  27  *
  28  * @{
  29  */
  30
  31
  32 #ifndef _LIBVLC_H
  33 #define _LIBVLC_H 1
  34
  35 #include <vlc/vlc.h>
  36
  37 # ifdef __cplusplus
  38 extern "C" {
  39 # endif
  40
  41 /*****************************************************************************
  42  * Exception handling
  43  *****************************************************************************/
  44 /** defgroup libvlc_exception Exceptions
  45  * \ingroup libvlc
  46  * LibVLC Exceptions handling
  47  * @{
  48  */
  49
  50 struct libvlc_exception_t
  51 {
  52     int b_raised;
  53     char *psz_message;
  54 };
  55 typedef struct libvlc_exception_t libvlc_exception_t;
  56
  57 /**
  58  * Initialize an exception structure. This can be called several times to reuse
  59  * an exception structure.
  60  * \param p_exception the exception to initialize
  61  */
  62 void libvlc_exception_init( libvlc_exception_t *p_exception );
  63
  64 /**
  65  * Has an exception been raised ?
  66  * \param p_exception the exception to query
  67  * \return 0 if no exception raised, 1 else
  68  */
  69 int libvlc_exception_raised( libvlc_exception_t *p_exception );
  70
  71 /**
  72  * Raise an exception
  73  * \param p_exception the exception to raise
  74  * \param psz_message the exception message
  75  */
  76 void libvlc_exception_raise( libvlc_exception_t *p_exception, char *psz_format, ... );
  77
  78 /**
  79  * Clear an exception object so it can be reused.
  80  * The exception object must be initialized
  81  * \param p_exception the exception to clear
  82  */
  83 void libvlc_exception_clear( libvlc_exception_t * );
  84
  85 /**
  86  * Get exception message
  87  * \param p_exception the exception to query
  88  * \return the exception message or NULL if not applicable (exception not raised
  89  * for example)
  90  */
  91 char* libvlc_exception_get_message( libvlc_exception_t *p_exception );
  92
  93 /**@} */
  94
  95 /*****************************************************************************
  96  * Core handling
  97  *****************************************************************************/
  98
  99 /** defgroup libvlc_core Core
 100  * \ingroup libvlc
 101  * LibVLC Core
 102  * @{
 103  */
 104
 105 /** This structure is opaque. It represents a libvlc instance */
 106 typedef struct libvlc_instance_t libvlc_instance_t;
 107
 108 /**
 109  * Create an initialized libvlc instance
 110  * \param argc the number of arguments
 111  * \param argv command-line-type arguments
 112  * \param exception an initialized exception pointer
 113  */
 114 libvlc_instance_t * libvlc_new( int , char **, libvlc_exception_t *);
 115
 116 /**
 117  * Returns a libvlc instance identifier for legacy APIs. Use of this
 118  * function is discouraged, you should convert your program to use the
 119  * new API.
 120  * \param p_instance the instance
 121  */
 122 int libvlc_get_vlc_id( libvlc_instance_t *p_instance );
 123
 124 /**
 125  * Destroy a libvlc instance
 126  * \param p_instance the instance to destroy
 127  */
 128 void libvlc_destroy( libvlc_instance_t *);
 129
 130 /** @}*/
 131
 132 /*****************************************************************************
 133  * Playlist
 134  *****************************************************************************/
 135 /** defgroup libvlc_playlist Playlist
 136  * \ingroup libvlc
 137  * LibVLC Playlist handling
 138  * @{
 139  */
 140
 141 /**
 142  * Start playing. You can give some additionnal playlist item options
 143  * that will be added to the item before playing it.
 144  * \param p_instance the instance
 145  * \param i_id the item to play. If this is a negative number, the next
 146  * item will be selected. Else, the item with the given ID will be played
 147  * \param i_options the number of options to add to the item
 148  * \param ppsz_options the options to add to the item
 149  * \param p_exception an initialized exception
 150  */
 151 void libvlc_playlist_play( libvlc_instance_t*, int, int, char **,
 152                            libvlc_exception_t * );
 153
 154 /**
 155  * Pause a running playlist, resume if it was stopped
 156  * \param p_instance the instance to pause
 157  * \param p_exception an initialized exception
 158  */
 159 void libvlc_playlist_pause( libvlc_instance_t *, libvlc_exception_t * );
 160
 161 /**
 162  * Checks if the playlist is running
 163  * \param p_instance the instance
 164  * \param p_exception an initialized exception
 165  * \return 0 if the playlist is stopped or paused, 1 if it is running
 166  */
 167 int libvlc_playlist_isplaying( libvlc_instance_t *, libvlc_exception_t * );
 168
 169 /**
 170  * Get the number of items in the playlist
 171  * \param p_instance the instance
 172  * \param p_exception an initialized exception
 173  * \return the number of items
 174  */
 175 int libvlc_playlist_items_count( libvlc_instance_t *, libvlc_exception_t * );
 176
 177 /**
 178  * Stop playing
 179  * \param p_instance the instance to stop
 180  * \param p_exception an initialized exception
 181  */
 182 void libvlc_playlist_stop( libvlc_instance_t *, libvlc_exception_t * );
 183
 184 /**
 185  * Go to next playlist item (starts playback if it was stopped)
 186  * \param p_instance the instance to use
 187  * \param p_exception an initialized exception
 188  */
 189 void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * );
 190
 191 /**
 192  * Go to previous playlist item (starts playback if it was stopped)
 193  * \param p_instance the instance to use
 194  * \param p_exception an initialized exception
 195  */
 196 void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * );
 197
 198 /**
 199  * Remove all playlist items
 200  * \param p_instance the instance
 201  * \param p_exception an initialized exception
 202  */
 203 void libvlc_playlist_clear( libvlc_instance_t *, libvlc_exception_t * );
 204
 205 /**
 206  * Add an item at the end of the playlist
 207  * If you need more advanced options, \see libvlc_playlist_add_extended
 208  * \param p_instance the instance
 209  * \param psz_uri the URI to open, using VLC format
 210  * \param psz_name a name that you might want to give or NULL
 211  * \return the identifier of the new item
 212  */
 213 int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *,
 214                          libvlc_exception_t * );
 215
 216 /**
 217  * Add an item at the end of the playlist, with additional input options
 218  * \param p_instance the instance
 219  * \param psz_uri the URI to open, using VLC format
 220  * \param psz_name a name that you might want to give or NULL
 221  * \param i_options the number of options to add
 222  * \param ppsz_options strings representing the options to add
 223  * \param p_exception an initialized exception
 224  * \return the identifier of the new item
 225  */
 226 int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
 227                                   const char *, int, const char **,
 228                                   libvlc_exception_t * );
 229
 230 /**
 231  * Delete the playlist item with the given ID.
 232  * \param p_instance the instance
 233  * \param i_id the id to remove
 234  * \param p_exception an initialized exception
 235  * \return
 236  */
 237 int libvlc_playlist_delete_item( libvlc_instance_t *, int,
 238                                  libvlc_exception_t * );
 239
 240 typedef struct libvlc_input_t libvlc_input_t;
 241
 242 /* Get the input that is currently being played by the playlist
 243  * \param p_instance the instance to use
 244  * \param p_exception an initialized excecption
 245  * \return an input object
 246  */
 247 libvlc_input_t *libvlc_playlist_get_input( libvlc_instance_t *,
 248                                            libvlc_exception_t * );
 249
 250 /** @}*/
 251
 252 /*****************************************************************************
 253  * Input
 254  *****************************************************************************/
 255 /** defgroup libvlc_input Input
 256  * \ingroup libvlc
 257  * LibVLC Input handling
 258  * @{
 259  */
 260
 261 /** Free an input object
 262  * \param p_input the input to free
 263  */
 264 void libvlc_input_free( libvlc_input_t * );
 265
 266 /// \bug This might go away ... to be replaced by a broader system
 267 vlc_int64_t libvlc_input_get_length     ( libvlc_input_t *, libvlc_exception_t *);
 268 vlc_int64_t libvlc_input_get_time       ( libvlc_input_t *, libvlc_exception_t *);
 269 void        libvlc_input_set_time       ( libvlc_input_t *, vlc_int64_t, libvlc_exception_t *);
 270 float       libvlc_input_get_position   ( libvlc_input_t *, libvlc_exception_t *);
 271 void        libvlc_input_set_position   ( libvlc_input_t *, float, libvlc_exception_t *);
 272 vlc_bool_t  libvlc_input_will_play      ( libvlc_input_t *, libvlc_exception_t *);
 273
 274 /** @} */
 275
 276 /** defgroup libvlc_video Video
 277  * \ingroup libvlc
 278  * LibVLC Video handling
 279  * @{
 280  */
 281
 282 /**
 283  * Does this input have a video output ?
 284  * \param p_input the input
 285  * \param p_exception an initialized exception
 286  */
 287 vlc_bool_t  libvlc_input_has_vout       ( libvlc_input_t *, libvlc_exception_t *);
 288 float       libvlc_input_get_fps        ( libvlc_input_t *, libvlc_exception_t *);
 289
 290 /**
 291  * Toggle fullscreen status on video output
 292  * \param p_input the input
 293  * \param p_exception an initialized exception
 294  */
 295 void libvlc_toggle_fullscreen( libvlc_input_t *, libvlc_exception_t * );
 296
 297 /**
 298  * Enable or disable fullscreen on a video output
 299  * \param p_input the input
 300  * \param b_fullscreen boolean for fullscreen status
 301  * \param p_exception an initialized exception
 302  */
 303 void libvlc_set_fullscreen( libvlc_input_t *, int, libvlc_exception_t * );
 304
 305 /**
 306  * Get current fullscreen status
 307  * \param p_input the input
 308  * \param p_exception an initialized exception
 309  * \return the fullscreen status (boolean)
 310  */
 311 int libvlc_get_fullscreen( libvlc_input_t *, libvlc_exception_t * );
 312
 313 /**
 314  * Get current video height
 315  * \param p_input the input
 316  * \param p_exception an initialized exception
 317  * \return the video height
 318  */
 319 int libvlc_video_get_height( libvlc_input_t *, libvlc_exception_t * );
 320
 321 /**
 322  * Get current video width
 323  * \param p_input the input
 324  * \param p_exception an initialized exception
 325  * \return the video width
 326  */
 327 int libvlc_video_get_width( libvlc_input_t *, libvlc_exception_t * );
 328
 329 /**
 330  * Take a snapshot of the current video window
 331  * \param p_input the input
 332  * \param psz_filepath the path where to save the screenshot to
 333  * \param p_exception an initialized exception
 334  */
 335 void libvlc_video_take_snapshot( libvlc_input_t *, char *, libvlc_exception_t * );
 336
 337 int libvlc_video_destroy( libvlc_input_t *, libvlc_exception_t *);
 338
 339
 340 /**
 341  * Resize the video output window
 342  * \param p_instance libvlc instance
 343  * \param width new width for video output window
 344  * \param height new height for video output window
 345  * \param p_exception an initialized exception
 346  * \return the mute status (boolean)
 347  */
 348 void libvlc_video_resize( libvlc_input_t *, int, int, libvlc_exception_t *);
 349
 350 /**
 351 * Downcast to this general type as placeholder for a platform specific one, such as:
 352 *  Drawable on X11,
 353 *  CGrafPort on MacOSX,
 354 *  HWND on win32
 355 */
 356 typedef int libvlc_drawable_t;
 357
 358 /**
 359  * change the video output parent
 360  * \param p_instance libvlc instance
 361  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
 362  * \param p_exception an initialized exception
 363  * \return the mute status (boolean)
 364  */
 365 int libvlc_video_reparent( libvlc_input_t *, libvlc_drawable_t, libvlc_exception_t * );
 366
 367 /**
 368  * Set the video output parent
 369  * \param p_instance libvlc instance
 370  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
 371  * \param p_exception an initialized exception
 372  */
 373 void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
 374
 375 /**
 376  * Set the video output size
 377  * \param p_instance libvlc instance
 378  * \param width new width for video drawable
 379  * \param height new height for video drawable
 380  * \param p_exception an initialized exception
 381  */
 382 void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
 383
 384 /**
 385 * Downcast to this general type as placeholder for a platform specific one, such as:
 386 *  Drawable on X11,
 387 *  CGrafPort on MacOSX,
 388 *  HWND on win32
 389 */
 390 typedef struct
 391 {
 392     int top, left;
 393     int bottom, right;
 394 }
 395 libvlc_rectangle_t;
 396
 397 /**
 398  * Set the video output viewport for a windowless video ouput (MacOS X only)
 399  * \param p_instance libvlc instance
 400  * \param view coordinates within video drawable
 401  * \param clip coordinates within video drawable
 402  * \param p_exception an initialized exception
 403  */
 404 void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
 405
 406
 407 /** @} */
 408
 409 /**
 410  * defgroup libvlc_vlm VLM
 411  * \ingroup libvlc
 412  * LibVLC VLM handling
 413  * @{
 414  */
 415
 416 /** defgroup libvlc_audio Audio
 417  * \ingroup libvlc
 418  * LibVLC Audio handling
 419  * @{
 420  */
 421
 422 /**
 423  * Toggle mute status
 424  * \param p_instance libvlc instance
 425  * \param p_exception an initialized exception
 426  * \return void
 427  */
 428 void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
 429
 430 /**
 431  * Get current mute status
 432  * \param p_instance libvlc instance
 433  * \param p_exception an initialized exception
 434  * \return the mute status (boolean)
 435  */
 436 vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
 437
 438 /**
 439  * Set mute status
 440  * \param p_instance libvlc instance
 441  * \param status If status is VLC_TRUE then mute, otherwise unmute
 442  * \param p_exception an initialized exception
 443  * \return void
 444  */
 445 void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * );
 446
 447
 448 /**
 449  * Get current audio level
 450  * \param p_instance libvlc instance
 451  * \param p_exception an initialized exception
 452  * \return the audio level (int)
 453  */
 454 int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
 455
 456
 457 /**
 458  * Set current audio level
 459  * \param p_instance libvlc instance
 460  * \param i_volume the volume (int)
 461  * \param p_exception an initialized exception
 462  * \return void
 463  */
 464 void libvlc_audio_set_volume( libvlc_instance_t *, int , libvlc_exception_t *);
 465
 466 /** @} */
 467
 468
 469 /**
 470  * Add a broadcast, with one input
 471  * \param p_instance the instance
 472  * \param psz_name the name of the new broadcast
 473  * \param psz_input the input MRL
 474  * \param psz_output the output MRL (the parameter to the "sout" variable)
 475  * \param i_options number of additional options
 476  * \param ppsz_options additional options
 477  * \param b_enabled boolean for enabling the new broadcast
 478  * \param b_loop Should this broadcast be played in loop ?
 479  * \param p_exception an initialized exception
 480  */
 481 void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
 482                                int, char **, int, int, libvlc_exception_t * );
 483
 484 /**
 485  * Delete a media (vod or broadcast)
 486  * \param p_instance the instance
 487  * \param psz_name the media to delete
 488  * \param p_exception an initialized exception
 489  */
 490 void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
 491
 492 /**
 493  * Enable or disable a media (vod or broadcast)
 494  * \param p_instance the instance
 495  * \param psz_name the media to work on
 496  * \param b_enabled the new status
 497  * \param p_exception an initialized exception
 498  */
 499 void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
 500                              libvlc_exception_t *);
 501
 502 /**
 503  * Set the output for a media
 504  * \param p_instance the instance
 505  * \param psz_name the media to work on
 506  * \param psz_output the output MRL (the parameter to the "sout" variable)
 507  * \param p_exception an initialized exception
 508  */
 509 void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
 510                             libvlc_exception_t *);
 511
 512 /**
 513  * Set a media's input MRL. This will delete all existing inputs and
 514  * add the specified one.
 515  * \param p_instance the instance
 516  * \param psz_name the media to work on
 517  * \param psz_input the input MRL
 518  * \param p_exception an initialized exception
 519  */
 520 void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
 521                            libvlc_exception_t *);
 522
 523 /**
 524  * Set output for a media
 525  * \param p_instance the instance
 526  * \param psz_name the media to work on
 527  * \param b_loop the new status
 528  * \param p_exception an initialized exception
 529  */
 530 void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
 531                           libvlc_exception_t *);
 532
 533
 534
 535
 536 /**
 537  * Edit the parameters of a media. This will delete all existing inputs and
 538  * add the specified one.
 539  * \param p_instance the instance
 540  * \param psz_name the name of the new broadcast
 541  * \param psz_input the input MRL
 542  * \param psz_output the output MRL (the parameter to the "sout" variable)
 543  * \param i_options number of additional options
 544  * \param ppsz_options additional options
 545  * \param b_enabled boolean for enabling the new broadcast
 546  * \param b_loop Should this broadcast be played in loop ?
 547  * \param p_exception an initialized exception
 548  */
 549 void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
 550                               int, char **, int, int, libvlc_exception_t * );
 551
 552 /**
 553  * Plays the named broadcast.
 554  * \param p_instance the instance
 555  * \param psz_name the name of the broadcast
 556  * \param p_exception an initialized exception
 557  */
 558 void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
 559
 560 /**
 561  * Stops the named broadcast.
 562  * \param p_instance the instance
 563  * \param psz_name the name of the broadcast
 564  * \param p_exception an initialized exception
 565  */
 566 void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
 567
 568
 569 /**
 570  * Pauses the named broadcast.
 571  * \param p_instance the instance
 572  * \param psz_name the name of the broadcast
 573  * \param p_exception an initialized exception
 574  */
 575 void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
 576
 577
 578
 579 /** @} */
 580 /** @} */
 581
 582 # ifdef __cplusplus
 583 }
 584 # endif
 585
 586 #endif /* <vlc/libvlc.h> */