libvlc_video
[libvlc_media_player]

Collaboration diagram for libvlc_video:

LibVLC Video handling. More...

Functions
VLC_PUBLIC_API void	libvlc_toggle_fullscreen (libvlc_media_player_t *, libvlc_exception_t *)
	Toggle fullscreen status on video output.
VLC_PUBLIC_API void	libvlc_set_fullscreen (libvlc_media_player_t *, int, libvlc_exception_t *)
	Enable or disable fullscreen on a video output.
VLC_PUBLIC_API int	libvlc_get_fullscreen (libvlc_media_player_t *, libvlc_exception_t *)
	Get current fullscreen status.
VLC_PUBLIC_API void	libvlc_video_set_key_input (libvlc_media_player_t *mp, unsigned on)
	Enable or disable key press events handling, according to the LibVLC hotkeys configuration.
VLC_PUBLIC_API void	libvlc_video_set_mouse_input (libvlc_media_player_t *mp, unsigned on)
	Enable or disable mouse click events handling.
VLC_PUBLIC_API int	libvlc_video_get_height (libvlc_media_player_t *, libvlc_exception_t *)
	Get current video height.
VLC_PUBLIC_API int	libvlc_video_get_width (libvlc_media_player_t *, libvlc_exception_t *)
	Get current video width.
VLC_PUBLIC_API float	libvlc_video_get_scale (libvlc_media_player_t *, libvlc_exception_t *p_e)
	Get the current video scaling factor.
VLC_PUBLIC_API void	libvlc_video_set_scale (libvlc_media_player_t *, float, libvlc_exception_t *p_e)
	Set the video scaling factor.
VLC_PUBLIC_API char *	libvlc_video_get_aspect_ratio (libvlc_media_player_t *, libvlc_exception_t *)
	Get current video aspect ratio.
VLC_PUBLIC_API void	libvlc_video_set_aspect_ratio (libvlc_media_player_t *, const char *, libvlc_exception_t *)
	Set new video aspect ratio.
VLC_PUBLIC_API int	libvlc_video_get_spu (libvlc_media_player_t *, libvlc_exception_t *)
	Get current video subtitle.
VLC_PUBLIC_API int	libvlc_video_get_spu_count (libvlc_media_player_t *, libvlc_exception_t *)
	Get the number of available video subtitles.
VLC_PUBLIC_API libvlc_track_description_t *	libvlc_video_get_spu_description (libvlc_media_player_t *, libvlc_exception_t *)
	Get the description of available video subtitles.
VLC_PUBLIC_API void	libvlc_video_set_spu (libvlc_media_player_t *, int, libvlc_exception_t *)
	Set new video subtitle.
VLC_PUBLIC_API int	libvlc_video_set_subtitle_file (libvlc_media_player_t *, const char *, libvlc_exception_t *)
	Set new video subtitle file.
VLC_PUBLIC_API libvlc_track_description_t *	libvlc_video_get_title_description (libvlc_media_player_t *, libvlc_exception_t *)
	Get the description of available titles.
VLC_PUBLIC_API libvlc_track_description_t *	libvlc_video_get_chapter_description (libvlc_media_player_t *, int, libvlc_exception_t *)
	Get the description of available chapters for specific title.
VLC_PUBLIC_API char *	libvlc_video_get_crop_geometry (libvlc_media_player_t *, libvlc_exception_t *)
	Get current crop filter geometry.
VLC_PUBLIC_API void	libvlc_video_set_crop_geometry (libvlc_media_player_t *, const char *, libvlc_exception_t *)
	Set new crop filter geometry.
VLC_PUBLIC_API void	libvlc_toggle_teletext (libvlc_media_player_t *, libvlc_exception_t *)
	Toggle teletext transparent status on video output.
VLC_PUBLIC_API int	libvlc_video_get_teletext (libvlc_media_player_t *, libvlc_exception_t *)
	Get current teletext page requested.
VLC_PUBLIC_API void	libvlc_video_set_teletext (libvlc_media_player_t *, int, libvlc_exception_t *)
	Set new teletext page to retrieve.
VLC_PUBLIC_API int	libvlc_video_get_track_count (libvlc_media_player_t *, libvlc_exception_t *)
	Get number of available video tracks.
