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_media_descriptor Media Descriptor
129 * LibVLC Media Descriptor
134 * Create a media descriptor with the given mrl.
135 * \param p_instance the instance
136 * \param psz_mrl the mrl to read
138 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_new(
139 libvlc_instance_t *p_instance,
140 const char * psz_mrl,
141 libvlc_exception_t *p_e );
143 VLC_PUBLIC_API void libvlc_media_descriptor_retain(
144 libvlc_media_descriptor_t *p_meta_desc );
146 VLC_PUBLIC_API void libvlc_media_descriptor_release(
147 libvlc_media_descriptor_t *p_meta_desc );
149 VLC_PUBLIC_API char * libvlc_media_descriptor_get_mrl( libvlc_media_descriptor_t * p_md,
150 libvlc_exception_t * p_e );
153 * Read the meta of the media descriptor.
154 * \param p_meta_desc the media descriptor to read
155 * \param p_meta_desc the meta to read
157 VLC_PUBLIC_API char * libvlc_media_descriptor_get_meta(
158 libvlc_media_descriptor_t *p_meta_desc,
159 libvlc_meta_t e_meta,
160 libvlc_exception_t *p_e );
163 VLC_PUBLIC_API void libvlc_media_descriptor_add_tag( libvlc_media_descriptor_t *p_md,
165 const libvlc_tag_t tag,
166 libvlc_exception_t *p_e );
168 VLC_PUBLIC_API void libvlc_media_descriptor_remove_tag( libvlc_media_descriptor_t *p_md,
170 const libvlc_tag_t tag,
171 libvlc_exception_t *p_e );
174 libvlc_media_descriptor_tags_count_for_key( libvlc_media_descriptor_t *p_md,
176 libvlc_exception_t *p_e );
178 VLC_PUBLIC_API libvlc_tag_t
179 libvlc_media_descriptor_tag_at_index_for_key( libvlc_media_descriptor_t *p_md,
182 libvlc_exception_t *p_e );
184 VLC_PUBLIC_API libvlc_media_list_t *
185 libvlc_media_descriptor_subitems( libvlc_media_descriptor_t *p_md,
186 libvlc_exception_t *p_e );
188 VLC_PUBLIC_API libvlc_event_manager_t *
189 libvlc_media_descriptor_event_manager( libvlc_media_descriptor_t * p_md,
190 libvlc_exception_t * p_e );
194 /*****************************************************************************
196 *****************************************************************************/
197 /** defgroup libvlc_playlist Playlist
199 * LibVLC Playlist handling
206 VLC_PUBLIC_API void libvlc_playlist_loop( libvlc_instance_t* , vlc_bool_t,
207 libvlc_exception_t * );
210 * Start playing. You can give some additionnal playlist item options
211 * that will be added to the item before playing it.
212 * \param p_instance the instance
213 * \param i_id the item to play. If this is a negative number, the next
214 * item will be selected. Else, the item with the given ID will be played
215 * \param i_options the number of options to add to the item
216 * \param ppsz_options the options to add to the item
217 * \param p_exception an initialized exception
219 VLC_PUBLIC_API void libvlc_playlist_play( libvlc_instance_t*, int, int, char **,
220 libvlc_exception_t * );
223 * Pause a running playlist, resume if it was stopped
224 * \param p_instance the instance to pause
225 * \param p_exception an initialized exception
227 VLC_PUBLIC_API void libvlc_playlist_pause( libvlc_instance_t *, libvlc_exception_t * );
230 * Checks if the playlist is running
231 * \param p_instance the instance
232 * \param p_exception an initialized exception
233 * \return 0 if the playlist is stopped or paused, 1 if it is running
235 VLC_PUBLIC_API int libvlc_playlist_isplaying( libvlc_instance_t *, libvlc_exception_t * );
238 * Get the number of items in the playlist
239 * \param p_instance the instance
240 * \param p_exception an initialized exception
241 * \return the number of items
243 VLC_PUBLIC_API int libvlc_playlist_items_count( libvlc_instance_t *, libvlc_exception_t * );
246 * Lock the playlist instance
247 * \param p_instance the instance
249 VLC_PUBLIC_API void libvlc_playlist_lock( libvlc_instance_t * );
252 * Unlock the playlist instance
253 * \param p_instance the instance
255 VLC_PUBLIC_API void libvlc_playlist_unlock( libvlc_instance_t * );
259 * \param p_instance the instance to stop
260 * \param p_exception an initialized exception
262 VLC_PUBLIC_API void libvlc_playlist_stop( libvlc_instance_t *, libvlc_exception_t * );
265 * Go to next playlist item (starts playback if it was stopped)
266 * \param p_instance the instance to use
267 * \param p_exception an initialized exception
269 VLC_PUBLIC_API void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * );
272 * Go to previous playlist item (starts playback if it was stopped)
273 * \param p_instance the instance to use
274 * \param p_exception an initialized exception
276 VLC_PUBLIC_API void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * );
279 * Remove all playlist items
280 * \param p_instance the instance
281 * \param p_exception an initialized exception
283 VLC_PUBLIC_API void libvlc_playlist_clear( libvlc_instance_t *, libvlc_exception_t * );
286 * Add an item at the end of the playlist
287 * If you need more advanced options, \see libvlc_playlist_add_extended
288 * \param p_instance the instance
289 * \param psz_uri the URI to open, using VLC format
290 * \param psz_name a name that you might want to give or NULL
291 * \return the identifier of the new item
293 VLC_PUBLIC_API int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *,
294 libvlc_exception_t * );
297 * Add an item at the end of the playlist, with additional input options
298 * \param p_instance the instance
299 * \param psz_uri the URI to open, using VLC format
300 * \param psz_name a name that you might want to give or NULL
301 * \param i_options the number of options to add
302 * \param ppsz_options strings representing the options to add
303 * \param p_exception an initialized exception
304 * \return the identifier of the new item
306 VLC_PUBLIC_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
307 const char *, int, const char **,
308 libvlc_exception_t * );
311 * Delete the playlist item with the given ID.
312 * \param p_instance the instance
313 * \param i_id the id to remove
314 * \param p_exception an initialized exception
317 VLC_PUBLIC_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
318 libvlc_exception_t * );
320 /* Get the input that is currently being played by the playlist
321 * \param p_instance the instance to use
322 * \param p_exception an initialized excecption
323 * \return an input object
325 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_playlist_get_media_instance(
326 libvlc_instance_t *, libvlc_exception_t * );
330 /*****************************************************************************
332 *****************************************************************************/
333 /** defgroup libvlc_media_instance Media Instance
335 * LibVLC Media Instance
339 /** Create an empty Media Instance object
340 * \param p_libvlc_instance the libvlc instance in which the Media Instance
341 * should be (not used for now).
343 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new( libvlc_instance_t *, libvlc_exception_t * );
345 /** Create a Media Instance object from a Media Descriptor
346 * \param p_md the media descriptor. Afterwards the p_md can safely be
349 VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new_from_media_descriptor( libvlc_media_descriptor_t *, libvlc_exception_t * );
351 /** Release a media_instance after use
352 * \param p_mi the Media Instance to free
354 VLC_PUBLIC_API void libvlc_media_instance_release( libvlc_media_instance_t * );
355 VLC_PUBLIC_API void libvlc_media_instance_retain( libvlc_media_instance_t * );
357 /** Set the media descriptor that will be used by the media_instance. If any,
358 * previous md will be released.
359 * \param p_mi the Media Instance
360 * \param p_md the Media Descriptor. Afterwards the p_md can safely be
363 VLC_PUBLIC_API void libvlc_media_instance_set_media_descriptor( libvlc_media_instance_t *, libvlc_media_descriptor_t *, libvlc_exception_t * );
365 /** Get the media descriptor used by the media_instance (if any). A copy of
366 * the md is returned. NULL is returned if no media instance is associated.
367 * \param p_mi the Media Instance
369 VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_instance_get_media_descriptor( libvlc_media_instance_t *, libvlc_exception_t * );
371 /** Get the Event Manager from which the media instance send event.
372 * \param p_mi the Media Instance
374 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_instance_event_manager ( libvlc_media_instance_t *, libvlc_exception_t * );
376 VLC_PUBLIC_API void libvlc_media_instance_play ( libvlc_media_instance_t *, libvlc_exception_t * );
377 VLC_PUBLIC_API void libvlc_media_instance_pause ( libvlc_media_instance_t *, libvlc_exception_t * );
378 VLC_PUBLIC_API void libvlc_media_instance_stop ( libvlc_media_instance_t *, libvlc_exception_t * );
380 VLC_PUBLIC_API void libvlc_media_instance_set_drawable ( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
382 /// \bug This might go away ... to be replaced by a broader system
383 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_length ( libvlc_media_instance_t *, libvlc_exception_t *);
384 VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_time ( libvlc_media_instance_t *, libvlc_exception_t *);
385 VLC_PUBLIC_API void libvlc_media_instance_set_time ( libvlc_media_instance_t *, vlc_int64_t, libvlc_exception_t *);
386 VLC_PUBLIC_API float libvlc_media_instance_get_position ( libvlc_media_instance_t *, libvlc_exception_t *);
387 VLC_PUBLIC_API void libvlc_media_instance_set_position ( libvlc_media_instance_t *, float, libvlc_exception_t *);
388 VLC_PUBLIC_API vlc_bool_t libvlc_media_instance_will_play ( libvlc_media_instance_t *, libvlc_exception_t *);
389 VLC_PUBLIC_API float libvlc_media_instance_get_rate ( libvlc_media_instance_t *, libvlc_exception_t *);
390 VLC_PUBLIC_API void libvlc_media_instance_set_rate ( libvlc_media_instance_t *, float, libvlc_exception_t *);
391 VLC_PUBLIC_API int libvlc_media_instance_get_state ( libvlc_media_instance_t *, libvlc_exception_t *);
394 * Does this input have a video output ?
395 * \param p_input the input
396 * \param p_exception an initialized exception
398 VLC_PUBLIC_API vlc_bool_t libvlc_media_instance_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
399 VLC_PUBLIC_API float libvlc_media_instance_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
404 /*****************************************************************************
406 *****************************************************************************/
407 /** defgroup libvlc_tag_query Tag Query
412 VLC_PUBLIC_API libvlc_tag_query_t *
413 libvlc_tag_query_new( libvlc_instance_t *, libvlc_exception_t * );
416 libvlc_tag_query_release( libvlc_tag_query_t * );
419 libvlc_tag_query_retain( libvlc_tag_query_t * );
422 libvlc_tag_query_set_match_tag_and_key( libvlc_tag_query_t * p_q,
425 libvlc_exception_t * );
427 VLC_PUBLIC_API vlc_bool_t
428 libvlc_tag_query_match( libvlc_tag_query_t *, libvlc_media_descriptor_t *,
429 libvlc_exception_t * );
433 /*****************************************************************************
435 *****************************************************************************/
436 /** defgroup libvlc_media_list MediaList
441 VLC_PUBLIC_API libvlc_media_list_t *
442 libvlc_media_list_new( libvlc_instance_t *, libvlc_exception_t * );
445 libvlc_media_list_release( libvlc_media_list_t * );
448 libvlc_media_list_retain( libvlc_media_list_t * );
451 libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
452 const char * psz_uri,
453 libvlc_exception_t * p_e );
456 libvlc_media_list_set_name( libvlc_media_list_t *,
457 const char * psz_name,
458 libvlc_exception_t *);
460 VLC_PUBLIC_API char *
461 libvlc_media_list_name( libvlc_media_list_t *,
462 libvlc_exception_t *);
465 libvlc_media_list_add_media_descriptor( libvlc_media_list_t *,
466 libvlc_media_descriptor_t *,
467 libvlc_exception_t * );
469 libvlc_media_list_insert_media_descriptor( libvlc_media_list_t *,
470 libvlc_media_descriptor_t *,
472 libvlc_exception_t * );
474 libvlc_media_list_remove_index( libvlc_media_list_t *, int,
475 libvlc_exception_t * );
478 libvlc_media_list_count( libvlc_media_list_t * p_mlist,
479 libvlc_exception_t * p_e );
481 VLC_PUBLIC_API libvlc_media_descriptor_t *
482 libvlc_media_list_item_at_index( libvlc_media_list_t *, int,
483 libvlc_exception_t * );
485 libvlc_media_list_index_of_item( libvlc_media_list_t *,
486 libvlc_media_descriptor_t *,
487 libvlc_exception_t * );
490 libvlc_media_list_lock( libvlc_media_list_t * );
492 libvlc_media_list_unlock( libvlc_media_list_t * );
494 VLC_PUBLIC_API libvlc_media_list_t *
495 libvlc_media_list_flat_media_list( libvlc_media_list_t *,
496 libvlc_exception_t * );
498 VLC_PUBLIC_API libvlc_event_manager_t *
499 libvlc_media_list_event_manager( libvlc_media_list_t *,
500 libvlc_exception_t * );
503 /*****************************************************************************
505 *****************************************************************************/
506 /** defgroup libvlc_media_list MediaList
511 VLC_PUBLIC_API libvlc_dynamic_media_list_t *
512 libvlc_dynamic_media_list_new( libvlc_media_list_t * p_mlist,
513 libvlc_tag_query_t * p_query,
515 libvlc_exception_t * p_e );
517 libvlc_dynamic_media_list_release( libvlc_dynamic_media_list_t * p_dmlist );
520 libvlc_dynamic_media_list_retain( libvlc_dynamic_media_list_t * p_dmlist );
522 libvlc_media_list_t *
523 libvlc_dynamic_media_list_media_list( libvlc_dynamic_media_list_t * p_dmlist,
524 libvlc_exception_t * p_e );
528 /*****************************************************************************
530 *****************************************************************************/
531 /** defgroup libvlc_media_library Media Library
533 * LibVLC Media Library
536 VLC_PUBLIC_API libvlc_media_library_t *
537 libvlc_media_library_new( libvlc_instance_t * p_inst,
538 libvlc_exception_t * p_e );
540 libvlc_media_library_release( libvlc_media_library_t * p_mlib );
542 libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
546 libvlc_media_library_load( libvlc_media_library_t * p_mlib,
547 libvlc_exception_t * p_e );
550 libvlc_media_library_save( libvlc_media_library_t * p_mlib,
551 libvlc_exception_t * p_e );
553 VLC_PUBLIC_API libvlc_media_list_t *
554 libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
555 libvlc_exception_t * p_e );
560 /*****************************************************************************
562 *****************************************************************************/
563 /** defgroup libvlc_media_list_player MediaListPlayer
565 * LibVLC Media List Player
568 VLC_PUBLIC_API libvlc_media_list_player_t *
569 libvlc_media_list_player_new( libvlc_instance_t * p_instance,
570 libvlc_exception_t * p_e );
572 libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
575 libvlc_media_list_player_set_media_instance(
576 libvlc_media_list_player_t * p_mlp,
577 libvlc_media_instance_t * p_mi,
578 libvlc_exception_t * p_e );
581 libvlc_media_list_player_set_media_list(
582 libvlc_media_list_player_t * p_mlp,
583 libvlc_media_list_t * p_mlist,
584 libvlc_exception_t * p_e );
587 libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
588 libvlc_exception_t * p_e );
591 libvlc_media_list_player_play_item_at_index(
592 libvlc_media_list_player_t * p_mlp,
594 libvlc_exception_t * p_e );
597 libvlc_media_list_player_play_item(
598 libvlc_media_list_player_t * p_mlp,
599 libvlc_media_descriptor_t * p_md,
600 libvlc_exception_t * p_e );
603 libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
604 libvlc_exception_t * p_e );
606 libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
607 libvlc_exception_t * p_e );
611 /** defgroup libvlc_video Video
613 * LibVLC Video handling
618 * Does this input have a video output ?
619 * \param p_input the input
620 * \param p_exception an initialized exception
622 VLC_PUBLIC_API vlc_bool_t libvlc_input_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
623 VLC_PUBLIC_API float libvlc_input_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
626 * Toggle fullscreen status on video output
627 * \param p_input the input
628 * \param p_exception an initialized exception
630 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
633 * Enable or disable fullscreen on a video output
634 * \param p_input the input
635 * \param b_fullscreen boolean for fullscreen status
636 * \param p_exception an initialized exception
638 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_instance_t *, int, libvlc_exception_t * );
641 * Get current fullscreen status
642 * \param p_input the input
643 * \param p_exception an initialized exception
644 * \return the fullscreen status (boolean)
646 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
649 * Get current video height
650 * \param p_input the input
651 * \param p_exception an initialized exception
652 * \return the video height
654 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_instance_t *, libvlc_exception_t * );
657 * Get current video width
658 * \param p_input the input
659 * \param p_exception an initialized exception
660 * \return the video width
662 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_instance_t *, libvlc_exception_t * );
665 * Get current video aspect ratio
666 * \param p_input the input
667 * \param p_exception an initialized exception
668 * \return the video aspect ratio
670 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_instance_t *, libvlc_exception_t * );
673 * Set new video aspect ratio
674 * \param p_input the input
675 * \param psz_aspect new video aspect-ratio
676 * \param p_exception an initialized exception
678 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_instance_t *, char *, libvlc_exception_t * );
681 * Get current video subtitle
682 * \param p_input the input
683 * \param p_exception an initialized exception
684 * \return the video subtitle selected
686 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_instance_t *, libvlc_exception_t * );
689 * Set new video subtitle
690 * \param p_input the input
691 * \param i_spu new video subtitle to select
692 * \param p_exception an initialized exception
694 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_instance_t *, int , libvlc_exception_t * );
697 * Get current crop filter geometry
698 * \param p_input the input
699 * \param p_exception an initialized exception
700 * \return the crop filter geometry
702 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_instance_t *, libvlc_exception_t * );
705 * Set new crop filter geometry
706 * \param p_input the input
707 * \param psz_geometry new crop filter geometry
708 * \param p_exception an initialized exception
710 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_instance_t *, char *, libvlc_exception_t * );
713 * Get current teletext page requested.
714 * \param p_input the input
715 * \param p_exception an initialized exception
716 * \return the current teletext page requested.
718 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
721 * Set new teletext page to retrieve
722 * \param p_input the input
723 * \param i_page teletex page number requested
724 * \param p_exception an initialized exception
726 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_instance_t *, int, libvlc_exception_t * );
729 * Take a snapshot of the current video window
730 * \param p_input the input
731 * \param psz_filepath the path where to save the screenshot to
732 * \param p_exception an initialized exception
734 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_instance_t *, char *, libvlc_exception_t * );
736 VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *);
739 * Resize the current video output window
740 * \param p_instance libvlc instance
741 * \param width new width for video output window
742 * \param height new height for video output window
743 * \param p_exception an initialized exception
744 * \return the success status (boolean)
746 VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *);
749 * change the parent for the current the video output
750 * \param p_instance libvlc instance
751 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
752 * \param p_exception an initialized exception
753 * \return the success status (boolean)
755 VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
758 * Tell windowless video output to redraw rectangular area (MacOS X only)
759 * \param p_instance libvlc instance
760 * \param area coordinates within video drawable
761 * \param p_exception an initialized exception
763 VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
766 * Set the default video output parent
767 * this settings will be used as default for all video outputs
768 * \param p_instance libvlc instance
769 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
770 * \param p_exception an initialized exception
772 VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
775 * Set the default video output parent
776 * this settings will be used as default for all video outputs
777 * \param p_instance libvlc instance
778 * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
779 * \param p_exception an initialized exception
781 VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
784 * Set the default video output size
785 * this settings will be used as default for all video outputs
786 * \param p_instance libvlc instance
787 * \param width new width for video drawable
788 * \param height new height for video drawable
789 * \param p_exception an initialized exception
791 VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
794 * Set the default video output viewport for a windowless video output (MacOS X only)
795 * this settings will be used as default for all video outputs
796 * \param p_instance libvlc instance
797 * \param view coordinates within video drawable
798 * \param clip coordinates within video drawable
799 * \param p_exception an initialized exception
801 VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
805 /** defgroup libvlc_audio Audio
807 * LibVLC Audio handling
813 * \param p_instance libvlc instance
814 * \param p_exception an initialized exception
817 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
820 * Get current mute status
821 * \param p_instance libvlc instance
822 * \param p_exception an initialized exception
823 * \return the mute status (boolean)
825 VLC_PUBLIC_API vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
829 * \param p_instance libvlc instance
830 * \param status If status is VLC_TRUE then mute, otherwise unmute
831 * \param p_exception an initialized exception
834 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * );
837 * Get current audio level
838 * \param p_instance libvlc instance
839 * \param p_exception an initialized exception
840 * \return the audio level (int)
842 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
845 * Set current audio level
846 * \param p_instance libvlc instance
847 * \param i_volume the volume (int)
848 * \param p_exception an initialized exception
850 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
853 + * Get current audio track
854 + * \param p_input input instance
855 + * \param p_exception an initialized exception
856 + * \return the audio track (int)
858 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_instance_t *, libvlc_exception_t * );
861 * Set current audio track
862 * \param p_input input instance
863 * \param i_track the track (int)
864 * \param p_exception an initialized exception
866 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_instance_t *, int, libvlc_exception_t * );
869 * Get current audio channel
870 * \param p_instance input instance
871 * \param p_exception an initialized exception
872 * \return the audio channel (int)
874 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
877 * Set current audio channel
878 * \param p_instance input instance
879 * \param i_channel the audio channel (int)
880 * \param p_exception an initialized exception
882 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * );
886 /*****************************************************************************
887 * Services/Media Discovery
888 *****************************************************************************/
889 /** defgroup libvlc_media_discoverer Media Discoverer
891 * LibVLC Media Discoverer
895 VLC_PUBLIC_API libvlc_media_discoverer_t *
896 libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
897 const char * psz_name,
898 libvlc_exception_t * p_e );
899 VLC_PUBLIC_API void libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
900 VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
902 VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
906 /*****************************************************************************
908 *****************************************************************************/
909 /** defgroup libvlc_vlm VLM
916 * Add a broadcast, with one input
917 * \param p_instance the instance
918 * \param psz_name the name of the new broadcast
919 * \param psz_input the input MRL
920 * \param psz_output the output MRL (the parameter to the "sout" variable)
921 * \param i_options number of additional options
922 * \param ppsz_options additional options
923 * \param b_enabled boolean for enabling the new broadcast
924 * \param b_loop Should this broadcast be played in loop ?
925 * \param p_exception an initialized exception
927 VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
928 int, char **, int, int, libvlc_exception_t * );
931 * Delete a media (vod or broadcast)
932 * \param p_instance the instance
933 * \param psz_name the media to delete
934 * \param p_exception an initialized exception
936 VLC_PUBLIC_API void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
939 * Enable or disable a media (vod or broadcast)
940 * \param p_instance the instance
941 * \param psz_name the media to work on
942 * \param b_enabled the new status
943 * \param p_exception an initialized exception
945 VLC_PUBLIC_API void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
946 libvlc_exception_t *);
949 * Set the output for a media
950 * \param p_instance the instance
951 * \param psz_name the media to work on
952 * \param psz_output the output MRL (the parameter to the "sout" variable)
953 * \param p_exception an initialized exception
955 VLC_PUBLIC_API void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
956 libvlc_exception_t *);
959 * Set a media's input MRL. This will delete all existing inputs and
960 * add the specified one.
961 * \param p_instance the instance
962 * \param psz_name the media to work on
963 * \param psz_input the input MRL
964 * \param p_exception an initialized exception
966 VLC_PUBLIC_API void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
967 libvlc_exception_t *);
970 * Add a media's input MRL. This will add the specified one.
971 * \param p_instance the instance
972 * \param psz_name the media to work on
973 * \param psz_input the input MRL
974 * \param p_exception an initialized exception
976 VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, char *, char *,
977 libvlc_exception_t *p_exception );
979 * Set output for a media
980 * \param p_instance the instance
981 * \param psz_name the media to work on
982 * \param b_loop the new status
983 * \param p_exception an initialized exception
985 VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
986 libvlc_exception_t *);
989 * Edit the parameters of a media. This will delete all existing inputs and
990 * add the specified one.
991 * \param p_instance the instance
992 * \param psz_name the name of the new broadcast
993 * \param psz_input the input MRL
994 * \param psz_output the output MRL (the parameter to the "sout" variable)
995 * \param i_options number of additional options
996 * \param ppsz_options additional options
997 * \param b_enabled boolean for enabling the new broadcast
998 * \param b_loop Should this broadcast be played in loop ?
999 * \param p_exception an initialized exception
1001 VLC_PUBLIC_API void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
1002 int, char **, int, int, libvlc_exception_t * );
1005 * Plays the named broadcast.
1006 * \param p_instance the instance
1007 * \param psz_name the name of the broadcast
1008 * \param p_exception an initialized exception
1010 VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1013 * Stops the named broadcast.
1014 * \param p_instance the instance
1015 * \param psz_name the name of the broadcast
1016 * \param p_exception an initialized exception
1018 VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
1021 * Pauses the named broadcast.
1022 * \param p_instance the instance
1023 * \param psz_name the name of the broadcast
1024 * \param p_exception an initialized exception
1026 VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1029 * Seeks in the named broadcast.
1030 * \param p_instance the instance
1031 * \param psz_name the name of the broadcast
1032 * \param f_percentage the percentage to seek to
1033 * \param p_exception an initialized exception
1035 VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
1036 float, libvlc_exception_t * );
1039 * Return information of the named broadcast.
1040 * \param p_instance the instance
1041 * \param psz_name the name of the broadcast
1042 * \param p_exception an initialized exception
1044 VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
1046 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
1047 returnType libvlc_vlm_get_media_## attr( libvlc_instance_t *, \
1048 char *, int , libvlc_exception_t * );
1050 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1);
1051 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time, int, Integer, -1);
1052 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length, int, Integer, -1);
1053 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate, int, Integer, -1);
1054 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title, int, Integer, 0);
1055 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter, int, Integer, 0);
1056 VLC_PUBLIC_API LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool, 0);
1058 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
1062 /*****************************************************************************
1063 * Message log handling
1064 *****************************************************************************/
1066 /** defgroup libvlc_log Log
1068 * LibVLC Message Logging
1073 * Returns the VLC messaging verbosity level
1074 * \param p_instance libvlc instance
1075 * \param exception an initialized exception pointer
1077 VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
1078 libvlc_exception_t *p_e );
1081 * Set the VLC messaging verbosity level
1082 * \param p_log libvlc log instance
1083 * \param exception an initialized exception pointer
1085 VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
1086 libvlc_exception_t *p_e );
1089 * Open an instance to VLC message log
1090 * \param p_instance libvlc instance
1091 * \param exception an initialized exception pointer
1093 VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( const libvlc_instance_t *, libvlc_exception_t *);
1096 * Close an instance of VLC message log
1097 * \param p_log libvlc log instance
1098 * \param exception an initialized exception pointer
1100 VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
1103 * Returns the number of messages in log
1104 * \param p_log libvlc log instance
1105 * \param exception an initialized exception pointer
1107 VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
1110 * Clear all messages in log
1111 * the log should be cleared on a regular basis to avoid clogging
1112 * \param p_log libvlc log instance
1113 * \param exception an initialized exception pointer
1115 VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
1118 * Allocate and returns a new iterator to messages in log
1119 * \param p_log libvlc log instance
1120 * \param exception an initialized exception pointer
1122 VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
1125 * Releases a previoulsy allocated iterator
1126 * \param p_log libvlc log iterator
1127 * \param exception an initialized exception pointer
1129 VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1132 * Returns whether log iterator has more messages
1133 * \param p_log libvlc log iterator
1134 * \param exception an initialized exception pointer
1136 VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
1139 * Returns next log message
1140 * the content of message must not be freed
1141 * \param p_log libvlc log iterator
1142 * \param exception an initialized exception pointer
1144 VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
1145 struct libvlc_log_message_t *buffer,
1146 libvlc_exception_t *p_e );
1150 /*****************************************************************************
1152 *****************************************************************************/
1154 /** defgroup libvlc_callbacks Callbacks
1161 * Register for an event notification
1162 * \param p_event_manager the event manager to which you want to attach to
1163 * Generally it is obtained by vlc_my_object_event_manager() where my_object
1164 * Is the object you want to listen to.
1165 * \param i_event_type the desired event to which we want to listen
1166 * \param f_callback the function to call when i_event_type occurs
1167 * \param user_data user provided data to carry with the event
1168 * \param p_e an initialized exception pointer
1170 VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
1171 libvlc_event_type_t i_event_type,
1172 libvlc_callback_t f_callback,
1174 libvlc_exception_t *p_e );
1177 * Unregister an event notification
1178 * \param p_event_manager the event manager
1179 * \param i_event_type the desired event to which we want to unregister
1180 * \param f_callback the function to call when i_event_type occurs
1181 * \param p_e an initialized exception pointer
1183 VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
1184 libvlc_event_type_t i_event_type,
1185 libvlc_callback_t f_callback,
1187 libvlc_exception_t *p_e );
1190 * Get an event type name
1191 * \param i_event_type the desired event
1193 #define libvlc_event_type_name(a) #a
1202 #endif /* <vlc/libvlc.h> */