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 );
144 VLC_PUBLIC_API void libvlc_media_descriptor_retain(
145 libvlc_media_descriptor_t *p_meta_desc );
147 VLC_PUBLIC_API void libvlc_media_descriptor_release(
148 libvlc_media_descriptor_t *p_meta_desc );
150 VLC_PUBLIC_API char * libvlc_media_descriptor_get_mrl( libvlc_media_descriptor_t * p_md,
151 libvlc_exception_t * p_e );
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
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 );
165 /*****************************************************************************
167 *****************************************************************************/
168 /** defgroup libvlc_playlist Playlist
170 * LibVLC Playlist handling
177 VLC_PUBLIC_API void libvlc_playlist_loop( libvlc_instance_t* , vlc_bool_t,
178 libvlc_exception_t * );
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
190 VLC_PUBLIC_API void libvlc_playlist_play( libvlc_instance_t*, int, int, char **,
191 libvlc_exception_t * );
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
198 VLC_PUBLIC_API void libvlc_playlist_pause( libvlc_instance_t *, libvlc_exception_t * );
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
206 VLC_PUBLIC_API int libvlc_playlist_isplaying( libvlc_instance_t *, libvlc_exception_t * );
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
214 VLC_PUBLIC_API int libvlc_playlist_items_count( libvlc_instance_t *, libvlc_exception_t * );
217 * Lock the playlist instance
218 * \param p_instance the instance
220 VLC_PUBLIC_API void libvlc_playlist_lock( libvlc_instance_t * );
223 * Unlock the playlist instance
224 * \param p_instance the instance
226 VLC_PUBLIC_API void libvlc_playlist_unlock( libvlc_instance_t * );
230 * \param p_instance the instance to stop
231 * \param p_exception an initialized exception
233 VLC_PUBLIC_API void libvlc_playlist_stop( libvlc_instance_t *, libvlc_exception_t * );
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
240 VLC_PUBLIC_API void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * );
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
247 VLC_PUBLIC_API void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * );
250 * Remove all playlist items
251 * \param p_instance the instance
252 * \param p_exception an initialized exception
254 VLC_PUBLIC_API void libvlc_playlist_clear( libvlc_instance_t *, libvlc_exception_t * );
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
264 VLC_PUBLIC_API int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *,
265 libvlc_exception_t * );
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
277 VLC_PUBLIC_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
278 const char *, int, const char **,
279 libvlc_exception_t * );
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
288 VLC_PUBLIC_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
289 libvlc_exception_t * );
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
296 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_playlist_get_media_instance(
297 libvlc_instance_t *, libvlc_exception_t * );
301 /*****************************************************************************
303 *****************************************************************************/
304 /** defgroup libvlc_media_instance Media Instance
306 * LibVLC Media Instance
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).
314 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new( libvlc_instance_t *, libvlc_exception_t * );
316 /** Create a Media Instance object from a Media Descriptor
317 * \param p_md the media descriptor. Afterwards the p_md can safely be
320 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new_from_media_descriptor( libvlc_media_descriptor_t *, libvlc_exception_t * );
322 /** Release a media_instance after use
323 * \param p_mi the Media Instance to free
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 * );
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
334 VLC_PUBLIC_API void libvlc_media_instance_set_media_descriptor( libvlc_media_instance_t *, libvlc_media_descriptor_t *, libvlc_exception_t * );
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
340 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_instance_get_media_descriptor( libvlc_media_instance_t *, libvlc_exception_t * );
342 /** Get the Event Manager from which the media instance send event.
343 * \param p_mi the Media Instance
345 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_instance_event_manager ( libvlc_media_instance_t *, libvlc_exception_t * );
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 * );
351 VLC_PUBLIC_API void libvlc_media_instance_set_drawable ( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
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 *);
365 * Does this input have a video output ?
366 * \param p_input the input
367 * \param p_exception an initialized exception
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 *);
375 /*****************************************************************************
377 *****************************************************************************/
378 /** defgroup libvlc_tag_query Tag Query
383 VLC_PUBLIC_API libvlc_tag_query_t *
384 libvlc_tag_query_new( libvlc_instance_t *, libvlc_exception_t * );
387 libvlc_tag_query_release( libvlc_tag_query_t * );
390 libvlc_tag_query_retain( libvlc_tag_query_t * );
392 VLC_PUBLIC_API vlc_bool_t
393 libvlc_tag_query_match( libvlc_tag_query_t *, libvlc_media_descriptor_t *,
394 libvlc_exception_t * );
398 /*****************************************************************************
400 *****************************************************************************/
401 /** defgroup libvlc_media_list MediaList
406 VLC_PUBLIC_API libvlc_media_list_t *
407 libvlc_media_list_new( libvlc_instance_t *, libvlc_exception_t * );
410 libvlc_media_list_release( libvlc_media_list_t * );
413 libvlc_media_list_retain( libvlc_media_list_t * );
416 libvlc_media_list_add_media_descriptor( libvlc_media_list_t *,
417 libvlc_media_descriptor_t *,
418 libvlc_exception_t * );
420 libvlc_media_list_insert_media_descriptor( libvlc_media_list_t *,
421 libvlc_media_descriptor_t *,
423 libvlc_exception_t * );
425 libvlc_media_list_remove_index( libvlc_media_list_t *, int,
426 libvlc_exception_t * );
429 libvlc_media_list_count( libvlc_media_list_t * p_mlist,
430 libvlc_exception_t * p_e );
432 VLC_PUBLIC_API libvlc_media_descriptor_t *
433 libvlc_media_list_item_at_index( libvlc_media_list_t *, int,
434 libvlc_exception_t * );
436 libvlc_media_list_index_of_item( libvlc_media_list_t *,
437 libvlc_media_descriptor_t *,
438 libvlc_exception_t * );
441 libvlc_media_list_lock( libvlc_media_list_t * );
443 libvlc_media_list_unlock( libvlc_media_list_t * );
445 VLC_PUBLIC_API libvlc_event_manager_t *
446 libvlc_media_list_event_manager( libvlc_media_list_t *,
447 libvlc_exception_t * );
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 * );
456 /*****************************************************************************
458 *****************************************************************************/
459 /** defgroup libvlc_media_list_player MediaListPlayer
461 * LibVLC Media List Player
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 );
468 libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
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 );
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 );
483 libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
484 libvlc_exception_t * p_e );
487 libvlc_media_list_player_play_item_at_index(
488 libvlc_media_list_player_t * p_mlp,
490 libvlc_exception_t * p_e );
493 libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
494 libvlc_exception_t * p_e );
496 libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
497 libvlc_exception_t * p_e );
501 /** defgroup libvlc_video Video
503 * LibVLC Video handling
508 * Does this input have a video output ?
509 * \param p_input the input
510 * \param p_exception an initialized exception
512 VLC_PUBLIC_API vlc_bool_t libvlc_input_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
513 VLC_PUBLIC_API float libvlc_input_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
516 * Toggle fullscreen status on video output
517 * \param p_input the input
518 * \param p_exception an initialized exception
520 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
523 * Enable or disable fullscreen on a video output
524 * \param p_input the input
525 * \param b_fullscreen boolean for fullscreen status
526 * \param p_exception an initialized exception
528 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_instance_t *, int, libvlc_exception_t * );
531 * Get current fullscreen status
532 * \param p_input the input
533 * \param p_exception an initialized exception
534 * \return the fullscreen status (boolean)
536 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
539 * Get current video height
540 * \param p_input the input
541 * \param p_exception an initialized exception
542 * \return the video height
544 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_instance_t *, libvlc_exception_t * );
547 * Get current video width
548 * \param p_input the input
549 * \param p_exception an initialized exception
550 * \return the video width
552 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_instance_t *, libvlc_exception_t * );
555 * Get current video aspect ratio
556 * \param p_input the input
557 * \param p_exception an initialized exception
558 * \return the video aspect ratio
560 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_instance_t *, libvlc_exception_t * );
563 * Set new video aspect ratio
564 * \param p_input the input
565 * \param psz_aspect new video aspect-ratio
566 * \param p_exception an initialized exception
568 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_instance_t *, char *, libvlc_exception_t * );
571 * Get current video subtitle
572 * \param p_input the input
573 * \param p_exception an initialized exception
574 * \return the video subtitle selected
576 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_instance_t *, libvlc_exception_t * );
579 * Set new video subtitle
580 * \param p_input the input
581 * \param i_spu new video subtitle to select
582 * \param p_exception an initialized exception
584 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_instance_t *, int , libvlc_exception_t * );
587 * Get current crop filter geometry
588 * \param p_input the input
589 * \param p_exception an initialized exception
590 * \return the crop filter geometry
592 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_instance_t *, libvlc_exception_t * );
595 * Set new crop filter geometry
596 * \param p_input the input
597 * \param psz_geometry new crop filter geometry
598 * \param p_exception an initialized exception
600 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_instance_t *, char *, libvlc_exception_t * );
603 * Get current teletext page requested.
604 * \param p_input the input
605 * \param p_exception an initialized exception
606 * \return the current teletext page requested.
608 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
611 * Set new teletext page to retrieve
612 * \param p_input the input
613 * \param i_page teletex page number requested
614 * \param p_exception an initialized exception
616 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_instance_t *, int, libvlc_exception_t * );
619 * Take a snapshot of the current video window
620 * \param p_input the input
621 * \param psz_filepath the path where to save the screenshot to
622 * \param p_exception an initialized exception
624 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_instance_t *, char *, libvlc_exception_t * );
626 VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *);
629 * Resize the current video output window
630 * \param p_instance libvlc instance
631 * \param width new width for video output window
632 * \param height new height for video output window
633 * \param p_exception an initialized exception
634 * \return the success status (boolean)
636 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *);
639 * change the parent for the current the video output
640 * \param p_instance libvlc instance
641 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
642 * \param p_exception an initialized exception
643 * \return the success status (boolean)
645 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
648 * Tell windowless video output to redraw rectangular area (MacOS X only)
649 * \param p_instance libvlc instance
650 * \param area coordinates within video drawable
651 * \param p_exception an initialized exception
653 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
656 * Set the default video output parent
657 * this settings will be used as default for all video outputs
658 * \param p_instance libvlc instance
659 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
660 * \param p_exception an initialized exception
662 VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
665 * Set the default video output parent
666 * this settings will be used as default for all video outputs
667 * \param p_instance libvlc instance
668 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
669 * \param p_exception an initialized exception
671 VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
674 * Set the default video output size
675 * this settings will be used as default for all video outputs
676 * \param p_instance libvlc instance
677 * \param width new width for video drawable
678 * \param height new height for video drawable
679 * \param p_exception an initialized exception
681 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
684 * Set the default video output viewport for a windowless video output (MacOS X only)
685 * this settings will be used as default for all video outputs
686 * \param p_instance libvlc instance
687 * \param view coordinates within video drawable
688 * \param clip coordinates within video drawable
689 * \param p_exception an initialized exception
691 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
696 * defgroup libvlc_vlm VLM
698 * LibVLC VLM handling
702 /** defgroup libvlc_audio Audio
704 * LibVLC Audio handling
710 * \param p_instance libvlc instance
711 * \param p_exception an initialized exception
714 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
717 * Get current mute status
718 * \param p_instance libvlc instance
719 * \param p_exception an initialized exception
720 * \return the mute status (boolean)
722 VLC_PUBLIC_API vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
726 * \param p_instance libvlc instance
727 * \param status If status is VLC_TRUE then mute, otherwise unmute
728 * \param p_exception an initialized exception
731 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * );
734 * Get current audio level
735 * \param p_instance libvlc instance
736 * \param p_exception an initialized exception
737 * \return the audio level (int)
739 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
742 * Set current audio level
743 * \param p_instance libvlc instance
744 * \param i_volume the volume (int)
745 * \param p_exception an initialized exception
747 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
750 + * Get current audio track
751 + * \param p_input input instance
752 + * \param p_exception an initialized exception
753 + * \return the audio track (int)
755 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_instance_t *, libvlc_exception_t * );
758 * Set current audio track
759 * \param p_input input instance
760 * \param i_track the track (int)
761 * \param p_exception an initialized exception
763 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_instance_t *, int, libvlc_exception_t * );
766 * Get current audio channel
767 * \param p_instance input instance
768 * \param p_exception an initialized exception
769 * \return the audio channel (int)
771 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
774 * Set current audio channel
775 * \param p_instance input instance
776 * \param i_channel the audio channel (int)
777 * \param p_exception an initialized exception
779 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * );
785 * Add a broadcast, with one input
786 * \param p_instance the instance
787 * \param psz_name the name of the new broadcast
788 * \param psz_input the input MRL
789 * \param psz_output the output MRL (the parameter to the "sout" variable)
790 * \param i_options number of additional options
791 * \param ppsz_options additional options
792 * \param b_enabled boolean for enabling the new broadcast
793 * \param b_loop Should this broadcast be played in loop ?
794 * \param p_exception an initialized exception
796 VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
797 int, char **, int, int, libvlc_exception_t * );
800 * Delete a media (vod or broadcast)
801 * \param p_instance the instance
802 * \param psz_name the media to delete
803 * \param p_exception an initialized exception
805 VLC_PUBLIC_API void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
808 * Enable or disable a media (vod or broadcast)
809 * \param p_instance the instance
810 * \param psz_name the media to work on
811 * \param b_enabled the new status
812 * \param p_exception an initialized exception
814 VLC_PUBLIC_API void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
815 libvlc_exception_t *);
818 * Set the output for a media
819 * \param p_instance the instance
820 * \param psz_name the media to work on
821 * \param psz_output the output MRL (the parameter to the "sout" variable)
822 * \param p_exception an initialized exception
824 VLC_PUBLIC_API void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
825 libvlc_exception_t *);
828 * Set a media's input MRL. This will delete all existing inputs and
829 * add the specified one.
830 * \param p_instance the instance
831 * \param psz_name the media to work on
832 * \param psz_input the input MRL
833 * \param p_exception an initialized exception
835 VLC_PUBLIC_API void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
836 libvlc_exception_t *);
839 * Add a media's input MRL. This will add the specified one.
840 * \param p_instance the instance
841 * \param psz_name the media to work on
842 * \param psz_input the input MRL
843 * \param p_exception an initialized exception
845 VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, char *, char *,
846 libvlc_exception_t *p_exception );
848 * Set output for a media
849 * \param p_instance the instance
850 * \param psz_name the media to work on
851 * \param b_loop the new status
852 * \param p_exception an initialized exception
854 VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
855 libvlc_exception_t *);
858 * Edit the parameters of a media. This will delete all existing inputs and
859 * add the specified one.
860 * \param p_instance the instance
861 * \param psz_name the name of the new broadcast
862 * \param psz_input the input MRL
863 * \param psz_output the output MRL (the parameter to the "sout" variable)
864 * \param i_options number of additional options
865 * \param ppsz_options additional options
866 * \param b_enabled boolean for enabling the new broadcast
867 * \param b_loop Should this broadcast be played in loop ?
868 * \param p_exception an initialized exception
870 VLC_PUBLIC_API void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
871 int, char **, int, int, libvlc_exception_t * );
874 * Plays the named broadcast.
875 * \param p_instance the instance
876 * \param psz_name the name of the broadcast
877 * \param p_exception an initialized exception
879 VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
882 * Stops the named broadcast.
883 * \param p_instance the instance
884 * \param psz_name the name of the broadcast
885 * \param p_exception an initialized exception
887 VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
890 * Pauses the named broadcast.
891 * \param p_instance the instance
892 * \param psz_name the name of the broadcast
893 * \param p_exception an initialized exception
895 VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
898 * Seeks in the named broadcast.
899 * \param p_instance the instance
900 * \param psz_name the name of the broadcast
901 * \param f_percentage the percentage to seek to
902 * \param p_exception an initialized exception
904 VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
905 float, libvlc_exception_t * );
908 * Return information of the named broadcast.
909 * \param p_instance the instance
910 * \param psz_name the name of the broadcast
911 * \param p_exception an initialized exception
913 VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
915 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
916 returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \
917 char *, int , libvlc_exception_t * );
919 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1);
920 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time, int, Integer, -1);
921 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length, int, Integer, -1);
922 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate, int, Integer, -1);
923 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title, int, Integer, 0);
924 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter, int, Integer, 0);
925 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
927 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
932 /*****************************************************************************
933 * Message log handling
934 *****************************************************************************/
936 /** defgroup libvlc_log Log
938 * LibVLC Message Logging
943 * Returns the VLC messaging verbosity level
944 * \param p_instance libvlc instance
945 * \param exception an initialized exception pointer
947 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
948 libvlc_exception_t *p_e );
951 * Set the VLC messaging verbosity level
952 * \param p_log libvlc log instance
953 * \param exception an initialized exception pointer
955 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
956 libvlc_exception_t *p_e );
959 * Open an instance to VLC message log
960 * \param p_instance libvlc instance
961 * \param exception an initialized exception pointer
963 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( const libvlc_instance_t *, libvlc_exception_t *);
966 * Close an instance of VLC message log
967 * \param p_log libvlc log instance
968 * \param exception an initialized exception pointer
970 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
973 * Returns the number of messages in log
974 * \param p_log libvlc log instance
975 * \param exception an initialized exception pointer
977 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
980 * Clear all messages in log
981 * the log should be cleared on a regular basis to avoid clogging
982 * \param p_log libvlc log instance
983 * \param exception an initialized exception pointer
985 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
988 * Allocate and returns a new iterator to messages in log
989 * \param p_log libvlc log instance
990 * \param exception an initialized exception pointer
992 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
995 * Releases a previoulsy allocated iterator
996 * \param p_log libvlc log iterator
997 * \param exception an initialized exception pointer
999 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1002 * Returns whether log iterator has more messages
1003 * \param p_log libvlc log iterator
1004 * \param exception an initialized exception pointer
1006 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1009 * Returns next log message
1010 * the content of message must not be freed
1011 * \param p_log libvlc log iterator
1012 * \param exception an initialized exception pointer
1014 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
1015 struct libvlc_log_message_t *buffer,
1016 libvlc_exception_t *p_e );
1020 /*****************************************************************************
1022 *****************************************************************************/
1024 /** defgroup libvlc_callbacks Callbacks
1031 * Register for an event notification
1032 * \param p_event_manager the event manager to which you want to attach to
1033 * Generally it is obtained by vlc_my_object_event_manager() where my_object
1034 * Is the object you want to listen to.
1035 * \param i_event_type the desired event to which we want to listen
1036 * \param f_callback the function to call when i_event_type occurs
1037 * \param user_data user provided data to carry with the event
1038 * \param p_e an initialized exception pointer
1040 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
1041 libvlc_event_type_t i_event_type,
1042 libvlc_callback_t f_callback,
1044 libvlc_exception_t *p_e );
1047 * Unregister an event notification
1048 * \param p_event_manager the event manager
1049 * \param i_event_type the desired event to which we want to unregister
1050 * \param f_callback the function to call when i_event_type occurs
1051 * \param p_e an initialized exception pointer
1053 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
1054 libvlc_event_type_t i_event_type,
1055 libvlc_callback_t f_callback,
1057 libvlc_exception_t *p_e );
1061 * Get an event type name
1062 * \param i_event_type the desired event
1064 #define libvlc_event_type_name(a) #a
1073 #endif /* <vlc/libvlc.h> */