VLC_PUBLIC_API libvlc_track_description_t *	libvlc_video_get_track_description (libvlc_media_player_t *, libvlc_exception_t *)
	Get the description of available video tracks.
VLC_PUBLIC_API int	libvlc_video_get_track (libvlc_media_player_t *, libvlc_exception_t *)
	Get current video track.
VLC_PUBLIC_API void	libvlc_video_set_track (libvlc_media_player_t *, int, libvlc_exception_t *)
	Set video track.
VLC_PUBLIC_API void	libvlc_video_take_snapshot (libvlc_media_player_t *, const char *, unsigned int, unsigned int, libvlc_exception_t *)
	Take a snapshot of the current video window.
VLC_PUBLIC_API void	libvlc_video_set_deinterlace (libvlc_media_player_t *, int, const char *, libvlc_exception_t *)
	Enable or disable deinterlace filter.
VLC_PUBLIC_API int	libvlc_video_get_marquee_option_as_int (libvlc_media_player_t *, libvlc_video_marquee_int_option_t, libvlc_exception_t *)
	Get an option value (option which return an int).
VLC_PUBLIC_API char *	libvlc_video_get_marquee_option_as_string (libvlc_media_player_t *, libvlc_video_marquee_string_option_t, libvlc_exception_t *)
	Get an option value (option which return a string).
VLC_PUBLIC_API void	libvlc_video_set_marquee_option_as_int (libvlc_media_player_t *, libvlc_video_marquee_int_option_t, int, libvlc_exception_t *)
	Enable, disable or set a marq option (only int).
VLC_PUBLIC_API void	libvlc_video_set_marquee_option_as_string (libvlc_media_player_t *, libvlc_video_marquee_string_option_t, const char *, libvlc_exception_t *)
	Set a marq option (only string).

---

Detailed Description

LibVLC Video handling.

---

Function Documentation

VLC_PUBLIC_API int libvlc_get_fullscreen	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get current fullscreen status.

Parameters:

	p_mediaplayer	the media player
	p_e	an initialized exception pointer

Returns:

the fullscreen status (boolean)

References GetVout(), var_GetBool, and vlc_object_release.

Referenced by mediacontrol_get_fullscreen().

VLC_PUBLIC_API void libvlc_set_fullscreen	(	libvlc_media_player_t *	,
		int	,
		libvlc_exception_t *
	)

Enable or disable fullscreen on a video output.

Parameters:

	p_mediaplayer	the media player
	b_fullscreen	boolean for fullscreen status
	p_e	an initialized exception pointer

References GetVout(), var_SetBool, and vlc_object_release.

Referenced by mediacontrol_set_fullscreen().

VLC_PUBLIC_API void libvlc_toggle_fullscreen	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Toggle fullscreen status on video output.

Parameters:

	p_mediaplayer	the media player
	p_e	an initialized exception pointer

References GetVout(), var_ToggleBool, and vlc_object_release.

VLC_PUBLIC_API void libvlc_toggle_teletext	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Toggle teletext transparent status on video output.

Parameters:

	p_mediaplayer	the media player
	p_e	an initialized exception pointer

References FIND_CHILD, vlc_list_t::i_count, vlc_value_t::i_int, libvlc_exception_raise(), libvlc_get_input_thread(), vlc_value_t::p_list, vlc_list_t::p_values, var_Change, var_CountChoices, var_FreeList(), var_GetBool, var_GetInteger, var_SetBool, var_SetInteger, vlc_object_find_name, vlc_object_release, and VLC_VAR_GETLIST.

VLC_PUBLIC_API char* libvlc_video_get_aspect_ratio	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get current video aspect ratio.

Parameters:

	p_mediaplayer	the media player
	p_e	an initialized exception pointer

Returns:

the video aspect ratio

References GetVout(), strdup(), var_GetNonEmptyString, and vlc_object_release.

VLC_PUBLIC_API libvlc_track_description_t* libvlc_video_get_chapter_description	(	libvlc_media_player_t *	,
		int	,
		libvlc_exception_t *
	)

Get the description of available chapters for specific title.

Parameters:

	p_mediaplayer	the media player
	i_title	selected title
	p_e	an initialized exception pointer

Returns:

list containing description of available chapter for title i_title

