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 $
7 * Authors: Clément Stenac <zorglub@videolan.org>
8 * Jean-Paul Saman <jpsaman _at_ m2x _dot_ nl>
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.
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.
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 *****************************************************************************/
26 * \defgroup libvlc Libvlc
27 * This is libvlc, the base library of the VLC program.
37 #include <vlc/libvlc_structures.h>
43 /*****************************************************************************
45 *****************************************************************************/
46 /** defgroup libvlc_exception Exceptions
48 * LibVLC Exceptions handling
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
57 VLC_PUBLIC_API void libvlc_exception_init( libvlc_exception_t *p_exception );
60 * Has an exception been raised ?
61 * \param p_exception the exception to query
62 * \return 0 if no exception raised, 1 else
64 VLC_PUBLIC_API int libvlc_exception_raised( libvlc_exception_t *p_exception );
68 * \param p_exception the exception to raise
69 * \param psz_message the exception message
71 VLC_PUBLIC_API void libvlc_exception_raise( libvlc_exception_t *p_exception, const char *psz_format, ... );
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
78 VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
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
86 VLC_PUBLIC_API char* libvlc_exception_get_message( libvlc_exception_t *p_exception );
90 /*****************************************************************************
92 *****************************************************************************/
94 /** defgroup libvlc_core Core
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
106 VLC_PUBLIC_API libvlc_instance_t * libvlc_new( int , char **, libvlc_exception_t *);
109 * Returns a libvlc instance identifier for legacy APIs. Use of this
110 * function is discouraged, you should convert your program to use the
112 * \param p_instance the instance
114 VLC_PUBLIC_API int libvlc_get_vlc_id( libvlc_instance_t *p_instance );
117 * Destroy a libvlc instance.
118 * \param p_instance the instance to destroy
120 VLC_PUBLIC_API void libvlc_destroy( libvlc_instance_t *, libvlc_exception_t * );
125 /*****************************************************************************
127 *****************************************************************************/
128 /** defgroup libvlc_media_descriptor Media Descriptor
130 * LibVLC Media Descriptor
135 * Create a media descriptor with the given mrl.
136 * \param p_instance the instance
137 * \param psz_mrl the mrl to read
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 );
145 * Destroy a media descriptor object.
146 * \param p_meta_desc the md to destroy
148 VLC_PUBLIC_API void libvlc_media_descriptor_destroy(
149 libvlc_media_descriptor_t *p_meta_desc );
152 * Read the meta of the media descriptor.
153 * \param p_meta_desc the media descriptor to read
154 * \param p_meta_desc the meta to read
156 VLC_PUBLIC_API char * libvlc_media_descriptor_get_meta(
157 libvlc_media_descriptor_t *p_meta_desc,
158 libvlc_meta_t e_meta,
159 libvlc_exception_t *p_e );
163 /*****************************************************************************
165 *****************************************************************************/
166 /** defgroup libvlc_playlist Playlist
168 * LibVLC Playlist handling
175 VLC_PUBLIC_API void libvlc_playlist_loop( libvlc_instance_t* , vlc_bool_t,
176 libvlc_exception_t * );
179 * Start playing. You can give some additionnal playlist item options
180 * that will be added to the item before playing it.
181 * \param p_instance the instance
182 * \param i_id the item to play. If this is a negative number, the next
183 * item will be selected. Else, the item with the given ID will be played
184 * \param i_options the number of options to add to the item
185 * \param ppsz_options the options to add to the item
186 * \param p_exception an initialized exception
188 VLC_PUBLIC_API void libvlc_playlist_play( libvlc_instance_t*, int, int, char **,
189 libvlc_exception_t * );
192 * Pause a running playlist, resume if it was stopped
193 * \param p_instance the instance to pause
194 * \param p_exception an initialized exception
196 VLC_PUBLIC_API void libvlc_playlist_pause( libvlc_instance_t *, libvlc_exception_t * );
199 * Checks if the playlist is running
200 * \param p_instance the instance
201 * \param p_exception an initialized exception
202 * \return 0 if the playlist is stopped or paused, 1 if it is running
204 VLC_PUBLIC_API int libvlc_playlist_isplaying( libvlc_instance_t *, libvlc_exception_t * );
207 * Get the number of items in the playlist
208 * \param p_instance the instance
209 * \param p_exception an initialized exception
210 * \return the number of items
212 VLC_PUBLIC_API int libvlc_playlist_items_count( libvlc_instance_t *, libvlc_exception_t * );
215 * Lock the playlist instance
216 * \param p_instance the instance
218 VLC_PUBLIC_API void libvlc_playlist_lock( libvlc_instance_t * );
221 * Unlock the playlist instance
222 * \param p_instance the instance
224 VLC_PUBLIC_API void libvlc_playlist_unlock( libvlc_instance_t * );
228 * \param p_instance the instance to stop
229 * \param p_exception an initialized exception
231 VLC_PUBLIC_API void libvlc_playlist_stop( libvlc_instance_t *, libvlc_exception_t * );
234 * Go to next playlist item (starts playback if it was stopped)
235 * \param p_instance the instance to use
236 * \param p_exception an initialized exception
238 VLC_PUBLIC_API void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * );
241 * Go to previous playlist item (starts playback if it was stopped)
242 * \param p_instance the instance to use
243 * \param p_exception an initialized exception
245 VLC_PUBLIC_API void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * );
248 * Remove all playlist items
249 * \param p_instance the instance
250 * \param p_exception an initialized exception
252 VLC_PUBLIC_API void libvlc_playlist_clear( libvlc_instance_t *, libvlc_exception_t * );
255 * Add an item at the end of the playlist
256 * If you need more advanced options, \see libvlc_playlist_add_extended
257 * \param p_instance the instance
258 * \param psz_uri the URI to open, using VLC format
259 * \param psz_name a name that you might want to give or NULL
260 * \return the identifier of the new item
262 VLC_PUBLIC_API int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *,
263 libvlc_exception_t * );
266 * Add an item at the end of the playlist, with additional input options
267 * \param p_instance the instance
268 * \param psz_uri the URI to open, using VLC format
269 * \param psz_name a name that you might want to give or NULL
270 * \param i_options the number of options to add
271 * \param ppsz_options strings representing the options to add
272 * \param p_exception an initialized exception
273 * \return the identifier of the new item
275 VLC_PUBLIC_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
276 const char *, int, const char **,
277 libvlc_exception_t * );
280 * Delete the playlist item with the given ID.
281 * \param p_instance the instance
282 * \param i_id the id to remove
283 * \param p_exception an initialized exception
286 VLC_PUBLIC_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
287 libvlc_exception_t * );
289 /* Get the input that is currently being played by the playlist
290 * \param p_instance the instance to use
291 * \param p_exception an initialized excecption
292 * \return an input object
294 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_playlist_get_media_instance(
295 libvlc_instance_t *, libvlc_exception_t * );
299 /*****************************************************************************
301 *****************************************************************************/
302 /** defgroup libvlc_media_instance Media Instance
304 * LibVLC Media Instance
308 /** Create a Media Instance object from a Media Descriptor
309 * \param p_md the Media Descriptor from which the Media Instance should be
310 * created. The p_md can then be destroyed if needed.
312 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new( libvlc_media_descriptor_t * );
314 /** Destroy a Media Instance object
315 * \param p_mi the Media Instance to free
317 VLC_PUBLIC_API void libvlc_media_instance_destroy( libvlc_media_instance_t * );
319 VLC_PUBLIC_API void libvlc_media_instance_play ( libvlc_media_instance_t *, libvlc_exception_t * );
320 VLC_PUBLIC_API void libvlc_media_instance_pause ( libvlc_media_instance_t *, libvlc_exception_t * );
322 /// \bug This might go away ... to be replaced by a broader system
323 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_length ( libvlc_media_instance_t *, libvlc_exception_t *);
324 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_time ( libvlc_media_instance_t *, libvlc_exception_t *);
325 VLC_PUBLIC_API void libvlc_media_instance_set_time ( libvlc_media_instance_t *, vlc_int64_t, libvlc_exception_t *);
326 VLC_PUBLIC_API float libvlc_media_instance_get_position ( libvlc_media_instance_t *, libvlc_exception_t *);
327 VLC_PUBLIC_API void libvlc_media_instance_set_position ( libvlc_media_instance_t *, float, libvlc_exception_t *);
328 VLC_PUBLIC_API vlc_bool_t libvlc_media_instance_will_play ( libvlc_media_instance_t *, libvlc_exception_t *);
329 VLC_PUBLIC_API float libvlc_media_instance_get_rate ( libvlc_media_instance_t *, libvlc_exception_t *);
330 VLC_PUBLIC_API void libvlc_media_instance_set_rate ( libvlc_media_instance_t *, float, libvlc_exception_t *);
331 VLC_PUBLIC_API int libvlc_media_instance_get_state ( libvlc_media_instance_t *, libvlc_exception_t *);
334 * Does this input have a video output ?
335 * \param p_input the input
336 * \param p_exception an initialized exception
338 VLC_PUBLIC_API vlc_bool_t libvlc_media_instance_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
339 VLC_PUBLIC_API float libvlc_media_instance_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
344 /** defgroup libvlc_video Video
346 * LibVLC Video handling
351 * Does this input have a video output ?
352 * \param p_input the input
353 * \param p_exception an initialized exception
355 VLC_PUBLIC_API vlc_bool_t libvlc_input_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
356 VLC_PUBLIC_API float libvlc_input_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
359 * Toggle fullscreen status on video output
360 * \param p_input the input
361 * \param p_exception an initialized exception
363 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
366 * Enable or disable fullscreen on a video output
367 * \param p_input the input
368 * \param b_fullscreen boolean for fullscreen status
369 * \param p_exception an initialized exception
371 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_instance_t *, int, libvlc_exception_t * );
374 * Get current fullscreen status
375 * \param p_input the input
376 * \param p_exception an initialized exception
377 * \return the fullscreen status (boolean)
379 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
382 * Get current video height
383 * \param p_input the input
384 * \param p_exception an initialized exception
385 * \return the video height
387 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_instance_t *, libvlc_exception_t * );
390 * Get current video width
391 * \param p_input the input
392 * \param p_exception an initialized exception
393 * \return the video width
395 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_instance_t *, libvlc_exception_t * );
398 * Get current video aspect ratio
399 * \param p_input the input
400 * \param p_exception an initialized exception
401 * \return the video aspect ratio
403 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_instance_t *, libvlc_exception_t * );
406 * Set new video aspect ratio
407 * \param p_input the input
408 * \param psz_aspect new video aspect-ratio
409 * \param p_exception an initialized exception
411 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_instance_t *, char *, libvlc_exception_t * );
414 * Get current video subtitle
415 * \param p_input the input
416 * \param p_exception an initialized exception
417 * \return the video subtitle selected
419 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_instance_t *, libvlc_exception_t * );
422 * Set new video subtitle
423 * \param p_input the input
424 * \param i_spu new video subtitle to select
425 * \param p_exception an initialized exception
427 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_instance_t *, int , libvlc_exception_t * );
430 * Get current crop filter geometry
431 * \param p_input the input
432 * \param p_exception an initialized exception
433 * \return the crop filter geometry
435 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_instance_t *, libvlc_exception_t * );
438 * Set new crop filter geometry
439 * \param p_input the input
440 * \param psz_geometry new crop filter geometry
441 * \param p_exception an initialized exception
443 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_instance_t *, char *, libvlc_exception_t * );
446 * Take a snapshot of the current video window
447 * \param p_input the input
448 * \param psz_filepath the path where to save the screenshot to
449 * \param p_exception an initialized exception
451 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_instance_t *, char *, libvlc_exception_t * );
453 VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *);
456 * Resize the current video output window
457 * \param p_instance libvlc instance
458 * \param width new width for video output window
459 * \param height new height for video output window
460 * \param p_exception an initialized exception
461 * \return the success status (boolean)
463 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *);
466 * change the parent for the current the video output
467 * \param p_instance libvlc instance
468 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
469 * \param p_exception an initialized exception
470 * \return the success status (boolean)
472 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
475 * Tell windowless video output to redraw rectangular area (MacOS X only)
476 * \param p_instance libvlc instance
477 * \param area coordinates within video drawable
478 * \param p_exception an initialized exception
480 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
483 * Set the default video output parent
484 * this settings will be used as default for all video outputs
485 * \param p_instance libvlc instance
486 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
487 * \param p_exception an initialized exception
489 VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
492 * Set the default video output parent
493 * this settings will be used as default for all video outputs
494 * \param p_instance libvlc instance
495 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
496 * \param p_exception an initialized exception
498 VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
501 * Set the default video output size
502 * this settings will be used as default for all video outputs
503 * \param p_instance libvlc instance
504 * \param width new width for video drawable
505 * \param height new height for video drawable
506 * \param p_exception an initialized exception
508 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
511 * Set the default video output viewport for a windowless video output (MacOS X only)
512 * this settings will be used as default for all video outputs
513 * \param p_instance libvlc instance
514 * \param view coordinates within video drawable
515 * \param clip coordinates within video drawable
516 * \param p_exception an initialized exception
518 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
523 * defgroup libvlc_vlm VLM
525 * LibVLC VLM handling
529 /** defgroup libvlc_audio Audio
531 * LibVLC Audio handling
537 * \param p_instance libvlc instance
538 * \param p_exception an initialized exception
541 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
544 * Get current mute status
545 * \param p_instance libvlc instance
546 * \param p_exception an initialized exception
547 * \return the mute status (boolean)
549 VLC_PUBLIC_API vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
553 * \param p_instance libvlc instance
554 * \param status If status is VLC_TRUE then mute, otherwise unmute
555 * \param p_exception an initialized exception
558 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * );
561 * Get current audio level
562 * \param p_instance libvlc instance
563 * \param p_exception an initialized exception
564 * \return the audio level (int)
566 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
569 * Set current audio level
570 * \param p_instance libvlc instance
571 * \param i_volume the volume (int)
572 * \param p_exception an initialized exception
574 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
577 + * Get current audio track
578 + * \param p_input input instance
579 + * \param p_exception an initialized exception
580 + * \return the audio track (int)
582 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_instance_t *, libvlc_exception_t * );
585 * Set current audio track
586 * \param p_input input instance
587 * \param i_track the track (int)
588 * \param p_exception an initialized exception
590 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_instance_t *, int, libvlc_exception_t * );
593 * Get current audio channel
594 * \param p_instance input instance
595 * \param p_exception an initialized exception
596 * \return the audio channel (int)
598 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
601 * Set current audio channel
602 * \param p_instance input instance
603 * \param i_channel the audio channel (int)
604 * \param p_exception an initialized exception
606 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * );
612 * Add a broadcast, with one input
613 * \param p_instance the instance
614 * \param psz_name the name of the new broadcast
615 * \param psz_input the input MRL
616 * \param psz_output the output MRL (the parameter to the "sout" variable)
617 * \param i_options number of additional options
618 * \param ppsz_options additional options
619 * \param b_enabled boolean for enabling the new broadcast
620 * \param b_loop Should this broadcast be played in loop ?
621 * \param p_exception an initialized exception
623 VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
624 int, char **, int, int, libvlc_exception_t * );
627 * Delete a media (vod or broadcast)
628 * \param p_instance the instance
629 * \param psz_name the media to delete
630 * \param p_exception an initialized exception
632 VLC_PUBLIC_API void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
635 * Enable or disable a media (vod or broadcast)
636 * \param p_instance the instance
637 * \param psz_name the media to work on
638 * \param b_enabled the new status
639 * \param p_exception an initialized exception
641 VLC_PUBLIC_API void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
642 libvlc_exception_t *);
645 * Set the output for a media
646 * \param p_instance the instance
647 * \param psz_name the media to work on
648 * \param psz_output the output MRL (the parameter to the "sout" variable)
649 * \param p_exception an initialized exception
651 VLC_PUBLIC_API void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
652 libvlc_exception_t *);
655 * Set a media's input MRL. This will delete all existing inputs and
656 * add the specified one.
657 * \param p_instance the instance
658 * \param psz_name the media to work on
659 * \param psz_input the input MRL
660 * \param p_exception an initialized exception
662 VLC_PUBLIC_API void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
663 libvlc_exception_t *);
666 * Add a media's input MRL. This will add the specified one.
667 * \param p_instance the instance
668 * \param psz_name the media to work on
669 * \param psz_input the input MRL
670 * \param p_exception an initialized exception
672 VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, char *, char *,
673 libvlc_exception_t *p_exception );
675 * Set output for a media
676 * \param p_instance the instance
677 * \param psz_name the media to work on
678 * \param b_loop the new status
679 * \param p_exception an initialized exception
681 VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
682 libvlc_exception_t *);
685 * Edit the parameters of a media. This will delete all existing inputs and
686 * add the specified one.
687 * \param p_instance the instance
688 * \param psz_name the name of the new broadcast
689 * \param psz_input the input MRL
690 * \param psz_output the output MRL (the parameter to the "sout" variable)
691 * \param i_options number of additional options
692 * \param ppsz_options additional options
693 * \param b_enabled boolean for enabling the new broadcast
694 * \param b_loop Should this broadcast be played in loop ?
695 * \param p_exception an initialized exception
697 VLC_PUBLIC_API void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
698 int, char **, int, int, libvlc_exception_t * );
701 * Plays the named broadcast.
702 * \param p_instance the instance
703 * \param psz_name the name of the broadcast
704 * \param p_exception an initialized exception
706 VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
709 * Stops the named broadcast.
710 * \param p_instance the instance
711 * \param psz_name the name of the broadcast
712 * \param p_exception an initialized exception
714 VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
717 * Pauses the named broadcast.
718 * \param p_instance the instance
719 * \param psz_name the name of the broadcast
720 * \param p_exception an initialized exception
722 VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
725 * Seeks in the named broadcast.
726 * \param p_instance the instance
727 * \param psz_name the name of the broadcast
728 * \param f_percentage the percentage to seek to
729 * \param p_exception an initialized exception
731 VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
732 float, libvlc_exception_t * );
735 * Return information of the named broadcast.
736 * \param p_instance the instance
737 * \param psz_name the name of the broadcast
738 * \param p_exception an initialized exception
740 VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
742 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
743 returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \
744 char *, int , libvlc_exception_t * );
746 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1);
747 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time, int, Integer, -1);
748 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length, int, Integer, -1);
749 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate, int, Integer, -1);
750 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title, int, Integer, 0);
751 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter, int, Integer, 0);
752 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
754 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
759 /*****************************************************************************
760 * Message log handling
761 *****************************************************************************/
763 /** defgroup libvlc_log Log
765 * LibVLC Message Logging
770 * Returns the VLC messaging verbosity level
771 * \param p_instance libvlc instance
772 * \param exception an initialized exception pointer
774 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
775 libvlc_exception_t *p_e );
778 * Set the VLC messaging verbosity level
779 * \param p_log libvlc log instance
780 * \param exception an initialized exception pointer
782 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
783 libvlc_exception_t *p_e );
786 * Open an instance to VLC message log
787 * \param p_instance libvlc instance
788 * \param exception an initialized exception pointer
790 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( const libvlc_instance_t *, libvlc_exception_t *);
793 * Close an instance of VLC message log
794 * \param p_log libvlc log instance
795 * \param exception an initialized exception pointer
797 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
800 * Returns the number of messages in log
801 * \param p_log libvlc log instance
802 * \param exception an initialized exception pointer
804 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
807 * Clear all messages in log
808 * the log should be cleared on a regular basis to avoid clogging
809 * \param p_log libvlc log instance
810 * \param exception an initialized exception pointer
812 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
815 * Allocate and returns a new iterator to messages in log
816 * \param p_log libvlc log instance
817 * \param exception an initialized exception pointer
819 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
822 * Releases a previoulsy allocated iterator
823 * \param p_log libvlc log iterator
824 * \param exception an initialized exception pointer
826 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
829 * Returns whether log iterator has more messages
830 * \param p_log libvlc log iterator
831 * \param exception an initialized exception pointer
833 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
836 * Returns next log message
837 * the content of message must not be freed
838 * \param p_log libvlc log iterator
839 * \param exception an initialized exception pointer
841 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
842 struct libvlc_log_message_t *buffer,
843 libvlc_exception_t *p_e );
847 /*****************************************************************************
849 *****************************************************************************/
851 /** defgroup libvlc_callbacks Callbacks
853 * LibVLC Event Callbacks
858 * Register for a callback notification
859 * \param p_instance the libvlc instance
860 * \param i_event_type the desired event mask to which we want to listen
861 * \param f_callback the function to call when i_event_type occurs
862 * \param user_data user provided data to carry with the event
863 * \param p_e an initialized exception pointer
865 VLC_PUBLIC_API void libvlc_event_add_callback( libvlc_instance_t *p_instance,
866 libvlc_event_type_t i_event_type,
867 libvlc_callback_t f_callback,
869 libvlc_exception_t *p_e );
872 * Unregister all callbacks notification from an instance
873 * \param p_instance the libvlc instance
874 * \param p_e an initialized exception pointer
876 VLC_PUBLIC_API void libvlc_event_remove_all_callbacks( libvlc_instance_t *p_instance,
877 libvlc_exception_t *p_e );
880 * Unregister a callback notification
881 * \param p_instance the libvlc instance
882 * \param i_event_type the desired event mask to which we want to unregister
883 * \param f_callback the function to call when i_event_type occurs
884 * \param p_e an initialized exception pointer
886 VLC_PUBLIC_API void libvlc_event_remove_callback( libvlc_instance_t *p_instance,
887 libvlc_event_type_t i_event_type,
888 libvlc_callback_t f_callback,
890 libvlc_exception_t *p_e );
899 #endif /* <vlc/libvlc.h> */