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
65 libvlc_exception_raised( const libvlc_exception_t *p_exception );
69 * \param p_exception the exception to raise
70 * \param psz_message the exception message
73 libvlc_exception_raise( libvlc_exception_t *p_exception,
74 const char *psz_format, ... );
77 * Clear an exception object so it can be reused.
78 * The exception object must be initialized
79 * \param p_exception the exception to clear
81 VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
84 * Get exception message
85 * \param p_exception the exception to query
86 * \return the exception message or NULL if not applicable (exception not raised
89 VLC_PUBLIC_API const char *
90 libvlc_exception_get_message( const libvlc_exception_t *p_exception );
94 /*****************************************************************************
96 *****************************************************************************/
98 /** defgroup libvlc_core Core
105 * Create an initialized libvlc instance.
106 * \param argc the number of arguments
107 * \param argv command-line-type arguments
108 * \param exception an initialized exception pointer
110 VLC_PUBLIC_API libvlc_instance_t *
111 libvlc_new( int , const char *const *, libvlc_exception_t *);
114 * Returns a libvlc instance identifier for legacy APIs. Use of this
115 * function is discouraged, you should convert your program to use the
117 * \param p_instance the instance
119 VLC_PUBLIC_API int libvlc_get_vlc_id( libvlc_instance_t *p_instance );
122 * Decrements the reference count of a libvlc instance, and destroys it
123 * if it reaches zero.
124 * \param p_instance the instance to destroy
126 VLC_PUBLIC_API void libvlc_release( libvlc_instance_t *, libvlc_exception_t * );
129 * Increments the reference count of a libvlc instance.
130 * The reference count is initially one when libvlc_new() returns.
132 VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
136 /*****************************************************************************
138 *****************************************************************************/
139 /** defgroup libvlc_media_descriptor Media Descriptor
141 * LibVLC Media Descriptor
146 * Create a media descriptor with the given mrl.
147 * \param p_instance the instance
148 * \param psz_mrl the mrl to read
150 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_new(
151 libvlc_instance_t *p_instance,
152 const char * psz_mrl,
153 libvlc_exception_t *p_e );
156 * Create a media descriptor as an empty node with the passed name.
157 * \param p_instance the instance
158 * \param psz_name the name of the node
160 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_new_as_node(
161 libvlc_instance_t *p_instance,
162 const char * psz_name,
163 libvlc_exception_t *p_e );
166 * Add an option to the media descriptor,
167 * This option will be used to determine how the media_instance will
168 * read the media_descriptor. This allow to use VLC advanced
169 * reading/streaming options in a per-media basis.
171 * The options are detailled in vlc --long-help, for instance "--sout-all"
172 * \param p_instance the instance
173 * \param psz_mrl the mrl to read
175 VLC_PUBLIC_API void libvlc_media_descriptor_add_option(
176 libvlc_media_descriptor_t * p_md,
177 const char * ppsz_options,
178 libvlc_exception_t * p_e );
180 VLC_PUBLIC_API void libvlc_media_descriptor_retain(
181 libvlc_media_descriptor_t *p_meta_desc );
183 VLC_PUBLIC_API void libvlc_media_descriptor_release(
184 libvlc_media_descriptor_t *p_meta_desc );
186 VLC_PUBLIC_API char * libvlc_media_descriptor_get_mrl( libvlc_media_descriptor_t * p_md,
187 libvlc_exception_t * p_e );
190 * Read the meta of the media descriptor.
191 * \param p_meta_desc the media descriptor to read
192 * \param p_meta_desc the meta to read
194 VLC_PUBLIC_API char * libvlc_media_descriptor_get_meta(
195 libvlc_media_descriptor_t *p_meta_desc,
196 libvlc_meta_t e_meta,
197 libvlc_exception_t *p_e );
199 VLC_PUBLIC_API libvlc_state_t libvlc_media_descriptor_get_state(
200 libvlc_media_descriptor_t *p_meta_desc,
201 libvlc_exception_t *p_e );
204 VLC_PUBLIC_API void libvlc_media_descriptor_add_tag( libvlc_media_descriptor_t *p_md,
206 const libvlc_tag_t tag,
207 libvlc_exception_t *p_e );
209 VLC_PUBLIC_API void libvlc_media_descriptor_remove_tag( libvlc_media_descriptor_t *p_md,
211 const libvlc_tag_t tag,
212 libvlc_exception_t *p_e );
215 libvlc_media_descriptor_tags_count_for_key( libvlc_media_descriptor_t *p_md,
217 libvlc_exception_t *p_e );
219 VLC_PUBLIC_API libvlc_tag_t
220 libvlc_media_descriptor_tag_at_index_for_key( libvlc_media_descriptor_t *p_md,
223 libvlc_exception_t *p_e );
225 VLC_PUBLIC_API libvlc_media_list_t *
226 libvlc_media_descriptor_subitems( libvlc_media_descriptor_t *p_md,
227 libvlc_exception_t *p_e );
229 VLC_PUBLIC_API libvlc_event_manager_t *
230 libvlc_media_descriptor_event_manager( libvlc_media_descriptor_t * p_md,
231 libvlc_exception_t * p_e );
233 VLC_PUBLIC_API vlc_int64_t
234 libvlc_media_descriptor_get_duration( libvlc_media_descriptor_t * p_md,
235 libvlc_exception_t * p_e );
237 VLC_PUBLIC_API vlc_bool_t
238 libvlc_media_descriptor_is_preparsed( libvlc_media_descriptor_t * p_md,
239 libvlc_exception_t * p_e );
242 libvlc_media_descriptor_set_user_data( libvlc_media_descriptor_t * p_md,
243 void * p_new_user_data,
244 libvlc_exception_t * p_e);
245 VLC_PUBLIC_API void *
246 libvlc_media_descriptor_get_user_data( libvlc_media_descriptor_t * p_md,
247 libvlc_exception_t * p_e);
251 /*****************************************************************************
253 *****************************************************************************/
254 /** defgroup libvlc_playlist Playlist
256 * LibVLC Playlist handling
263 VLC_PUBLIC_API void libvlc_playlist_loop( libvlc_instance_t* , vlc_bool_t,
264 libvlc_exception_t * );
267 * Start playing. You can give some additionnal playlist item options
268 * that will be added to the item before playing it.
269 * \param p_instance the instance
270 * \param i_id the item to play. If this is a negative number, the next
271 * item will be selected. Else, the item with the given ID will be played
272 * \param i_options the number of options to add to the item
273 * \param ppsz_options the options to add to the item
274 * \param p_exception an initialized exception
276 VLC_PUBLIC_API void libvlc_playlist_play( libvlc_instance_t*, int, int, char **,
277 libvlc_exception_t * );
280 * Pause a running playlist, resume if it was stopped
281 * \param p_instance the instance to pause
282 * \param p_exception an initialized exception
284 VLC_PUBLIC_API void libvlc_playlist_pause( libvlc_instance_t *, libvlc_exception_t * );
287 * Checks if the playlist is running
288 * \param p_instance the instance
289 * \param p_exception an initialized exception
290 * \return 0 if the playlist is stopped or paused, 1 if it is running
292 VLC_PUBLIC_API int libvlc_playlist_isplaying( libvlc_instance_t *, libvlc_exception_t * );
295 * Get the number of items in the playlist
296 * \param p_instance the instance
297 * \param p_exception an initialized exception
298 * \return the number of items
300 VLC_PUBLIC_API int libvlc_playlist_items_count( libvlc_instance_t *, libvlc_exception_t * );
303 * Lock the playlist instance
304 * \param p_instance the instance
306 VLC_PUBLIC_API void libvlc_playlist_lock( libvlc_instance_t * );
309 * Unlock the playlist instance
310 * \param p_instance the instance
312 VLC_PUBLIC_API void libvlc_playlist_unlock( libvlc_instance_t * );
316 * \param p_instance the instance to stop
317 * \param p_exception an initialized exception
319 VLC_PUBLIC_API void libvlc_playlist_stop( libvlc_instance_t *, libvlc_exception_t * );
322 * Go to next playlist item (starts playback if it was stopped)
323 * \param p_instance the instance to use
324 * \param p_exception an initialized exception
326 VLC_PUBLIC_API void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * );
329 * Go to previous playlist item (starts playback if it was stopped)
330 * \param p_instance the instance to use
331 * \param p_exception an initialized exception
333 VLC_PUBLIC_API void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * );
336 * Remove all playlist items
337 * \param p_instance the instance
338 * \param p_exception an initialized exception
340 VLC_PUBLIC_API void libvlc_playlist_clear( libvlc_instance_t *, libvlc_exception_t * );
343 * Add an item at the end of the playlist
344 * If you need more advanced options, \see libvlc_playlist_add_extended
345 * \param p_instance the instance
346 * \param psz_uri the URI to open, using VLC format
347 * \param psz_name a name that you might want to give or NULL
348 * \return the identifier of the new item
350 VLC_PUBLIC_API int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *,
351 libvlc_exception_t * );
354 * Add an item at the end of the playlist, with additional input options
355 * \param p_instance the instance
356 * \param psz_uri the URI to open, using VLC format
357 * \param psz_name a name that you might want to give or NULL
358 * \param i_options the number of options to add
359 * \param ppsz_options strings representing the options to add
360 * \param p_exception an initialized exception
361 * \return the identifier of the new item
363 VLC_PUBLIC_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
364 const char *, int, const char **,
365 libvlc_exception_t * );
368 * Delete the playlist item with the given ID.
369 * \param p_instance the instance
370 * \param i_id the id to remove
371 * \param p_exception an initialized exception
374 VLC_PUBLIC_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
375 libvlc_exception_t * );
377 /** Get the input that is currently being played by the playlist
378 * \param p_instance the instance to use
379 * \param p_exception an initialized excecption
380 * \return an input object
382 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_playlist_get_media_instance(
383 libvlc_instance_t *, libvlc_exception_t * );
387 /*****************************************************************************
389 *****************************************************************************/
390 /** defgroup libvlc_media_instance Media Instance
392 * LibVLC Media Instance
396 /** Create an empty Media Instance object
397 * \param p_libvlc_instance the libvlc instance in which the Media Instance
398 * should be (not used for now).
400 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new( libvlc_instance_t *, libvlc_exception_t * );
402 /** Create a Media Instance object from a Media Descriptor
403 * \param p_md the media descriptor. Afterwards the p_md can safely be
406 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new_from_media_descriptor( libvlc_media_descriptor_t *, libvlc_exception_t * );
408 /** Release a media_instance after use
409 * \param p_mi the Media Instance to free
411 VLC_PUBLIC_API void libvlc_media_instance_release( libvlc_media_instance_t * );
412 VLC_PUBLIC_API void libvlc_media_instance_retain( libvlc_media_instance_t * );
414 /** Set the media descriptor that will be used by the media_instance. If any,
415 * previous md will be released.
416 * \param p_mi the Media Instance
417 * \param p_md the Media Descriptor. Afterwards the p_md can safely be
420 VLC_PUBLIC_API void libvlc_media_instance_set_media_descriptor( libvlc_media_instance_t *, libvlc_media_descriptor_t *, libvlc_exception_t * );
422 /** Get the media descriptor used by the media_instance (if any). A copy of
423 * the md is returned. NULL is returned if no media instance is associated.
424 * \param p_mi the Media Instance
426 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_instance_get_media_descriptor( libvlc_media_instance_t *, libvlc_exception_t * );
428 /** Get the Event Manager from which the media instance send event.
429 * \param p_mi the Media Instance
431 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_instance_event_manager ( libvlc_media_instance_t *, libvlc_exception_t * );
433 VLC_PUBLIC_API void libvlc_media_instance_play ( libvlc_media_instance_t *, libvlc_exception_t * );
434 VLC_PUBLIC_API void libvlc_media_instance_pause ( libvlc_media_instance_t *, libvlc_exception_t * );
435 VLC_PUBLIC_API void libvlc_media_instance_stop ( libvlc_media_instance_t *, libvlc_exception_t * );
437 VLC_PUBLIC_API void libvlc_media_instance_set_drawable ( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
439 /** \bug This might go away ... to be replaced by a broader system */
440 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_length ( libvlc_media_instance_t *, libvlc_exception_t *);
441 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_time ( libvlc_media_instance_t *, libvlc_exception_t *);
442 VLC_PUBLIC_API void libvlc_media_instance_set_time ( libvlc_media_instance_t *, vlc_int64_t, libvlc_exception_t *);
443 VLC_PUBLIC_API float libvlc_media_instance_get_position ( libvlc_media_instance_t *, libvlc_exception_t *);
444 VLC_PUBLIC_API void libvlc_media_instance_set_position ( libvlc_media_instance_t *, float, libvlc_exception_t *);
445 VLC_PUBLIC_API void libvlc_media_instance_set_chapter ( libvlc_media_instance_t *, int, libvlc_exception_t *);
446 VLC_PUBLIC_API int libvlc_media_instance_get_chapter (libvlc_media_instance_t *, libvlc_exception_t *);
447 VLC_PUBLIC_API int libvlc_media_instance_get_chapter_count( libvlc_media_instance_t *, libvlc_exception_t *);
448 VLC_PUBLIC_API vlc_bool_t libvlc_media_instance_will_play ( libvlc_media_instance_t *, libvlc_exception_t *);
449 VLC_PUBLIC_API float libvlc_media_instance_get_rate ( libvlc_media_instance_t *, libvlc_exception_t *);
450 VLC_PUBLIC_API void libvlc_media_instance_set_rate ( libvlc_media_instance_t *, float, libvlc_exception_t *);
451 VLC_PUBLIC_API libvlc_state_t libvlc_media_instance_get_state ( libvlc_media_instance_t *, libvlc_exception_t *);
454 * Does this input have a video output ?
455 * \param p_input the input
456 * \param p_exception an initialized exception
458 VLC_PUBLIC_API vlc_bool_t libvlc_media_instance_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
459 VLC_PUBLIC_API float libvlc_media_instance_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
464 /*****************************************************************************
466 *****************************************************************************/
467 /** defgroup libvlc_tag_query Tag Query
472 VLC_PUBLIC_API libvlc_tag_query_t *
473 libvlc_tag_query_new( libvlc_instance_t *, libvlc_exception_t * );
476 libvlc_tag_query_release( libvlc_tag_query_t * );
479 libvlc_tag_query_retain( libvlc_tag_query_t * );
482 libvlc_tag_query_set_match_tag_and_key( libvlc_tag_query_t * p_q,
485 libvlc_exception_t * );
487 VLC_PUBLIC_API vlc_bool_t
488 libvlc_tag_query_match( libvlc_tag_query_t *, libvlc_media_descriptor_t *,
489 libvlc_exception_t * );
493 /*****************************************************************************
495 *****************************************************************************/
496 /** defgroup libvlc_media_list MediaList
501 VLC_PUBLIC_API libvlc_media_list_t *
502 libvlc_media_list_new( libvlc_instance_t *, libvlc_exception_t * );
505 libvlc_media_list_release( libvlc_media_list_t * );
508 libvlc_media_list_retain( libvlc_media_list_t * );
511 libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
512 const char * psz_uri,
513 libvlc_exception_t * p_e );
516 libvlc_media_list_set_media_descriptor( libvlc_media_list_t *,
517 libvlc_media_descriptor_t *,
518 libvlc_exception_t *);
520 VLC_PUBLIC_API libvlc_media_descriptor_t *
521 libvlc_media_list_media_descriptor( libvlc_media_list_t *,
522 libvlc_exception_t *);
525 libvlc_media_list_add_media_descriptor( libvlc_media_list_t *,
526 libvlc_media_descriptor_t *,
527 libvlc_exception_t * );
529 libvlc_media_list_insert_media_descriptor( libvlc_media_list_t *,
530 libvlc_media_descriptor_t *,
532 libvlc_exception_t * );
534 libvlc_media_list_remove_index( libvlc_media_list_t *, int,
535 libvlc_exception_t * );
538 libvlc_media_list_count( libvlc_media_list_t * p_mlist,
539 libvlc_exception_t * p_e );
541 VLC_PUBLIC_API libvlc_media_descriptor_t *
542 libvlc_media_list_item_at_index( libvlc_media_list_t *, int,
543 libvlc_exception_t * );
545 libvlc_media_list_index_of_item( libvlc_media_list_t *,
546 libvlc_media_descriptor_t *,
547 libvlc_exception_t * );
550 libvlc_media_list_lock( libvlc_media_list_t * );
552 libvlc_media_list_unlock( libvlc_media_list_t * );
554 VLC_PUBLIC_API libvlc_media_list_view_t *
555 libvlc_media_list_flat_view( libvlc_media_list_t *,
556 libvlc_exception_t * );
558 VLC_PUBLIC_API libvlc_media_list_view_t *
559 libvlc_media_list_hierarchical_view( libvlc_media_list_t *,
560 libvlc_exception_t * );
562 VLC_PUBLIC_API libvlc_event_manager_t *
563 libvlc_media_list_event_manager( libvlc_media_list_t *,
564 libvlc_exception_t * );
568 /*****************************************************************************
570 *****************************************************************************/
571 /** defgroup libvlc_media_list_view MediaListView
573 * LibVLC Media List View
577 libvlc_media_list_view_retain( libvlc_media_list_view_t * p_mlv );
580 libvlc_media_list_view_release( libvlc_media_list_view_t * p_mlv );
582 VLC_PUBLIC_API libvlc_event_manager_t *
583 libvlc_media_list_view_event_manager( libvlc_media_list_view_t * p_mlv );
586 libvlc_media_list_view_count( libvlc_media_list_view_t * p_mlv,
587 libvlc_exception_t * p_e );
589 VLC_PUBLIC_API libvlc_media_descriptor_t *
590 libvlc_media_list_view_item_at_index( libvlc_media_list_view_t * p_mlv,
592 libvlc_exception_t * p_e );
594 VLC_PUBLIC_API libvlc_media_list_view_t *
595 libvlc_media_list_view_children_at_index( libvlc_media_list_view_t * p_mlv,
597 libvlc_exception_t * p_e );
601 libvlc_media_list_view_index_of_item( libvlc_media_list_view_t * p_mlv,
602 libvlc_media_descriptor_t * p_md,
603 libvlc_exception_t * p_e );
606 libvlc_media_list_view_insert_at_index( libvlc_media_list_view_t * p_mlv,
607 libvlc_media_descriptor_t * p_md,
609 libvlc_exception_t * p_e );
612 libvlc_media_list_view_remove_at_index( libvlc_media_list_view_t * p_mlv,
614 libvlc_exception_t * p_e );
617 libvlc_media_list_view_add_item( libvlc_media_list_view_t * p_mlv,
618 libvlc_media_descriptor_t * p_md,
619 libvlc_exception_t * p_e );
621 VLC_PUBLIC_API libvlc_media_list_t *
622 libvlc_media_list_view_parent_media_list( libvlc_media_list_view_t * p_mlv,
623 libvlc_exception_t * p_e );
627 /*****************************************************************************
628 * Dynamic Media List (Deprecated)
629 *****************************************************************************/
630 /** defgroup libvlc_media_list MediaList
635 VLC_PUBLIC_API libvlc_dynamic_media_list_t *
636 libvlc_dynamic_media_list_new( libvlc_media_list_t * p_mlist,
637 libvlc_tag_query_t * p_query,
639 libvlc_exception_t * p_e );
641 libvlc_dynamic_media_list_release( libvlc_dynamic_media_list_t * p_dmlist );
644 libvlc_dynamic_media_list_retain( libvlc_dynamic_media_list_t * p_dmlist );
646 libvlc_media_list_t *
647 libvlc_dynamic_media_list_media_list( libvlc_dynamic_media_list_t * p_dmlist,
648 libvlc_exception_t * p_e );
652 /*****************************************************************************
654 *****************************************************************************/
655 /** defgroup libvlc_media_library Media Library
657 * LibVLC Media Library
660 VLC_PUBLIC_API libvlc_media_library_t *
661 libvlc_media_library_new( libvlc_instance_t * p_inst,
662 libvlc_exception_t * p_e );
664 libvlc_media_library_release( libvlc_media_library_t * p_mlib );
666 libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
670 libvlc_media_library_load( libvlc_media_library_t * p_mlib,
671 libvlc_exception_t * p_e );
674 libvlc_media_library_save( libvlc_media_library_t * p_mlib,
675 libvlc_exception_t * p_e );
677 VLC_PUBLIC_API libvlc_media_list_t *
678 libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
679 libvlc_exception_t * p_e );
684 /*****************************************************************************
686 *****************************************************************************/
687 /** defgroup libvlc_media_list_player MediaListPlayer
689 * LibVLC Media List Player
692 VLC_PUBLIC_API libvlc_media_list_player_t *
693 libvlc_media_list_player_new( libvlc_instance_t * p_instance,
694 libvlc_exception_t * p_e );
696 libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
699 libvlc_media_list_player_set_media_instance(
700 libvlc_media_list_player_t * p_mlp,
701 libvlc_media_instance_t * p_mi,
702 libvlc_exception_t * p_e );
705 libvlc_media_list_player_set_media_list(
706 libvlc_media_list_player_t * p_mlp,
707 libvlc_media_list_t * p_mlist,
708 libvlc_exception_t * p_e );
711 libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
712 libvlc_exception_t * p_e );
715 libvlc_media_list_player_pause( libvlc_media_list_player_t * p_mlp,
716 libvlc_exception_t * p_e );
719 libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp,
720 libvlc_exception_t * p_e );
722 VLC_PUBLIC_API libvlc_state_t
723 libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp,
724 libvlc_exception_t * p_e );
727 libvlc_media_list_player_play_item_at_index(
728 libvlc_media_list_player_t * p_mlp,
730 libvlc_exception_t * p_e );
733 libvlc_media_list_player_play_item(
734 libvlc_media_list_player_t * p_mlp,
735 libvlc_media_descriptor_t * p_md,
736 libvlc_exception_t * p_e );
739 libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
740 libvlc_exception_t * p_e );
742 libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
743 libvlc_exception_t * p_e );
747 /** defgroup libvlc_video Video
749 * LibVLC Video handling
754 * Toggle fullscreen status on video output
755 * \param p_input the input
756 * \param p_exception an initialized exception
758 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
761 * Enable or disable fullscreen on a video output
762 * \param p_input the input
763 * \param b_fullscreen boolean for fullscreen status
764 * \param p_exception an initialized exception
766 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_instance_t *, int, libvlc_exception_t * );
769 * Get current fullscreen status
770 * \param p_input the input
771 * \param p_exception an initialized exception
772 * \return the fullscreen status (boolean)
774 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
777 * Get current video height
778 * \param p_input the input
779 * \param p_exception an initialized exception
780 * \return the video height
782 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_instance_t *, libvlc_exception_t * );
785 * Get current video width
786 * \param p_input the input
787 * \param p_exception an initialized exception
788 * \return the video width
790 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_instance_t *, libvlc_exception_t * );
793 * Get current video aspect ratio
794 * \param p_input the input
795 * \param p_exception an initialized exception
796 * \return the video aspect ratio
798 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_instance_t *, libvlc_exception_t * );
801 * Set new video aspect ratio
802 * \param p_input the input
803 * \param psz_aspect new video aspect-ratio
804 * \param p_exception an initialized exception
806 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_instance_t *, char *, libvlc_exception_t * );
809 * Get current video subtitle
810 * \param p_input the input
811 * \param p_exception an initialized exception
812 * \return the video subtitle selected
814 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_instance_t *, libvlc_exception_t * );
817 * Set new video subtitle
818 * \param p_input the input
819 * \param i_spu new video subtitle to select
820 * \param p_exception an initialized exception
822 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_instance_t *, int , libvlc_exception_t * );
825 * Get current crop filter geometry
826 * \param p_input the input
827 * \param p_exception an initialized exception
828 * \return the crop filter geometry
830 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_instance_t *, libvlc_exception_t * );
833 * Set new crop filter geometry
834 * \param p_input the input
835 * \param psz_geometry new crop filter geometry
836 * \param p_exception an initialized exception
838 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_instance_t *, char *, libvlc_exception_t * );
841 * Toggle teletext transparent status on video output
842 * \param p_input the input
843 * \param p_exception an initialized exception
845 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
848 * Get current teletext page requested.
849 * \param p_input the input
850 * \param p_exception an initialized exception
851 * \return the current teletext page requested.
853 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
856 * Set new teletext page to retrieve
857 * \param p_input the input
858 * \param i_page teletex page number requested
859 * \param p_exception an initialized exception
861 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_instance_t *, int, libvlc_exception_t * );
864 * Take a snapshot of the current video window
865 * If i_width AND i_height is 0, original size is used
866 * if i_width XOR i_height is 0, original aspect-ratio is preserved
867 * \param p_input the input
868 * \param psz_filepath the path where to save the screenshot to
869 * \param i_width the snapshot's width
870 * \param i_height the snapshot's height
871 * \param p_exception an initialized exception
873 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_instance_t *, char *,unsigned int, unsigned int, libvlc_exception_t * );
875 VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *);
878 * Resize the current video output window
879 * \param p_instance libvlc instance
880 * \param width new width for video output window
881 * \param height new height for video output window
882 * \param p_exception an initialized exception
883 * \return the success status (boolean)
885 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *);
888 * change the parent for the current the video output
889 * \param p_instance libvlc instance
890 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
891 * \param p_exception an initialized exception
892 * \return the success status (boolean)
894 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
897 * Tell windowless video output to redraw rectangular area (MacOS X only)
898 * \param p_instance libvlc instance
899 * \param area coordinates within video drawable
900 * \param p_exception an initialized exception
902 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
905 * Set the default video output parent
906 * this settings will be used as default for all video outputs
907 * \param p_instance libvlc instance
908 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
909 * \param p_exception an initialized exception
911 VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
914 * Set the default video output parent
915 * this settings will be used as default for all video outputs
916 * \param p_instance libvlc instance
917 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
918 * \param p_exception an initialized exception
920 VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
923 * Set the default video output size
924 * this settings will be used as default for all video outputs
925 * \param p_instance libvlc instance
926 * \param width new width for video drawable
927 * \param height new height for video drawable
928 * \param p_exception an initialized exception
930 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
933 * Set the default video output viewport for a windowless video output (MacOS X only)
934 * this settings will be used as default for all video outputs
935 * \param p_instance libvlc instance
936 * \param view coordinates within video drawable
937 * \param clip coordinates within video drawable
938 * \param p_exception an initialized exception
940 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
944 /** defgroup libvlc_audio Audio
946 * LibVLC Audio handling
952 * \param p_instance libvlc instance
953 * \param p_exception an initialized exception
956 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
959 * Get current mute status
960 * \param p_instance libvlc instance
961 * \param p_exception an initialized exception
962 * \return the mute status (boolean)
964 VLC_PUBLIC_API vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
968 * \param p_instance libvlc instance
969 * \param status If status is VLC_TRUE then mute, otherwise unmute
970 * \param p_exception an initialized exception
973 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * );
976 * Get current audio level
977 * \param p_instance libvlc instance
978 * \param p_exception an initialized exception
979 * \return the audio level (int)
981 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
984 * Set current audio level
985 * \param p_instance libvlc instance
986 * \param i_volume the volume (int)
987 * \param p_exception an initialized exception
989 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
992 * Get number of available audio tracks
993 * \param p_mi media instance
994 * \param p_e an initialized exception
995 * \return the number of available audio tracks (int)
997 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_instance_t *, libvlc_exception_t * );
1000 + * Get current audio track
1001 + * \param p_input input instance
1002 + * \param p_exception an initialized exception
1003 + * \return the audio track (int)
1005 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_instance_t *, libvlc_exception_t * );
1008 * Set current audio track
1009 * \param p_input input instance
1010 * \param i_track the track (int)
1011 * \param p_exception an initialized exception
1013 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_instance_t *, int, libvlc_exception_t * );
1016 * Get current audio channel
1017 * \param p_instance input instance
1018 * \param p_exception an initialized exception
1019 * \return the audio channel (int)
1021 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
1024 * Set current audio channel
1025 * \param p_instance input instance
1026 * \param i_channel the audio channel (int)
1027 * \param p_exception an initialized exception
1029 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * );
1033 /*****************************************************************************
1034 * Services/Media Discovery
1035 *****************************************************************************/
1036 /** defgroup libvlc_media_discoverer Media Discoverer
1038 * LibVLC Media Discoverer
1042 VLC_PUBLIC_API libvlc_media_discoverer_t *
1043 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
1044 const char * psz_name,
1045 libvlc_exception_t * p_e );
1046 VLC_PUBLIC_API void libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
1047 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
1049 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
1051 VLC_PUBLIC_API libvlc_event_manager_t *
1052 libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis );
1055 libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis );
1059 /*****************************************************************************
1061 *****************************************************************************/
1062 /** defgroup libvlc_vlm VLM
1069 * Add a broadcast, with one input
1070 * \param p_instance the instance
1071 * \param psz_name the name of the new broadcast
1072 * \param psz_input the input MRL
1073 * \param psz_output the output MRL (the parameter to the "sout" variable)
1074 * \param i_options number of additional options
1075 * \param ppsz_options additional options
1076 * \param b_enabled boolean for enabling the new broadcast
1077 * \param b_loop Should this broadcast be played in loop ?
1078 * \param p_exception an initialized exception
1080 VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
1081 int, char **, int, int, libvlc_exception_t * );
1084 * Delete a media (vod or broadcast)
1085 * \param p_instance the instance
1086 * \param psz_name the media to delete
1087 * \param p_exception an initialized exception
1089 VLC_PUBLIC_API void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1092 * Enable or disable a media (vod or broadcast)
1093 * \param p_instance the instance
1094 * \param psz_name the media to work on
1095 * \param b_enabled the new status
1096 * \param p_exception an initialized exception
1098 VLC_PUBLIC_API void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
1099 libvlc_exception_t *);
1102 * Set the output for a media
1103 * \param p_instance the instance
1104 * \param psz_name the media to work on
1105 * \param psz_output the output MRL (the parameter to the "sout" variable)
1106 * \param p_exception an initialized exception
1108 VLC_PUBLIC_API void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
1109 libvlc_exception_t *);
1112 * Set a media's input MRL. This will delete all existing inputs and
1113 * add the specified one.
1114 * \param p_instance the instance
1115 * \param psz_name the media to work on
1116 * \param psz_input the input MRL
1117 * \param p_exception an initialized exception
1119 VLC_PUBLIC_API void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
1120 libvlc_exception_t *);
1123 * Add a media's input MRL. This will add the specified one.
1124 * \param p_instance the instance
1125 * \param psz_name the media to work on
1126 * \param psz_input the input MRL
1127 * \param p_exception an initialized exception
1129 VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, char *, char *,
1130 libvlc_exception_t *p_exception );
1132 * Set output for a media
1133 * \param p_instance the instance
1134 * \param psz_name the media to work on
1135 * \param b_loop the new status
1136 * \param p_exception an initialized exception
1138 VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
1139 libvlc_exception_t *);
1142 * Edit the parameters of a media. This will delete all existing inputs and
1143 * add the specified one.
1144 * \param p_instance the instance
1145 * \param psz_name the name of the new broadcast
1146 * \param psz_input the input MRL
1147 * \param psz_output the output MRL (the parameter to the "sout" variable)
1148 * \param i_options number of additional options
1149 * \param ppsz_options additional options
1150 * \param b_enabled boolean for enabling the new broadcast
1151 * \param b_loop Should this broadcast be played in loop ?
1152 * \param p_exception an initialized exception
1154 VLC_PUBLIC_API void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
1155 int, char **, int, int, libvlc_exception_t * );
1158 * Plays the named broadcast.
1159 * \param p_instance the instance
1160 * \param psz_name the name of the broadcast
1161 * \param p_exception an initialized exception
1163 VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1166 * Stops the named broadcast.
1167 * \param p_instance the instance
1168 * \param psz_name the name of the broadcast
1169 * \param p_exception an initialized exception
1171 VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1174 * Pauses the named broadcast.
1175 * \param p_instance the instance
1176 * \param psz_name the name of the broadcast
1177 * \param p_exception an initialized exception
1179 VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1182 * Seeks in the named broadcast.
1183 * \param p_instance the instance
1184 * \param psz_name the name of the broadcast
1185 * \param f_percentage the percentage to seek to
1186 * \param p_exception an initialized exception
1188 VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
1189 float, libvlc_exception_t * );
1192 * Return information of the named broadcast.
1193 * \param p_instance the instance
1194 * \param psz_name the name of the broadcast
1195 * \param p_exception an initialized exception
1197 VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1199 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
1200 returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \
1201 char *, int , libvlc_exception_t * );
1203 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1);
1204 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time, int, Integer, -1);
1205 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length, int, Integer, -1);
1206 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate, int, Integer, -1);
1207 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title, int, Integer, 0);
1208 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter, int, Integer, 0);
1209 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
1211 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
1215 /*****************************************************************************
1216 * Message log handling
1217 *****************************************************************************/
1219 /** defgroup libvlc_log Log
1221 * LibVLC Message Logging
1226 * Returns the VLC messaging verbosity level
1227 * \param p_instance libvlc instance
1228 * \param exception an initialized exception pointer
1230 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
1231 libvlc_exception_t *p_e );
1234 * Set the VLC messaging verbosity level
1235 * \param p_log libvlc log instance
1236 * \param exception an initialized exception pointer
1238 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
1239 libvlc_exception_t *p_e );
1242 * Open an instance to VLC message log
1243 * \param p_instance libvlc instance
1244 * \param exception an initialized exception pointer
1246 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
1249 * Close an instance of VLC message log
1250 * \param p_log libvlc log instance
1251 * \param exception an initialized exception pointer
1253 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
1256 * Returns the number of messages in log
1257 * \param p_log libvlc log instance
1258 * \param exception an initialized exception pointer
1260 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
1263 * Clear all messages in log
1264 * the log should be cleared on a regular basis to avoid clogging
1265 * \param p_log libvlc log instance
1266 * \param exception an initialized exception pointer
1268 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
1271 * Allocate and returns a new iterator to messages in log
1272 * \param p_log libvlc log instance
1273 * \param exception an initialized exception pointer
1275 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
1278 * Releases a previoulsy allocated iterator
1279 * \param p_log libvlc log iterator
1280 * \param exception an initialized exception pointer
1282 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1285 * Returns whether log iterator has more messages
1286 * \param p_log libvlc log iterator
1287 * \param exception an initialized exception pointer
1289 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1292 * Returns next log message
1293 * the content of message must not be freed
1294 * \param p_log libvlc log iterator
1295 * \param exception an initialized exception pointer
1297 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
1298 struct libvlc_log_message_t *buffer,
1299 libvlc_exception_t *p_e );
1303 /*****************************************************************************
1305 *****************************************************************************/
1307 /** defgroup libvlc_callbacks Callbacks
1314 * Register for an event notification
1315 * \param p_event_manager the event manager to which you want to attach to
1316 * Generally it is obtained by vlc_my_object_event_manager() where my_object
1317 * Is the object you want to listen to.
1318 * \param i_event_type the desired event to which we want to listen
1319 * \param f_callback the function to call when i_event_type occurs
1320 * \param user_data user provided data to carry with the event
1321 * \param p_e an initialized exception pointer
1323 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
1324 libvlc_event_type_t i_event_type,
1325 libvlc_callback_t f_callback,
1327 libvlc_exception_t *p_e );
1330 * Unregister an event notification
1331 * \param p_event_manager the event manager
1332 * \param i_event_type the desired event to which we want to unregister
1333 * \param f_callback the function to call when i_event_type occurs
1334 * \param p_e an initialized exception pointer
1336 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
1337 libvlc_event_type_t i_event_type,
1338 libvlc_callback_t f_callback,
1340 libvlc_exception_t *p_e );
1343 * Get an event type name
1344 * \param i_event_type the desired event
1346 VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
1355 #endif /* <vlc/libvlc.h> */