References libvlc_get_track_description().

VLC_PUBLIC_API char* libvlc_video_get_crop_geometry	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get current crop filter geometry.

Parameters:

	p_mediaplayer	the media player
	p_e	an initialized exception pointer

Returns:

the crop filter geometry

References GetVout(), strdup(), var_GetNonEmptyString, and vlc_object_release.

VLC_PUBLIC_API int libvlc_video_get_height	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get current video height.

Parameters:

	p_mediaplayer	the media player
	p_e	an initialized exception pointer

Returns:

the video height

References GetVout(), vout_thread_t::i_window_height, and vlc_object_release.

VLC_PUBLIC_API int libvlc_video_get_marquee_option_as_int	(	libvlc_media_player_t *	,
		libvlc_video_marquee_int_option_t	,
		libvlc_exception_t *
	)

Get an option value (option which return an int).

Parameters:

	p_mi	libvlc media player
	option	marq option to get
	p_e	an initialized exception pointer

References get_marquee_int_option_identifier(), get_marquee_object(), libvlc_exception_raise(), libvlc_marquee_Enabled, libvlc_printerr(), var_GetInteger, and vlc_object_release.

VLC_PUBLIC_API char* libvlc_video_get_marquee_option_as_string	(	libvlc_media_player_t *	,
		libvlc_video_marquee_string_option_t	,
		libvlc_exception_t *
	)

Get an option value (option which return a string).

Parameters:

	p_mi	libvlc media player
	option	marq option to get
	p_e	an initialized exception pointer

References get_marquee_object(), get_marquee_string_option_identifier(), libvlc_exception_raise(), libvlc_printerr(), var_GetString, and vlc_object_release.

VLC_PUBLIC_API float libvlc_video_get_scale	(	libvlc_media_player_t *	,
		libvlc_exception_t *	p_e
	)

Get the current video scaling factor.

See also libvlc_video_set_scale().

Parameters:

	p_mediaplayer	the media player
	p_e	an initialized exception pointer

Returns:

the currently configured zoom factor, or 0. if the video is set to fit to the output window/drawable automatically.

References GetVout(), var_GetBool, var_GetFloat, and vlc_object_release.

VLC_PUBLIC_API int libvlc_video_get_spu	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get current video subtitle.

Parameters:

	p_mediaplayer	the media player
	p_e	an initialized exception pointer

Returns:

the video subtitle selected

References i, vlc_list_t::i_count, vlc_value_t::i_int, libvlc_exception_raise(), libvlc_get_input_thread(), libvlc_printerr(), vlc_value_t::p_list, vlc_list_t::p_values, var_Change, var_FreeList(), var_Get, vlc_object_release, and VLC_VAR_GETCHOICES.

VLC_PUBLIC_API int libvlc_video_get_spu_count	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get the number of available video subtitles.

Parameters:

	p_mediaplayer	the media player
	p_e	an initialized exception pointer

Returns:

the number of available video subtitles

References libvlc_get_input_thread(), var_CountChoices, and vlc_object_release.

VLC_PUBLIC_API libvlc_track_description_t* libvlc_video_get_spu_description	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get the description of available video subtitles.

Parameters:

	p_mediaplayer	the media player
	p_e	an initialized exception pointer

Returns:

list containing description of available video subtitles

References libvlc_get_track_description().

VLC_PUBLIC_API int libvlc_video_get_teletext	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get current teletext page requested.

Parameters:

	p_mediaplayer	the media player
	p_e	an initialized exception pointer

Returns:

the current teletext page requested.

References FIND_CHILD, GetVout(), var_GetInteger, vlc_object_find_name, vlc_object_release, and VLC_UNUSED.

VLC_PUBLIC_API libvlc_track_description_t* libvlc_video_get_title_description	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get the description of available titles.

Parameters:

	p_mediaplayer	the media player
	p_e	an initialized exception pointer

Returns:

list containing description of available titles

References libvlc_get_track_description().

VLC_PUBLIC_API int libvlc_video_get_track	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get current video track.

Parameters:

	p_mi	media player
	p_e	an initialized exception pointer

Returns:

the video track (int)

