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 NSView handler where the media player should render its video output.
205 * The object minimal_macosx expects is of kind NSObject and should
206 * respect the protocol:
208 * @protocol VLCOpenGLVoutEmbedding
209 * - (void)addVoutSubview:(NSView *)view;
210 * - (void)removeVoutSubview:(NSView *)view;
212 * - (void)enterFullscreen;
213 * - (void)leaveFullscreen;
215 * - (BOOL)stretchesVideo;
216 * - (void)setOnTop: (BOOL)ontop; // Do we really want that in protocol?
219 * You can find a live example in VLCVideoView in VLCKit.framework.
221 * \param p_mi the Media Player
222 * \param drawable the NSView handler
223 * \param p_e an initialized exception pointer
225 VLC_PUBLIC_API void libvlc_media_player_set_nsobject ( libvlc_media_player_t *p_mi, void * drawable, libvlc_exception_t *p_e );
228 * Get the NSView handler previously set with libvlc_media_player_set_nsobject().
230 * \param p_mi the Media Player
231 * \return the NSView handler or 0 if none where set
233 VLC_PUBLIC_API void * libvlc_media_player_get_nsobject ( libvlc_media_player_t *p_mi );
236 * Set the agl handler where the media player should render its video output.
238 * \param p_mi the Media Player
239 * \param drawable the agl handler
240 * \param p_e an initialized exception pointer
242 VLC_PUBLIC_API void libvlc_media_player_set_agl ( libvlc_media_player_t *p_mi, uint32_t drawable, libvlc_exception_t *p_e );
245 * Get the agl handler previously set with libvlc_media_player_set_agl().
247 * \param p_mi the Media Player
248 * \return the agl handler or 0 if none where set
250 VLC_PUBLIC_API uint32_t libvlc_media_player_get_agl ( libvlc_media_player_t *p_mi );
253 * Set an X Window System drawable where the media player should render its
254 * video output. If LibVLC was built without X11 output support, then this has
257 * The specified identifier must correspond to an existing Input/Output class
258 * X11 window. Pixmaps are <b>not</b> supported. The caller shall ensure that
259 * the X11 server is the same as the one the VLC instance has been configured
261 * If XVideo is <b>not</b> used, it is assumed that the drawable has the
262 * following properties in common with the default X11 screen: depth, scan line
263 * pad, black pixel. This is a bug.
265 * \param p_mi the Media Player
266 * \param drawable the ID of the X window
267 * \param p_e an initialized exception pointer
269 VLC_PUBLIC_API void libvlc_media_player_set_xwindow ( libvlc_media_player_t *p_mi, uint32_t drawable, libvlc_exception_t *p_e );
272 * Get the X Window System window identifier previously set with
273 * libvlc_media_player_set_xwindow(). Note that this will return the identifier
274 * even if VLC is not currently using it (for instance if it is playing an
277 * \param p_mi the Media Player
278 * \return an X window ID, or 0 if none where set.
280 VLC_PUBLIC_API uint32_t libvlc_media_player_get_xwindow ( libvlc_media_player_t *p_mi );
283 * Set a Win32/Win64 API window handle (HWND) where the media player should
284 * render its video output. If LibVLC was built without Win32/Win64 API output
285 * support, then this has no effects.
287 * \param p_mi the Media Player
288 * \param drawable windows handle of the drawable
289 * \param p_e an initialized exception pointer
291 VLC_PUBLIC_API void libvlc_media_player_set_hwnd ( libvlc_media_player_t *p_mi, void *drawable, libvlc_exception_t *p_e );
294 * Get the Windows API window handle (HWND) previously set with
295 * libvlc_media_player_set_hwnd(). The handle will be returned even if LibVLC
296 * is not currently outputting any video to it.
298 * \param p_mi the Media Player
299 * \return a window handle or NULL if there are none.
301 VLC_PUBLIC_API void *libvlc_media_player_get_hwnd ( libvlc_media_player_t *p_mi );
305 /** \bug This might go away ... to be replaced by a broader system */
308 * Get the current movie length (in ms).
310 * \param p_mi the Media Player
311 * \param p_e an initialized exception pointer
312 * \return the movie length (in ms).
314 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length( libvlc_media_player_t *, libvlc_exception_t *);
317 * Get the current movie time (in ms).
319 * \param p_mi the Media Player
320 * \param p_e an initialized exception pointer
321 * \return the movie time (in ms).
323 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *, libvlc_exception_t *);
326 * Set the movie time (in ms).
328 * \param p_mi the Media Player
329 * \param the movie time (in ms).
330 * \param p_e an initialized exception pointer
332 VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *);
335 * Get movie position.
337 * \param p_mi the Media Player
338 * \param p_e an initialized exception pointer
339 * \return movie position
341 VLC_PUBLIC_API float libvlc_media_player_get_position( libvlc_media_player_t *, libvlc_exception_t *);
344 * Set movie position.
346 * \param p_mi the Media Player
347 * \param f_pos the position
348 * \param p_e an initialized exception pointer
350 VLC_PUBLIC_API void libvlc_media_player_set_position( libvlc_media_player_t *, float, libvlc_exception_t *);
355 * \param p_mi the Media Player
356 * \param i_chapter chapter number to play
357 * \param p_e an initialized exception pointer
359 VLC_PUBLIC_API void libvlc_media_player_set_chapter( libvlc_media_player_t *, int, libvlc_exception_t *);
364 * \param p_mi the Media Player
365 * \param p_e an initialized exception pointer
366 * \return chapter number currently playing
368 VLC_PUBLIC_API int libvlc_media_player_get_chapter( libvlc_media_player_t *, libvlc_exception_t * );
371 * Get movie chapter count
373 * \param p_mi the Media Player
374 * \param p_e an initialized exception pointer
375 * \return number of chapters in movie
377 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *, libvlc_exception_t *);
380 * Will the player play
382 * \param p_mi the Media Player
383 * \param p_e an initialized exception pointer
386 VLC_PUBLIC_API int libvlc_media_player_will_play ( libvlc_media_player_t *, libvlc_exception_t *);
389 * Get title chapter count
391 * \param p_mi the Media Player
392 * \param i_title title
393 * \param p_e an initialized exception pointer
394 * \return number of chapters in title
396 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count_for_title(
397 libvlc_media_player_t *, int, libvlc_exception_t *);
402 * \param p_mi the Media Player
403 * \param i_title title number to play
404 * \param p_e an initialized exception pointer
406 VLC_PUBLIC_API void libvlc_media_player_set_title( libvlc_media_player_t *, int, libvlc_exception_t *);
411 * \param p_mi the Media Player
412 * \param p_e an initialized exception pointer
413 * \return title number currently playing
415 VLC_PUBLIC_API int libvlc_media_player_get_title( libvlc_media_player_t *, libvlc_exception_t *);
418 * Get movie title count
420 * \param p_mi the Media Player
421 * \param p_e an initialized exception pointer
422 * \return title number count
424 VLC_PUBLIC_API int libvlc_media_player_get_title_count( libvlc_media_player_t *, libvlc_exception_t *);
427 * Set previous chapter
429 * \param p_mi the Media Player
430 * \param p_e an initialized exception pointer
432 VLC_PUBLIC_API void libvlc_media_player_previous_chapter( libvlc_media_player_t *, libvlc_exception_t *);
437 * \param p_mi the Media Player
438 * \param p_e an initialized exception pointer
440 VLC_PUBLIC_API void libvlc_media_player_next_chapter( libvlc_media_player_t *, libvlc_exception_t *);
443 * Get movie play rate
445 * \param p_mi the Media Player
446 * \param p_e an initialized exception pointer
447 * \return movie play rate
449 VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t *, libvlc_exception_t *);
452 * Set movie play rate
454 * \param p_mi the Media Player
455 * \param movie play rate to set
456 * \param p_e an initialized exception pointer
458 VLC_PUBLIC_API void libvlc_media_player_set_rate( libvlc_media_player_t *, float, libvlc_exception_t *);
461 * Get current movie state
463 * \param p_mi the Media Player
464 * \param p_e an initialized exception pointer
465 * \return current movie state as libvlc_state_t
467 VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *, libvlc_exception_t *);
472 * \param p_mi the Media Player
473 * \param p_e an initialized exception pointer
474 * \return frames per second (fps) for this playing movie
476 VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *, libvlc_exception_t *);
481 * Does this media player have a video output?
483 * \param p_md the media player
484 * \param p_e an initialized exception pointer
486 VLC_PUBLIC_API int libvlc_media_player_has_vout( libvlc_media_player_t *, libvlc_exception_t *);
489 * Is this media player seekable?
491 * \param p_input the input
492 * \param p_e an initialized exception pointer
494 VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
497 * Can this media player be paused?
499 * \param p_input the input
500 * \param p_e an initialized exception pointer
502 VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
506 * Display the next frame
508 * \param p_input the libvlc_media_player_t instance
509 * \param p_e an initialized exception pointer
511 VLC_PUBLIC_API void libvlc_media_player_next_frame( libvlc_media_player_t *p_input,
512 libvlc_exception_t *p_e );
517 * Release (free) libvlc_track_description_t
519 * \param p_track_description the structure to release
521 VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t *p_track_description );
523 /** \defgroup libvlc_video libvlc_video
524 * \ingroup libvlc_media_player
525 * LibVLC Video handling
530 * Toggle fullscreen status on a non-embedded video output.
532 * @warning The same limitations applies to this function
533 * as to libvlc_set_fullscreen().
535 * \param p_mediaplayer the media player
536 * \param p_e an initialized exception pointer
538 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
541 * Enable or disable fullscreen on a non-embedded video output.
543 * @warning With most window managers, only a top-level windows can switch to
544 * full-screen mode. Hence, this function will not operate properly if
545 * libvlc_media_player_set_xid() or libvlc_media_player_set_hwnd() was
546 * used to embed the video in a non-LibVLC widget. If you want to to render an
547 * embedded LibVLC video full-screen, the parent embedding widget must expanded
548 * to full screen (LibVLC cannot take care of that).
549 * LibVLC will then automatically resize the video as appropriate.
551 * \param p_mediaplayer the media player
552 * \param b_fullscreen boolean for fullscreen status
553 * \param p_e an initialized exception pointer
555 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *, int, libvlc_exception_t * );
558 * Get current fullscreen status.
560 * \param p_mediaplayer the media player
561 * \param p_e an initialized exception pointer
562 * \return the fullscreen status (boolean)
564 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
567 * Enable or disable key press events handling, according to the LibVLC hotkeys
568 * configuration. By default and for historical reasons, keyboard events are
569 * handled by the LibVLC video widget.
571 * \note On X11, there can be only one subscriber for key press and mouse
572 * click events per window. If your application has subscribed to those events
573 * for the X window ID of the video widget, then LibVLC will not be able to
574 * handle key presses and mouse clicks in any case.
576 * \warning This function is only implemented for X11 at the moment.
578 * \param mp the media player
579 * \param on true to handle key press events, false to ignore them.
582 void libvlc_video_set_key_input( libvlc_media_player_t *mp, unsigned on );
585 * Enable or disable mouse click events handling. By default, those events are
586 * handled. This is needed for DVD menus to work, as well as a few video
587 * filters such as "puzzle".
589 * \note See also \func libvlc_video_set_key_input().
591 * \warning This function is only implemented for X11 at the moment.
593 * \param mp the media player
594 * \param on true to handle mouse click events, false to ignore them.
597 void libvlc_video_set_mouse_input( libvlc_media_player_t *mp, unsigned on );
600 * Get current video height.
602 * \param p_mediaplayer the media player
603 * \param p_e an initialized exception pointer
604 * \return the video height
606 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_player_t *, libvlc_exception_t * );
609 * Get current video width.
611 * \param p_mediaplayer the media player
612 * \param p_e an initialized exception pointer
613 * \return the video width
615 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_player_t *, libvlc_exception_t * );
618 * Get the current video scaling factor.
619 * See also libvlc_video_set_scale().
621 * \param p_mediaplayer the media player
622 * \param p_e an initialized exception pointer
623 * \return the currently configured zoom factor, or 0. if the video is set
624 * to fit to the output window/drawable automatically.
626 VLC_PUBLIC_API float libvlc_video_get_scale( libvlc_media_player_t *,
627 libvlc_exception_t *p_e );
630 * Set the video scaling factor. That is the ratio of the number of pixels on
631 * screen to the number of pixels in the original decoded video in each
632 * dimension. Zero is a special value; it will adjust the video to the output
633 * window/drawable (in windowed mode) or the entire screen.
635 * Note that not all video outputs support scaling.
637 * \param p_mediaplayer the media player
638 * \param i_factor the scaling factor, or zero
639 * \param p_e an initialized exception pointer
641 VLC_PUBLIC_API void libvlc_video_set_scale( libvlc_media_player_t *, float,
642 libvlc_exception_t *p_e );
645 * Get current video aspect ratio.
647 * \param p_mediaplayer the media player
648 * \param p_e an initialized exception pointer
649 * \return the video aspect ratio
651 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *, libvlc_exception_t * );
654 * Set new video aspect ratio.
656 * \param p_mediaplayer the media player
657 * \param psz_aspect new video aspect-ratio
658 * \param p_e an initialized exception pointer
660 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *, const char *, libvlc_exception_t * );
663 * Get current video subtitle.
665 * \param p_mediaplayer the media player
666 * \param p_e an initialized exception pointer
667 * \return the video subtitle selected
669 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *, libvlc_exception_t * );
672 * Get the number of available video subtitles.
674 * \param p_mediaplayer the media player
675 * \param p_e an initialized exception pointer
676 * \return the number of available video subtitles
678 VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t *, libvlc_exception_t * );
681 * Get the description of available video subtitles.
683 * \param p_mediaplayer the media player
684 * \param p_e an initialized exception pointer
685 * \return list containing description of available video subtitles
687 VLC_PUBLIC_API libvlc_track_description_t *
688 libvlc_video_get_spu_description( libvlc_media_player_t *, libvlc_exception_t * );
691 * Set new video subtitle.
693 * \param p_mediaplayer the media player
694 * \param i_spu new video subtitle to select
695 * \param p_e an initialized exception pointer
697 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_player_t *, int , libvlc_exception_t * );
700 * Set new video subtitle file.
702 * \param p_mediaplayer the media player
703 * \param psz_subtitle new video subtitle file
704 * \param p_e an initialized exception pointer
705 * \return the success status (boolean)
707 VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *, const char *, libvlc_exception_t * );
710 * Get the description of available titles.
712 * \param p_mediaplayer the media player
713 * \param p_e an initialized exception pointer
714 * \return list containing description of available titles
716 VLC_PUBLIC_API libvlc_track_description_t *
717 libvlc_video_get_title_description( libvlc_media_player_t *, libvlc_exception_t * );
720 * Get the description of available chapters for specific title.
722 * \param p_mediaplayer the media player
723 * \param i_title selected title
724 * \param p_e an initialized exception pointer
725 * \return list containing description of available chapter for title i_title
727 VLC_PUBLIC_API libvlc_track_description_t *
728 libvlc_video_get_chapter_description( libvlc_media_player_t *, int, libvlc_exception_t * );
731 * Get current crop filter geometry.
733 * \param p_mediaplayer the media player
734 * \param p_e an initialized exception pointer
735 * \return the crop filter geometry
737 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *, libvlc_exception_t * );
740 * Set new crop filter geometry.
742 * \param p_mediaplayer the media player
743 * \param psz_geometry new crop filter geometry
744 * \param p_e an initialized exception pointer
746 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_player_t *, const char *, libvlc_exception_t * );
749 * Toggle teletext transparent status on video output.
751 * \param p_mediaplayer the media player
752 * \param p_e an initialized exception pointer
754 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *, libvlc_exception_t * );
757 * Get current teletext page requested.
759 * \param p_mediaplayer the media player
760 * \param p_e an initialized exception pointer
761 * \return the current teletext page requested.
763 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *, libvlc_exception_t * );
766 * Set new teletext page to retrieve.
768 * \param p_mediaplayer the media player
769 * \param i_page teletex page number requested
770 * \param p_e an initialized exception pointer
772 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_player_t *, int, libvlc_exception_t * );
775 * Get number of available video tracks.
777 * \param p_mi media player
778 * \param p_e an initialized exception
779 * \return the number of available video tracks (int)
781 VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_t *, libvlc_exception_t * );
784 * Get the description of available video tracks.
786 * \param p_mi media player
787 * \param p_e an initialized exception
788 * \return list with description of available video tracks
790 VLC_PUBLIC_API libvlc_track_description_t *
791 libvlc_video_get_track_description( libvlc_media_player_t *, libvlc_exception_t * );
794 * Get current video track.
796 * \param p_mi media player
797 * \param p_e an initialized exception pointer
798 * \return the video track (int)
800 VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t *, libvlc_exception_t * );
805 * \param p_mi media player
806 * \param i_track the track (int)
807 * \param p_e an initialized exception pointer
809 VLC_PUBLIC_API void libvlc_video_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
812 * Take a snapshot of the current video window.
814 * If i_width AND i_height is 0, original size is used.
815 * If i_width XOR i_height is 0, original aspect-ratio is preserved.
817 * \param p_mi media player instance
818 * \param psz_filepath the path where to save the screenshot to
819 * \param i_width the snapshot's width
820 * \param i_height the snapshot's height
821 * \param p_e an initialized exception pointer
823 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_player_t *, const char *,unsigned int, unsigned int, libvlc_exception_t * );
826 * Enable or disable deinterlace filter
828 * \param p_mi libvlc media player
829 * \param b_enable boolean to enable or disable deinterlace filter
830 * \param psz_mode type of deinterlace filter to use
831 * \param p_e an initialized exception pointer
833 VLC_PUBLIC_API void libvlc_video_set_deinterlace( libvlc_media_player_t *,
835 libvlc_exception_t *);
838 * Get an option value (option which return an int)
840 * \param p_mi libvlc media player
841 * \param option marq option to get
842 * \param p_e an initialized exception pointer
844 VLC_PUBLIC_API int libvlc_video_get_marquee_option_as_int( libvlc_media_player_t *,
845 libvlc_video_marquee_int_option_t,
846 libvlc_exception_t * );
849 * Get an option value (option which return a string)
851 * \param p_mi libvlc media player
852 * \param option marq option to get
853 * \param p_e an initialized exception pointer
855 VLC_PUBLIC_API char *libvlc_video_get_marquee_option_as_string( libvlc_media_player_t *,
856 libvlc_video_marquee_string_option_t,
857 libvlc_exception_t * );
860 * Enable, disable or set a marq option (only int)
862 * \param p_mi libvlc media player
863 * \param option marq option to set
864 * \param i_val marq option value
865 * \param p_e an initialized exception pointer
867 VLC_PUBLIC_API void libvlc_video_set_marquee_option_as_int( libvlc_media_player_t *,
868 libvlc_video_marquee_int_option_t,
869 int, libvlc_exception_t * );
872 * Set a marq option (only string)
874 * \param p_mi libvlc media player
875 * \param option marq option to set
876 * \param psz_text marq option value
877 * \param p_e an initialized exception pointer
879 VLC_PUBLIC_API void libvlc_video_set_marquee_option_as_string( libvlc_media_player_t *,
880 libvlc_video_marquee_string_option_t,
882 libvlc_exception_t * );
886 /** \defgroup libvlc_audio libvlc_audio
887 * \ingroup libvlc_media_player
888 * LibVLC Audio handling
895 typedef enum libvlc_audio_output_device_types_t {
896 libvlc_AudioOutputDevice_Error = -1,
897 libvlc_AudioOutputDevice_Mono = 1,
898 libvlc_AudioOutputDevice_Stereo = 2,
899 libvlc_AudioOutputDevice_2F2R = 4,
900 libvlc_AudioOutputDevice_3F2R = 5,
901 libvlc_AudioOutputDevice_5_1 = 6,
902 libvlc_AudioOutputDevice_6_1 = 7,
903 libvlc_AudioOutputDevice_7_1 = 8,
904 libvlc_AudioOutputDevice_SPDIF = 10
905 } libvlc_audio_output_device_types_t;
910 typedef enum libvlc_audio_output_channel_t {
911 libvlc_AudioChannel_Error = -1,
912 libvlc_AudioChannel_Stereo = 1,
913 libvlc_AudioChannel_RStereo = 2,
914 libvlc_AudioChannel_Left = 3,
915 libvlc_AudioChannel_Right = 4,
916 libvlc_AudioChannel_Dolbys = 5
917 } libvlc_audio_output_channel_t;
921 * Get the list of available audio outputs
923 * \param p_instance libvlc instance
924 * \param p_e an initialized exception pointer
925 * \return list of available audio outputs, at the end free it with
926 * \see libvlc_audio_output_list_release \see libvlc_audio_output_t
928 VLC_PUBLIC_API libvlc_audio_output_t *
929 libvlc_audio_output_list_get( libvlc_instance_t *,
930 libvlc_exception_t * );
933 * Free the list of available audio outputs
935 * \param p_list list with audio outputs for release
937 VLC_PUBLIC_API void libvlc_audio_output_list_release( libvlc_audio_output_t * );
940 * Set the audio output.
941 * Change will be applied after stop and play.
943 * \param p_instance libvlc instance
944 * \param psz_name name of audio output,
945 * use psz_name of \see libvlc_audio_output_t
946 * \return true if function succeded
948 VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_instance_t *,
952 * Get count of devices for audio output, these devices are hardware oriented
953 * like analor or digital output of sound card
955 * \param p_instance libvlc instance
956 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
957 * \return number of devices
959 VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_t *,
963 * Get long name of device, if not available short name given
965 * \param p_instance libvlc instance
966 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
967 * \param i_device device index
968 * \return long name of device
970 VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_t *,
975 * Get id name of device
977 * \param p_instance libvlc instance
978 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
979 * \param i_device device index
980 * \return id name of device, use for setting device, need to be free after use
982 VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *,
987 * Set device for using
989 * \param p_instance libvlc instance
990 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
991 * \param psz_device_id device
993 VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_instance_t *,
998 * Get current audio device type. Device type describes something like
999 * character of output sound - stereo sound, 2.1, 5.1 etc
1001 * \param p_instance vlc instance
1002 * \param p_e an initialized exception pointer
1003 * \return the audio devices type \see libvlc_audio_output_device_types_t
1005 VLC_PUBLIC_API int libvlc_audio_output_get_device_type(
1006 libvlc_instance_t *, libvlc_exception_t * );
1009 * Set current audio device type.
1011 * \param p_instance vlc instance
1012 * \param device_type the audio device type,
1013 according to \see libvlc_audio_output_device_types_t
1014 * \param p_e an initialized exception pointer
1016 VLC_PUBLIC_API void libvlc_audio_output_set_device_type( libvlc_instance_t *,
1018 libvlc_exception_t * );
1022 * Toggle mute status.
1024 * \param p_instance libvlc instance
1026 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t * );
1029 * Get current mute status.
1031 * \param p_instance libvlc instance
1032 * \return the mute status (boolean)
1034 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_instance_t * );
1039 * \param p_instance libvlc instance
1040 * \param status If status is true then mute, otherwise unmute
1042 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, int );
1045 * Get current audio level.
1047 * \param p_instance libvlc instance
1048 * \param p_e an initialized exception pointer
1049 * \return the audio level (int)
1051 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t * );
1054 * Set current audio level.
1056 * \param p_instance libvlc instance
1057 * \param i_volume the volume (int)
1058 * \param p_e an initialized exception pointer
1060 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
1063 * Get number of available audio tracks.
1065 * \param p_mi media player
1066 * \param p_e an initialized exception
1067 * \return the number of available audio tracks (int)
1069 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *, libvlc_exception_t * );
1072 * Get the description of available audio tracks.
1074 * \param p_mi media player
1075 * \param p_e an initialized exception
1076 * \return list with description of available audio tracks
1078 VLC_PUBLIC_API libvlc_track_description_t *
1079 libvlc_audio_get_track_description( libvlc_media_player_t *, libvlc_exception_t * );
1082 * Get current audio track.
1084 * \param p_mi media player
1085 * \param p_e an initialized exception pointer
1086 * \return the audio track (int)
1088 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *, libvlc_exception_t * );
1091 * Set current audio track.
1093 * \param p_mi media player
1094 * \param i_track the track (int)
1095 * \param p_e an initialized exception pointer
1097 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
1100 * Get current audio channel.
1102 * \param p_instance vlc instance
1103 * \param p_e an initialized exception pointer
1104 * \return the audio channel \see libvlc_audio_output_channel_t
1107 libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
1110 * Set current audio channel.
1112 * \param p_instance vlc instance
1113 * \param channel the audio channel, \see libvlc_audio_output_channel_t
1114 * \param p_e an initialized exception pointer
1116 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *,
1118 libvlc_exception_t * );
1122 /** @} media_player */
1124 #endif /* VLC_LIBVLC_MEDIA_PLAYER_H */