Video controls. More...

#include <vlc-qt/Video.h>

Public Member Functions
	VlcVideo (VlcMediaPlayer *player)
	VlcVideo constructor.
	~VlcVideo ()
	VlcVideo destructor.
Vlc::Ratio	aspectRatio () const
	Get current video aspect ratio.
Vlc::Ratio	cropGeometry () const
	Get current crop filter geometry.
void	hideLogo ()
	Hide logo.
void	hideMarquee ()
	Hide marquee.
Vlc::Scale	scale () const
	Get current scale ratio.
void	setAspectRatio (const Vlc::Ratio &ratio)
	Set new video aspect ratio.
void	setCropGeometry (const Vlc::Ratio &ratio)
	Set new crop filter geometry.
void	setDeinterlace (const Vlc::Deinterlacing &filter)
	Enable or disable deinterlace filter.
void	setScale (const Vlc::Scale &scale)
	Set new scale ratio.
void	setSubtitle (const int &subtitle)
	Set current video subtitle.
void	setSubtitleFile (const QString &subtitle)
	Set new video subtitle file.
void	setTeletextPage (const int &page)
	Set new teletext page to retrieve.
void	setTrack (const int &track)
	Set current video track.
void	showLogo (const QString &file, const int &x, const int &y, const int &opacity=255)
	Show logo.
void	showMarquee (const QString &text, const int &x, const int &y, const int &timeout=0, const int &opacity=255, const int &size=-1, const int &color=0xFFFFFF)
	Show logo.
QSize	size () const
	Get current video size. (currently primary only)
int	subtitle () const
	Get current video subtitle.
int	subtitleCount () const
	Get number of available video subtitles.
QStringList	subtitleDescription () const
	Get the descriptions of available video subtitles.
QList< int >	subtitleIds () const
	Get the ids of available video subtitles.
bool	takeSnapshot (const QString &path) const
	Take a snapshot of current video (currently primary only)
int	teletextPage () const
	Get current teletext page requested.
void	toggleTeletextTransparency ()
	Toggle teletext transparent status on video output.
int	track () const
	Get current video track.
int	trackCount () const
	Get number of available video tracks.
QStringList	trackDescription () const
	Get the description of available video tracks.
QList< int >	trackIds () const
	Get the ids of available video tracks.

Detailed Description

Video controls.

A group of video controls functions.

Constructor & Destructor Documentation

VlcVideo::VlcVideo ( VlcMediaPlayer * player ) [explicit]

VlcVideo constructor.

This constructor creates a new video manager.

Parameters:

player media player (VlcMediaPlayer *)

Member Function Documentation

Vlc::Ratio VlcVideo::aspectRatio ( ) const

Get current video aspect ratio.

Returns:: current video aspect-ratio or NULL if not specified (const Vlc::Ratio)

Vlc::Ratio VlcVideo::cropGeometry ( ) const

Get current crop filter geometry.

Returns:: current crop filter geometry or NULL if not specified (const Vlc::Ratio)

Vlc::Scale VlcVideo::scale ( ) const

Get current scale ratio.

Returns:: current scale ratio or NULL if not specified (const Vlc::Scale)

void VlcVideo::setAspectRatio ( const Vlc::Ratio & ratio )

Set new video aspect ratio.

Parameters:

ratio new video aspect-ratio or NULL to reset to default (Vlc::Ratio)

void VlcVideo::setCropGeometry ( const Vlc::Ratio & ratio )

Set new crop filter geometry.

Parameters:

ratio new crop filter geometry or NULL to reset to default (Vlc::Ratio)

void VlcVideo::setDeinterlace ( const Vlc::Deinterlacing & filter )

Enable or disable deinterlace filter.

Parameters:

filter type of deinterlace filter or NULL to reset to default (Vlc::Deinterlacing)

void VlcVideo::setScale ( const Vlc::Scale & scale )

Set new scale ratio.

Parameters:

scale scale ratio or NULL to reset to default (Vlc::Scale)

void VlcVideo::setSubtitle ( const int & subtitle )

Set current video subtitle.

Parameters:

subtitle new video subtitle (int)

void VlcVideo::setSubtitleFile ( const QString & subtitle )

Set new video subtitle file.

Parameters:

subtitle new video subtitle file (QString)

void VlcVideo::setTeletextPage ( const int & page )

Set new teletext page to retrieve.

Parameters:

page	new teletext page number (int)

void VlcVideo::setTrack ( const int & track )

Set current video track.

Parameters:

track new video track (int)

void VlcVideo::showLogo	(	const QString &	file,
		const int &	x,
		const int &	y,
		const int &	opacity = `255`
	)

Show logo.

Parameters:

file	logo file (QString)
x	x-coordinate (int)
y	y-coordinate (int)
opacity	logo opacity (int)

void VlcVideo::showMarquee	(	const QString &	text,
		const int &	x,
		const int &	y,
		const int &	timeout = `0`,
		const int &	opacity = `255`,
		const int &	size = `-1`,
		const int &	color = `0xFFFFFF`
	)

Show logo.

Parameters:

file	logo file (QString)
x	x-coordinate (int)
y	y-coordinate (int)
opacity	logo opacity (int)

QSize VlcVideo::size ( ) const

Get current video size. (currently primary only)

Returns:: size of the video (QSize)

int VlcVideo::subtitle ( ) const

Get current video subtitle.

Returns:: the number of current video subtitle, or -1 if none (const int)

int VlcVideo::subtitleCount ( ) const

Get number of available video subtitles.

Returns:: the number of available video subtitles, or -1 if unavailable (const int)

QStringList VlcVideo::subtitleDescription ( ) const

Get the descriptions of available video subtitles.

Returns:: list with descriptions of available video subtitles (const QStringList)

QList< int > VlcVideo::subtitleIds ( ) const

Get the ids of available video subtitles.

Returns:: list with ids of available video subtitles (const QList<int>)

bool VlcVideo::takeSnapshot ( const QString & path ) const

Take a snapshot of current video (currently primary only)

Parameters:

path	output path (QString)

Returns:: true if successfull (bool)

int VlcVideo::teletextPage ( ) const

Get current teletext page requested.

Returns:: current teletext page number (int)

int VlcVideo::track ( ) const

Get current video track.

Returns:: the number of current video track, or -1 if none (const int)

int VlcVideo::trackCount ( ) const

Get number of available video tracks.

Returns:: the number of available video tracks, or -1 if unavailable (const int)

QStringList VlcVideo::trackDescription ( ) const

Get the description of available video tracks.

Returns:: list with description of available video tracks (const QStringList)

QList< int > VlcVideo::trackIds ( ) const

Get the ids of available video tracks.

Returns:: list with ids of available video tracks (const QList<int>)

The documentation for this class was generated from the following files:

Video.h
Video.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation