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, const 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 *, libvlc_exception_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  * Set loop variable
 143  */
 144 void libvlc_playlist_loop( libvlc_instance_t* , vlc_bool_t, libvlc_exception_t * );
 145
 146 /**
 147  * Start playing. You can give some additionnal playlist item options
 148  * that will be added to the item before playing it.
 149  * \param p_instance the instance
 150  * \param i_id the item to play. If this is a negative number, the next
 151  * item will be selected. Else, the item with the given ID will be played
 152  * \param i_options the number of options to add to the item
 153  * \param ppsz_options the options to add to the item
 154  * \param p_exception an initialized exception
 155  */
 156 void libvlc_playlist_play( libvlc_instance_t*, int, int, char **,
 157                            libvlc_exception_t * );
 158
 159 /**
 160  * Pause a running playlist, resume if it was stopped
 161  * \param p_instance the instance to pause
 162  * \param p_exception an initialized exception
 163  */
 164 void libvlc_playlist_pause( libvlc_instance_t *, libvlc_exception_t * );
 165
 166 /**
 167  * Checks if the playlist is running
 168  * \param p_instance the instance
 169  * \param p_exception an initialized exception
 170  * \return 0 if the playlist is stopped or paused, 1 if it is running
 171  */
 172 int libvlc_playlist_isplaying( libvlc_instance_t *, libvlc_exception_t * );
 173
 174 /**
 175  * Get the number of items in the playlist
 176  * \param p_instance the instance
 177  * \param p_exception an initialized exception
 178  * \return the number of items
 179  */
 180 int libvlc_playlist_items_count( libvlc_instance_t *, libvlc_exception_t * );
 181
 182 /**
 183  * Stop playing
 184  * \param p_instance the instance to stop
 185  * \param p_exception an initialized exception
 186  */
 187 void libvlc_playlist_stop( libvlc_instance_t *, libvlc_exception_t * );
 188
 189 /**
 190  * Go to next playlist item (starts playback if it was stopped)
 191  * \param p_instance the instance to use
 192  * \param p_exception an initialized exception
 193  */
 194 void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * );
 195
 196 /**
 197  * Go to previous playlist item (starts playback if it was stopped)
 198  * \param p_instance the instance to use
 199  * \param p_exception an initialized exception
 200  */
 201 void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * );
 202
 203 /**
 204  * Remove all playlist items
 205  * \param p_instance the instance
 206  * \param p_exception an initialized exception
 207  */
 208 void libvlc_playlist_clear( libvlc_instance_t *, libvlc_exception_t * );
 209
 210 /**
 211  * Add an item at the end of the playlist
 212  * If you need more advanced options, \see libvlc_playlist_add_extended
 213  * \param p_instance the instance
 214  * \param psz_uri the URI to open, using VLC format
 215  * \param psz_name a name that you might want to give or NULL
 216  * \return the identifier of the new item
 217  */
 218 int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *,
 219                          libvlc_exception_t * );
 220
 221 /**
 222  * Add an item at the end of the playlist, with additional input options
 223  * \param p_instance the instance
 224  * \param psz_uri the URI to open, using VLC format
 225  * \param psz_name a name that you might want to give or NULL
 226  * \param i_options the number of options to add
 227  * \param ppsz_options strings representing the options to add
 228  * \param p_exception an initialized exception
 229  * \return the identifier of the new item
 230  */
 231 int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
 232                                   const char *, int, const char **,
 233                                   libvlc_exception_t * );
 234
 235 /**
 236  * Delete the playlist item with the given ID.
 237  * \param p_instance the instance
 238  * \param i_id the id to remove
 239  * \param p_exception an initialized exception
 240  * \return
 241  */
 242 int libvlc_playlist_delete_item( libvlc_instance_t *, int,
 243                                  libvlc_exception_t * );
 244
 245 typedef struct libvlc_input_t libvlc_input_t;
 246
 247 /* Get the input that is currently being played by the playlist
 248  * \param p_instance the instance to use
 249  * \param p_exception an initialized excecption
 250  * \return an input object
 251  */
 252 libvlc_input_t *libvlc_playlist_get_input( libvlc_instance_t *,
 253                                            libvlc_exception_t * );
 254
 255 /** @}*/
 256
 257 /*****************************************************************************
 258  * Input
 259  *****************************************************************************/
 260 /** defgroup libvlc_input Input
 261  * \ingroup libvlc
 262  * LibVLC Input handling
 263  * @{
 264  */
 265
 266 /** Free an input object
 267  * \param p_input the input to free
 268  */
 269 void libvlc_input_free( libvlc_input_t * );
 270
 271 /// \bug This might go away ... to be replaced by a broader system
 272 vlc_int64_t libvlc_input_get_length     ( libvlc_input_t *, libvlc_exception_t *);
 273 vlc_int64_t libvlc_input_get_time       ( libvlc_input_t *, libvlc_exception_t *);
 274 void        libvlc_input_set_time       ( libvlc_input_t *, vlc_int64_t, libvlc_exception_t *);
 275 float       libvlc_input_get_position   ( libvlc_input_t *, libvlc_exception_t *);
 276 void        libvlc_input_set_position   ( libvlc_input_t *, float, libvlc_exception_t *);
 277 vlc_bool_t  libvlc_input_will_play      ( libvlc_input_t *, libvlc_exception_t *);
 278 float       libvlc_input_get_rate       ( libvlc_input_t *, libvlc_exception_t *);
 279 void        libvlc_input_set_rate       ( libvlc_input_t *, float, libvlc_exception_t *);
 280 int         libvlc_input_get_state      ( libvlc_input_t *, libvlc_exception_t *);
 281
 282 /** @} */
 283
 284 /** defgroup libvlc_video Video
 285  * \ingroup libvlc
 286  * LibVLC Video handling
 287  * @{
 288  */
 289
 290 /**
 291  * Does this input have a video output ?
 292  * \param p_input the input
 293  * \param p_exception an initialized exception
 294  */
 295 vlc_bool_t  libvlc_input_has_vout       ( libvlc_input_t *, libvlc_exception_t *);
 296 float       libvlc_input_get_fps        ( libvlc_input_t *, libvlc_exception_t *);
 297
 298 /**
 299  * Toggle fullscreen status on video output
 300  * \param p_input the input
 301  * \param p_exception an initialized exception
 302  */
 303 void libvlc_toggle_fullscreen( libvlc_input_t *, libvlc_exception_t * );
 304
 305 /**
 306  * Enable or disable fullscreen on a video output
 307  * \param p_input the input
 308  * \param b_fullscreen boolean for fullscreen status
 309  * \param p_exception an initialized exception
 310  */
 311 void libvlc_set_fullscreen( libvlc_input_t *, int, libvlc_exception_t * );
 312
 313 /**
 314  * Get current fullscreen status
 315  * \param p_input the input
 316  * \param p_exception an initialized exception
 317  * \return the fullscreen status (boolean)
 318  */
 319 int libvlc_get_fullscreen( libvlc_input_t *, libvlc_exception_t * );
 320
 321 /**
 322  * Get current video height
 323  * \param p_input the input
 324  * \param p_exception an initialized exception
 325  * \return the video height
 326  */
 327 int libvlc_video_get_height( libvlc_input_t *, libvlc_exception_t * );
 328
 329 /**
 330  * Get current video width
 331  * \param p_input the input
 332  * \param p_exception an initialized exception
 333  * \return the video width
 334  */
 335 int libvlc_video_get_width( libvlc_input_t *, libvlc_exception_t * );
 336
 337 /**
 338  * Get current video aspect ratio
 339  * \param p_input the input
 340  * \param p_exception an initialized exception
 341  * \return the video aspect ratio
 342  */
 343 char *libvlc_video_get_aspect_ratio( libvlc_input_t *, libvlc_exception_t * );
 344
 345 /**
 346  * Set new video aspect ratio
 347  * \param p_input the input
 348  * \param psz_aspect new video aspect-ratio
 349  * \param p_exception an initialized exception
 350  */
 351 void libvlc_video_set_aspect_ratio( libvlc_input_t *, char *, libvlc_exception_t * );
 352
 353 /**
 354  * Take a snapshot of the current video window
 355  * \param p_input the input
 356  * \param psz_filepath the path where to save the screenshot to
 357  * \param p_exception an initialized exception
 358  */
 359 void libvlc_video_take_snapshot( libvlc_input_t *, char *, libvlc_exception_t * );
 360
 361 int libvlc_video_destroy( libvlc_input_t *, libvlc_exception_t *);
 362
 363 /**
 364  * Resize the current video output window
 365  * \param p_instance libvlc instance
 366  * \param width new width for video output window
 367  * \param height new height for video output window
 368  * \param p_exception an initialized exception
 369  * \return the mute status (boolean)
 370  */
 371 void libvlc_video_resize( libvlc_input_t *, int, int, libvlc_exception_t *);
 372
 373 /**
 374 * Downcast to this general type as placeholder for a platform specific one, such as:
 375 *  Drawable on X11,
 376 *  CGrafPort on MacOSX,
 377 *  HWND on win32
 378 */
 379 typedef int libvlc_drawable_t;
 380
 381 /**
 382  * change the parent for the current the video output
 383  * \param p_instance libvlc instance
 384  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
 385  * \param p_exception an initialized exception
 386  * \return the mute status (boolean)
 387  */
 388 int libvlc_video_reparent( libvlc_input_t *, libvlc_drawable_t, libvlc_exception_t * );
 389
 390 /**
 391  * Set the default video output parent
 392  *  this settings will be used as default for all video outputs
 393  * \param p_instance libvlc instance
 394  * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
 395  * \param p_exception an initialized exception
 396  */
 397 void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
 398
 399 /**
 400  * Set the default video output size
 401  *  this settings will be used as default for all video outputs
 402  * \param p_instance libvlc instance
 403  * \param width new width for video drawable
 404  * \param height new height for video drawable
 405  * \param p_exception an initialized exception
 406  */
 407 void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
 408
 409 /**
 410 * Downcast to this general type as placeholder for a platform specific one, such as:
 411 *  Drawable on X11,
 412 *  CGrafPort on MacOSX,
 413 *  HWND on win32
 414 */
 415 typedef struct
 416 {
 417     int top, left;
 418     int bottom, right;
 419 }
 420 libvlc_rectangle_t;
 421
 422 /**
 423  * Set the default video output viewport for a windowless video output (MacOS X only)
 424  *  this settings will be used as default for all video outputs
 425  * \param p_instance libvlc instance
 426  * \param view coordinates within video drawable
 427  * \param clip coordinates within video drawable
 428  * \param p_exception an initialized exception
 429  */
 430 void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
 431
 432
 433 /** @} */
 434
 435 /**
 436  * defgroup libvlc_vlm VLM
 437  * \ingroup libvlc
 438  * LibVLC VLM handling
 439  * @{
 440  */
 441
 442 /** defgroup libvlc_audio Audio
 443  * \ingroup libvlc
 444  * LibVLC Audio handling
 445  * @{
 446  */
 447
 448 /**
 449  * Toggle mute status
 450  * \param p_instance libvlc instance
 451  * \param p_exception an initialized exception
 452  * \return void
 453  */
 454 void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
 455
 456 /**
 457  * Get current mute status
 458  * \param p_instance libvlc instance
 459  * \param p_exception an initialized exception
 460  * \return the mute status (boolean)
 461  */
 462 vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
 463
 464 /**
 465  * Set mute status
 466  * \param p_instance libvlc instance
 467  * \param status If status is VLC_TRUE then mute, otherwise unmute
 468  * \param p_exception an initialized exception
 469  * \return void
 470  */
 471 void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * );
 472
 473 /**
 474  * Get current audio level
 475  * \param p_instance libvlc instance
 476  * \param p_exception an initialized exception
 477  * \return the audio level (int)
 478  */
 479 int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
 480
 481 /**
 482  * Set current audio level
 483  * \param p_instance libvlc instance
 484  * \param i_volume the volume (int)
 485  * \param p_exception an initialized exception
 486  * \return void
 487  */
 488 void libvlc_audio_set_volume( libvlc_instance_t *, int , libvlc_exception_t *);
 489
 490 /** @} */
 491
 492
 493 /**
 494  * Add a broadcast, with one input
 495  * \param p_instance the instance
 496  * \param psz_name the name of the new broadcast
 497  * \param psz_input the input MRL
 498  * \param psz_output the output MRL (the parameter to the "sout" variable)
 499  * \param i_options number of additional options
 500  * \param ppsz_options additional options
 501  * \param b_enabled boolean for enabling the new broadcast
 502  * \param b_loop Should this broadcast be played in loop ?
 503  * \param p_exception an initialized exception
 504  */
 505 void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
 506                                int, char **, int, int, libvlc_exception_t * );
 507
 508 /**
 509  * Delete a media (vod or broadcast)
 510  * \param p_instance the instance
 511  * \param psz_name the media to delete
 512  * \param p_exception an initialized exception
 513  */
 514 void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
 515
 516 /**
 517  * Enable or disable a media (vod or broadcast)
 518  * \param p_instance the instance
 519  * \param psz_name the media to work on
 520  * \param b_enabled the new status
 521  * \param p_exception an initialized exception
 522  */
 523 void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
 524                              libvlc_exception_t *);
 525
 526 /**
 527  * Set the output for a media
 528  * \param p_instance the instance
 529  * \param psz_name the media to work on
 530  * \param psz_output the output MRL (the parameter to the "sout" variable)
 531  * \param p_exception an initialized exception
 532  */
 533 void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
 534                             libvlc_exception_t *);
 535
 536 /**
 537  * Set a media's input MRL. This will delete all existing inputs and
 538  * add the specified one.
 539  * \param p_instance the instance
 540  * \param psz_name the media to work on
 541  * \param psz_input the input MRL
 542  * \param p_exception an initialized exception
 543  */
 544 void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
 545                            libvlc_exception_t *);
 546
 547 /**
 548  * Set output for a media
 549  * \param p_instance the instance
 550  * \param psz_name the media to work on
 551  * \param b_loop the new status
 552  * \param p_exception an initialized exception
 553  */
 554 void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
 555                           libvlc_exception_t *);
 556
 557 /**
 558  * Edit the parameters of a media. This will delete all existing inputs and
 559  * add the specified one.
 560  * \param p_instance the instance
 561  * \param psz_name the name of the new broadcast
 562  * \param psz_input the input MRL
 563  * \param psz_output the output MRL (the parameter to the "sout" variable)
 564  * \param i_options number of additional options
 565  * \param ppsz_options additional options
 566  * \param b_enabled boolean for enabling the new broadcast
 567  * \param b_loop Should this broadcast be played in loop ?
 568  * \param p_exception an initialized exception
 569  */
 570 void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
 571                               int, char **, int, int, libvlc_exception_t * );
 572
 573 /**
 574  * Plays the named broadcast.
 575  * \param p_instance the instance
 576  * \param psz_name the name of the broadcast
 577  * \param p_exception an initialized exception
 578  */
 579 void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
 580
 581 /**
 582  * Stops the named broadcast.
 583  * \param p_instance the instance
 584  * \param psz_name the name of the broadcast
 585  * \param p_exception an initialized exception
 586  */
 587 void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
 588
 589 /**
 590  * Pauses the named broadcast.
 591  * \param p_instance the instance
 592  * \param psz_name the name of the broadcast
 593  * \param p_exception an initialized exception
 594  */
 595 void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
 596
 597 /**
 598  * Seeks in the named broadcast.
 599  * \param p_instance the instance
 600  * \param psz_name the name of the broadcast
 601  * \param f_percentage the percentage to seek to
 602  * \param p_exception an initialized exception
 603  */
 604 void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
 605                             float, libvlc_exception_t * );
 606
 607 /**
 608  * Return information of the named broadcast.
 609  * \param p_instance the instance
 610  * \param psz_name the name of the broadcast
 611  * \param p_exception an initialized exception
 612  */
 613 char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
 614
 615 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
 616 returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \
 617                         char *, int , libvlc_exception_t * );
 618
 619 LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1);
 620 LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time, int, Integer, -1);
 621 LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length, int, Integer, -1);
 622 LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate, int, Integer, -1);
 623 LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title, int, Integer, 0);
 624 LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter, int, Integer, 0);
 625 LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
 626
 627 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
 628
 629 /** @} */
 630 /** @} */
 631
 632 /*****************************************************************************
 633  * Message log handling
 634  *****************************************************************************/
 635
 636 /** defgroup libvlc_log Log
 637  * \ingroup libvlc
 638  * LibVLC Message Logging
 639  * @{
 640  */
 641
 642 /** This structure is opaque. It represents a libvlc log instance */
 643 typedef struct libvlc_log_t libvlc_log_t;
 644
 645 /** This structure is opaque. It represents a libvlc log iterator */
 646 typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;
 647
 648 typedef struct libvlc_log_message_t
 649 {
 650     unsigned    sizeof_msg;   /* sizeof() of message structure, must be filled in by user */
 651     int         i_severity;   /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
 652     const char *psz_type;     /* module type */
 653     const char *psz_name;     /* module name */
 654     const char *psz_header;   /* optional header */
 655     const char *psz_message;  /* message */
 656 } libvlc_log_message_t;
 657
 658 /**
 659  * Returns the VLC messaging verbosity level
 660  * \param p_instance libvlc instance
 661  * \param exception an initialized exception pointer
 662  */
 663 unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance, libvlc_exception_t *p_e );
 664
 665 /**
 666  * Set the VLC messaging verbosity level
 667  * \param p_log libvlc log instance
 668  * \param exception an initialized exception pointer
 669  */
 670 void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level, libvlc_exception_t *p_e );
 671
 672 /**
 673  * Open an instance to VLC message log
 674  * \param p_instance libvlc instance
 675  * \param exception an initialized exception pointer
 676  */
 677 libvlc_log_t *libvlc_log_open( const libvlc_instance_t *, libvlc_exception_t *);
 678
 679 /**
 680  * Close an instance of VLC message log
 681  * \param p_log libvlc log instance
 682  * \param exception an initialized exception pointer
 683  */
 684 void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
 685
 686 /**
 687  * Returns the number of messages in log
 688  * \param p_log libvlc log instance
 689  * \param exception an initialized exception pointer
 690  */
 691 unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
 692
 693 /**
 694  * Clear all messages in log
 695  *  the log should be cleared on a regular basis to avoid clogging
 696  * \param p_log libvlc log instance
 697  * \param exception an initialized exception pointer
 698  */
 699 void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
 700
 701 /**
 702  * Allocate and returns a new iterator to messages in log
 703  * \param p_log libvlc log instance
 704  * \param exception an initialized exception pointer
 705  */
 706 libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
 707
 708 /**
 709  * Releases a previoulsy allocated iterator
 710  * \param p_log libvlc log iterator
 711  * \param exception an initialized exception pointer
 712  */
 713 void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
 714
 715 /**
 716  * Returns whether log iterator has more messages
 717  * \param p_log libvlc log iterator
 718  * \param exception an initialized exception pointer
 719  */
 720 int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
 721
 722 /**
 723  * Returns next log message
 724  *   the content of message must not be freed
 725  * \param p_log libvlc log iterator
 726  * \param exception an initialized exception pointer
 727  */
 728 libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
 729                                                 struct libvlc_log_message_t *buffer,
 730                                                 libvlc_exception_t *p_e );
 731
 732 /** @} */
 733
 734 # ifdef __cplusplus
 735 }
 736 # endif
 737
 738 #endif /* <vlc/libvlc.h> */