References i, vlc_list_t::i_count, vlc_value_t::i_int, libvlc_exception_raise(), libvlc_get_input_thread(), libvlc_printerr(), vlc_value_t::p_list, vlc_list_t::p_values, var_Change, var_FreeList(), var_Get, vlc_object_release, and VLC_VAR_GETCHOICES.

VLC_PUBLIC_API int libvlc_video_get_track_count	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get number of available video tracks.

Parameters:

	p_mi	media player
	p_e	an initialized exception

Returns:

the number of available video tracks (int)

References libvlc_get_input_thread(), var_CountChoices, and vlc_object_release.

VLC_PUBLIC_API libvlc_track_description_t* libvlc_video_get_track_description	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get the description of available video tracks.

Parameters:

	p_mi	media player
	p_e	an initialized exception

Returns:

list with description of available video tracks

References libvlc_get_track_description().

VLC_PUBLIC_API int libvlc_video_get_width	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get current video width.

Parameters:

	p_mediaplayer	the media player
	p_e	an initialized exception pointer

Returns:

the video width

References GetVout(), vout_thread_t::i_window_width, and vlc_object_release.

VLC_PUBLIC_API void libvlc_video_set_aspect_ratio	(	libvlc_media_player_t *	,
		const char *	,
		libvlc_exception_t *
	)

Set new video aspect ratio.

Parameters:

	p_mediaplayer	the media player
	psz_aspect	new video aspect-ratio
	p_e	an initialized exception pointer

References GetVout(), libvlc_exception_raise(), libvlc_printerr(), var_SetString, and vlc_object_release.

VLC_PUBLIC_API void libvlc_video_set_crop_geometry	(	libvlc_media_player_t *	,
		const char *	,
		libvlc_exception_t *
	)

Set new crop filter geometry.

Parameters:

	p_mediaplayer	the media player
	psz_geometry	new crop filter geometry
	p_e	an initialized exception pointer

References GetVout(), libvlc_exception_raise(), libvlc_printerr(), var_SetString, and vlc_object_release.

VLC_PUBLIC_API void libvlc_video_set_deinterlace	(	libvlc_media_player_t *	,
		int	,
		const char *	,
		libvlc_exception_t *
	)

Enable or disable deinterlace filter.

Parameters:

	p_mi	libvlc media player
	b_enable	boolean to enable or disable deinterlace filter
	psz_mode	type of deinterlace filter to use
	p_e	an initialized exception pointer

References GetVout(), libvlc_exception_raise(), libvlc_printerr(), var_SetInteger, var_SetString, and vlc_object_release.

VLC_PUBLIC_API void libvlc_video_set_key_input	(	libvlc_media_player_t *	mp,
		unsigned	on
	)

Enable or disable key press events handling, according to the LibVLC hotkeys configuration.

By default and for historical reasons, keyboard events are handled by the LibVLC video widget.

Note:

On X11, there can be only one subscriber for key press and mouse click events per window. If your application has subscribed to those events for the X window ID of the video widget, then LibVLC will not be able to handle key presses and mouse clicks in any case.

Warning:

This function is only implemented for X11 at the moment.

Parameters:

	mp	the media player
	on	true to handle key press events, false to ignore them.

References libvlc_media_player_t::keyboard_events.

VLC_PUBLIC_API void libvlc_video_set_marquee_option_as_int	(	libvlc_media_player_t *	,
		libvlc_video_marquee_int_option_t	,
		int	,
		libvlc_exception_t *
	)

Enable, disable or set a marq option (only int).

Parameters:

	p_mi	libvlc media player
	option	marq option to set
	i_val	marq option value
	p_e	an initialized exception pointer

References get_marquee_int_option_identifier(), get_marquee_object(), GetVout(), libvlc_exception_clear(), libvlc_exception_init(), libvlc_exception_raise(), libvlc_marquee_Enabled, libvlc_printerr(), var_SetInteger, vlc_object_release, and vout_EnableFilter().

VLC_PUBLIC_API void libvlc_video_set_marquee_option_as_string	(	libvlc_media_player_t *	,
		libvlc_video_marquee_string_option_t	,
		const char *	,
		libvlc_exception_t *
	)

Set a marq option (only string).

Parameters:

	p_mi	libvlc media player
	option	marq option to set
	psz_text	marq option value
	p_e	an initialized exception pointer

