Frame Class Reference

A media frame containing images, audio, and metadata. More...

#include <frame.h>

Public Types
using	Ptr = SharedPtr< Frame >
	Shared pointer type for Frame.
using	List = promeki::List< Frame >
	Plain value list of Frame objects.
using	PtrList = promeki::List< Ptr >
	List of shared pointers to Frame objects.

Public Member Functions
	Frame ()=default
	Constructs an empty frame with no images, audio, or metadata.
const Image::PtrList &	imageList () const
	Returns a const reference to the list of image planes.
Image::PtrList &	imageList ()
	Returns a mutable reference to the list of image planes.
const Audio::PtrList &	audioList () const
	Returns a const reference to the list of audio tracks.
Audio::PtrList &	audioList ()
	Returns a mutable reference to the list of audio tracks.
const Metadata &	metadata () const
	Returns a const reference to the frame metadata.
Metadata &	metadata ()
	Returns a mutable reference to the frame metadata.

Detailed Description

A media frame containing images, audio, and metadata.

Aggregates one or more image planes, one or more audio tracks, and a metadata container into a single unit that represents a frame of

Example

VideoDesc vdesc;
Frame::Ptr frame = Frame::Ptr::create(vdesc);
frame->setTimecode(Timecode(Timecode::NDF24, 1, 0, 0, 0));
Image img = frame->image(0);

media content.

Member Function Documentation

audioList() [1/2]

Audio::PtrList & Frame::audioList ( )

inline

Returns a mutable reference to the list of audio tracks.

Returns

The audio pointer list.

audioList() [2/2]

const Audio::PtrList & Frame::audioList ( ) const

inline

Returns a const reference to the list of audio tracks.

Returns

The audio pointer list.

imageList() [1/2]

Image::PtrList & Frame::imageList ( )

inline

Returns a mutable reference to the list of image planes.

Returns

The image pointer list.

imageList() [2/2]

const Image::PtrList & Frame::imageList ( ) const

inline

Returns a const reference to the list of image planes.

Returns

The image pointer list.

metadata() [1/2]

Metadata & Frame::metadata ( )

inline

Returns a mutable reference to the frame metadata.

Returns

The metadata container.

metadata() [2/2]

const Metadata & Frame::metadata ( ) const

inline

Returns a const reference to the frame metadata.

Returns

The metadata container.

---

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

• include/promeki/proav/frame.h