MillicastSDK 2.0.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
millicast::EncodedFrame Class Referenceabstract

#include <encoded_frames.h>

Inheritance diagram for millicast::EncodedFrame:
Inheritance graph
[legend]

Public Member Functions

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.
 

Member Function Documentation

◆ data()

virtual Span< const uint8_t > millicast::EncodedFrame::data ( ) const
pure virtual

Get the original encoded frame data.

Returns
a span representing the original frame

◆ metadata()

virtual Span< const uint8_t > millicast::EncodedFrame::metadata ( ) const
pure virtual

return the metadata associated with the frame. It will return an empty span if no metadata is set.

Returns
a span representing the metadata if available. Will return an empty span if there is no metadata

◆ set_metadata()

virtual void millicast::EncodedFrame::set_metadata ( Span< const uint8_t >  metadata)
pure virtual

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.

Parameters
metadataa span representing the metadata to be appended

◆ ssrc()

virtual uint32_t millicast::EncodedFrame::ssrc ( ) const
pure virtual

Gets the SSRC of the frame.

Returns
The SSRC of the frame.

◆ timestamp()

virtual uint32_t millicast::EncodedFrame::timestamp ( ) const
pure virtual

Gets the RTP timestamp of the frame.

Returns
The timestamp of the frame.

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