Media Player Kit v1.3.0 API Reference for Windows
Public Types | Public Member Functions | Public Attributes | List of all members
agora::media::base::AudioPcmFrame Struct Reference

Public Types

enum  : size_t { kMaxDataSizeSamples = 3840 , kMaxDataSizeBytes = kMaxDataSizeSamples * sizeof(int16_t) }
 

Public Member Functions

 AudioPcmFrame ()
 

Public Attributes

uint32_t capture_timestamp = 0
 
size_t samples_per_channel_ = 0
 
int sample_rate_hz_ = 0
 
size_t num_channels_ = 0
 
size_t bytes_per_sample = 0
 
int16_t data_ [kMaxDataSizeSamples] = {0}
 

Detailed Description

The detailed information of the incoming audio frame in the PCM format.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : size_t

The size of the audio data buffer.

Enumerator
kMaxDataSizeSamples 

The max number of the samples of the data.

When the number of audio channel is two, the sample rate is 32 kHZ, the buffer length of the data is 60 ms, the number of the samples of the data is 3840 (2 x 32 x 60).

kMaxDataSizeBytes 

The max number of the bytes of the data.

Constructor & Destructor Documentation

◆ AudioPcmFrame()

agora::media::base::AudioPcmFrame::AudioPcmFrame ( )
inline

Member Data Documentation

◆ capture_timestamp

uint32_t agora::media::base::AudioPcmFrame::capture_timestamp = 0

The timestamp (ms) of current audio frame.

◆ samples_per_channel_

size_t agora::media::base::AudioPcmFrame::samples_per_channel_ = 0

The number of samples per channel.

◆ sample_rate_hz_

int agora::media::base::AudioPcmFrame::sample_rate_hz_ = 0

The sample rate (Hz) of the audio data.

◆ num_channels_

size_t agora::media::base::AudioPcmFrame::num_channels_ = 0

The channel number.

◆ bytes_per_sample

size_t agora::media::base::AudioPcmFrame::bytes_per_sample = 0

The number of bytes per sample.

◆ data_

int16_t agora::media::base::AudioPcmFrame::data_[kMaxDataSizeSamples] = {0}

The max number of the bytes of the data.