1 /*****************************************************************************
2 * libvlc_media_player.h: libvlc_media_player external API
3 *****************************************************************************
4 * Copyright (C) 1998-2009 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@videolan.org>
8 * Jean-Paul Saman <jpsaman@videolan.org>
9 * Pierre d'Herbemont <pdherbemont@videolan.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
28 * This file defines libvlc_media_player external API
31 #ifndef VLC_LIBVLC_MEDIA_PLAYER_H
32 #define VLC_LIBVLC_MEDIA_PLAYER_H 1
34 /*****************************************************************************
36 *****************************************************************************/
37 /** \defgroup libvlc_media_player libvlc_media_player
39 * LibVLC Media Player, object that let you play a media
40 * in a custom drawable
44 typedef struct libvlc_media_player_t libvlc_media_player_t;
47 * Description for video, audio tracks and subtitles. It contains
48 * id, name (description string) and pointer to next record.
50 typedef struct libvlc_track_description_t
54 struct libvlc_track_description_t *p_next;
56 } libvlc_track_description_t;
59 * Description for audio output. It contains
60 * name, description and pointer to next record.
62 typedef struct libvlc_audio_output_t
65 char *psz_description;
66 struct libvlc_audio_output_t *p_next;
68 } libvlc_audio_output_t;
71 * Rectangle type for video geometry
73 typedef struct libvlc_rectangle_t
80 * Marq int options definition
82 typedef enum libvlc_video_marquee_int_option_t {
83 libvlc_marquee_Enabled = 0,
85 libvlc_marquee_Opacity,
86 libvlc_marquee_Position,
87 libvlc_marquee_Refresh,
89 libvlc_marquee_Timeout,
92 } libvlc_video_marquee_int_option_t;
95 * Marq string options definition
97 typedef enum libvlc_video_marquee_string_option_t {
98 libvlc_marquee_Text = 0
99 } libvlc_video_marquee_string_option_t;
103 * Create an empty Media Player object
105 * \param p_libvlc_instance the libvlc instance in which the Media Player
107 * \param p_e an initialized exception pointer
109 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new( libvlc_instance_t *, libvlc_exception_t * );
112 * Create a Media Player object from a Media
114 * \param p_md the media. Afterwards the p_md can be safely
116 * \param p_e an initialized exception pointer
118 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new_from_media( libvlc_media_t *, libvlc_exception_t * );
121 * Release a media_player after use
122 * Decrement the reference count of a media player object. If the
123 * reference count is 0, then libvlc_media_player_release() will
124 * release the media player object. If the media player object
125 * has been released, then it should not be used again.
127 * \param p_mi the Media Player to free
129 VLC_PUBLIC_API void libvlc_media_player_release( libvlc_media_player_t * );
132 * Retain a reference to a media player object. Use
133 * libvlc_media_player_release() to decrement reference count.
135 * \param p_mi media player object
137 VLC_PUBLIC_API void libvlc_media_player_retain( libvlc_media_player_t * );
140 * Set the media that will be used by the media_player. If any,
141 * previous md will be released.
143 * \param p_mi the Media Player
144 * \param p_md the Media. Afterwards the p_md can be safely
146 * \param p_e an initialized exception pointer
148 VLC_PUBLIC_API void libvlc_media_player_set_media( libvlc_media_player_t *, libvlc_media_t *, libvlc_exception_t * );
151 * Get the media used by the media_player.
153 * \param p_mi the Media Player
154 * \param p_e an initialized exception pointer
155 * \return the media associated with p_mi, or NULL if no
156 * media is associated
158 VLC_PUBLIC_API libvlc_media_t * libvlc_media_player_get_media( libvlc_media_player_t *, libvlc_exception_t * );
161 * Get the Event Manager from which the media player send event.
163 * \param p_mi the Media Player
164 * \param p_e an initialized exception pointer
165 * \return the event manager associated with p_mi
167 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_media_player_t *, libvlc_exception_t * );
172 * \param p_mi the Media Player
173 * \param p_e an initialized exception pointer
174 * \return 1 if the media player is playing, 0 otherwise
176 VLC_PUBLIC_API int libvlc_media_player_is_playing ( libvlc_media_player_t *, libvlc_exception_t * );
181 * \param p_mi the Media Player
182 * \param p_e an initialized exception pointer
184 VLC_PUBLIC_API void libvlc_media_player_play ( libvlc_media_player_t *, libvlc_exception_t * );
189 * \param p_mi the Media Player
190 * \param p_e an initialized exception pointer
192 VLC_PUBLIC_API void libvlc_media_player_pause ( libvlc_media_player_t *, libvlc_exception_t * );
197 * \param p_mi the Media Player
198 * \param p_e an initialized exception pointer
200 VLC_PUBLIC_API void libvlc_media_player_stop ( libvlc_media_player_t *, libvlc_exception_t * );
203 * Set the agl handler where the media player should render its video output.
205 * \param p_mi the Media Player
206 * \param drawable the agl handler
207 * \param p_e an initialized exception pointer
209 VLC_PUBLIC_API void libvlc_media_player_set_nsobject ( libvlc_media_player_t *p_mi, void * drawable, libvlc_exception_t *p_e );
212 * Get the agl handler previously set with libvlc_media_player_set_agl().
214 * \return the agl handler or 0 if none where set
216 VLC_PUBLIC_API void * libvlc_media_player_get_nsobject ( libvlc_media_player_t *p_mi );
219 * Set the agl handler where the media player should render its video output.
221 * \param p_mi the Media Player
222 * \param drawable the agl handler
223 * \param p_e an initialized exception pointer
225 VLC_PUBLIC_API void libvlc_media_player_set_agl ( libvlc_media_player_t *p_mi, uint32_t drawable, libvlc_exception_t *p_e );
228 * Get the agl handler previously set with libvlc_media_player_set_agl().
230 * \param p_mi the Media Player
231 * \return the agl handler or 0 if none where set
233 VLC_PUBLIC_API uint32_t libvlc_media_player_get_agl ( libvlc_media_player_t *p_mi );
236 * Set an X Window System drawable where the media player should render its
237 * video output. If LibVLC was built without X11 output support, then this has
240 * The specified identifier must correspond to an existing Input/Output class
241 * X11 window. Pixmaps are <b>not</b> supported. The caller shall ensure that
242 * the X11 server is the same as the one the VLC instance has been configured
244 * If XVideo is <b>not</b> used, it is assumed that the drawable has the
245 * following properties in common with the default X11 screen: depth, scan line
246 * pad, black pixel. This is a bug.
248 * \param p_mi the Media Player
249 * \param drawable the ID of the X window
250 * \param p_e an initialized exception pointer
252 VLC_PUBLIC_API void libvlc_media_player_set_xwindow ( libvlc_media_player_t *p_mi, uint32_t drawable, libvlc_exception_t *p_e );
255 * Get the X Window System window identifier previously set with
256 * libvlc_media_player_set_xwindow(). Note that this will return the identifier
257 * even if VLC is not currently using it (for instance if it is playing an
260 * \return an X window ID, or 0 if none where set.
262 VLC_PUBLIC_API uint32_t libvlc_media_player_get_xwindow ( libvlc_media_player_t *p_mi );
265 * Set a Win32/Win64 API window handle (HWND) where the media player should
266 * render its video output. If LibVLC was built without Win32/Win64 API output
267 * support, then this has no effects.
269 * \param p_mi the Media Player
270 * \param drawable windows handle of the drawable
271 * \param p_e an initialized exception pointer
273 VLC_PUBLIC_API void libvlc_media_player_set_hwnd ( libvlc_media_player_t *p_mi, void *drawable, libvlc_exception_t *p_e );
276 * Get the Windows API window handle (HWND) previously set with
277 * libvlc_media_player_set_hwnd(). The handle will be returned even if LibVLC
278 * is not currently outputting any video to it.
280 * \return a window handle or NULL if there are none.
282 VLC_PUBLIC_API void *libvlc_media_player_get_hwnd ( libvlc_media_player_t *p_mi );
286 /** \bug This might go away ... to be replaced by a broader system */
289 * Get the current movie length (in ms).
291 * \param p_mi the Media Player
292 * \param p_e an initialized exception pointer
293 * \return the movie length (in ms).
295 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length( libvlc_media_player_t *, libvlc_exception_t *);
298 * Get the current movie time (in ms).
300 * \param p_mi the Media Player
301 * \param p_e an initialized exception pointer
302 * \return the movie time (in ms).
304 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *, libvlc_exception_t *);
307 * Set the movie time (in ms).
309 * \param p_mi the Media Player
310 * \param the movie time (in ms).
311 * \param p_e an initialized exception pointer
313 VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *);
316 * Get movie position.
318 * \param p_mi the Media Player
319 * \param p_e an initialized exception pointer
320 * \return movie position
322 VLC_PUBLIC_API float libvlc_media_player_get_position( libvlc_media_player_t *, libvlc_exception_t *);
325 * Set movie position.
327 * \param p_mi the Media Player
328 * \param f_pos the position
329 * \param p_e an initialized exception pointer
331 VLC_PUBLIC_API void libvlc_media_player_set_position( libvlc_media_player_t *, float, libvlc_exception_t *);
336 * \param p_mi the Media Player
337 * \param i_chapter chapter number to play
338 * \param p_e an initialized exception pointer
340 VLC_PUBLIC_API void libvlc_media_player_set_chapter( libvlc_media_player_t *, int, libvlc_exception_t *);
345 * \param p_mi the Media Player
346 * \param p_e an initialized exception pointer
347 * \return chapter number currently playing
349 VLC_PUBLIC_API int libvlc_media_player_get_chapter( libvlc_media_player_t *, libvlc_exception_t * );
352 * Get movie chapter count
354 * \param p_mi the Media Player
355 * \param p_e an initialized exception pointer
356 * \return number of chapters in movie
358 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *, libvlc_exception_t *);
361 * Will the player play
363 * \param p_mi the Media Player
364 * \param p_e an initialized exception pointer
367 VLC_PUBLIC_API int libvlc_media_player_will_play ( libvlc_media_player_t *, libvlc_exception_t *);
370 * Get title chapter count
372 * \param p_mi the Media Player
373 * \param i_title title
374 * \param p_e an initialized exception pointer
375 * \return number of chapters in title
377 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count_for_title(
378 libvlc_media_player_t *, int, libvlc_exception_t *);
383 * \param p_mi the Media Player
384 * \param i_title title number to play
385 * \param p_e an initialized exception pointer
387 VLC_PUBLIC_API void libvlc_media_player_set_title( libvlc_media_player_t *, int, libvlc_exception_t *);
392 * \param p_mi the Media Player
393 * \param p_e an initialized exception pointer
394 * \return title number currently playing
396 VLC_PUBLIC_API int libvlc_media_player_get_title( libvlc_media_player_t *, libvlc_exception_t *);
399 * Get movie title count
401 * \param p_mi the Media Player
402 * \param p_e an initialized exception pointer
403 * \return title number count
405 VLC_PUBLIC_API int libvlc_media_player_get_title_count( libvlc_media_player_t *, libvlc_exception_t *);
408 * Set previous chapter
410 * \param p_mi the Media Player
411 * \param p_e an initialized exception pointer
413 VLC_PUBLIC_API void libvlc_media_player_previous_chapter( libvlc_media_player_t *, libvlc_exception_t *);
418 * \param p_mi the Media Player
419 * \param p_e an initialized exception pointer
421 VLC_PUBLIC_API void libvlc_media_player_next_chapter( libvlc_media_player_t *, libvlc_exception_t *);
424 * Get movie play rate
426 * \param p_mi the Media Player
427 * \param p_e an initialized exception pointer
428 * \return movie play rate
430 VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t *, libvlc_exception_t *);
433 * Set movie play rate
435 * \param p_mi the Media Player
436 * \param movie play rate to set
437 * \param p_e an initialized exception pointer
439 VLC_PUBLIC_API void libvlc_media_player_set_rate( libvlc_media_player_t *, float, libvlc_exception_t *);
442 * Get current movie state
444 * \param p_mi the Media Player
445 * \param p_e an initialized exception pointer
446 * \return current movie state as libvlc_state_t
448 VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *, libvlc_exception_t *);
453 * \param p_mi the Media Player
454 * \param p_e an initialized exception pointer
455 * \return frames per second (fps) for this playing movie
457 VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *, libvlc_exception_t *);
462 * Does this media player have a video output?
464 * \param p_md the media player
465 * \param p_e an initialized exception pointer
467 VLC_PUBLIC_API int libvlc_media_player_has_vout( libvlc_media_player_t *, libvlc_exception_t *);
470 * Is this media player seekable?
472 * \param p_input the input
473 * \param p_e an initialized exception pointer
475 VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
478 * Can this media player be paused?
480 * \param p_input the input
481 * \param p_e an initialized exception pointer
483 VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
487 * Display the next frame
489 * \param p_input the libvlc_media_player_t instance
490 * \param p_e an initialized exception pointer
492 VLC_PUBLIC_API void libvlc_media_player_next_frame( libvlc_media_player_t *p_input,
493 libvlc_exception_t *p_e );
498 * Release (free) libvlc_track_description_t
500 * \param p_track_description the structure to release
502 VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t *p_track_description );
504 /** \defgroup libvlc_video libvlc_video
505 * \ingroup libvlc_media_player
506 * LibVLC Video handling
511 * Toggle fullscreen status on video output.
513 * \param p_mediaplayer the media player
514 * \param p_e an initialized exception pointer
516 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
519 * Enable or disable fullscreen on a video output.
521 * \param p_mediaplayer the media player
522 * \param b_fullscreen boolean for fullscreen status
523 * \param p_e an initialized exception pointer
525 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *, int, libvlc_exception_t * );
528 * Get current fullscreen status.
530 * \param p_mediaplayer the media player
531 * \param p_e an initialized exception pointer
532 * \return the fullscreen status (boolean)
534 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
537 * Get current video height.
539 * \param p_mediaplayer the media player
540 * \param p_e an initialized exception pointer
541 * \return the video height
543 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_player_t *, libvlc_exception_t * );
546 * Get current video width.
548 * \param p_mediaplayer the media player
549 * \param p_e an initialized exception pointer
550 * \return the video width
552 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_player_t *, libvlc_exception_t * );
555 * Get the current video scaling factor.
556 * See also libvlc_video_set_scale().
558 * \param p_mediaplayer the media player
559 * \param p_e an initialized exception pointer
560 * \return the currently configured zoom factor, or 0. if the video is set
561 * to fit to the output window/drawable automatically.
563 VLC_PUBLIC_API float libvlc_video_get_scale( libvlc_media_player_t *,
564 libvlc_exception_t *p_e );
567 * Set the video scaling factor. That is the ratio of the number of pixels on
568 * screen to the number of pixels in the original decoded video in each
569 * dimension. Zero is a special value; it will adjust the video to the output
570 * window/drawable (in windowed mode) or the entire screen.
572 * Note that not all video outputs support scaling.
574 * \param p_mediaplayer the media player
575 * \param i_factor the scaling factor, or zero
576 * \param p_e an initialized exception pointer
578 VLC_PUBLIC_API void libvlc_video_set_scale( libvlc_media_player_t *, float,
579 libvlc_exception_t *p_e );
582 * Get current video aspect ratio.
584 * \param p_mediaplayer the media player
585 * \param p_e an initialized exception pointer
586 * \return the video aspect ratio
588 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *, libvlc_exception_t * );
591 * Set new video aspect ratio.
593 * \param p_mediaplayer the media player
594 * \param psz_aspect new video aspect-ratio
595 * \param p_e an initialized exception pointer
597 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *, const char *, libvlc_exception_t * );
600 * Get current video subtitle.
602 * \param p_mediaplayer the media player
603 * \param p_e an initialized exception pointer
604 * \return the video subtitle selected
606 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *, libvlc_exception_t * );
609 * Get the number of available video subtitles.
611 * \param p_mediaplayer the media player
612 * \param p_e an initialized exception pointer
613 * \return the number of available video subtitles
615 VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t *, libvlc_exception_t * );
618 * Get the description of available video subtitles.
620 * \param p_mediaplayer the media player
621 * \param p_e an initialized exception pointer
622 * \return list containing description of available video subtitles
624 VLC_PUBLIC_API libvlc_track_description_t *
625 libvlc_video_get_spu_description( libvlc_media_player_t *, libvlc_exception_t * );
628 * Set new video subtitle.
630 * \param p_mediaplayer the media player
631 * \param i_spu new video subtitle to select
632 * \param p_e an initialized exception pointer
634 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_player_t *, int , libvlc_exception_t * );
637 * Set new video subtitle file.
639 * \param p_mediaplayer the media player
640 * \param psz_subtitle new video subtitle file
641 * \param p_e an initialized exception pointer
642 * \return the success status (boolean)
644 VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *, const char *, libvlc_exception_t * );
647 * Get the description of available titles.
649 * \param p_mediaplayer the media player
650 * \param p_e an initialized exception pointer
651 * \return list containing description of available titles
653 VLC_PUBLIC_API libvlc_track_description_t *
654 libvlc_video_get_title_description( libvlc_media_player_t *, libvlc_exception_t * );
657 * Get the description of available chapters for specific title.
659 * \param p_mediaplayer the media player
660 * \param i_title selected title
661 * \param p_e an initialized exception pointer
662 * \return list containing description of available chapter for title i_title
664 VLC_PUBLIC_API libvlc_track_description_t *
665 libvlc_video_get_chapter_description( libvlc_media_player_t *, int, libvlc_exception_t * );
668 * Get current crop filter geometry.
670 * \param p_mediaplayer the media player
671 * \param p_e an initialized exception pointer
672 * \return the crop filter geometry
674 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *, libvlc_exception_t * );
677 * Set new crop filter geometry.
679 * \param p_mediaplayer the media player
680 * \param psz_geometry new crop filter geometry
681 * \param p_e an initialized exception pointer
683 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_player_t *, const char *, libvlc_exception_t * );
686 * Toggle teletext transparent status on video output.
688 * \param p_mediaplayer the media player
689 * \param p_e an initialized exception pointer
691 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *, libvlc_exception_t * );
694 * Get current teletext page requested.
696 * \param p_mediaplayer the media player
697 * \param p_e an initialized exception pointer
698 * \return the current teletext page requested.
700 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *, libvlc_exception_t * );
703 * Set new teletext page to retrieve.
705 * \param p_mediaplayer the media player
706 * \param i_page teletex page number requested
707 * \param p_e an initialized exception pointer
709 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_player_t *, int, libvlc_exception_t * );
712 * Get number of available video tracks.
714 * \param p_mi media player
715 * \param p_e an initialized exception
716 * \return the number of available video tracks (int)
718 VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_t *, libvlc_exception_t * );
721 * Get the description of available video tracks.
723 * \param p_mi media player
724 * \param p_e an initialized exception
725 * \return list with description of available video tracks
727 VLC_PUBLIC_API libvlc_track_description_t *
728 libvlc_video_get_track_description( libvlc_media_player_t *, libvlc_exception_t * );
731 * Get current video track.
733 * \param p_mi media player
734 * \param p_e an initialized exception pointer
735 * \return the video track (int)
737 VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t *, libvlc_exception_t * );
742 * \param p_mi media player
743 * \param i_track the track (int)
744 * \param p_e an initialized exception pointer
746 VLC_PUBLIC_API void libvlc_video_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
749 * Take a snapshot of the current video window.
751 * If i_width AND i_height is 0, original size is used.
752 * If i_width XOR i_height is 0, original aspect-ratio is preserved.
754 * \param p_mi media player instance
755 * \param psz_filepath the path where to save the screenshot to
756 * \param i_width the snapshot's width
757 * \param i_height the snapshot's height
758 * \param p_e an initialized exception pointer
760 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_player_t *, const char *,unsigned int, unsigned int, libvlc_exception_t * );
763 * Enable or disable deinterlace filter
765 * \param p_mi libvlc media player
766 * \param b_enable boolean to enable or disable deinterlace filter
767 * \param psz_mode type of deinterlace filter to use
768 * \param p_e an initialized exception pointer
770 VLC_PUBLIC_API void libvlc_video_set_deinterlace( libvlc_media_player_t *,
772 libvlc_exception_t *);
775 * Get an option value (option which return an int)
777 * \param p_mi libvlc media player
778 * \param option marq option to get
779 * \param p_e an initialized exception pointer
781 VLC_PUBLIC_API int libvlc_video_get_marquee_option_as_int( libvlc_media_player_t *,
782 libvlc_video_marquee_int_option_t,
783 libvlc_exception_t * );
786 * Get an option value (option which return a string)
788 * \param p_mi libvlc media player
789 * \param option marq option to get
790 * \param p_e an initialized exception pointer
792 VLC_PUBLIC_API char *libvlc_video_get_marquee_option_as_string( libvlc_media_player_t *,
793 libvlc_video_marquee_string_option_t,
794 libvlc_exception_t * );
797 * Enable, disable or set a marq option (only int)
799 * \param p_mi libvlc media player
800 * \param option marq option to set
801 * \param i_val marq option value
802 * \param p_e an initialized exception pointer
804 VLC_PUBLIC_API void libvlc_video_set_marquee_option_as_int( libvlc_media_player_t *,
805 libvlc_video_marquee_int_option_t,
806 int, libvlc_exception_t * );
809 * Set a marq option (only string)
811 * \param p_mi libvlc media player
812 * \param option marq option to set
813 * \param psz_text marq option value
814 * \param p_e an initialized exception pointer
816 VLC_PUBLIC_API void libvlc_video_set_marquee_option_as_string( libvlc_media_player_t *,
817 libvlc_video_marquee_string_option_t,
819 libvlc_exception_t * );
823 /** \defgroup libvlc_audio libvlc_audio
824 * \ingroup libvlc_media_player
825 * LibVLC Audio handling
832 typedef enum libvlc_audio_output_device_types_t {
833 libvlc_AudioOutputDevice_Error = -1,
834 libvlc_AudioOutputDevice_Mono = 1,
835 libvlc_AudioOutputDevice_Stereo = 2,
836 libvlc_AudioOutputDevice_2F2R = 4,
837 libvlc_AudioOutputDevice_3F2R = 5,
838 libvlc_AudioOutputDevice_5_1 = 6,
839 libvlc_AudioOutputDevice_6_1 = 7,
840 libvlc_AudioOutputDevice_7_1 = 8,
841 libvlc_AudioOutputDevice_SPDIF = 10
842 } libvlc_audio_output_device_types_t;
847 typedef enum libvlc_audio_output_channel_t {
848 libvlc_AudioChannel_Error = -1,
849 libvlc_AudioChannel_Stereo = 1,
850 libvlc_AudioChannel_RStereo = 2,
851 libvlc_AudioChannel_Left = 3,
852 libvlc_AudioChannel_Right = 4,
853 libvlc_AudioChannel_Dolbys = 5
854 } libvlc_audio_output_channel_t;
858 * Get the list of available audio outputs
860 * \param p_instance libvlc instance
861 * \param p_e an initialized exception pointer
862 * \return list of available audio outputs, at the end free it with
863 * \see libvlc_audio_output_list_release \see libvlc_audio_output_t
865 VLC_PUBLIC_API libvlc_audio_output_t *
866 libvlc_audio_output_list_get( libvlc_instance_t *,
867 libvlc_exception_t * );
870 * Free the list of available audio outputs
872 * \param p_list list with audio outputs for release
874 VLC_PUBLIC_API void libvlc_audio_output_list_release( libvlc_audio_output_t * );
877 * Set the audio output.
878 * Change will be applied after stop and play.
880 * \param p_instance libvlc instance
881 * \param psz_name name of audio output,
882 * use psz_name of \see libvlc_audio_output_t
883 * \return true if function succeded
885 VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_instance_t *,
889 * Get count of devices for audio output, these devices are hardware oriented
890 * like analor or digital output of sound card
892 * \param p_instance libvlc instance
893 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
894 * \return number of devices
896 VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_t *,
900 * Get long name of device, if not available short name given
902 * \param p_instance libvlc instance
903 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
904 * \param i_device device index
905 * \return long name of device
907 VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_t *,
912 * Get id name of device
914 * \param p_instance libvlc instance
915 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
916 * \param i_device device index
917 * \return id name of device, use for setting device, need to be free after use
919 VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *,
924 * Set device for using
926 * \param p_instance libvlc instance
927 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
928 * \param psz_device_id device
930 VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_instance_t *,
935 * Get current audio device type. Device type describes something like
936 * character of output sound - stereo sound, 2.1, 5.1 etc
938 * \param p_instance vlc instance
939 * \param p_e an initialized exception pointer
940 * \return the audio devices type \see libvlc_audio_output_device_types_t
942 VLC_PUBLIC_API int libvlc_audio_output_get_device_type(
943 libvlc_instance_t *, libvlc_exception_t * );
946 * Set current audio device type.
948 * \param p_instance vlc instance
949 * \param device_type the audio device type,
950 according to \see libvlc_audio_output_device_types_t
951 * \param p_e an initialized exception pointer
953 VLC_PUBLIC_API void libvlc_audio_output_set_device_type( libvlc_instance_t *,
955 libvlc_exception_t * );
959 * Toggle mute status.
961 * \param p_instance libvlc instance
962 * \param p_e an initialized exception pointer
964 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
967 * Get current mute status.
969 * \param p_instance libvlc instance
970 * \param p_e an initialized exception pointer
971 * \return the mute status (boolean)
973 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
978 * \param p_instance libvlc instance
979 * \param status If status is true then mute, otherwise unmute
980 * \param p_e an initialized exception pointer
982 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, int , libvlc_exception_t * );
985 * Get current audio level.
987 * \param p_instance libvlc instance
988 * \param p_e an initialized exception pointer
989 * \return the audio level (int)
991 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
994 * Set current audio level.
996 * \param p_instance libvlc instance
997 * \param i_volume the volume (int)
998 * \param p_e an initialized exception pointer
1000 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
1003 * Get number of available audio tracks.
1005 * \param p_mi media player
1006 * \param p_e an initialized exception
1007 * \return the number of available audio tracks (int)
1009 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *, libvlc_exception_t * );
1012 * Get the description of available audio tracks.
1014 * \param p_mi media player
1015 * \param p_e an initialized exception
1016 * \return list with description of available audio tracks
1018 VLC_PUBLIC_API libvlc_track_description_t *
1019 libvlc_audio_get_track_description( libvlc_media_player_t *, libvlc_exception_t * );
1022 * Get current audio track.
1024 * \param p_mi media player
1025 * \param p_e an initialized exception pointer
1026 * \return the audio track (int)
1028 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *, libvlc_exception_t * );
1031 * Set current audio track.
1033 * \param p_mi media player
1034 * \param i_track the track (int)
1035 * \param p_e an initialized exception pointer
1037 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
1040 * Get current audio channel.
1042 * \param p_instance vlc instance
1043 * \param p_e an initialized exception pointer
1044 * \return the audio channel \see libvlc_audio_output_channel_t
1047 libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
1050 * Set current audio channel.
1052 * \param p_instance vlc instance
1053 * \param channel the audio channel, \see libvlc_audio_output_channel_t
1054 * \param p_e an initialized exception pointer
1056 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *,
1058 libvlc_exception_t * );
1062 /** @} media_player */
1064 #endif /* VLC_LIBVLC_MEDIA_PLAYER_H */