Agora RTC Objective-C API Reference  Refactor
Properties
AgoraAudioFrame Class Reference

Inherits <NSObject>.

Properties

NSInteger samplesPerChannel
 
NSInteger bytesPerSample
 
NSInteger channels
 
NSInteger samplesPerSec
 
void *_Nullable buffer
 
int64_t renderTimeMs
 
NSInteger avSyncType
 

Detailed Description

The class of AgoraAudioFrame.

Property Documentation

◆ samplesPerChannel

- (NSInteger) samplesPerChannel
readwritenonatomicassign

The number of samples per channel.

◆ bytesPerSample

- (NSInteger) bytesPerSample
readwritenonatomicassign

The number of bytes per audio sample. For example, each PCM audio sample usually takes up 16 bits (2 bytes).

◆ channels

- (NSInteger) channels
readwritenonatomicassign

The number of audio channels. If the channel uses stereo, the data is interleaved.

  • 1: Mono.
  • 2: Stereo.

◆ samplesPerSec

- (NSInteger) samplesPerSec
readwritenonatomicassign

The sample rate.

◆ buffer

- (void* _Nullable) buffer
readwritenonatomicassign

The buffer of the sample audio data. When the audio frame uses a stereo channel, the data buffer is interleaved. The size of the data buffer is as follows: buffer = samplesPerChannel × channels × bytesPerSample.

◆ renderTimeMs

- (int64_t) renderTimeMs
readwritenonatomicassign

The timestamp of the external audio frame. You can use this parameter for the following purposes:

  • Restore the order of the captured audio frame.
  • Synchronize audio and video frames in video-related scenarios, including where external video sources are used.

◆ avSyncType

- (NSInteger) avSyncType
readwritenonatomicassign

Reserved for future use.