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

#include <encoded_frames.h>

Inheritance diagram for millicast::EncodedAudioFrame:
Inheritance graph
[legend]
Collaboration diagram for millicast::EncodedAudioFrame:
Collaboration graph
[legend]

Public Member Functions

virtual ~EncodedAudioFrame ()=default
 
virtual uint16_t sequence_number () const =0
 Gets the sequence number of of the audio frame.
 
virtual uint64_t absolute_capture_time () const =0
 The NTP timestamp of when the audio frame was initially capture. This field is encoded as a 64-bit unsigned fixed-point number with the high 32 bits for the timestamp in seconds and low 32 bits for the fractional part. This is also known as the UQ32.32 format and is what the RTP specification defines as the canonical format to represent NTP timestamps.
 
- 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

◆ ~EncodedAudioFrame()

virtual millicast::EncodedAudioFrame::~EncodedAudioFrame ( )
virtualdefault

Member Function Documentation

◆ absolute_capture_time()

virtual uint64_t millicast::EncodedAudioFrame::absolute_capture_time ( ) const
pure virtual

The NTP timestamp of when the audio frame was initially capture. This field is encoded as a 64-bit unsigned fixed-point number with the high 32 bits for the timestamp in seconds and low 32 bits for the fractional part. This is also known as the UQ32.32 format and is what the RTP specification defines as the canonical format to represent NTP timestamps.

Returns
The capture timestamp of the audio frame.

◆ sequence_number()

virtual uint16_t millicast::EncodedAudioFrame::sequence_number ( ) const
pure virtual

Gets the sequence number of of the audio frame.

Returns
The timestamp of the frame.

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