millicast::EncodedVideoFrame Class Reference

#include <encoded_frames.h>

Inheritance diagram for millicast::EncodedVideoFrame:

Collaboration diagram for millicast::EncodedVideoFrame:

Public Member Functions
virtual	~EncodedVideoFrame ()=default
virtual int	width () const =0
	Gets the width of the encoded video frame.
virtual int	height () const =0
	Gets the height of the encoded video frame.
virtual bool	is_keyframe () const =0
	Checks if the frame is a key frame.
virtual int64_t	frame_id () const =0
	Gets the ID of the frame.
virtual int	temporal_index () const =0
	Gets the temporal index of the frame, this will be valid if the stream has temporal layers.
virtual int	spatial_index () const =0
	Gets the spatial index of the frame, this will be valid if the stream has spatial layers.
Public Member Functions inherited from millicast::EncodedFrame
virtual Span< const uint8_t >	data () const =0
	Get the original encoded frame data.
virtual void	set_metadata (Span< const uint8_t > metadata)=0
	Set metadata to be appended on top of the original frame. This will be extracted and presented to the viewer if they subscribed to the appropriate event.
virtual Span< const uint8_t >	metadata () const =0
	return the metadata associated with the frame. It will return an empty span if no metadata is set.
virtual uint32_t	timestamp () const =0
	Gets the RTP timestamp of the frame.
virtual uint32_t	ssrc () const =0
	Gets the SSRC of the frame.

Constructor & Destructor Documentation

~EncodedVideoFrame()

virtual millicast::EncodedVideoFrame::~EncodedVideoFrame ( )

virtualdefault

Member Function Documentation

frame_id()

virtual int64_t millicast::EncodedVideoFrame::frame_id ( ) const

pure virtual

Gets the ID of the frame.

Returns

The ID of the frame.

height()

virtual int millicast::EncodedVideoFrame::height ( ) const

pure virtual

Gets the height of the encoded video frame.

Returns

The height of the frame.

is_keyframe()

virtual bool millicast::EncodedVideoFrame::is_keyframe ( ) const

pure virtual

Checks if the frame is a key frame.

Returns

true if keyframe, false otherwise.

spatial_index()

virtual int millicast::EncodedVideoFrame::spatial_index ( ) const

pure virtual

Gets the spatial index of the frame, this will be valid if the stream has spatial layers.

Returns

Tthe spatial index of the frame.

temporal_index()

virtual int millicast::EncodedVideoFrame::temporal_index ( ) const

pure virtual

Gets the temporal index of the frame, this will be valid if the stream has temporal layers.

Returns

The temporal index of the frame.

width()

virtual int millicast::EncodedVideoFrame::width ( ) const

pure virtual

Gets the width of the encoded video frame.

Returns

The width of the frame.

---

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

• api/millicast-sdk/encoded_frames.h