VlcQmlVideoOutput Class Reference

QML video output. More...

#include <VLCQtQml/QmlVideoOutput.h>

Public Slots

void presentFrame (const std::shared_ptr< const VlcYUVVideoFrame > &frame)
 Set frame which will be rendered in the output. More...
 

Signals

void sourceChanged ()
 Source changed signal.
 
void fillModeChanged ()
 Fill mode changed signal.
 
void aspectRatioChanged ()
 Fill mode changed signal.
 
void cropRatioChanged ()
 Fill mode changed signal.
 

Public Member Functions

VlcQmlSourcesource () const
 Current video source. More...
 
void setSource (VlcQmlSource *source)
 Set video source. More...
 
int fillMode () const
 Current fill mode. More...
 
void setFillMode (int mode)
 Set fill mode. More...
 
int aspectRatio () const
 Current aspect ratio. More...
 
void setAspectRatio (int aspectRatio)
 Set aspect ratio. More...
 
int cropRatio () const
 Current crop ratio. More...
 
void setCropRatio (int cropRatio)
 Set crop ratio. More...
 

Properties

VlcQmlSource source
 Current video source. More...
 
int fillMode
 Current fill mode. More...
 
int aspectRatio
 Current aspect ratio. More...
 
int cropRatio
 Current crop ratio. More...
 

Detailed Description

QML video output.

A QML video output that can be used to display video inside QML.

Since
VLC-Qt 1.1

Member Function Documentation

int VlcQmlVideoOutput::aspectRatio ( ) const

Current aspect ratio.

Returns
aspect ratio

Used as property in QML.

int VlcQmlVideoOutput::cropRatio ( ) const

Current crop ratio.

Returns
crop ratio

Used as property in QML.

int VlcQmlVideoOutput::fillMode ( ) const

Current fill mode.

Returns
fill mode

Used as property in QML.

void VlcQmlVideoOutput::presentFrame ( const std::shared_ptr< const VlcYUVVideoFrame > &  frame)
slot

Set frame which will be rendered in the output.

Parameters
frame
void VlcQmlVideoOutput::setAspectRatio ( int  aspectRatio)

Set aspect ratio.

Parameters
aspectRationew aspect ratio

No effect when fillMode equals Vlc::Stretch. Used as property in QML.

void VlcQmlVideoOutput::setCropRatio ( int  cropRatio)

Set crop ratio.

Parameters
cropRationew crop ratio

No effect when fillMode equals Vlc::Stretch. Used as property in QML.

void VlcQmlVideoOutput::setFillMode ( int  mode)

Set fill mode.

Parameters
modefill mode

Used as property in QML.

void VlcQmlVideoOutput::setSource ( VlcQmlSource source)

Set video source.

Parameters
sourcevideo source

Used as property in QML.

VlcQmlSource* VlcQmlVideoOutput::source ( ) const

Current video source.

Returns
source

Used as property in QML.

Property Documentation

int VlcQmlVideoOutput::aspectRatio
readwrite

Current aspect ratio.

See also
aspectRatio
setAspectRatio
aspectRatioChanged
int VlcQmlVideoOutput::cropRatio
readwrite

Current crop ratio.

See also
cropRatio
setCropRatio
cropRatioChanged
int VlcQmlVideoOutput::fillMode
readwrite

Current fill mode.

See also
fillMode
setFillMode
fillModeChanged
VlcQmlSource * VlcQmlVideoOutput::source
readwrite

Current video source.

See also
source
setSource
sourceChanged

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