encoded_video_frame

🚀

SDK Beta

This interface is a part of the Beta program.

Module: Media Recorder API

The interface that wraps encoded video frames received from the conference.

#include <media_engine.h>

Public Functions

Name
virtual~encoded_video_frame() =default
virtual intwidth() const =0
Gets the width of the frame.
virtual ssize_tsize() const =0
Returns the size of the payload.
virtual boolis_keyframe() const =0
Checks if the frame is a key frame.
virtual intheight() const =0
Gets the height of the video frame.
virtual const uint8_t *data() const =0
Returns the binary data containing the frame payload.
class dolbyio::comms::encoded_video_frame;

Public Functions Documentation

function ~encoded_video_frame

virtual ~encoded_video_frame() =default

function width

virtual int width() const =0

Gets the width of the frame.

Return: The width of the frame.

function size

virtual ssize_t size() const =0

Returns the size of the payload.

Return: The size of the payload in bytes.

function is_keyframe

virtual bool is_keyframe() const =0

Checks if the frame is a key frame.

Return: true if keyframe, false otherwise.

function height

virtual int height() const =0

Gets the height of the video frame.

Return: The height of the frame.

function data

virtual const uint8_t * data() const =0

Returns the binary data containing the frame payload.

Return: The non-null pointer to the payload data.



Did this page help you?