Class vl::Frame#

Public Functions#

Type	Name
	Frame ()
	Frame (CaptureStatus status, Image img, int64_t timestamp=hs::timestamp_us())
	Frame (const Frame & f, const ImageSettings & settings) Construct a new Frame object with customizable image settings. The internally storedImage is being cloned and (if necessary) adjusted according to the provided settings.
const EncodedImage &	encodedImage () const
EncodedImage &	encodedImage ()
const Image &	image () const
Image &	image ()
void	setStatus (CaptureStatus status)
void	setTimestamp (int64_t timestamp)
CaptureStatus	status () const
int64_t	timestamp () const

Protected Functions#

Type	Name
void	encode (const Image & img, const EncodingSettings & enc)

Public Functions Documentation#

function Frame [1/3]#

vl::Frame::Frame ()

function Frame [2/3]#

vl::Frame::Frame (
    CaptureStatus status,
    Image img,
    int64_t timestamp=hs::timestamp_us()
)

function Frame [3/3]#

Construct a new Frame object with customizable image settings. The internally storedImage is being cloned and (if necessary) adjusted according to the provided settings.

vl::Frame::Frame (
    const  Frame & f,
    const  ImageSettings & settings
)

Parameters:

img
settings

function encodedImage [1/2]#

const  EncodedImage & vl::Frame::encodedImage () const

function encodedImage [2/2]#

EncodedImage & vl::Frame::encodedImage ()

function image [1/2]#

const  Image & vl::Frame::image () const

function image [2/2]#

Image & vl::Frame::image ()

function setStatus#

void vl::Frame::setStatus (
    CaptureStatus status
)

function setTimestamp#

void vl::Frame::setTimestamp (
    int64_t timestamp
)

function status#

CaptureStatus vl::Frame::status () const

function timestamp#

int64_t vl::Frame::timestamp () const

Protected Functions Documentation#

function encode#

void vl::Frame::encode (
    const  Image & img,
    const  EncodingSettings & enc
)

The documentation for this class was generated from the following file docs/libvl/build/1.4.0/doxygen/source/vl/frame.h