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 * \return the agl handler or 0 if none where set
232 VLC_PUBLIC_API uint32_t libvlc_media_player_get_agl ( libvlc_media_player_t *p_mi );
235 * Set an X Window System drawable where the media player should render its
236 * video output. If LibVLC was built without X11 output support, then this has
239 * The specified identifier must correspond to an existing Input/Output class
240 * X11 window. Pixmaps are <b>not</b> supported. The caller shall ensure that
241 * the X11 server is the same as the one the VLC instance has been configured
243 * If XVideo is <b>not</b> used, it is assumed that the drawable has the
244 * following properties in common with the default X11 screen: depth, scan line
245 * pad, black pixel. This is a bug.
247 * \param p_mi the Media Player
248 * \param drawable the ID of the X window
249 * \param p_e an initialized exception pointer
251 VLC_PUBLIC_API void libvlc_media_player_set_xwindow ( libvlc_media_player_t *p_mi, uint32_t drawable, libvlc_exception_t *p_e );
254 * Get the X Window System window identifier previously set with
255 * libvlc_media_player_set_xwindow(). Note that this will return the identifier
256 * even if VLC is not currently using it (for instance if it is playing an
259 * \return an X window ID, or 0 if none where set.
261 VLC_PUBLIC_API uint32_t libvlc_media_player_get_xwindow ( libvlc_media_player_t *p_mi );
264 * Set a Win32/Win64 API window handle (HWND) where the media player should
265 * render its video output. If LibVLC was built without Win32/Win64 API output
266 * support, then this has no effects.
268 * \param p_mi the Media Player
269 * \param drawable windows handle of the drawable
270 * \param p_e an initialized exception pointer
272 VLC_PUBLIC_API void libvlc_media_player_set_hwnd ( libvlc_media_player_t *p_mi, void *drawable, libvlc_exception_t *p_e );
275 * Get the Windows API window handle (HWND) previously set with
276 * libvlc_media_player_set_hwnd(). The handle will be returned even if LibVLC
277 * is not currently outputting any video to it.
279 * \return a window handle or NULL if there are none.
281 VLC_PUBLIC_API void *libvlc_media_player_get_hwnd ( libvlc_media_player_t *p_mi );
285 /** \bug This might go away ... to be replaced by a broader system */
288 * Get the current movie length (in ms).
290 * \param p_mi the Media Player
291 * \param p_e an initialized exception pointer
292 * \return the movie length (in ms).
294 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length( libvlc_media_player_t *, libvlc_exception_t *);
297 * Get the current movie time (in ms).
299 * \param p_mi the Media Player
300 * \param p_e an initialized exception pointer
301 * \return the movie time (in ms).
303 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *, libvlc_exception_t *);
306 * Set the movie time (in ms).
308 * \param p_mi the Media Player
309 * \param the movie time (in ms).
310 * \param p_e an initialized exception pointer
312 VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *);
315 * Get movie position.
317 * \param p_mi the Media Player
318 * \param p_e an initialized exception pointer
319 * \return movie position
321 VLC_PUBLIC_API float libvlc_media_player_get_position( libvlc_media_player_t *, libvlc_exception_t *);
324 * Set movie position.
326 * \param p_mi the Media Player
327 * \param f_pos the position
328 * \param p_e an initialized exception pointer
330 VLC_PUBLIC_API void libvlc_media_player_set_position( libvlc_media_player_t *, float, libvlc_exception_t *);
335 * \param p_mi the Media Player
336 * \param i_chapter chapter number to play
337 * \param p_e an initialized exception pointer
339 VLC_PUBLIC_API void libvlc_media_player_set_chapter( libvlc_media_player_t *, int, libvlc_exception_t *);
344 * \param p_mi the Media Player
345 * \param p_e an initialized exception pointer
346 * \return chapter number currently playing
348 VLC_PUBLIC_API int libvlc_media_player_get_chapter( libvlc_media_player_t *, libvlc_exception_t * );
351 * Get movie chapter count
353 * \param p_mi the Media Player
354 * \param p_e an initialized exception pointer
355 * \return number of chapters in movie
357 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *, libvlc_exception_t *);
358 VLC_PUBLIC_API int libvlc_media_player_will_play ( libvlc_media_player_t *, libvlc_exception_t *);
361 * Get title chapter count
363 * \param p_mi the Media Player
364 * \param i_title title
365 * \param p_e an initialized exception pointer
366 * \return number of chapters in title
368 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count_for_title(
369 libvlc_media_player_t *, int, libvlc_exception_t *);
374 * \param p_mi the Media Player
375 * \param i_title title number to play
376 * \param p_e an initialized exception pointer
378 VLC_PUBLIC_API void libvlc_media_player_set_title( libvlc_media_player_t *, int, libvlc_exception_t *);
383 * \param p_mi the Media Player
384 * \param p_e an initialized exception pointer
385 * \return title number currently playing
387 VLC_PUBLIC_API int libvlc_media_player_get_title( libvlc_media_player_t *, libvlc_exception_t *);
390 * Get movie title count
392 * \param p_mi the Media Player
393 * \param p_e an initialized exception pointer
394 * \return title number count
396 VLC_PUBLIC_API int libvlc_media_player_get_title_count( libvlc_media_player_t *, libvlc_exception_t *);
399 * Set previous chapter
401 * \param p_mi the Media Player
402 * \param p_e an initialized exception pointer
404 VLC_PUBLIC_API void libvlc_media_player_previous_chapter( libvlc_media_player_t *, libvlc_exception_t *);
409 * \param p_mi the Media Player
410 * \param p_e an initialized exception pointer
412 VLC_PUBLIC_API void libvlc_media_player_next_chapter( libvlc_media_player_t *, libvlc_exception_t *);
415 * Get movie play rate
417 * \param p_mi the Media Player
418 * \param p_e an initialized exception pointer
419 * \return movie play rate
421 VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t *, libvlc_exception_t *);
424 * Set movie play rate
426 * \param p_mi the Media Player
427 * \param movie play rate to set
428 * \param p_e an initialized exception pointer
430 VLC_PUBLIC_API void libvlc_media_player_set_rate( libvlc_media_player_t *, float, libvlc_exception_t *);
433 * Get current movie state
435 * \param p_mi the Media Player
436 * \param p_e an initialized exception pointer
437 * \return current movie state as libvlc_state_t
439 VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *, libvlc_exception_t *);
444 * \param p_mi the Media Player
445 * \param p_e an initialized exception pointer
446 * \return frames per second (fps) for this playing movie
448 VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *, libvlc_exception_t *);
453 * Does this media player have a video output?
455 * \param p_md the media player
456 * \param p_e an initialized exception pointer
458 VLC_PUBLIC_API int libvlc_media_player_has_vout( libvlc_media_player_t *, libvlc_exception_t *);
461 * Is this media player seekable?
463 * \param p_input the input
464 * \param p_e an initialized exception pointer
466 VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
469 * Can this media player be paused?
471 * \param p_input the input
472 * \param p_e an initialized exception pointer
474 VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
477 * Release (free) libvlc_track_description_t
479 * \param p_track_description the structure to release
481 VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t *p_track_description );
483 /** \defgroup libvlc_video libvlc_video
484 * \ingroup libvlc_media_player
485 * LibVLC Video handling
490 * Toggle fullscreen status on video output.
492 * \param p_mediaplayer the media player
493 * \param p_e an initialized exception pointer
495 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
498 * Enable or disable fullscreen on a video output.
500 * \param p_mediaplayer the media player
501 * \param b_fullscreen boolean for fullscreen status
502 * \param p_e an initialized exception pointer
504 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *, int, libvlc_exception_t * );
507 * Get current fullscreen status.
509 * \param p_mediaplayer the media player
510 * \param p_e an initialized exception pointer
511 * \return the fullscreen status (boolean)
513 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
516 * Get current video height.
518 * \param p_mediaplayer the media player
519 * \param p_e an initialized exception pointer
520 * \return the video height
522 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_player_t *, libvlc_exception_t * );
525 * Get current video width.
527 * \param p_mediaplayer the media player
528 * \param p_e an initialized exception pointer
529 * \return the video width
531 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_player_t *, libvlc_exception_t * );
534 * Get the current video scaling factor.
535 * See also libvlc_video_set_scale().
537 * \param p_mediaplayer the media player
538 * \param p_e an initialized exception pointer
539 * \return the currently configured zoom factor, or 0. if the video is set
540 * to fit to the output window/drawable automatically.
542 VLC_PUBLIC_API float libvlc_video_get_scale( libvlc_media_player_t *,
543 libvlc_exception_t *p_e );
546 * Set the video scaling factor. That is the ratio of the number of pixels on
547 * screen to the number of pixels in the original decoded video in each
548 * dimension. Zero is a special value; it will adjust the video to the output
549 * window/drawable (in windowed mode) or the entire screen.
551 * Note that not all video outputs support scaling.
553 * \param p_mediaplayer the media player
554 * \param i_factor the scaling factor, or zero
555 * \param p_e an initialized exception pointer
557 VLC_PUBLIC_API void libvlc_video_set_scale( libvlc_media_player_t *, float,
558 libvlc_exception_t *p_e );
561 * Get current video aspect ratio.
563 * \param p_mediaplayer the media player
564 * \param p_e an initialized exception pointer
565 * \return the video aspect ratio
567 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *, libvlc_exception_t * );
570 * Set new video aspect ratio.
572 * \param p_mediaplayer the media player
573 * \param psz_aspect new video aspect-ratio
574 * \param p_e an initialized exception pointer
576 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *, char *, libvlc_exception_t * );
579 * Get current video subtitle.
581 * \param p_mediaplayer the media player
582 * \param p_e an initialized exception pointer
583 * \return the video subtitle selected
585 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *, libvlc_exception_t * );
588 * Get the number of available video subtitles.
590 * \param p_mediaplayer the media player
591 * \param p_e an initialized exception pointer
592 * \return the number of available video subtitles
594 VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t *, libvlc_exception_t * );
597 * Get the description of available video subtitles.
599 * \param p_mediaplayer the media player
600 * \param p_e an initialized exception pointer
601 * \return list containing description of available video subtitles
603 VLC_PUBLIC_API libvlc_track_description_t *
604 libvlc_video_get_spu_description( libvlc_media_player_t *, libvlc_exception_t * );
607 * Set new video subtitle.
609 * \param p_mediaplayer the media player
610 * \param i_spu new video subtitle to select
611 * \param p_e an initialized exception pointer
613 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_player_t *, int , libvlc_exception_t * );
616 * Set new video subtitle file.
618 * \param p_mediaplayer the media player
619 * \param psz_subtitle new video subtitle file
620 * \param p_e an initialized exception pointer
621 * \return the success status (boolean)
623 VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *, char *, libvlc_exception_t * );
626 * Get the description of available titles.
628 * \param p_mediaplayer the media player
629 * \param p_e an initialized exception pointer
630 * \return list containing description of available titles
632 VLC_PUBLIC_API libvlc_track_description_t *
633 libvlc_video_get_title_description( libvlc_media_player_t *, libvlc_exception_t * );
636 * Get the description of available chapters for specific title.
638 * \param p_mediaplayer the media player
639 * \param i_title selected title
640 * \param p_e an initialized exception pointer
641 * \return list containing description of available chapter for title i_title
643 VLC_PUBLIC_API libvlc_track_description_t *
644 libvlc_video_get_chapter_description( libvlc_media_player_t *, int, libvlc_exception_t * );
647 * Get current crop filter geometry.
649 * \param p_mediaplayer the media player
650 * \param p_e an initialized exception pointer
651 * \return the crop filter geometry
653 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *, libvlc_exception_t * );
656 * Set new crop filter geometry.
658 * \param p_mediaplayer the media player
659 * \param psz_geometry new crop filter geometry
660 * \param p_e an initialized exception pointer
662 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_player_t *, char *, libvlc_exception_t * );
665 * Toggle teletext transparent status on video output.
667 * \param p_mediaplayer the media player
668 * \param p_e an initialized exception pointer
670 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *, libvlc_exception_t * );
673 * Get current teletext page requested.
675 * \param p_mediaplayer the media player
676 * \param p_e an initialized exception pointer
677 * \return the current teletext page requested.
679 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *, libvlc_exception_t * );
682 * Set new teletext page to retrieve.
684 * \param p_mediaplayer the media player
685 * \param i_page teletex page number requested
686 * \param p_e an initialized exception pointer
688 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_player_t *, int, libvlc_exception_t * );
691 * Get number of available video tracks.
693 * \param p_mi media player
694 * \param p_e an initialized exception
695 * \return the number of available video tracks (int)
697 VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_t *, libvlc_exception_t * );
700 * Get the description of available video tracks.
702 * \param p_mi media player
703 * \param p_e an initialized exception
704 * \return list with description of available video tracks
706 VLC_PUBLIC_API libvlc_track_description_t *
707 libvlc_video_get_track_description( libvlc_media_player_t *, libvlc_exception_t * );
710 * Get current video track.
712 * \param p_mi media player
713 * \param p_e an initialized exception pointer
714 * \return the video track (int)
716 VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t *, libvlc_exception_t * );
721 * \param p_mi media player
722 * \param i_track the track (int)
723 * \param p_e an initialized exception pointer
725 VLC_PUBLIC_API void libvlc_video_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
728 * Take a snapshot of the current video window.
730 * If i_width AND i_height is 0, original size is used.
731 * If i_width XOR i_height is 0, original aspect-ratio is preserved.
733 * \param p_mi media player instance
734 * \param psz_filepath the path where to save the screenshot to
735 * \param i_width the snapshot's width
736 * \param i_height the snapshot's height
737 * \param p_e an initialized exception pointer
739 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_player_t *, const char *,unsigned int, unsigned int, libvlc_exception_t * );
742 * Enable or disable deinterlace filter
744 * \param p_mi libvlc media player
745 * \param b_enable boolean to enable or disable deinterlace filter
746 * \param psz_mode type of deinterlace filter to use
747 * \param p_e an initialized exception pointer
749 VLC_PUBLIC_API void libvlc_video_set_deinterlace( libvlc_media_player_t *,
751 libvlc_exception_t *);
754 * Get an option value (option which return an int)
756 * \param p_mi libvlc media player
757 * \param option marq option to get
758 * \param p_e an initialized exception pointer
760 VLC_PUBLIC_API int libvlc_video_get_marquee_option_as_int( libvlc_media_player_t *,
761 libvlc_video_marquee_int_option_t,
762 libvlc_exception_t * );
765 * Get an option value (option which return a string)
767 * \param p_mi libvlc media player
768 * \param option marq option to get
769 * \param p_e an initialized exception pointer
771 VLC_PUBLIC_API char *libvlc_video_get_marquee_option_as_string( libvlc_media_player_t *,
772 libvlc_video_marquee_string_option_t,
773 libvlc_exception_t * );
776 * Enable, disable or set a marq option (only int)
778 * \param p_mi libvlc media player
779 * \param option marq option to set
780 * \param i_val marq option value
781 * \param p_e an initialized exception pointer
783 VLC_PUBLIC_API void libvlc_video_set_marquee_option_as_int( libvlc_media_player_t *,
784 libvlc_video_marquee_int_option_t,
785 int, libvlc_exception_t * );
788 * Set a marq option (only string)
790 * \param p_mi libvlc media player
791 * \param option marq option to set
792 * \param psz_text marq option value
793 * \param p_e an initialized exception pointer
795 VLC_PUBLIC_API void libvlc_video_set_marquee_option_as_string( libvlc_media_player_t *,
796 libvlc_video_marquee_string_option_t,
798 libvlc_exception_t * );
802 /** \defgroup libvlc_audio libvlc_audio
803 * \ingroup libvlc_media_player
804 * LibVLC Audio handling
811 typedef enum libvlc_audio_output_device_types_t {
812 libvlc_AudioOutputDevice_Error = -1,
813 libvlc_AudioOutputDevice_Mono = 1,
814 libvlc_AudioOutputDevice_Stereo = 2,
815 libvlc_AudioOutputDevice_2F2R = 4,
816 libvlc_AudioOutputDevice_3F2R = 5,
817 libvlc_AudioOutputDevice_5_1 = 6,
818 libvlc_AudioOutputDevice_6_1 = 7,
819 libvlc_AudioOutputDevice_7_1 = 8,
820 libvlc_AudioOutputDevice_SPDIF = 10
821 } libvlc_audio_output_device_types_t;
826 typedef enum libvlc_audio_output_channel_t {
827 libvlc_AudioChannel_Error = -1,
828 libvlc_AudioChannel_Stereo = 1,
829 libvlc_AudioChannel_RStereo = 2,
830 libvlc_AudioChannel_Left = 3,
831 libvlc_AudioChannel_Right = 4,
832 libvlc_AudioChannel_Dolbys = 5
833 } libvlc_audio_output_channel_t;
837 * Get the list of available audio outputs
839 * \param p_instance libvlc instance
840 * \param p_e an initialized exception pointer
841 * \return list of available audio outputs, at the end free it with
842 * \see libvlc_audio_output_list_release \see libvlc_audio_output_t
844 VLC_PUBLIC_API libvlc_audio_output_t *
845 libvlc_audio_output_list_get( libvlc_instance_t *,
846 libvlc_exception_t * );
849 * Free the list of available audio outputs
851 * \param p_list list with audio outputs for release
853 VLC_PUBLIC_API void libvlc_audio_output_list_release( libvlc_audio_output_t * );
856 * Set the audio output.
857 * Change will be applied after stop and play.
859 * \param p_instance libvlc instance
860 * \param psz_name name of audio output,
861 * use psz_name of \see libvlc_audio_output_t
862 * \return true if function succeded
864 VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_instance_t *,
868 * Get count of devices for audio output, these devices are hardware oriented
869 * like analor or digital output of sound card
871 * \param p_instance libvlc instance
872 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
873 * \return number of devices
875 VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_t *,
879 * Get long name of device, if not available short name given
881 * \param p_instance libvlc instance
882 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
883 * \param i_device device index
884 * \return long name of device
886 VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_t *,
891 * Get id name of device
893 * \param p_instance libvlc instance
894 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
895 * \param i_device device index
896 * \return id name of device, use for setting device, need to be free after use
898 VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *,
903 * Set device for using
905 * \param p_instance libvlc instance
906 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
907 * \param psz_device_id device
909 VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_instance_t *,
914 * Get current audio device type. Device type describes something like
915 * character of output sound - stereo sound, 2.1, 5.1 etc
917 * \param p_instance vlc instance
918 * \param p_e an initialized exception pointer
919 * \return the audio devices type \see libvlc_audio_output_device_types_t
921 VLC_PUBLIC_API int libvlc_audio_output_get_device_type(
922 libvlc_instance_t *, libvlc_exception_t * );
925 * Set current audio device type.
927 * \param p_instance vlc instance
928 * \param device_type the audio device type,
929 according to \see libvlc_audio_output_device_types_t
930 * \param p_e an initialized exception pointer
932 VLC_PUBLIC_API void libvlc_audio_output_set_device_type( libvlc_instance_t *,
934 libvlc_exception_t * );
938 * Toggle mute status.
940 * \param p_instance libvlc instance
941 * \param p_e an initialized exception pointer
943 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
946 * Get current mute status.
948 * \param p_instance libvlc instance
949 * \param p_e an initialized exception pointer
950 * \return the mute status (boolean)
952 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
957 * \param p_instance libvlc instance
958 * \param status If status is true then mute, otherwise unmute
959 * \param p_e an initialized exception pointer
961 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, int , libvlc_exception_t * );
964 * Get current audio level.
966 * \param p_instance libvlc instance
967 * \param p_e an initialized exception pointer
968 * \return the audio level (int)
970 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
973 * Set current audio level.
975 * \param p_instance libvlc instance
976 * \param i_volume the volume (int)
977 * \param p_e an initialized exception pointer
979 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
982 * Get number of available audio tracks.
984 * \param p_mi media player
985 * \param p_e an initialized exception
986 * \return the number of available audio tracks (int)
988 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *, libvlc_exception_t * );
991 * Get the description of available audio tracks.
993 * \param p_mi media player
994 * \param p_e an initialized exception
995 * \return list with description of available audio tracks
997 VLC_PUBLIC_API libvlc_track_description_t *
998 libvlc_audio_get_track_description( libvlc_media_player_t *, libvlc_exception_t * );
1001 * Get current audio track.
1003 * \param p_mi media player
1004 * \param p_e an initialized exception pointer
1005 * \return the audio track (int)
1007 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *, libvlc_exception_t * );
1010 * Set current audio track.
1012 * \param p_mi media player
1013 * \param i_track the track (int)
1014 * \param p_e an initialized exception pointer
1016 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
1019 * Get current audio channel.
1021 * \param p_instance vlc instance
1022 * \param p_e an initialized exception pointer
1023 * \return the audio channel \see libvlc_audio_output_channel_t
1026 libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
1029 * Set current audio channel.
1031 * \param p_instance vlc instance
1032 * \param channel the audio channel, \see libvlc_audio_output_channel_t
1033 * \param p_e an initialized exception pointer
1035 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *,
1037 libvlc_exception_t * );
1041 /** @} media_player */
1043 #endif /* VLC_LIBVLC_MEDIA_PLAYER_H */