git.sesse.net Git - vlc/blob - include/vlc/libvlc.h

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