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 * );
124 /*****************************************************************************
126 *****************************************************************************/
127 /** defgroup libvlc_tree Tree
129 * LibVLC Tree. A tree holds an item plus several subtrees.
132 VLC_PUBLIC_API libvlc_tree_t *
133 libvlc_tree_new_with_media_list_as_item( libvlc_media_list_t * p_mlist,
134 libvlc_exception_t * p_e );
136 VLC_PUBLIC_API libvlc_tree_t *
137 libvlc_tree_new_with_string_as_item( const char * psz,
138 libvlc_exception_t * p_e );
140 libvlc_tree_release( libvlc_tree_t * p_tree );
143 libvlc_tree_retain( libvlc_tree_t * p_tree );
145 VLC_PUBLIC_API char *
146 libvlc_tree_item_as_string( libvlc_tree_t * p_tree,
147 libvlc_exception_t * p_e );
149 VLC_PUBLIC_API libvlc_media_list_t *
150 libvlc_tree_item_as_media_list( libvlc_tree_t * p_tree,
151 libvlc_exception_t * p_e );
154 libvlc_tree_subtree_count( libvlc_tree_t * p_tree, libvlc_exception_t * p_e );
156 VLC_PUBLIC_API libvlc_tree_t *
157 libvlc_tree_subtree_at_index( libvlc_tree_t * p_tree,
159 libvlc_exception_t * p_e );
162 libvlc_tree_insert_subtree_at_index( libvlc_tree_t * p_tree,
163 libvlc_tree_t * p_subtree,
165 libvlc_exception_t * p_e );
168 libvlc_tree_remove_subtree_at_index( libvlc_tree_t * p_tree,
170 libvlc_exception_t * p_e );
176 /*****************************************************************************
178 *****************************************************************************/
179 /** defgroup libvlc_media_descriptor Media Descriptor
181 * LibVLC Media Descriptor
186 * Create a media descriptor with the given mrl.
187 * \param p_instance the instance
188 * \param psz_mrl the mrl to read
190 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_new(
191 libvlc_instance_t *p_instance,
192 const char * psz_mrl,
193 libvlc_exception_t *p_e );
195 VLC_PUBLIC_API void libvlc_media_descriptor_retain(
196 libvlc_media_descriptor_t *p_meta_desc );
198 VLC_PUBLIC_API void libvlc_media_descriptor_release(
199 libvlc_media_descriptor_t *p_meta_desc );
201 VLC_PUBLIC_API char * libvlc_media_descriptor_get_mrl( libvlc_media_descriptor_t * p_md,
202 libvlc_exception_t * p_e );
205 * Read the meta of the media descriptor.
206 * \param p_meta_desc the media descriptor to read
207 * \param p_meta_desc the meta to read
209 VLC_PUBLIC_API char * libvlc_media_descriptor_get_meta(
210 libvlc_media_descriptor_t *p_meta_desc,
211 libvlc_meta_t e_meta,
212 libvlc_exception_t *p_e );
215 VLC_PUBLIC_API void libvlc_media_descriptor_add_tag( libvlc_media_descriptor_t *p_md,
217 const libvlc_tag_t tag,
218 libvlc_exception_t *p_e );
220 VLC_PUBLIC_API void libvlc_media_descriptor_remove_tag( libvlc_media_descriptor_t *p_md,
222 const libvlc_tag_t tag,
223 libvlc_exception_t *p_e );
226 libvlc_media_descriptor_tags_count_for_key( libvlc_media_descriptor_t *p_md,
228 libvlc_exception_t *p_e );
230 VLC_PUBLIC_API libvlc_tag_t
231 libvlc_media_descriptor_tag_at_index_for_key( libvlc_media_descriptor_t *p_md,
234 libvlc_exception_t *p_e );
238 /*****************************************************************************
240 *****************************************************************************/
241 /** defgroup libvlc_playlist Playlist
243 * LibVLC Playlist handling
250 VLC_PUBLIC_API void libvlc_playlist_loop( libvlc_instance_t* , vlc_bool_t,
251 libvlc_exception_t * );
254 * Start playing. You can give some additionnal playlist item options
255 * that will be added to the item before playing it.
256 * \param p_instance the instance
257 * \param i_id the item to play. If this is a negative number, the next
258 * item will be selected. Else, the item with the given ID will be played
259 * \param i_options the number of options to add to the item
260 * \param ppsz_options the options to add to the item
261 * \param p_exception an initialized exception
263 VLC_PUBLIC_API void libvlc_playlist_play( libvlc_instance_t*, int, int, char **,
264 libvlc_exception_t * );
267 * Pause a running playlist, resume if it was stopped
268 * \param p_instance the instance to pause
269 * \param p_exception an initialized exception
271 VLC_PUBLIC_API void libvlc_playlist_pause( libvlc_instance_t *, libvlc_exception_t * );
274 * Checks if the playlist is running
275 * \param p_instance the instance
276 * \param p_exception an initialized exception
277 * \return 0 if the playlist is stopped or paused, 1 if it is running
279 VLC_PUBLIC_API int libvlc_playlist_isplaying( libvlc_instance_t *, libvlc_exception_t * );
282 * Get the number of items in the playlist
283 * \param p_instance the instance
284 * \param p_exception an initialized exception
285 * \return the number of items
287 VLC_PUBLIC_API int libvlc_playlist_items_count( libvlc_instance_t *, libvlc_exception_t * );
290 * Lock the playlist instance
291 * \param p_instance the instance
293 VLC_PUBLIC_API void libvlc_playlist_lock( libvlc_instance_t * );
296 * Unlock the playlist instance
297 * \param p_instance the instance
299 VLC_PUBLIC_API void libvlc_playlist_unlock( libvlc_instance_t * );
303 * \param p_instance the instance to stop
304 * \param p_exception an initialized exception
306 VLC_PUBLIC_API void libvlc_playlist_stop( libvlc_instance_t *, libvlc_exception_t * );
309 * Go to next playlist item (starts playback if it was stopped)
310 * \param p_instance the instance to use
311 * \param p_exception an initialized exception
313 VLC_PUBLIC_API void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * );
316 * Go to previous playlist item (starts playback if it was stopped)
317 * \param p_instance the instance to use
318 * \param p_exception an initialized exception
320 VLC_PUBLIC_API void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * );
323 * Remove all playlist items
324 * \param p_instance the instance
325 * \param p_exception an initialized exception
327 VLC_PUBLIC_API void libvlc_playlist_clear( libvlc_instance_t *, libvlc_exception_t * );
330 * Add an item at the end of the playlist
331 * If you need more advanced options, \see libvlc_playlist_add_extended
332 * \param p_instance the instance
333 * \param psz_uri the URI to open, using VLC format
334 * \param psz_name a name that you might want to give or NULL
335 * \return the identifier of the new item
337 VLC_PUBLIC_API int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *,
338 libvlc_exception_t * );
341 * Add an item at the end of the playlist, with additional input options
342 * \param p_instance the instance
343 * \param psz_uri the URI to open, using VLC format
344 * \param psz_name a name that you might want to give or NULL
345 * \param i_options the number of options to add
346 * \param ppsz_options strings representing the options to add
347 * \param p_exception an initialized exception
348 * \return the identifier of the new item
350 VLC_PUBLIC_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
351 const char *, int, const char **,
352 libvlc_exception_t * );
355 * Delete the playlist item with the given ID.
356 * \param p_instance the instance
357 * \param i_id the id to remove
358 * \param p_exception an initialized exception
361 VLC_PUBLIC_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
362 libvlc_exception_t * );
364 /* Get the input that is currently being played by the playlist
365 * \param p_instance the instance to use
366 * \param p_exception an initialized excecption
367 * \return an input object
369 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_playlist_get_media_instance(
370 libvlc_instance_t *, libvlc_exception_t * );
374 /*****************************************************************************
376 *****************************************************************************/
377 /** defgroup libvlc_media_instance Media Instance
379 * LibVLC Media Instance
383 /** Create an empty Media Instance object
384 * \param p_libvlc_instance the libvlc instance in which the Media Instance
385 * should be (not used for now).
387 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new( libvlc_instance_t *, libvlc_exception_t * );
389 /** Create a Media Instance object from a Media Descriptor
390 * \param p_md the media descriptor. Afterwards the p_md can safely be
393 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new_from_media_descriptor( libvlc_media_descriptor_t *, libvlc_exception_t * );
395 /** Release a media_instance after use
396 * \param p_mi the Media Instance to free
398 VLC_PUBLIC_API void libvlc_media_instance_release( libvlc_media_instance_t * );
399 VLC_PUBLIC_API void libvlc_media_instance_retain( libvlc_media_instance_t * );
401 /** Set the media descriptor that will be used by the media_instance. If any,
402 * previous md will be released.
403 * \param p_mi the Media Instance
404 * \param p_md the Media Descriptor. Afterwards the p_md can safely be
407 VLC_PUBLIC_API void libvlc_media_instance_set_media_descriptor( libvlc_media_instance_t *, libvlc_media_descriptor_t *, libvlc_exception_t * );
409 /** Get the media descriptor used by the media_instance (if any). A copy of
410 * the md is returned. NULL is returned if no media instance is associated.
411 * \param p_mi the Media Instance
413 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_instance_get_media_descriptor( libvlc_media_instance_t *, libvlc_exception_t * );
415 /** Get the Event Manager from which the media instance send event.
416 * \param p_mi the Media Instance
418 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_instance_event_manager ( libvlc_media_instance_t *, libvlc_exception_t * );
420 VLC_PUBLIC_API void libvlc_media_instance_play ( libvlc_media_instance_t *, libvlc_exception_t * );
421 VLC_PUBLIC_API void libvlc_media_instance_pause ( libvlc_media_instance_t *, libvlc_exception_t * );
422 VLC_PUBLIC_API void libvlc_media_instance_stop ( libvlc_media_instance_t *, libvlc_exception_t * );
424 VLC_PUBLIC_API void libvlc_media_instance_set_drawable ( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
426 /// \bug This might go away ... to be replaced by a broader system
427 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_length ( libvlc_media_instance_t *, libvlc_exception_t *);
428 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_time ( libvlc_media_instance_t *, libvlc_exception_t *);
429 VLC_PUBLIC_API void libvlc_media_instance_set_time ( libvlc_media_instance_t *, vlc_int64_t, libvlc_exception_t *);
430 VLC_PUBLIC_API float libvlc_media_instance_get_position ( libvlc_media_instance_t *, libvlc_exception_t *);
431 VLC_PUBLIC_API void libvlc_media_instance_set_position ( libvlc_media_instance_t *, float, libvlc_exception_t *);
432 VLC_PUBLIC_API vlc_bool_t libvlc_media_instance_will_play ( libvlc_media_instance_t *, libvlc_exception_t *);
433 VLC_PUBLIC_API float libvlc_media_instance_get_rate ( libvlc_media_instance_t *, libvlc_exception_t *);
434 VLC_PUBLIC_API void libvlc_media_instance_set_rate ( libvlc_media_instance_t *, float, libvlc_exception_t *);
435 VLC_PUBLIC_API int libvlc_media_instance_get_state ( libvlc_media_instance_t *, libvlc_exception_t *);
438 * Does this input have a video output ?
439 * \param p_input the input
440 * \param p_exception an initialized exception
442 VLC_PUBLIC_API vlc_bool_t libvlc_media_instance_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
443 VLC_PUBLIC_API float libvlc_media_instance_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
448 /*****************************************************************************
450 *****************************************************************************/
451 /** defgroup libvlc_tag_query Tag Query
456 VLC_PUBLIC_API libvlc_tag_query_t *
457 libvlc_tag_query_new( libvlc_instance_t *, libvlc_exception_t * );
460 libvlc_tag_query_release( libvlc_tag_query_t * );
463 libvlc_tag_query_retain( libvlc_tag_query_t * );
465 VLC_PUBLIC_API vlc_bool_t
466 libvlc_tag_query_match( libvlc_tag_query_t *, libvlc_media_descriptor_t *,
467 libvlc_exception_t * );
471 /*****************************************************************************
473 *****************************************************************************/
474 /** defgroup libvlc_media_list MediaList
479 VLC_PUBLIC_API libvlc_media_list_t *
480 libvlc_media_list_new( libvlc_instance_t *, libvlc_exception_t * );
483 libvlc_media_list_release( libvlc_media_list_t * );
486 libvlc_media_list_retain( libvlc_media_list_t * );
489 libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
490 const char * psz_uri,
491 libvlc_exception_t * p_e );
494 libvlc_media_list_set_name( libvlc_media_list_t *,
495 const char * psz_name,
496 libvlc_exception_t *);
498 VLC_PUBLIC_API char *
499 libvlc_media_list_name( libvlc_media_list_t *,
500 libvlc_exception_t *);
503 libvlc_media_list_add_media_descriptor( libvlc_media_list_t *,
504 libvlc_media_descriptor_t *,
505 libvlc_exception_t * );
507 libvlc_media_list_insert_media_descriptor( libvlc_media_list_t *,
508 libvlc_media_descriptor_t *,
510 libvlc_exception_t * );
512 libvlc_media_list_remove_index( libvlc_media_list_t *, int,
513 libvlc_exception_t * );
516 libvlc_media_list_count( libvlc_media_list_t * p_mlist,
517 libvlc_exception_t * p_e );
519 VLC_PUBLIC_API libvlc_media_descriptor_t *
520 libvlc_media_list_item_at_index( libvlc_media_list_t *, int,
521 libvlc_exception_t * );
523 libvlc_media_list_index_of_item( libvlc_media_list_t *,
524 libvlc_media_descriptor_t *,
525 libvlc_exception_t * );
528 libvlc_media_list_lock( libvlc_media_list_t * );
530 libvlc_media_list_unlock( libvlc_media_list_t * );
532 VLC_PUBLIC_API libvlc_event_manager_t *
533 libvlc_media_list_event_manager( libvlc_media_list_t *,
534 libvlc_exception_t * );
537 /*****************************************************************************
539 *****************************************************************************/
540 /** defgroup libvlc_media_list MediaList
545 VLC_PUBLIC_API libvlc_dynamic_media_list_t *
546 libvlc_dynamic_media_list_new( libvlc_media_list_t * p_mlist,
547 libvlc_tag_query_t * p_query,
549 libvlc_exception_t * p_e );
551 libvlc_dynamic_media_list_release( libvlc_dynamic_media_list_t * p_dmlist );
554 libvlc_dynamic_media_list_retain( libvlc_dynamic_media_list_t * p_dmlist );
556 libvlc_media_list_t *
557 libvlc_dynamic_media_list_media_list( libvlc_dynamic_media_list_t * p_dmlist,
558 libvlc_exception_t * p_e );
562 /*****************************************************************************
564 *****************************************************************************/
565 /** defgroup libvlc_media_library Media Library
567 * LibVLC Media Library
570 VLC_PUBLIC_API libvlc_media_library_t *
571 libvlc_media_library_new( libvlc_instance_t * p_inst,
572 libvlc_exception_t * p_e );
574 libvlc_media_library_release( libvlc_media_library_t * p_mlib );
576 libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
580 libvlc_media_library_load( libvlc_media_library_t * p_mlib,
581 libvlc_exception_t * p_e );
584 libvlc_media_library_save( libvlc_media_library_t * p_mlib,
585 libvlc_exception_t * p_e );
587 VLC_PUBLIC_API libvlc_media_list_t *
588 libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
589 libvlc_exception_t * p_e );
594 /*****************************************************************************
596 *****************************************************************************/
597 /** defgroup libvlc_media_list_player MediaListPlayer
599 * LibVLC Media List Player
602 VLC_PUBLIC_API libvlc_media_list_player_t *
603 libvlc_media_list_player_new( libvlc_instance_t * p_instance,
604 libvlc_exception_t * p_e );
606 libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
609 libvlc_media_list_player_set_media_instance(
610 libvlc_media_list_player_t * p_mlp,
611 libvlc_media_instance_t * p_mi,
612 libvlc_exception_t * p_e );
615 libvlc_media_list_player_set_media_list(
616 libvlc_media_list_player_t * p_mlp,
617 libvlc_media_list_t * p_mlist,
618 libvlc_exception_t * p_e );
621 libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
622 libvlc_exception_t * p_e );
625 libvlc_media_list_player_play_item_at_index(
626 libvlc_media_list_player_t * p_mlp,
628 libvlc_exception_t * p_e );
631 libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
632 libvlc_exception_t * p_e );
634 libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
635 libvlc_exception_t * p_e );
639 /** defgroup libvlc_video Video
641 * LibVLC Video handling
646 * Does this input have a video output ?
647 * \param p_input the input
648 * \param p_exception an initialized exception
650 VLC_PUBLIC_API vlc_bool_t libvlc_input_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
651 VLC_PUBLIC_API float libvlc_input_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
654 * Toggle fullscreen status on video output
655 * \param p_input the input
656 * \param p_exception an initialized exception
658 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
661 * Enable or disable fullscreen on a video output
662 * \param p_input the input
663 * \param b_fullscreen boolean for fullscreen status
664 * \param p_exception an initialized exception
666 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_instance_t *, int, libvlc_exception_t * );
669 * Get current fullscreen status
670 * \param p_input the input
671 * \param p_exception an initialized exception
672 * \return the fullscreen status (boolean)
674 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
677 * Get current video height
678 * \param p_input the input
679 * \param p_exception an initialized exception
680 * \return the video height
682 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_instance_t *, libvlc_exception_t * );
685 * Get current video width
686 * \param p_input the input
687 * \param p_exception an initialized exception
688 * \return the video width
690 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_instance_t *, libvlc_exception_t * );
693 * Get current video aspect ratio
694 * \param p_input the input
695 * \param p_exception an initialized exception
696 * \return the video aspect ratio
698 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_instance_t *, libvlc_exception_t * );
701 * Set new video aspect ratio
702 * \param p_input the input
703 * \param psz_aspect new video aspect-ratio
704 * \param p_exception an initialized exception
706 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_instance_t *, char *, libvlc_exception_t * );
709 * Get current video subtitle
710 * \param p_input the input
711 * \param p_exception an initialized exception
712 * \return the video subtitle selected
714 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_instance_t *, libvlc_exception_t * );
717 * Set new video subtitle
718 * \param p_input the input
719 * \param i_spu new video subtitle to select
720 * \param p_exception an initialized exception
722 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_instance_t *, int , libvlc_exception_t * );
725 * Get current crop filter geometry
726 * \param p_input the input
727 * \param p_exception an initialized exception
728 * \return the crop filter geometry
730 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_instance_t *, libvlc_exception_t * );
733 * Set new crop filter geometry
734 * \param p_input the input
735 * \param psz_geometry new crop filter geometry
736 * \param p_exception an initialized exception
738 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_instance_t *, char *, libvlc_exception_t * );
741 * Get current teletext page requested.
742 * \param p_input the input
743 * \param p_exception an initialized exception
744 * \return the current teletext page requested.
746 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
749 * Set new teletext page to retrieve
750 * \param p_input the input
751 * \param i_page teletex page number requested
752 * \param p_exception an initialized exception
754 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_instance_t *, int, libvlc_exception_t * );
757 * Take a snapshot of the current video window
758 * \param p_input the input
759 * \param psz_filepath the path where to save the screenshot to
760 * \param p_exception an initialized exception
762 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_instance_t *, char *, libvlc_exception_t * );
764 VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *);
767 * Resize the current video output window
768 * \param p_instance libvlc instance
769 * \param width new width for video output window
770 * \param height new height for video output window
771 * \param p_exception an initialized exception
772 * \return the success status (boolean)
774 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *);
777 * change the parent for the current the video output
778 * \param p_instance libvlc instance
779 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
780 * \param p_exception an initialized exception
781 * \return the success status (boolean)
783 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
786 * Tell windowless video output to redraw rectangular area (MacOS X only)
787 * \param p_instance libvlc instance
788 * \param area coordinates within video drawable
789 * \param p_exception an initialized exception
791 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
794 * Set the default video output parent
795 * this settings will be used as default for all video outputs
796 * \param p_instance libvlc instance
797 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
798 * \param p_exception an initialized exception
800 VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
803 * Set the default video output parent
804 * this settings will be used as default for all video outputs
805 * \param p_instance libvlc instance
806 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
807 * \param p_exception an initialized exception
809 VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
812 * Set the default video output size
813 * this settings will be used as default for all video outputs
814 * \param p_instance libvlc instance
815 * \param width new width for video drawable
816 * \param height new height for video drawable
817 * \param p_exception an initialized exception
819 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
822 * Set the default video output viewport for a windowless video output (MacOS X only)
823 * this settings will be used as default for all video outputs
824 * \param p_instance libvlc instance
825 * \param view coordinates within video drawable
826 * \param clip coordinates within video drawable
827 * \param p_exception an initialized exception
829 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
833 /** defgroup libvlc_audio Audio
835 * LibVLC Audio handling
841 * \param p_instance libvlc instance
842 * \param p_exception an initialized exception
845 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
848 * Get current mute status
849 * \param p_instance libvlc instance
850 * \param p_exception an initialized exception
851 * \return the mute status (boolean)
853 VLC_PUBLIC_API vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
857 * \param p_instance libvlc instance
858 * \param status If status is VLC_TRUE then mute, otherwise unmute
859 * \param p_exception an initialized exception
862 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * );
865 * Get current audio level
866 * \param p_instance libvlc instance
867 * \param p_exception an initialized exception
868 * \return the audio level (int)
870 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
873 * Set current audio level
874 * \param p_instance libvlc instance
875 * \param i_volume the volume (int)
876 * \param p_exception an initialized exception
878 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
881 + * Get current audio track
882 + * \param p_input input instance
883 + * \param p_exception an initialized exception
884 + * \return the audio track (int)
886 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_instance_t *, libvlc_exception_t * );
889 * Set current audio track
890 * \param p_input input instance
891 * \param i_track the track (int)
892 * \param p_exception an initialized exception
894 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_instance_t *, int, libvlc_exception_t * );
897 * Get current audio channel
898 * \param p_instance input instance
899 * \param p_exception an initialized exception
900 * \return the audio channel (int)
902 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
905 * Set current audio channel
906 * \param p_instance input instance
907 * \param i_channel the audio channel (int)
908 * \param p_exception an initialized exception
910 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * );
914 /*****************************************************************************
915 * Services/Media Discovery
916 *****************************************************************************/
917 /** defgroup libvlc_media_discoverer Media Discoverer
919 * LibVLC Media Discoverer
923 VLC_PUBLIC_API libvlc_media_discoverer_t *
924 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
925 const char * psz_name,
926 libvlc_exception_t * p_e );
927 VLC_PUBLIC_API void libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
928 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
930 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
934 /*****************************************************************************
936 *****************************************************************************/
937 /** defgroup libvlc_vlm VLM
944 * Add a broadcast, with one input
945 * \param p_instance the instance
946 * \param psz_name the name of the new broadcast
947 * \param psz_input the input MRL
948 * \param psz_output the output MRL (the parameter to the "sout" variable)
949 * \param i_options number of additional options
950 * \param ppsz_options additional options
951 * \param b_enabled boolean for enabling the new broadcast
952 * \param b_loop Should this broadcast be played in loop ?
953 * \param p_exception an initialized exception
955 VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
956 int, char **, int, int, libvlc_exception_t * );
959 * Delete a media (vod or broadcast)
960 * \param p_instance the instance
961 * \param psz_name the media to delete
962 * \param p_exception an initialized exception
964 VLC_PUBLIC_API void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
967 * Enable or disable a media (vod or broadcast)
968 * \param p_instance the instance
969 * \param psz_name the media to work on
970 * \param b_enabled the new status
971 * \param p_exception an initialized exception
973 VLC_PUBLIC_API void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
974 libvlc_exception_t *);
977 * Set the output for a media
978 * \param p_instance the instance
979 * \param psz_name the media to work on
980 * \param psz_output the output MRL (the parameter to the "sout" variable)
981 * \param p_exception an initialized exception
983 VLC_PUBLIC_API void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
984 libvlc_exception_t *);
987 * Set a media's input MRL. This will delete all existing inputs and
988 * add the specified one.
989 * \param p_instance the instance
990 * \param psz_name the media to work on
991 * \param psz_input the input MRL
992 * \param p_exception an initialized exception
994 VLC_PUBLIC_API void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
995 libvlc_exception_t *);
998 * Add a media's input MRL. This will add the specified one.
999 * \param p_instance the instance
1000 * \param psz_name the media to work on
1001 * \param psz_input the input MRL
1002 * \param p_exception an initialized exception
1004 VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, char *, char *,
1005 libvlc_exception_t *p_exception );
1007 * Set output for a media
1008 * \param p_instance the instance
1009 * \param psz_name the media to work on
1010 * \param b_loop the new status
1011 * \param p_exception an initialized exception
1013 VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
1014 libvlc_exception_t *);
1017 * Edit the parameters of a media. This will delete all existing inputs and
1018 * add the specified one.
1019 * \param p_instance the instance
1020 * \param psz_name the name of the new broadcast
1021 * \param psz_input the input MRL
1022 * \param psz_output the output MRL (the parameter to the "sout" variable)
1023 * \param i_options number of additional options
1024 * \param ppsz_options additional options
1025 * \param b_enabled boolean for enabling the new broadcast
1026 * \param b_loop Should this broadcast be played in loop ?
1027 * \param p_exception an initialized exception
1029 VLC_PUBLIC_API void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
1030 int, char **, int, int, libvlc_exception_t * );
1033 * Plays the named broadcast.
1034 * \param p_instance the instance
1035 * \param psz_name the name of the broadcast
1036 * \param p_exception an initialized exception
1038 VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1041 * Stops the named broadcast.
1042 * \param p_instance the instance
1043 * \param psz_name the name of the broadcast
1044 * \param p_exception an initialized exception
1046 VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1049 * Pauses the named broadcast.
1050 * \param p_instance the instance
1051 * \param psz_name the name of the broadcast
1052 * \param p_exception an initialized exception
1054 VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1057 * Seeks in the named broadcast.
1058 * \param p_instance the instance
1059 * \param psz_name the name of the broadcast
1060 * \param f_percentage the percentage to seek to
1061 * \param p_exception an initialized exception
1063 VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
1064 float, libvlc_exception_t * );
1067 * Return information of the named broadcast.
1068 * \param p_instance the instance
1069 * \param psz_name the name of the broadcast
1070 * \param p_exception an initialized exception
1072 VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1074 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
1075 returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \
1076 char *, int , libvlc_exception_t * );
1078 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1);
1079 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time, int, Integer, -1);
1080 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length, int, Integer, -1);
1081 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate, int, Integer, -1);
1082 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title, int, Integer, 0);
1083 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter, int, Integer, 0);
1084 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
1086 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
1090 /*****************************************************************************
1091 * Message log handling
1092 *****************************************************************************/
1094 /** defgroup libvlc_log Log
1096 * LibVLC Message Logging
1101 * Returns the VLC messaging verbosity level
1102 * \param p_instance libvlc instance
1103 * \param exception an initialized exception pointer
1105 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
1106 libvlc_exception_t *p_e );
1109 * Set the VLC messaging verbosity level
1110 * \param p_log libvlc log instance
1111 * \param exception an initialized exception pointer
1113 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
1114 libvlc_exception_t *p_e );
1117 * Open an instance to VLC message log
1118 * \param p_instance libvlc instance
1119 * \param exception an initialized exception pointer
1121 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( const libvlc_instance_t *, libvlc_exception_t *);
1124 * Close an instance of VLC message log
1125 * \param p_log libvlc log instance
1126 * \param exception an initialized exception pointer
1128 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
1131 * Returns the number of messages in log
1132 * \param p_log libvlc log instance
1133 * \param exception an initialized exception pointer
1135 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
1138 * Clear all messages in log
1139 * the log should be cleared on a regular basis to avoid clogging
1140 * \param p_log libvlc log instance
1141 * \param exception an initialized exception pointer
1143 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
1146 * Allocate and returns a new iterator to messages in log
1147 * \param p_log libvlc log instance
1148 * \param exception an initialized exception pointer
1150 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
1153 * Releases a previoulsy allocated iterator
1154 * \param p_log libvlc log iterator
1155 * \param exception an initialized exception pointer
1157 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1160 * Returns whether log iterator has more messages
1161 * \param p_log libvlc log iterator
1162 * \param exception an initialized exception pointer
1164 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1167 * Returns next log message
1168 * the content of message must not be freed
1169 * \param p_log libvlc log iterator
1170 * \param exception an initialized exception pointer
1172 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
1173 struct libvlc_log_message_t *buffer,
1174 libvlc_exception_t *p_e );
1178 /*****************************************************************************
1180 *****************************************************************************/
1182 /** defgroup libvlc_callbacks Callbacks
1189 * Register for an event notification
1190 * \param p_event_manager the event manager to which you want to attach to
1191 * Generally it is obtained by vlc_my_object_event_manager() where my_object
1192 * Is the object you want to listen to.
1193 * \param i_event_type the desired event to which we want to listen
1194 * \param f_callback the function to call when i_event_type occurs
1195 * \param user_data user provided data to carry with the event
1196 * \param p_e an initialized exception pointer
1198 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
1199 libvlc_event_type_t i_event_type,
1200 libvlc_callback_t f_callback,
1202 libvlc_exception_t *p_e );
1205 * Unregister an event notification
1206 * \param p_event_manager the event manager
1207 * \param i_event_type the desired event to which we want to unregister
1208 * \param f_callback the function to call when i_event_type occurs
1209 * \param p_e an initialized exception pointer
1211 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
1212 libvlc_event_type_t i_event_type,
1213 libvlc_callback_t f_callback,
1215 libvlc_exception_t *p_e );
1219 * Get an event type name
1220 * \param i_event_type the desired event
1222 #define libvlc_event_type_name(a) #a
1231 #endif /* <vlc/libvlc.h> */