libvlc_video
[libvlc_media_player]

Collaboration diagram for libvlc_video:

LibVLC Video handling. More...

Data Structures
struct	libvlc_rectangle_t
	Rectangle type for video geometry. More...
Typedefs
typedef int	libvlc_drawable_t
	Downcast to this general type as placeholder for a platform specific one, such as: Drawable on X11, CGrafPort on MacOSX, HWND on win32.
Functions
void	libvlc_toggle_fullscreen (libvlc_media_player_t *, libvlc_exception_t *)
	Toggle fullscreen status on video output.
void	libvlc_set_fullscreen (libvlc_media_player_t *, int, libvlc_exception_t *)
	Enable or disable fullscreen on a video output.
int	libvlc_get_fullscreen (libvlc_media_player_t *, libvlc_exception_t *)
	Get current fullscreen status.
int	libvlc_video_get_height (libvlc_media_player_t *, libvlc_exception_t *)
	Get current video height.
int	libvlc_video_get_width (libvlc_media_player_t *, libvlc_exception_t *)
	Get current video width.
char *	libvlc_video_get_aspect_ratio (libvlc_media_player_t *, libvlc_exception_t *)
	Get current video aspect ratio.
void	libvlc_video_set_aspect_ratio (libvlc_media_player_t *, char *, libvlc_exception_t *)
	Set new video aspect ratio.
int	libvlc_video_get_spu (libvlc_media_player_t *, libvlc_exception_t *)
	Get current video subtitle.
void	libvlc_video_set_spu (libvlc_media_player_t *, int, libvlc_exception_t *)
	Set new video subtitle.
int	libvlc_video_set_subtitle_file (libvlc_media_player_t *, char *, libvlc_exception_t *)
	Set new video subtitle file.
char *	libvlc_video_get_crop_geometry (libvlc_media_player_t *, libvlc_exception_t *)
	Get current crop filter geometry.
void	libvlc_video_set_crop_geometry (libvlc_media_player_t *, char *, libvlc_exception_t *)
	Set new crop filter geometry.
void	libvlc_toggle_teletext (libvlc_media_player_t *, libvlc_exception_t *)
	Toggle teletext transparent status on video output.
int	libvlc_video_get_teletext (libvlc_media_player_t *, libvlc_exception_t *)
	Get current teletext page requested.
void	libvlc_video_set_teletext (libvlc_media_player_t *, int, libvlc_exception_t *)
	Set new teletext page to retrieve.
void	libvlc_video_take_snapshot (libvlc_media_player_t *, char *, unsigned int, unsigned int, libvlc_exception_t *)
	Take a snapshot of the current video window.
void	libvlc_video_resize (libvlc_media_player_t *, int, int, libvlc_exception_t *)
	Resize the current video output window.
int	libvlc_video_reparent (libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t *)
	Change the parent for the current the video output.
void	libvlc_video_redraw_rectangle (libvlc_media_player_t *, const libvlc_rectangle_t *, libvlc_exception_t *)
	Tell windowless video output to redraw rectangular area (MacOS X only).
void	libvlc_video_set_size (libvlc_instance_t *, int, int, libvlc_exception_t *)
	Set the default video output size.
void	libvlc_video_set_viewport (libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t *)
	Set the default video output viewport for a windowless video output (MacOS X only).

---

Detailed Description

LibVLC Video handling.

---

Typedef Documentation

typedef int libvlc_drawable_t

Downcast to this general type as placeholder for a platform specific one, such as: Drawable on X11, CGrafPort on MacOSX, HWND on win32.

---

Function Documentation

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)

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

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

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

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

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

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

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

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.

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

void libvlc_video_redraw_rectangle	(	libvlc_media_player_t *	,
		const libvlc_rectangle_t *	,
		libvlc_exception_t *
	)

Tell windowless video output to redraw rectangular area (MacOS X only).

Parameters:

	p_instance	libvlc instance
	area	coordinates within video drawable
	p_e	an initialized exception pointer

int libvlc_video_reparent	(	libvlc_media_player_t *	,
		libvlc_drawable_t	,
		libvlc_exception_t *
	)

Change the parent for the current the video output.

Parameters:

	p_instance	libvlc instance
	drawable	the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
	p_e	an initialized exception pointer

Returns:

the success status (boolean)

void libvlc_video_resize	(	libvlc_media_player_t *	,
		int	,
		int	,
		libvlc_exception_t *
	)

Resize the current video output window.

Parameters:

	p_instance	libvlc instance
	width	new width for video output window
	height	new height for video output window
	p_e	an initialized exception pointer

Returns:

the success status (boolean)

void libvlc_video_set_aspect_ratio	(	libvlc_media_player_t *	,
		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

void libvlc_video_set_crop_geometry	(	libvlc_media_player_t *	,
		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

void libvlc_video_set_size	(	libvlc_instance_t *	,
		int	,
		int	,
		libvlc_exception_t *
	)

Set the default video output size.

This setting will be used as default for all video outputs.

Parameters:

	p_instance	libvlc instance
	width	new width for video drawable
	height	new height for video drawable
	p_e	an initialized exception pointer

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

int libvlc_video_set_subtitle_file	(	libvlc_media_player_t *	,
		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)

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

void libvlc_video_set_viewport	(	libvlc_instance_t *	,
		const libvlc_rectangle_t *	,
		const libvlc_rectangle_t *	,
		libvlc_exception_t *
	)

Set the default video output viewport for a windowless video output (MacOS X only).

This setting will be used as default for all video outputs.

Parameters:

	p_instance	libvlc instance
	view	coordinates within video drawable
	clip	coordinates within video drawable
	p_e	an initialized exception pointer

void libvlc_video_take_snapshot	(	libvlc_media_player_t *	,
		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_mediaplayer	the media player
	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

---