ZegoAPIAudioFrame Class Reference

Inherits from NSObject
Declared in zego-api-audio-frame-oc.h

Overview

音频帧结构

– setSampleRate:channels:

设置采集的采样率

- (int)setSampleRate:(int)sampleRate channels:(int)channels

Parameters

sampleRate

采样率,PCM 和 AAC 帧的可设置的值为 [8000,16000,22050,24000,32000,44100,48000]

channels

通道数,支持 1(单声道) 或 2(立体声)

Return Value

详见 enum ZegoAPIErrorCode

Declared In

zego-api-audio-frame-oc.h

– getSampleRate:channels:

获取采样率

- (int)getSampleRate:(int *)sampleRate channels:(int *)channels

Parameters

sampleRate

采样率

channels

通道数

Return Value

详见 enum ZegoAPIErrorCode

Declared In

zego-api-audio-frame-oc.h

– setCapturedData:samples:

设置采集到的数据和其采样数

- (int)setCapturedData:(unsigned char *)data samples:(int)samples

Parameters

data

采集到的数据,注意:音频数据传给 SDK 后,需要由调用方管理其生命周期。

samples

采样数,若是 PCM 帧,此值是此帧包含的 PCM 采样数;若是 AAC 帧,此值是 AAC 编码一帧所需要的采样数,可设置的值为[480,512,1024,1960,2048]

Return Value

详见 enum ZegoAPIErrorCode

Discussion

  • 注意:仅支持 16 比特量化深度

Declared In

zego-api-audio-frame-oc.h

– setRenderBuffer:samples:

设置渲染数据缓存地址和指定需要的采样数

- (int)setRenderBuffer:(unsigned char *)buffer samples:(int)samples

Parameters

samples

采样数,若是 PCM 帧,此值是此帧包含的 PCM 采样数;若是 AAC 帧,此值是 AAC 编码一帧所需要的采样数,可设置的值为[480,512,1024,1960,2048]

data

渲染数据缓存地址,注意:缓存地址传给 SDK 后,需要由调用方管理其生命周期。

Return Value

详见 enum ZegoAPIErrorCode

Discussion

  • 注意:仅支持 16 比特量化深度

Declared In

zego-api-audio-frame-oc.h

– getRenderData:samples:

获取渲染数据和其采样数

- (int)getRenderData:(unsigned char **)data samples:(int *)samples

Parameters

data

渲染的数据

samples

采样数

Return Value

详见 enum ZegoAPIErrorCode

Discussion

  • 注意:仅支持 16 比特量化深度

Declared In

zego-api-audio-frame-oc.h

– setFrameType:

设置帧数据类型

- (int)setFrameType:(ZegoAPIAudioFrameType)type

Parameters

type

帧数据类型,详见 enum ZegoAPIAudioFrameType,默认是 kZegoAudioFrameTypePCM。

Return Value

详见 enum ZegoAPIErrorCode

Declared In

zego-api-audio-frame-oc.h

– getFrameType:

获取帧数据类型

- (int)getFrameType:(ZegoAPIAudioFrameType *)type

Parameters

type

帧数据类型,详见 enum ZegoAPIAudioFrameType

Return Value

详见 enum ZegoAPIErrorCode

Declared In

zego-api-audio-frame-oc.h

– setPcmtsTimestamp:

设置 PCM 数据(含时间戳)属性

- (int)setPcmtsTimestamp:(double)timestamp

Parameters

timestamp

时间戳

Return Value

详见 enum ZegoAPIErrorCode @attention timestamp 仅对 kZegoAPIAudioFrameTypePCMTS10 类型音频数据生效

Declared In

zego-api-audio-frame-oc.h

– setAacProperties:dataLength:specialConfigLength:

设置 AAC 编码数据属性

- (int)setAacProperties:(double)timestamp dataLength:(int)dataLength specialConfigLength:(int)specialConfigLength

Parameters

timestamp

编码时间戳,如果数据中只有 AAC 配置信息(specialConfig),填 0

dataLength

总数据长度,注意 dataLength = AAC 编码结果长度 + specialConfigLength

specialConfigLength

AAC 配置信息长度

Return Value

详见 enum ZegoAPIErrorCode

Declared In

zego-api-audio-frame-oc.h

– getAacProperties:dataLength:specialConfigLength:

获取 AAC 编码数据属性

- (int)getAacProperties:(double *)timestamp dataLength:(int *)dataLength specialConfigLength:(int *)specialConfigLength

Parameters

timestamp

编码时间戳

dataLength

总数据长度,注意 dataLength = AAC 编码结果长度 + specialConfigLength

specialConfigLength

AAC 配置信息长度

Return Value

详见 enum ZegoAPIErrorCode

Declared In

zego-api-audio-frame-oc.h