References get_marquee_object(), get_marquee_string_option_identifier(), libvlc_exception_raise(), libvlc_printerr(), var_SetString, and vlc_object_release.

VLC_PUBLIC_API void libvlc_video_set_mouse_input	(	libvlc_media_player_t *	mp,
		unsigned	on
	)

Enable or disable mouse click events handling.

By default, those events are handled. This is needed for DVD menus to work, as well as a few video filters such as "puzzle".

Note:

See also libvlc_video_set_key_input().

Warning:

This function is only implemented for X11 at the moment.

Parameters:

	mp	the media player
	on	true to handle mouse click events, false to ignore them.

References libvlc_media_player_t::mouse_events.

VLC_PUBLIC_API void libvlc_video_set_scale	(	libvlc_media_player_t *	,
		float	,
		libvlc_exception_t *	p_e
	)

Set the video scaling factor.

That is the ratio of the number of pixels on screen to the number of pixels in the original decoded video in each dimension. Zero is a special value; it will adjust the video to the output window/drawable (in windowed mode) or the entire screen.

Note that not all video outputs support scaling.

Parameters:

	p_mediaplayer	the media player
	i_factor	the scaling factor, or zero
	p_e	an initialized exception pointer

References GetVout(), var_SetBool, var_SetFloat, and vlc_object_release.

VLC_PUBLIC_API void libvlc_video_set_spu	(	libvlc_media_player_t *	,
		int	,
		libvlc_exception_t *
	)

Set new video subtitle.

Parameters:

	p_mediaplayer	the media player
	i_spu	new video subtitle to select
	p_e	an initialized exception pointer

References vlc_list_t::i_count, libvlc_exception_raise(), libvlc_get_input_thread(), libvlc_printerr(), vlc_value_t::p_list, vlc_list_t::p_values, var_Change, var_FreeList(), var_Set, vlc_object_release, and VLC_VAR_GETCHOICES.

VLC_PUBLIC_API int libvlc_video_set_subtitle_file	(	libvlc_media_player_t *	,
		const char *	,
		libvlc_exception_t *
	)

Set new video subtitle file.

Parameters:

	p_mediaplayer	the media player
	psz_subtitle	new video subtitle file
	p_e	an initialized exception pointer

Returns:

the success status (boolean)

References input_AddSubtitle(), libvlc_get_input_thread(), and vlc_object_release.

VLC_PUBLIC_API void libvlc_video_set_teletext	(	libvlc_media_player_t *	,
		int	,
		libvlc_exception_t *
	)

Set new teletext page to retrieve.

Parameters:

	p_mediaplayer	the media player
	i_page	teletex page number requested
	p_e	an initialized exception pointer

References FIND_CHILD, GetVout(), libvlc_exception_raise(), var_SetInteger, vlc_object_find_name, vlc_object_release, and VLC_UNUSED.

VLC_PUBLIC_API void libvlc_video_set_track	(	libvlc_media_player_t *	,
		int	,
		libvlc_exception_t *
	)

Set video track.

Parameters:

	p_mi	media player
	i_track	the track (int)
	p_e	an initialized exception pointer

References i, vlc_list_t::i_count, vlc_value_t::i_int, libvlc_exception_raise(), libvlc_get_input_thread(), libvlc_printerr(), vlc_value_t::p_list, vlc_list_t::p_values, var_Change, var_FreeList(), var_SetInteger, vlc_object_release, and VLC_VAR_GETCHOICES.

VLC_PUBLIC_API void libvlc_video_take_snapshot	(	libvlc_media_player_t *	,
		const char *	,
		unsigned	int,
		unsigned	int,
		libvlc_exception_t *
	)

Take a snapshot of the current video window.

If i_width AND i_height is 0, original size is used. If i_width XOR i_height is 0, original aspect-ratio is preserved.

Parameters:

	p_mi	media player instance
	psz_filepath	the path where to save the screenshot to
	i_width	the snapshot's width
	i_height	the snapshot's height
	p_e	an initialized exception pointer

References GetVout(), libvlc_exception_raise(), libvlc_printerr(), libvlc_media_player_t::p_input_thread, var_SetInteger, var_SetString, var_TriggerCallback, and vlc_object_release.