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
38 /*****************************************************************************
40 *****************************************************************************/
41 /** \defgroup libvlc_media_player libvlc_media_player
43 * LibVLC Media Player, object that let you play a media
44 * in a custom drawable
48 typedef struct libvlc_media_player_t libvlc_media_player_t;
51 * Description for video, audio tracks and subtitles. It contains
52 * id, name (description string) and pointer to next record.
54 typedef struct libvlc_track_description_t
58 struct libvlc_track_description_t *p_next;
60 } libvlc_track_description_t;
63 * Description for audio output. It contains
64 * name, description and pointer to next record.
66 typedef struct libvlc_audio_output_t
69 char *psz_description;
70 struct libvlc_audio_output_t *p_next;
72 } libvlc_audio_output_t;
75 * Rectangle type for video geometry
77 typedef struct libvlc_rectangle_t
84 * Marq options definition
86 typedef enum libvlc_video_marquee_option_t {
87 libvlc_marquee_Enable = 0,
88 libvlc_marquee_Text, /** string argument */
90 libvlc_marquee_Opacity,
91 libvlc_marquee_Position,
92 libvlc_marquee_Refresh,
94 libvlc_marquee_Timeout,
97 } libvlc_video_marquee_option_t;
100 * Create an empty Media Player object
102 * \param p_libvlc_instance the libvlc instance in which the Media Player
104 * \param p_e an initialized exception pointer
106 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new( libvlc_instance_t *, libvlc_exception_t * );
109 * Create a Media Player object from a Media
111 * \param p_md the media. Afterwards the p_md can be safely
113 * \param p_e an initialized exception pointer
115 VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new_from_media( libvlc_media_t *, libvlc_exception_t * );
118 * Release a media_player after use
119 * Decrement the reference count of a media player object. If the
120 * reference count is 0, then libvlc_media_player_release() will
121 * release the media player object. If the media player object
122 * has been released, then it should not be used again.
124 * \param p_mi the Media Player to free
126 VLC_PUBLIC_API void libvlc_media_player_release( libvlc_media_player_t * );
129 * Retain a reference to a media player object. Use
130 * libvlc_media_player_release() to decrement reference count.
132 * \param p_mi media player object
134 VLC_PUBLIC_API void libvlc_media_player_retain( libvlc_media_player_t * );
137 * Set the media that will be used by the media_player. If any,
138 * previous md will be released.
140 * \param p_mi the Media Player
141 * \param p_md the Media. Afterwards the p_md can be safely
144 VLC_PUBLIC_API void libvlc_media_player_set_media( libvlc_media_player_t *, libvlc_media_t * );
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 * );
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 * );
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 * );
174 * \param p_mi the Media Player
175 * \param p_e an initialized exception pointer
177 VLC_PUBLIC_API void libvlc_media_player_play ( libvlc_media_player_t *, libvlc_exception_t * );
182 * \param p_mi the Media Player
183 * \param p_e an initialized exception pointer
185 VLC_PUBLIC_API void libvlc_media_player_pause ( libvlc_media_player_t *, libvlc_exception_t * );
190 * \param p_mi the Media Player
191 * \param p_e an initialized exception pointer
193 VLC_PUBLIC_API void libvlc_media_player_stop ( libvlc_media_player_t * );
196 * Set the NSView handler where the media player should render its video output.
198 * The object minimal_macosx expects is of kind NSObject and should
199 * respect the protocol:
201 * @protocol VLCOpenGLVideoViewEmbedding <NSObject>
202 * - (void)addVoutSubview:(NSView *)view;
203 * - (void)removeVoutSubview:(NSView *)view;
206 * You can find a live example in VLCVideoView in VLCKit.framework.
208 * \param p_mi the Media Player
209 * \param drawable the NSView handler
211 VLC_PUBLIC_API void libvlc_media_player_set_nsobject ( libvlc_media_player_t *p_mi, void * drawable );
214 * Get the NSView handler previously set with libvlc_media_player_set_nsobject().
216 * \param p_mi the Media Player
217 * \return the NSView handler or 0 if none where set
219 VLC_PUBLIC_API void * libvlc_media_player_get_nsobject ( libvlc_media_player_t *p_mi );
222 * Set the agl handler where the media player should render its video output.
224 * \param p_mi the Media Player
225 * \param drawable the agl handler
226 * \param p_e an initialized exception pointer
228 VLC_PUBLIC_API void libvlc_media_player_set_agl ( libvlc_media_player_t *p_mi, uint32_t drawable );
231 * Get the agl handler previously set with libvlc_media_player_set_agl().
233 * \param p_mi the Media Player
234 * \return the agl handler or 0 if none where set
236 VLC_PUBLIC_API uint32_t libvlc_media_player_get_agl ( libvlc_media_player_t *p_mi );
239 * Set an X Window System drawable where the media player should render its
240 * video output. If LibVLC was built without X11 output support, then this has
243 * The specified identifier must correspond to an existing Input/Output class
244 * X11 window. Pixmaps are <b>not</b> supported. The caller shall ensure that
245 * the X11 server is the same as the one the VLC instance has been configured
247 * If XVideo is <b>not</b> used, it is assumed that the drawable has the
248 * following properties in common with the default X11 screen: depth, scan line
249 * pad, black pixel. This is a bug.
251 * \param p_mi the Media Player
252 * \param drawable the ID of the X window
254 VLC_PUBLIC_API void libvlc_media_player_set_xwindow ( libvlc_media_player_t *p_mi, uint32_t drawable );
257 * Get the X Window System window identifier previously set with
258 * libvlc_media_player_set_xwindow(). Note that this will return the identifier
259 * even if VLC is not currently using it (for instance if it is playing an
262 * \param p_mi the Media Player
263 * \return an X window ID, or 0 if none where set.
265 VLC_PUBLIC_API uint32_t libvlc_media_player_get_xwindow ( libvlc_media_player_t *p_mi );
268 * Set a Win32/Win64 API window handle (HWND) where the media player should
269 * render its video output. If LibVLC was built without Win32/Win64 API output
270 * support, then this has no effects.
272 * \param p_mi the Media Player
273 * \param drawable windows handle of the drawable
275 VLC_PUBLIC_API void libvlc_media_player_set_hwnd ( libvlc_media_player_t *p_mi, void *drawable );
278 * Get the Windows API window handle (HWND) previously set with
279 * libvlc_media_player_set_hwnd(). The handle will be returned even if LibVLC
280 * is not currently outputting any video to it.
282 * \param p_mi the Media Player
283 * \return a window handle or NULL if there are none.
285 VLC_PUBLIC_API void *libvlc_media_player_get_hwnd ( libvlc_media_player_t *p_mi );
289 /** \bug This might go away ... to be replaced by a broader system */
292 * Get the current movie length (in ms).
294 * \param p_mi the Media Player
295 * \param p_e an initialized exception pointer
296 * \return the movie length (in ms).
298 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length( libvlc_media_player_t *, libvlc_exception_t *);
301 * Get the current movie time (in ms).
303 * \param p_mi the Media Player
304 * \param p_e an initialized exception pointer
305 * \return the movie time (in ms).
307 VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *, libvlc_exception_t *);
310 * Set the movie time (in ms).
312 * \param p_mi the Media Player
313 * \param the movie time (in ms).
314 * \param p_e an initialized exception pointer
316 VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *);
319 * Get movie position.
321 * \param p_mi the Media Player
322 * \param p_e an initialized exception pointer
323 * \return movie position
325 VLC_PUBLIC_API float libvlc_media_player_get_position( libvlc_media_player_t *, libvlc_exception_t *);
328 * Set movie position.
330 * \param p_mi the Media Player
331 * \param f_pos the position
332 * \param p_e an initialized exception pointer
334 VLC_PUBLIC_API void libvlc_media_player_set_position( libvlc_media_player_t *, float, libvlc_exception_t *);
339 * \param p_mi the Media Player
340 * \param i_chapter chapter number to play
341 * \param p_e an initialized exception pointer
343 VLC_PUBLIC_API void libvlc_media_player_set_chapter( libvlc_media_player_t *, int, libvlc_exception_t *);
348 * \param p_mi the Media Player
349 * \param p_e an initialized exception pointer
350 * \return chapter number currently playing
352 VLC_PUBLIC_API int libvlc_media_player_get_chapter( libvlc_media_player_t *, libvlc_exception_t * );
355 * Get movie chapter count
357 * \param p_mi the Media Player
358 * \param p_e an initialized exception pointer
359 * \return number of chapters in movie
361 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *, libvlc_exception_t *);
364 * Will the player play
366 * \param p_mi the Media Player
367 * \param p_e an initialized exception pointer
370 VLC_PUBLIC_API int libvlc_media_player_will_play ( libvlc_media_player_t *, libvlc_exception_t *);
373 * Get title chapter count
375 * \param p_mi the Media Player
376 * \param i_title title
377 * \param p_e an initialized exception pointer
378 * \return number of chapters in title
380 VLC_PUBLIC_API int libvlc_media_player_get_chapter_count_for_title(
381 libvlc_media_player_t *, int, libvlc_exception_t *);
386 * \param p_mi the Media Player
387 * \param i_title title number to play
388 * \param p_e an initialized exception pointer
390 VLC_PUBLIC_API void libvlc_media_player_set_title( libvlc_media_player_t *, int, libvlc_exception_t *);
395 * \param p_mi the Media Player
396 * \param p_e an initialized exception pointer
397 * \return title number currently playing
399 VLC_PUBLIC_API int libvlc_media_player_get_title( libvlc_media_player_t *, libvlc_exception_t *);
402 * Get movie title count
404 * \param p_mi the Media Player
405 * \param p_e an initialized exception pointer
406 * \return title number count
408 VLC_PUBLIC_API int libvlc_media_player_get_title_count( libvlc_media_player_t *, libvlc_exception_t *);
411 * Set previous chapter
413 * \param p_mi the Media Player
414 * \param p_e an initialized exception pointer
416 VLC_PUBLIC_API void libvlc_media_player_previous_chapter( libvlc_media_player_t *, libvlc_exception_t *);
421 * \param p_mi the Media Player
422 * \param p_e an initialized exception pointer
424 VLC_PUBLIC_API void libvlc_media_player_next_chapter( libvlc_media_player_t *, libvlc_exception_t *);
427 * Get movie play rate
429 * \param p_mi the Media Player
430 * \param p_e an initialized exception pointer
431 * \return movie play rate
433 VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t *, libvlc_exception_t *);
436 * Set movie play rate
438 * \param p_mi the Media Player
439 * \param movie play rate to set
440 * \param p_e an initialized exception pointer
442 VLC_PUBLIC_API void libvlc_media_player_set_rate( libvlc_media_player_t *, float, libvlc_exception_t *);
445 * Get current movie state
447 * \param p_mi the Media Player
448 * \param p_e an initialized exception pointer
450 VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *);
455 * \param p_mi the Media Player
456 * \param p_e an initialized exception pointer
457 * \return frames per second (fps) for this playing movie
459 VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *, libvlc_exception_t *);
464 * Does this media player have a video output?
466 * \param p_md the media player
467 * \param p_e an initialized exception pointer
469 VLC_PUBLIC_API int libvlc_media_player_has_vout( libvlc_media_player_t *, libvlc_exception_t *);
472 * Is this media player seekable?
474 * \param p_input the input
475 * \param p_e an initialized exception pointer
477 VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
480 * Can this media player be paused?
482 * \param p_input the input
483 * \param p_e an initialized exception pointer
485 VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
489 * Display the next frame
491 * \param p_input the libvlc_media_player_t instance
492 * \param p_e an initialized exception pointer
494 VLC_PUBLIC_API void libvlc_media_player_next_frame( libvlc_media_player_t *p_input,
495 libvlc_exception_t *p_e );
500 * Release (free) libvlc_track_description_t
502 * \param p_track_description the structure to release
504 VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t *p_track_description );
506 /** \defgroup libvlc_video libvlc_video
507 * \ingroup libvlc_media_player
508 * LibVLC Video handling
513 * Toggle fullscreen status on a non-embedded video output.
515 * @warning The same limitations applies to this function
516 * as to libvlc_set_fullscreen().
518 * \param p_mediaplayer the media player
519 * \param p_e an initialized exception pointer
521 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
524 * Enable or disable fullscreen on a non-embedded video output.
526 * @warning With most window managers, only a top-level windows can switch to
527 * full-screen mode. Hence, this function will not operate properly if
528 * libvlc_media_player_set_xid() or libvlc_media_player_set_hwnd() was
529 * used to embed the video in a non-LibVLC widget. If you want to to render an
530 * embedded LibVLC video full-screen, the parent embedding widget must expanded
531 * to full screen (LibVLC cannot take care of that).
532 * LibVLC will then automatically resize the video as appropriate.
534 * \param p_mediaplayer the media player
535 * \param b_fullscreen boolean for fullscreen status
536 * \param p_e an initialized exception pointer
538 VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *, int, libvlc_exception_t * );
541 * Get current fullscreen status.
543 * \param p_mediaplayer the media player
544 * \param p_e an initialized exception pointer
545 * \return the fullscreen status (boolean)
547 VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
550 * Enable or disable key press events handling, according to the LibVLC hotkeys
551 * configuration. By default and for historical reasons, keyboard events are
552 * handled by the LibVLC video widget.
554 * \note On X11, there can be only one subscriber for key press and mouse
555 * click events per window. If your application has subscribed to those events
556 * for the X window ID of the video widget, then LibVLC will not be able to
557 * handle key presses and mouse clicks in any case.
559 * \warning This function is only implemented for X11 at the moment.
561 * \param mp the media player
562 * \param on true to handle key press events, false to ignore them.
565 void libvlc_video_set_key_input( libvlc_media_player_t *mp, unsigned on );
568 * Enable or disable mouse click events handling. By default, those events are
569 * handled. This is needed for DVD menus to work, as well as a few video
570 * filters such as "puzzle".
572 * \note See also \func libvlc_video_set_key_input().
574 * \warning This function is only implemented for X11 at the moment.
576 * \param mp the media player
577 * \param on true to handle mouse click events, false to ignore them.
580 void libvlc_video_set_mouse_input( libvlc_media_player_t *mp, unsigned on );
583 * Get current video height.
585 * \param p_mediaplayer the media player
586 * \param p_e an initialized exception pointer
587 * \return the video height
589 VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_player_t *, libvlc_exception_t * );
592 * Get current video width.
594 * \param p_mediaplayer the media player
595 * \param p_e an initialized exception pointer
596 * \return the video width
598 VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_player_t *, libvlc_exception_t * );
601 * Get the current video scaling factor.
602 * See also libvlc_video_set_scale().
604 * \param p_mediaplayer the media player
605 * \param p_e an initialized exception pointer
606 * \return the currently configured zoom factor, or 0. if the video is set
607 * to fit to the output window/drawable automatically.
609 VLC_PUBLIC_API float libvlc_video_get_scale( libvlc_media_player_t *,
610 libvlc_exception_t *p_e );
613 * Set the video scaling factor. That is the ratio of the number of pixels on
614 * screen to the number of pixels in the original decoded video in each
615 * dimension. Zero is a special value; it will adjust the video to the output
616 * window/drawable (in windowed mode) or the entire screen.
618 * Note that not all video outputs support scaling.
620 * \param p_mediaplayer the media player
621 * \param i_factor the scaling factor, or zero
622 * \param p_e an initialized exception pointer
624 VLC_PUBLIC_API void libvlc_video_set_scale( libvlc_media_player_t *, float,
625 libvlc_exception_t *p_e );
628 * Get current video aspect ratio.
630 * \param p_mediaplayer the media player
631 * \param p_e an initialized exception pointer
632 * \return the video aspect ratio
634 VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *, libvlc_exception_t * );
637 * Set new video aspect ratio.
639 * \param p_mediaplayer the media player
640 * \param psz_aspect new video aspect-ratio
641 * \param p_e an initialized exception pointer
643 VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *, const char *, libvlc_exception_t * );
646 * Get current video subtitle.
648 * \param p_mediaplayer the media player
649 * \param p_e an initialized exception pointer
650 * \return the video subtitle selected
652 VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *, libvlc_exception_t * );
655 * Get the number of available video subtitles.
657 * \param p_mediaplayer the media player
658 * \param p_e an initialized exception pointer
659 * \return the number of available video subtitles
661 VLC_PUBLIC_API int libvlc_video_get_spu_count( libvlc_media_player_t *, libvlc_exception_t * );
664 * Get the description of available video subtitles.
666 * \param p_mediaplayer the media player
667 * \param p_e an initialized exception pointer
668 * \return list containing description of available video subtitles
670 VLC_PUBLIC_API libvlc_track_description_t *
671 libvlc_video_get_spu_description( libvlc_media_player_t *, libvlc_exception_t * );
674 * Set new video subtitle.
676 * \param p_mediaplayer the media player
677 * \param i_spu new video subtitle to select
678 * \param p_e an initialized exception pointer
680 VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_player_t *, int , libvlc_exception_t * );
683 * Set new video subtitle file.
685 * \param p_mediaplayer the media player
686 * \param psz_subtitle new video subtitle file
687 * \param p_e an initialized exception pointer
688 * \return the success status (boolean)
690 VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *, const char *, libvlc_exception_t * );
693 * Get the description of available titles.
695 * \param p_mediaplayer the media player
696 * \param p_e an initialized exception pointer
697 * \return list containing description of available titles
699 VLC_PUBLIC_API libvlc_track_description_t *
700 libvlc_video_get_title_description( libvlc_media_player_t *, libvlc_exception_t * );
703 * Get the description of available chapters for specific title.
705 * \param p_mediaplayer the media player
706 * \param i_title selected title
707 * \param p_e an initialized exception pointer
708 * \return list containing description of available chapter for title i_title
710 VLC_PUBLIC_API libvlc_track_description_t *
711 libvlc_video_get_chapter_description( libvlc_media_player_t *, int, libvlc_exception_t * );
714 * Get current crop filter geometry.
716 * \param p_mediaplayer the media player
717 * \param p_e an initialized exception pointer
718 * \return the crop filter geometry
720 VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *, libvlc_exception_t * );
723 * Set new crop filter geometry.
725 * \param p_mediaplayer the media player
726 * \param psz_geometry new crop filter geometry
727 * \param p_e an initialized exception pointer
729 VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_player_t *, const char *, libvlc_exception_t * );
732 * Toggle teletext transparent status on video output.
734 * \param p_mediaplayer the media player
735 * \param p_e an initialized exception pointer
737 VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *, libvlc_exception_t * );
740 * Get number of available video tracks.
742 * \param p_mi media player
743 * \param p_e an initialized exception
744 * \return the number of available video tracks (int)
746 VLC_PUBLIC_API int libvlc_video_get_track_count( libvlc_media_player_t *, libvlc_exception_t * );
749 * Get the description of available video tracks.
751 * \param p_mi media player
752 * \param p_e an initialized exception
753 * \return list with description of available video tracks
755 VLC_PUBLIC_API libvlc_track_description_t *
756 libvlc_video_get_track_description( libvlc_media_player_t *, libvlc_exception_t * );
759 * Get current video track.
761 * \param p_mi media player
762 * \param p_e an initialized exception pointer
763 * \return the video track (int)
765 VLC_PUBLIC_API int libvlc_video_get_track( libvlc_media_player_t *, libvlc_exception_t * );
770 * \param p_mi media player
771 * \param i_track the track (int)
772 * \param p_e an initialized exception pointer
774 VLC_PUBLIC_API void libvlc_video_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
777 * Take a snapshot of the current video window.
779 * If i_width AND i_height is 0, original size is used.
780 * If i_width XOR i_height is 0, original aspect-ratio is preserved.
782 * \param p_mi media player instance
783 * \param psz_filepath the path where to save the screenshot to
784 * \param i_width the snapshot's width
785 * \param i_height the snapshot's height
786 * \param p_e an initialized exception pointer
788 VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_player_t *, const char *,unsigned int, unsigned int, libvlc_exception_t * );
791 * Enable or disable deinterlace filter
793 * \param p_mi libvlc media player
794 * \param b_enable boolean to enable or disable deinterlace filter
795 * \param psz_mode type of deinterlace filter to use
796 * \param p_e an initialized exception pointer
798 VLC_PUBLIC_API void libvlc_video_set_deinterlace( libvlc_media_player_t *,
800 libvlc_exception_t *);
803 * Get an integer marquee option value
805 * \param p_mi libvlc media player
806 * \param option marq option to get \see libvlc_video_marquee_int_option_t
807 * \param p_e an initialized exception pointer
809 VLC_PUBLIC_API int libvlc_video_get_marquee_int( libvlc_media_player_t *,
810 unsigned, libvlc_exception_t * );
813 * Get a string marquee option value
815 * \param p_mi libvlc media player
816 * \param option marq option to get \see libvlc_video_marquee_string_option_t
817 * \param p_e an initialized exception pointer
819 VLC_PUBLIC_API char *libvlc_video_get_marquee_string( libvlc_media_player_t *,
820 unsigned, libvlc_exception_t * );
823 * Enable, disable or set an integer marquee option
825 * Setting libvlc_marquee_Enable has the side effect of enabling (arg !0)
826 * or disabling (arg 0) the marq filter.
828 * \param p_mi libvlc media player
829 * \param option marq option to set \see libvlc_video_marquee_int_option_t
830 * \param i_val marq option value
831 * \param p_e an initialized exception pointer
833 VLC_PUBLIC_API void libvlc_video_set_marquee_int( libvlc_media_player_t *,
834 unsigned, int, libvlc_exception_t * );
837 * Set a marquee string option
839 * \param p_mi libvlc media player
840 * \param option marq option to set \see libvlc_video_marquee_string_option_t
841 * \param psz_text marq option value
842 * \param p_e an initialized exception pointer
844 VLC_PUBLIC_API void libvlc_video_set_marquee_string( libvlc_media_player_t *,
845 unsigned, const char *, libvlc_exception_t * );
847 /** option values for libvlc_video_{get,set}_logo_{int,string} */
848 enum libvlc_video_logo_option_t {
850 libvlc_logo_file, /**< string argument, "file,d,t;file,d,t;..." */
856 libvlc_logo_position,
860 * Get integer logo option.
862 * \param p_mi libvlc media player instance
863 * \param option logo option to get, values of libvlc_video_logo_option_t
864 * \param p_e an pointer to an initialized exception object
866 VLC_PUBLIC_API int libvlc_video_get_logo_int( libvlc_media_player_t *p_mi,
867 unsigned option, libvlc_exception_t *p_e );
870 * Set logo option as integer. Options that take a different type value
871 * cause an invalid argument exception.
872 * Passing libvlc_logo_enable as option value has the side effect of
873 * starting (arg !0) or stopping (arg 0) the logo filter.
875 * \param p_mi libvlc media player instance
876 * \param option logo option to set, values of libvlc_video_logo_option_t
877 * \param value logo option value
878 * \param p_e an pointer to an initialized exception object
880 VLC_PUBLIC_API void libvlc_video_set_logo_int( libvlc_media_player_t *p_mi,
881 unsigned option, int value, libvlc_exception_t *p_e );
884 * Set logo option as string. Options that take a different type value
885 * cause an invalid argument exception.
887 * \param p_mi libvlc media player instance
888 * \param option logo option to set, values of libvlc_video_logo_option_t
889 * \param psz_value logo option value
890 * \param p_e an pointer to an initialized exception object
892 VLC_PUBLIC_API void libvlc_video_set_logo_string( libvlc_media_player_t *p_mi,
893 unsigned option, const char *psz_value, libvlc_exception_t *p_e );
898 /** \defgroup libvlc_audio libvlc_audio
899 * \ingroup libvlc_media_player
900 * LibVLC Audio handling
907 typedef enum libvlc_audio_output_device_types_t {
908 libvlc_AudioOutputDevice_Error = -1,
909 libvlc_AudioOutputDevice_Mono = 1,
910 libvlc_AudioOutputDevice_Stereo = 2,
911 libvlc_AudioOutputDevice_2F2R = 4,
912 libvlc_AudioOutputDevice_3F2R = 5,
913 libvlc_AudioOutputDevice_5_1 = 6,
914 libvlc_AudioOutputDevice_6_1 = 7,
915 libvlc_AudioOutputDevice_7_1 = 8,
916 libvlc_AudioOutputDevice_SPDIF = 10
917 } libvlc_audio_output_device_types_t;
922 typedef enum libvlc_audio_output_channel_t {
923 libvlc_AudioChannel_Error = -1,
924 libvlc_AudioChannel_Stereo = 1,
925 libvlc_AudioChannel_RStereo = 2,
926 libvlc_AudioChannel_Left = 3,
927 libvlc_AudioChannel_Right = 4,
928 libvlc_AudioChannel_Dolbys = 5
929 } libvlc_audio_output_channel_t;
933 * Get the list of available audio outputs
935 * \param p_instance libvlc instance
936 * \return list of available audio outputs. It must be freed it with
937 * \see libvlc_audio_output_list_release \see libvlc_audio_output_t .
938 * In case of error, NULL is returned.
940 VLC_PUBLIC_API libvlc_audio_output_t *
941 libvlc_audio_output_list_get( libvlc_instance_t * );
944 * Free the list of available audio outputs
946 * \param p_list list with audio outputs for release
948 VLC_PUBLIC_API void libvlc_audio_output_list_release( libvlc_audio_output_t * );
951 * Set the audio output.
952 * Change will be applied after stop and play.
954 * \param p_instance libvlc instance
955 * \param psz_name name of audio output,
956 * use psz_name of \see libvlc_audio_output_t
957 * \return true if function succeded
959 VLC_PUBLIC_API int libvlc_audio_output_set( libvlc_instance_t *,
963 * Get count of devices for audio output, these devices are hardware oriented
964 * like analor or digital output of sound card
966 * \param p_instance libvlc instance
967 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
968 * \return number of devices
970 VLC_PUBLIC_API int libvlc_audio_output_device_count( libvlc_instance_t *,
974 * Get long name of device, if not available short name given
976 * \param p_instance libvlc instance
977 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
978 * \param i_device device index
979 * \return long name of device
981 VLC_PUBLIC_API char * libvlc_audio_output_device_longname( libvlc_instance_t *,
986 * Get id name of device
988 * \param p_instance libvlc instance
989 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
990 * \param i_device device index
991 * \return id name of device, use for setting device, need to be free after use
993 VLC_PUBLIC_API char * libvlc_audio_output_device_id( libvlc_instance_t *,
998 * Set device for using
1000 * \param p_instance libvlc instance
1001 * \param psz_audio_output - name of audio output, \see libvlc_audio_output_t
1002 * \param psz_device_id device
1004 VLC_PUBLIC_API void libvlc_audio_output_device_set( libvlc_instance_t *,
1009 * Get current audio device type. Device type describes something like
1010 * character of output sound - stereo sound, 2.1, 5.1 etc
1012 * \param p_instance vlc instance
1013 * \param p_e an initialized exception pointer
1014 * \return the audio devices type \see libvlc_audio_output_device_types_t
1016 VLC_PUBLIC_API int libvlc_audio_output_get_device_type(
1017 libvlc_instance_t *, libvlc_exception_t * );
1020 * Set current audio device type.
1022 * \param p_instance vlc instance
1023 * \param device_type the audio device type,
1024 according to \see libvlc_audio_output_device_types_t
1025 * \param p_e an initialized exception pointer
1027 VLC_PUBLIC_API void libvlc_audio_output_set_device_type( libvlc_instance_t *,
1029 libvlc_exception_t * );
1033 * Toggle mute status.
1035 * \param p_instance libvlc instance
1037 VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t * );
1040 * Get current mute status.
1042 * \param p_instance libvlc instance
1043 * \return the mute status (boolean)
1045 VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_instance_t * );
1050 * \param p_instance libvlc instance
1051 * \param status If status is true then mute, otherwise unmute
1053 VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, int );
1056 * Get current audio level.
1058 * \param p_instance libvlc instance
1059 * \param p_e an initialized exception pointer
1060 * \return the audio level (int)
1062 VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t * );
1065 * Set current audio level.
1067 * \param p_instance libvlc instance
1068 * \param i_volume the volume (int)
1069 * \param p_e an initialized exception pointer
1071 VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
1074 * Get number of available audio tracks.
1076 * \param p_mi media player
1077 * \param p_e an initialized exception
1078 * \return the number of available audio tracks (int)
1080 VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *, libvlc_exception_t * );
1083 * Get the description of available audio tracks.
1085 * \param p_mi media player
1086 * \param p_e an initialized exception
1087 * \return list with description of available audio tracks
1089 VLC_PUBLIC_API libvlc_track_description_t *
1090 libvlc_audio_get_track_description( libvlc_media_player_t *, libvlc_exception_t * );
1093 * Get current audio track.
1095 * \param p_mi media player
1096 * \param p_e an initialized exception pointer
1097 * \return the audio track (int)
1099 VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *, libvlc_exception_t * );
1102 * Set current audio track.
1104 * \param p_mi media player
1105 * \param i_track the track (int)
1106 * \param p_e an initialized exception pointer
1108 VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
1111 * Get current audio channel.
1113 * \param p_instance vlc instance
1114 * \param p_e an initialized exception pointer
1115 * \return the audio channel \see libvlc_audio_output_channel_t
1118 libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
1121 * Set current audio channel.
1123 * \param p_instance vlc instance
1124 * \param channel the audio channel, \see libvlc_audio_output_channel_t
1125 * \param p_e an initialized exception pointer
1127 VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *,
1129 libvlc_exception_t * );
1133 /** @} media_player */
1139 #endif /* VLC_LIBVLC_MEDIA_PLAYER_H */