Class vl::Frame#

Public Functions#

Type	Name
	Frame ()
	Frame (CaptureStatus status, Image img, int64_t timestamp=vl::timestamp_us())
	Frame (const Frame & f, const ImageSettings & settings) Copy a given Frame to a new instance with customizable image settings.
	Frame (const Frame & f)
	Frame (Frame && o) noexcept
const EncodedImage &	encodedImage () const Access the frame's encoded image data (const ref version)
EncodedImage &	encodedImage () Access the frame's encoded image data (mutable ref version)
const Image &	image () const Access the frame's raw image data (const ref version)
Image &	image () Access the frame's raw image data (mutable ref version)
Frame &	operator= (const Frame &)
Frame &	operator= (Frame &&) noexcept
void	setStatus (CaptureStatus status) Set / override the frame status.
void	setTimestamp (int64_t timestamp) Set / override the timestamp.
CaptureStatus	status () const Query the capture status of the frame.
int64_t	timestamp () const The frames timestamp.
bool	valid (void) const Check if frame is valid.

Protected Functions#

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

Public Functions Documentation#

function Frame [1/5]#

vl::Frame::Frame ()

function Frame [2/5]#

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

function Frame [3/5]#

Copy a given Frame to a new instance with customizable image settings.

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

The internally stored Image is being cloned and (if necessary) adjusted according to the provided settings.

Parameters:

f original frame to be copied
settings (new) image settings to apply

function Frame [4/5]#

vl::Frame::Frame (
    const  Frame & f
)

function Frame [5/5]#

vl::Frame::Frame (
    Frame && o
) noexcept

function encodedImage [1/2]#

Access the frame's encoded image data (const ref version)

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

This can be configured with the ImageSettings, encoding is done as requested.

Returns:

encoded Image

function encodedImage [2/2]#

Access the frame's encoded image data (mutable ref version)

EncodedImage & vl::Frame::encodedImage ()

This can be configured with the ImageSettings, encoding is done as requested.

Returns:

encoded Image

function image [1/2]#

Access the frame's raw image data (const ref version)

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

Make sure that the frame is valid before accessing the image, see status()! Make sure that the image is not deleted upon encoding the image, see ImageSettings!

Returns:

contained Image

function image [2/2]#

Access the frame's raw image data (mutable ref version)

Image & vl::Frame::image ()

Make sure that the frame is valid before accessing the image, see status()! Make sure that the image is not deleted upon encoding the image, see ImageSettings!

Returns:

contained Image

function operator=#

Frame & vl::Frame::operator= (
    const  Frame &
)

function operator=#

Frame & vl::Frame::operator= (
    Frame &&
) noexcept

function setStatus#

Set / override the frame status.

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

For internal user only

Parameters:

status new CaptureStatus for the frame

function setTimestamp#

Set / override the timestamp.

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

For internal user only

Parameters:

timestamp new timestamp [µs] for the frame

function status#

Query the capture status of the frame.

CaptureStatus vl::Frame::status () const

Check if the frame is usable or whether errors ocurred during capture.

Returns:

CaptureStatus of the frame

function timestamp#

The frames timestamp.

int64_t vl::Frame::timestamp () const

The unix timestamp when the frame was received from the camera.

Returns:

timestamp in µs

function valid#

Check if frame is valid.

bool vl::Frame::valid (
    void
) const

This considers the image itself (see Image::valid()), the timestamp and the CaptureStatus of the frame

Returns:

true if image info and capture status indicating a valid frame

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/2.1.0/doxygen/source/vl/frame.h