1 /*****************************************************************************
2 * libvlc_media_player.h: libvlc_media_player external API
3 *****************************************************************************
4 * Copyright (C) 1998-2010 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
38 /*****************************************************************************
40 *****************************************************************************/
41 /** \defgroup libvlc_media_player LibVLC media player
43 * A LibVLC media player plays one media (usually in a custom drawable).
47 typedef struct libvlc_media_player_t libvlc_media_player_t;
50 * Description for video, audio tracks and subtitles. It contains
51 * id, name (description string) and pointer to next record.
53 typedef struct libvlc_track_description_t
57 struct libvlc_track_description_t *p_next;
59 } libvlc_track_description_t;
62 * Description for audio output. It contains
63 * name, description and pointer to next record.
65 typedef struct libvlc_audio_output_t
68 char *psz_description;
69 struct libvlc_audio_output_t *p_next;
71 } libvlc_audio_output_t;
74 * Rectangle type for video geometry
76 typedef struct libvlc_rectangle_t
83 * Marq options definition
85 typedef enum libvlc_video_marquee_option_t {
86 libvlc_marquee_Enable = 0,
87 libvlc_marquee_Text, /** string argument */
89 libvlc_marquee_Opacity,
90 libvlc_marquee_Position,
91 libvlc_marquee_Refresh,
93 libvlc_marquee_Timeout,
96 } libvlc_video_marquee_option_t;
99 * Create an empty Media Player object
101 * \param p_libvlc_instance the libvlc instance in which the Media Player
103 * \return a new media player object, or NULL on error.
105 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new( libvlc_instance_t *p_libvlc_instance );
108 * Create a Media Player object from a Media
110 * \param p_md the media. Afterwards the p_md can be safely
112 * \return a new media player object, or NULL on error.
114 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new_from_media( libvlc_media_t *p_md );
117 * Release a media_player after use
118 * Decrement the reference count of a media player object. If the
119 * reference count is 0, then libvlc_media_player_release() will
120 * release the media player object. If the media player object
121 * has been released, then it should not be used again.
123 * \param p_mi the Media Player to free
125 VLC_PUBLIC_API void libvlc_media_player_release( libvlc_media_player_t *p_mi );
128 * Retain a reference to a media player object. Use
129 * libvlc_media_player_release() to decrement reference count.
131 * \param p_mi media player object
133 VLC_PUBLIC_API void libvlc_media_player_retain( libvlc_media_player_t *p_mi );
136 * Set the media that will be used by the media_player. If any,
137 * previous md will be released.
139 * \param p_mi the Media Player
140 * \param p_md the Media. Afterwards the p_md can be safely
143 VLC_PUBLIC_API void libvlc_media_player_set_media( libvlc_media_player_t *p_mi,
144 libvlc_media_t *p_md );
147 * Get the media used by the media_player.
149 * \param p_mi the Media Player
150 * \return the media associated with p_mi, or NULL if no
151 * media is associated
153 VLC_PUBLIC_API libvlc_media_t * libvlc_media_player_get_media( libvlc_media_player_t *p_mi );
156 * Get the Event Manager from which the media player send event.
158 * \param p_mi the Media Player
159 * \return the event manager associated with p_mi
161 VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_media_player_t *p_mi );
166 * \param p_mi the Media Player
167 * \return 1 if the media player is playing, 0 otherwise
169 VLC_PUBLIC_API int libvlc_media_player_is_playing ( libvlc_media_player_t *p_mi );
174 * \param p_mi the Media Player
175 * \return 0 if playback started (and was already started), or -1 on error.
177 VLC_PUBLIC_API int libvlc_media_player_play ( libvlc_media_player_t *p_mi );
180 * Pause or resume (no effect if there is no media)
182 * \param mp the Media Player
183 * \param do_pause play/resume if zero, pause if non-zero
185 VLC_PUBLIC_API void libvlc_media_player_set_pause ( libvlc_media_player_t *mp,
189 * Toggle pause (no effect if there is no media)
191 * \param p_mi the Media Player
193 VLC_PUBLIC_API void libvlc_media_player_pause ( libvlc_media_player_t *p_mi );
196 * Stop (no effect if there is no media)
198 * \param p_mi the Media Player
200 VLC_PUBLIC_API void libvlc_media_player_stop ( libvlc_media_player_t *p_mi );
203 * Set the NSView handler where the media player should render its video output.
205 * Use the vout called "macosx".
207 * The drawable is an NSObject that follow the VLCOpenGLVideoViewEmbedding
211 * \@protocol VLCOpenGLVideoViewEmbedding <NSObject>
212 * - (void)addVoutSubview:(NSView *)view;
213 * - (void)removeVoutSubview:(NSView *)view;
217 * Or it can be an NSView object.
219 * If you want to use it along with Qt4 see the QMacCocoaViewContainer. Then
220 * the following code should work:
223 * NSView *video = [[NSView alloc] init];
224 * QMacCocoaViewContainer *container = new QMacCocoaViewContainer(video, parent);
225 * libvlc_media_player_set_nsobject(mp, video);
230 * You can find a live example in VLCVideoView in VLCKit.framework.
232 * \param p_mi the Media Player
233 * \param drawable the drawable that is either an NSView or an object following
234 * the VLCOpenGLVideoViewEmbedding protocol.
236 VLC_PUBLIC_API void libvlc_media_player_set_nsobject ( libvlc_media_player_t *p_mi, void * drawable );
239 * Get the NSView handler previously set with libvlc_media_player_set_nsobject().
241 * \param p_mi the Media Player
242 * \return the NSView handler or 0 if none where set
244 VLC_PUBLIC_API void * libvlc_media_player_get_nsobject ( libvlc_media_player_t *p_mi );
247 * Set the agl handler where the media player should render its video output.
249 * \param p_mi the Media Player
250 * \param drawable the agl handler
252 VLC_PUBLIC_API void libvlc_media_player_set_agl ( libvlc_media_player_t *p_mi, uint32_t drawable );
255 * Get the agl handler previously set with libvlc_media_player_set_agl().
257 * \param p_mi the Media Player
258 * \return the agl handler or 0 if none where set
260 VLC_PUBLIC_API uint32_t libvlc_media_player_get_agl ( libvlc_media_player_t *p_mi );
263 * Set an X Window System drawable where the media player should render its
264 * video output. If LibVLC was built without X11 output support, then this has
267 * The specified identifier must correspond to an existing Input/Output class
268 * X11 window. Pixmaps are <b>not</b> supported. The caller shall ensure that
269 * the X11 server is the same as the one the VLC instance has been configured
271 * If XVideo is <b>not</b> used, it is assumed that the drawable has the
272 * following properties in common with the default X11 screen: depth, scan line
273 * pad, black pixel. This is a bug.
275 * \param p_mi the Media Player
276 * \param drawable the ID of the X window
278 VLC_PUBLIC_API void libvlc_media_player_set_xwindow ( libvlc_media_player_t *p_mi, uint32_t drawable );
281 * Get the X Window System window identifier previously set with
282 * libvlc_media_player_set_xwindow(). Note that this will return the identifier
283 * even if VLC is not currently using it (for instance if it is playing an
286 * \param p_mi the Media Player
287 * \return an X window ID, or 0 if none where set.
289 VLC_PUBLIC_API uint32_t libvlc_media_player_get_xwindow ( libvlc_media_player_t *p_mi );
292 * Set a Win32/Win64 API window handle (HWND) where the media player should
293 * render its video output. If LibVLC was built without Win32/Win64 API output
294 * support, then this has no effects.
296 * \param p_mi the Media Player
297 * \param drawable windows handle of the drawable
299 VLC_PUBLIC_API void libvlc_media_player_set_hwnd ( libvlc_media_player_t *p_mi, void *drawable );
302 * Get the Windows API window handle (HWND) previously set with
303 * libvlc_media_player_set_hwnd(). The handle will be returned even if LibVLC
304 * is not currently outputting any video to it.
306 * \param p_mi the Media Player
307 * \return a window handle or NULL if there are none.
309 VLC_PUBLIC_API void *libvlc_media_player_get_hwnd ( libvlc_media_player_t *p_mi );
313 /** \bug This might go away ... to be replaced by a broader system */
316 * Get the current movie length (in ms).
318 * \param p_mi the Media Player
319 * \return the movie length (in ms), or -1 if there is no media.
321 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length( libvlc_media_player_t *p_mi );
324 * Get the current movie time (in ms).
326 * \param p_mi the Media Player
327 * \return the movie time (in ms), or -1 if there is no media.
329 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *p_mi );
332 * Set the movie time (in ms). This has no effect if no media is being played.
333 * Not all formats and protocols support this.
335 * \param p_mi the Media Player
336 * \param i_time the movie time (in ms).
338 VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *p_mi, libvlc_time_t i_time );
341 * Get movie position.
343 * \param p_mi the Media Player
344 * \return movie position, or -1. in case of error
346 VLC_PUBLIC_API float libvlc_media_player_get_position( libvlc_media_player_t *p_mi );
349 * Set movie position. This has no effect if playback is not enabled.
350 * This might not work depending on the underlying input format and protocol.
352 * \param p_mi the Media Player
353 * \param f_pos the position
355 VLC_PUBLIC_API void libvlc_media_player_set_position( libvlc_media_player_t *p_mi, float f_pos );
358 * Set movie chapter (if applicable).
360 * \param p_mi the Media Player
361 * \param i_chapter chapter number to play
363 VLC_PUBLIC_API void libvlc_media_player_set_chapter( libvlc_media_player_t *p_mi, int i_chapter );
368 * \param p_mi the Media Player
369 * \return chapter number currently playing, or -1 if there is no media.
371 VLC_PUBLIC_API int libvlc_media_player_get_chapter( libvlc_media_player_t *p_mi );
374 * Get movie chapter count
376 * \param p_mi the Media Player
377 * \return number of chapters in movie, or -1.
379 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *p_mi );
382 * Is the player able to play
384 * \param p_mi the Media Player
387 VLC_PUBLIC_API int libvlc_media_player_will_play( libvlc_media_player_t *p_mi );
390 * Get title chapter count
392 * \param p_mi the Media Player
393 * \param i_title title
394 * \return number of chapters in title, or -1
396 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count_for_title(
397 libvlc_media_player_t *p_mi, int i_title );
402 * \param p_mi the Media Player
403 * \param i_title title number to play
405 VLC_PUBLIC_API void libvlc_media_player_set_title( libvlc_media_player_t *p_mi, int i_title );
410 * \param p_mi the Media Player
411 * \return title number currently playing, or -1
413 VLC_PUBLIC_API int libvlc_media_player_get_title( libvlc_media_player_t *p_mi );
416 * Get movie title count
418 * \param p_mi the Media Player
419 * \return title number count, or -1
421 VLC_PUBLIC_API int libvlc_media_player_get_title_count( libvlc_media_player_t *p_mi );
424 * Set previous chapter (if applicable)
426 * \param p_mi the Media Player
428 VLC_PUBLIC_API void libvlc_media_player_previous_chapter( libvlc_media_player_t *p_mi );
431 * Set next chapter (if applicable)
433 * \param p_mi the Media Player
435 VLC_PUBLIC_API void libvlc_media_player_next_chapter( libvlc_media_player_t *p_mi );
438 * Get the requested movie play rate.
439 * @warning Depending on the underlying media, the requested rate may be
440 * different from the real playback rate.
442 * \param p_mi the Media Player
443 * \return movie play rate
445 VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t *p_mi );
448 * Set movie play rate
450 * \param p_mi the Media Player
451 * \param rate movie play rate to set
452 * \return -1 if an error was detected, 0 otherwise (but even then, it might
453 * not actually work depending on the underlying media protocol)
455 VLC_PUBLIC_API int libvlc_media_player_set_rate( libvlc_media_player_t *p_mi, float rate );
458 * Get current movie state
460 * \param p_mi the Media Player
461 * \return the current state of the media player (playing, paused, ...) \see libvlc_state_t
463 VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *p_mi );
468 * \param p_mi the Media Player
469 * \return frames per second (fps) for this playing movie, or 0 if unspecified
471 VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *p_mi );
476 * How many video outputs does this media player have?
478 * \param p_mi the media player
479 * \return the number of video outputs
481 VLC_PUBLIC_API unsigned libvlc_media_player_has_vout( libvlc_media_player_t *p_mi );
484 * Is this media player seekable?
486 * \param p_mi the media player
487 * \return true if the media player can seek
489 VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi );
492 * Can this media player be paused?
494 * \param p_mi the media player
495 * \return true if the media player can pause
497 VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi );
501 * Display the next frame (if supported)
503 * \param p_mi the media player
505 VLC_PUBLIC_API void libvlc_media_player_next_frame( libvlc_media_player_t *p_mi );
510 * Release (free) libvlc_track_description_t
512 * \param p_track_description the structure to release
514 VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t *p_track_description );
516 /** \defgroup libvlc_video LibVLC video controls
521 * Toggle fullscreen status on non-embedded video outputs.
523 * @warning The same limitations applies to this function
524 * as to libvlc_set_fullscreen().
526 * \param p_mi the media player
528 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *p_mi );
531 * Enable or disable fullscreen.
533 * @warning With most window managers, only a top-level windows can be in
534 * full-screen mode. Hence, this function will not operate properly if
535 * libvlc_media_player_set_xid() was used to embed the video in a non-top-level
536 * window. In that case, the embedding window must be reparented to the root
537 * window <b>before</b> fullscreen mode is enabled. You will want to reparent
538 * it back to its normal parent when disabling fullscreen.
540 * \param p_mi the media player
541 * \param b_fullscreen boolean for fullscreen status
543 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *p_mi, int b_fullscreen );
546 * Get current fullscreen status.
548 * \param p_mi the media player
549 * \return the fullscreen status (boolean)
551 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *p_mi );
554 * Enable or disable key press events handling, according to the LibVLC hotkeys
555 * configuration. By default and for historical reasons, keyboard events are
556 * handled by the LibVLC video widget.
558 * \note On X11, there can be only one subscriber for key press and mouse
559 * click events per window. If your application has subscribed to those events
560 * for the X window ID of the video widget, then LibVLC will not be able to
561 * handle key presses and mouse clicks in any case.
563 * \warning This function is only implemented for X11 and Win32 at the moment.
565 * \param p_mi the media player
566 * \param on true to handle key press events, false to ignore them.
569 void libvlc_video_set_key_input( libvlc_media_player_t *p_mi, unsigned on );
572 * Enable or disable mouse click events handling. By default, those events are
573 * handled. This is needed for DVD menus to work, as well as a few video
574 * filters such as "puzzle".
576 * \note See also libvlc_video_set_key_input().
578 * \warning This function is only implemented for X11 and Win32 at the moment.
580 * \param p_mi the media player
581 * \param on true to handle mouse click events, false to ignore them.
584 void libvlc_video_set_mouse_input( libvlc_media_player_t *p_mi, unsigned on );
587 * Get the pixel dimensions of a video.
589 * \param p_mi media player
590 * \param num number of the video (starting from, and most commonly 0)
591 * \param px pointer to get the pixel width [OUT]
592 * \param py pointer to get the pixel height [OUT]
593 * \return 0 on success, -1 if the specified video does not exist
596 int libvlc_video_get_size( libvlc_media_player_t *p_mi, unsigned num,
597 unsigned *px, unsigned *py );
600 * Get current video height.
601 * You should use libvlc_video_get_size() instead.
603 * \param p_mi the media player
604 * \return the video pixel height or 0 if not applicable
607 int libvlc_video_get_height( libvlc_media_player_t *p_mi );
610 * Get current video width.
611 * You should use libvlc_video_get_size() instead.
613 * \param p_mi the media player
614 * \return the video pixel width or 0 if not applicable
617 int libvlc_video_get_width( libvlc_media_player_t *p_mi );
620 * Get the mouse pointer coordinates over a video.
621 * Coordinates are expressed in terms of the decoded video resolution,
622 * <b>not</b> in terms of pixels on the screen/viewport (to get the latter,
623 * you can query your windowing system directly).
625 * Either of the coordinates may be negative or larger than the corresponding
626 * dimension of the video, if the cursor is outside the rendering area.
628 * @warning The coordinates may be out-of-date if the pointer is not located
629 * on the video rendering area. LibVLC does not track the pointer if it is
630 * outside of the video widget.
632 * @note LibVLC does not support multiple pointers (it does of course support
633 * multiple input devices sharing the same pointer) at the moment.
635 * \param p_mi media player
636 * \param num number of the video (starting from, and most commonly 0)
637 * \param px pointer to get the abscissa [OUT]
638 * \param py pointer to get the ordinate [OUT]
639 * \return 0 on success, -1 if the specified video does not exist
642 int libvlc_video_get_cursor( libvlc_media_player_t *p_mi, unsigned num,
646 * Get the current video scaling factor.
647 * See also libvlc_video_set_scale().
649 * \param p_mi the media player
650 * \return the currently configured zoom factor, or 0. if the video is set
651 * to fit to the output window/drawable automatically.
653 VLC_PUBLIC_API float libvlc_video_get_scale( libvlc_media_player_t *p_mi );
656 * Set the video scaling factor. That is the ratio of the number of pixels on
657 * screen to the number of pixels in the original decoded video in each
658 * dimension. Zero is a special value; it will adjust the video to the output
659 * window/drawable (in windowed mode) or the entire screen.
661 * Note that not all video outputs support scaling.
663 * \param p_mi the media player
664 * \param f_factor the scaling factor, or zero
666 VLC_PUBLIC_API void libvlc_video_set_scale( libvlc_media_player_t *p_mi, float f_factor );
669 * Get current video aspect ratio.
671 * \param p_mi the media player
672 * \return the video aspect ratio or NULL if unspecified
673 * (the result must be released with free()).
675 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *p_mi );
678 * Set new video aspect ratio.
680 * \param p_mi the media player
681 * \param psz_aspect new video aspect-ratio or NULL to reset to default
682 * \note Invalid aspect ratios are ignored.
684 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *p_mi, const char *psz_aspect );
687 * Get current video subtitle.
689 * \param p_mi the media player
690 * \return the video subtitle selected, or -1 if none
692 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *p_mi );
695 * Get the number of available video subtitles.
697 * \param p_mi the media player
698 * \return the number of available video subtitles
700 VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t *p_mi );
703 * Get the description of available video subtitles.
705 * \param p_mi the media player
706 * \return list containing description of available video subtitles
708 VLC_PUBLIC_API libvlc_track_description_t *
709 libvlc_video_get_spu_description( libvlc_media_player_t *p_mi );
712 * Set new video subtitle.
714 * \param p_mi the media player
715 * \param i_spu new video subtitle to select
716 * \return 0 on success, -1 if out of range
718 VLC_PUBLIC_API int libvlc_video_set_spu( libvlc_media_player_t *p_mi, unsigned i_spu );
721 * Set new video subtitle file.
723 * \param p_mi the media player
724 * \param psz_subtitle new video subtitle file
725 * \return the success status (boolean)
727 VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *p_mi, const char *psz_subtitle );
730 * Get the description of available titles.
732 * \param p_mi the media player
733 * \return list containing description of available titles
735 VLC_PUBLIC_API libvlc_track_description_t *
736 libvlc_video_get_title_description( libvlc_media_player_t *p_mi );
739 * Get the description of available chapters for specific title.
741 * \param p_mi the media player
742 * \param i_title selected title
743 * \return list containing description of available chapter for title i_title
745 VLC_PUBLIC_API libvlc_track_description_t *
746 libvlc_video_get_chapter_description( libvlc_media_player_t *p_mi, int i_title );
749 * Get current crop filter geometry.
751 * \param p_mi the media player
752 * \return the crop filter geometry or NULL if unset
754 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *p_mi );
757 * Set new crop filter geometry.
759 * \param p_mi the media player
760 * \param psz_geometry new crop filter geometry (NULL to unset)
763 void libvlc_video_set_crop_geometry( libvlc_media_player_t *p_mi, const char *psz_geometry );
766 * Get current teletext page requested.
768 * \param p_mi the media player
769 * \return the current teletext page requested.
771 VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *p_mi );
774 * Set new teletext page to retrieve.
776 * \param p_mi the media player
777 * \param i_page teletex page number requested
779 VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_player_t *p_mi, int i_page );
782 * Toggle teletext transparent status on video output.
784 * \param p_mi the media player
786 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *p_mi );
789 * Get number of available video tracks.
791 * \param p_mi media player
792 * \return the number of available video tracks (int)
794 VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_t *p_mi );
797 * Get the description of available video tracks.
799 * \param p_mi media player
800 * \return list with description of available video tracks, or NULL on error
802 VLC_PUBLIC_API libvlc_track_description_t *
803 libvlc_video_get_track_description( libvlc_media_player_t *p_mi );
806 * Get current video track.
808 * \param p_mi media player
809 * \return the video track (int) or -1 if none
811 VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t *p_mi );
816 * \param p_mi media player
817 * \param i_track the track (int)
818 * \return 0 on success, -1 if out of range
821 int libvlc_video_set_track( libvlc_media_player_t *p_mi, int i_track );
824 * Take a snapshot of the current video window.
826 * If i_width AND i_height is 0, original size is used.
827 * If i_width XOR i_height is 0, original aspect-ratio is preserved.
829 * \param p_mi media player instance
830 * \param num number of video output (typically 0 for the first/only one)
831 * \param psz_filepath the path where to save the screenshot to
832 * \param i_width the snapshot's width
833 * \param i_height the snapshot's height
834 * \return 0 on success, -1 if the video was not found
837 int libvlc_video_take_snapshot( libvlc_media_player_t *p_mi, unsigned num,
838 const char *psz_filepath, unsigned int i_width,
839 unsigned int i_height );
842 * Enable or disable deinterlace filter
844 * \param p_mi libvlc media player
845 * \param psz_mode type of deinterlace filter, NULL to disable
847 VLC_PUBLIC_API void libvlc_video_set_deinterlace( libvlc_media_player_t *p_mi,
848 const char *psz_mode );
851 * Get an integer marquee option value
853 * \param p_mi libvlc media player
854 * \param option marq option to get \see libvlc_video_marquee_int_option_t
856 VLC_PUBLIC_API int libvlc_video_get_marquee_int( libvlc_media_player_t *p_mi,
860 * Get a string marquee option value
862 * \param p_mi libvlc media player
863 * \param option marq option to get \see libvlc_video_marquee_string_option_t
865 VLC_PUBLIC_API char *libvlc_video_get_marquee_string( libvlc_media_player_t *p_mi,
869 * Enable, disable or set an integer marquee option
871 * Setting libvlc_marquee_Enable has the side effect of enabling (arg !0)
872 * or disabling (arg 0) the marq filter.
874 * \param p_mi libvlc media player
875 * \param option marq option to set \see libvlc_video_marquee_int_option_t
876 * \param i_val marq option value
878 VLC_PUBLIC_API void libvlc_video_set_marquee_int( libvlc_media_player_t *p_mi,
879 unsigned option, int i_val );
882 * Set a marquee string option
884 * \param p_mi libvlc media player
885 * \param option marq option to set \see libvlc_video_marquee_string_option_t
886 * \param psz_text marq option value
888 VLC_PUBLIC_API void libvlc_video_set_marquee_string( libvlc_media_player_t *p_mi,
889 unsigned option, const char *psz_text );
891 /** option values for libvlc_video_{get,set}_logo_{int,string} */
892 enum libvlc_video_logo_option_t {
894 libvlc_logo_file, /**< string argument, "file,d,t;file,d,t;..." */
900 libvlc_logo_position,
904 * Get integer logo option.
906 * \param p_mi libvlc media player instance
907 * \param option logo option to get, values of libvlc_video_logo_option_t
909 VLC_PUBLIC_API int libvlc_video_get_logo_int( libvlc_media_player_t *p_mi,
913 * Set logo option as integer. Options that take a different type value
915 * Passing libvlc_logo_enable as option value has the side effect of
916 * starting (arg !0) or stopping (arg 0) the logo filter.
918 * \param p_mi libvlc media player instance
919 * \param option logo option to set, values of libvlc_video_logo_option_t
920 * \param value logo option value
922 VLC_PUBLIC_API void libvlc_video_set_logo_int( libvlc_media_player_t *p_mi,
923 unsigned option, int value );
926 * Set logo option as string. Options that take a different type value
929 * \param p_mi libvlc media player instance
930 * \param option logo option to set, values of libvlc_video_logo_option_t
931 * \param psz_value logo option value
933 VLC_PUBLIC_API void libvlc_video_set_logo_string( libvlc_media_player_t *p_mi,
934 unsigned option, const char *psz_value );
937 /** option values for libvlc_video_{get,set}_adjust_{int,float,bool} */
938 enum libvlc_video_adjust_option_t {
939 libvlc_adjust_Enable = 0,
940 libvlc_adjust_Contrast,
941 libvlc_adjust_Brightness,
943 libvlc_adjust_Saturation,
948 * Get integer adjust option.
950 * \param p_mi libvlc media player instance
951 * \param option adjust option to get, values of libvlc_video_adjust_option_t
953 VLC_PUBLIC_API int libvlc_video_get_adjust_int( libvlc_media_player_t *p_mi,
957 * Set adjust option as integer. Options that take a different type value
959 * Passing libvlc_adjust_enable as option value has the side effect of
960 * starting (arg !0) or stopping (arg 0) the adjust filter.
962 * \param p_mi libvlc media player instance
963 * \param option adust option to set, values of libvlc_video_adjust_option_t
964 * \param value adjust option value
966 VLC_PUBLIC_API void libvlc_video_set_adjust_int( libvlc_media_player_t *p_mi,
967 unsigned option, int value );
970 * Get float adjust option.
972 * \param p_mi libvlc media player instance
973 * \param option adjust option to get, values of libvlc_video_adjust_option_t
975 VLC_PUBLIC_API float libvlc_video_get_adjust_float( libvlc_media_player_t *p_mi,
979 * Set adjust option as float. Options that take a different type value
982 * \param p_mi libvlc media player instance
983 * \param option adust option to set, values of libvlc_video_adjust_option_t
984 * \param value adjust option value
986 VLC_PUBLIC_API void libvlc_video_set_adjust_float( libvlc_media_player_t *p_mi,
987 unsigned option, float value );
991 /** \defgroup libvlc_audio LibVLC audio controls
998 typedef enum libvlc_audio_output_device_types_t {
999 libvlc_AudioOutputDevice_Error = -1,
1000 libvlc_AudioOutputDevice_Mono = 1,
1001 libvlc_AudioOutputDevice_Stereo = 2,
1002 libvlc_AudioOutputDevice_2F2R = 4,
1003 libvlc_AudioOutputDevice_3F2R = 5,
1004 libvlc_AudioOutputDevice_5_1 = 6,
1005 libvlc_AudioOutputDevice_6_1 = 7,
1006 libvlc_AudioOutputDevice_7_1 = 8,
1007 libvlc_AudioOutputDevice_SPDIF = 10
1008 } libvlc_audio_output_device_types_t;
1013 typedef enum libvlc_audio_output_channel_t {
1014 libvlc_AudioChannel_Error = -1,
1015 libvlc_AudioChannel_Stereo = 1,
1016 libvlc_AudioChannel_RStereo = 2,
1017 libvlc_AudioChannel_Left = 3,
1018 libvlc_AudioChannel_Right = 4,
1019 libvlc_AudioChannel_Dolbys = 5
1020 } libvlc_audio_output_channel_t;
1024 * Get the list of available audio outputs
1026 * \param p_instance libvlc instance
1027 * \return list of available audio outputs. It must be freed it with
1028 * \see libvlc_audio_output_list_release \see libvlc_audio_output_t .
1029 * In case of error, NULL is returned.
1031 VLC_PUBLIC_API libvlc_audio_output_t *
1032 libvlc_audio_output_list_get( libvlc_instance_t *p_instance );
1035 * Free the list of available audio outputs
1037 * \param p_list list with audio outputs for release
1039 VLC_PUBLIC_API void libvlc_audio_output_list_release( libvlc_audio_output_t *p_list );
1042 * Set the audio output.
1043 * Change will be applied after stop and play.
1045 * \param p_mi media player
1046 * \param psz_name name of audio output,
1047 * use psz_name of \see libvlc_audio_output_t
1048 * \return true if function succeded
1050 VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_media_player_t *p_mi,
1051 const char *psz_name );
1054 * Get count of devices for audio output, these devices are hardware oriented
1055 * like analor or digital output of sound card
1057 * \param p_instance libvlc instance
1058 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1059 * \return number of devices
1061 VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_t *p_instance,
1062 const char *psz_audio_output );
1065 * Get long name of device, if not available short name given
1067 * \param p_instance libvlc instance
1068 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1069 * \param i_device device index
1070 * \return long name of device
1072 VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_t *p_instance,
1073 const char *psz_audio_output,
1077 * Get id name of device
1079 * \param p_instance libvlc instance
1080 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1081 * \param i_device device index
1082 * \return id name of device, use for setting device, need to be free after use
1084 VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *p_instance,
1085 const char *psz_audio_output,
1089 * Set audio output device. Changes are only effective after stop and play.
1091 * \param p_mi media player
1092 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1093 * \param psz_device_id device
1095 VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_media_player_t *p_mi,
1096 const char *psz_audio_output,
1097 const char *psz_device_id );
1100 * Get current audio device type. Device type describes something like
1101 * character of output sound - stereo sound, 2.1, 5.1 etc
1103 * \param p_mi media player
1104 * \return the audio devices type \see libvlc_audio_output_device_types_t
1106 VLC_PUBLIC_API int libvlc_audio_output_get_device_type( libvlc_media_player_t *p_mi );
1109 * Set current audio device type.
1111 * \param p_mi vlc instance
1112 * \param device_type the audio device type,
1113 according to \see libvlc_audio_output_device_types_t
1115 VLC_PUBLIC_API void libvlc_audio_output_set_device_type( libvlc_media_player_t *p_mi,
1120 * Toggle mute status.
1122 * \param p_mi media player
1124 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_media_player_t *p_mi );
1127 * Get current mute status.
1129 * \param p_mi media player
1130 * \return the mute status (boolean)
1132 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_media_player_t *p_mi );
1137 * \param p_mi media player
1138 * \param status If status is true then mute, otherwise unmute
1140 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_media_player_t *p_mi, int status );
1143 * Get current audio level.
1145 * \param p_mi media player
1146 * \return the audio level (int)
1148 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_media_player_t *p_mi );
1151 * Set current audio level.
1153 * \param p_mi media player
1154 * \param i_volume the volume (int)
1155 * \return 0 if the volume was set, -1 if it was out of range
1157 VLC_PUBLIC_API int libvlc_audio_set_volume( libvlc_media_player_t *p_mi, int i_volume );
1160 * Get number of available audio tracks.
1162 * \param p_mi media player
1163 * \return the number of available audio tracks (int), or -1 if unavailable
1165 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *p_mi );
1168 * Get the description of available audio tracks.
1170 * \param p_mi media player
1171 * \return list with description of available audio tracks, or NULL
1173 VLC_PUBLIC_API libvlc_track_description_t *
1174 libvlc_audio_get_track_description( libvlc_media_player_t *p_mi );
1177 * Get current audio track.
1179 * \param p_mi media player
1180 * \return the audio track (int), or -1 if none.
1182 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *p_mi );
1185 * Set current audio track.
1187 * \param p_mi media player
1188 * \param i_track the track (int)
1189 * \return 0 on success, -1 on error
1191 VLC_PUBLIC_API int libvlc_audio_set_track( libvlc_media_player_t *p_mi, int i_track );
1194 * Get current audio channel.
1196 * \param p_mi media player
1197 * \return the audio channel \see libvlc_audio_output_channel_t
1199 VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_media_player_t *p_mi );
1202 * Set current audio channel.
1204 * \param p_mi media player
1205 * \param channel the audio channel, \see libvlc_audio_output_channel_t
1206 * \return 0 on success, -1 on error
1208 VLC_PUBLIC_API int libvlc_audio_set_channel( libvlc_media_player_t *p_mi, int channel );
1212 /** @} media_player */
1218 #endif /* VLC_LIBVLC_MEDIA_PLAYER_H */