Agora C++ API Reference for All Platforms
Public Member Functions | Public Attributes | List of all members
agora::rtc::EncodedAudioFrameInfo Struct Reference

Public Member Functions

 EncodedAudioFrameInfo ()
 
 EncodedAudioFrameInfo (const EncodedAudioFrameInfo &rhs)
 

Public Attributes

AUDIO_CODEC_TYPE codec
 
int sampleRateHz
 
int samplesPerChannel
 
int numberOfChannels
 
EncodedAudioFrameAdvancedSettings advancedSettings
 
int64_t captureTimeMs
 

Detailed Description

The definition of the EncodedAudioFrameInfo struct.

Constructor & Destructor Documentation

◆ EncodedAudioFrameInfo() [1/2]

agora::rtc::EncodedAudioFrameInfo::EncodedAudioFrameInfo ( )
inline

◆ EncodedAudioFrameInfo() [2/2]

agora::rtc::EncodedAudioFrameInfo::EncodedAudioFrameInfo ( const EncodedAudioFrameInfo rhs)
inline

Member Data Documentation

◆ codec

AUDIO_CODEC_TYPE agora::rtc::EncodedAudioFrameInfo::codec

The audio codec: AUDIO_CODEC_TYPE.

◆ sampleRateHz

int agora::rtc::EncodedAudioFrameInfo::sampleRateHz

The sample rate (Hz) of the audio frame.

◆ samplesPerChannel

int agora::rtc::EncodedAudioFrameInfo::samplesPerChannel

The number of samples per audio channel.

If this value is not set, it is 1024 for AAC, or 960 for OPUS by default.

◆ numberOfChannels

int agora::rtc::EncodedAudioFrameInfo::numberOfChannels

The number of audio channels of the audio frame.

◆ advancedSettings

EncodedAudioFrameAdvancedSettings agora::rtc::EncodedAudioFrameInfo::advancedSettings

The advanced settings of the audio frame.

◆ captureTimeMs

int64_t agora::rtc::EncodedAudioFrameInfo::captureTimeMs

This is a input parameter which means the timestamp for capturing the audio frame.