ZEGO iOS/macOS API Reference

下载pdf
更新时间:2019-07-11 16:04

ZEGO SDK 拥有全面覆盖全球重点区域的网络节点,提供丰富的 API,为多端提供清晰稳定的实时语音视频云服务。

基本功能方法

此分类下主要包括初始化 SDK 和基本音视频通信的方法,适用于语音通话、视频通话、语音/视频直播等应用场景。

基础功能

方法 描述
初始化
initWithAppID:appSignature:completionBlock: 初始化 SDK
setUserID:userName: 设置用户 ID 及用户名
setConfig: 设置配置信息,如果没有特殊说明,必须确保在 InitSDK 前调用
环境配置
version ZegoLiveRoom SDK 版本号
version2 ZegoLiveRoom SDK 引擎版本号
setVerbose: 是否打开调试信息
setUseTestEnv: 是否启用测试环境
SDK 日志
setLogSize: 设置SDK日志大小
uploadLog 上报日志
登录登出
setRoomDelegate: 设置 room 代理对象
setRoomConfig:userStateUpdate: 设置房间配置信息
setCustomToken: 设置自定义token信息
loginRoom:roomName:role:withCompletionBlock: 登录房间
logoutRoom 退出房间

推拉流功能

方法 描述
推流
setLiveEventDelegate: 设置直播事件代理对象
setPublisherDelegate: 设置 Publisher 代理对象
startPublishing:title:flag:extraInfo: 开始发布直播
stopPublishing 停止直播
startPublishing2:title:flag:extraInfo:channelIndex: 开始发布直播,可推两路流
stopPublishing: 停止直播,与可推两路流的开始直播接口成对使用
拉流
setPlayerDelegate: 设置 Player 代理对象
startPlayingStream:inView: 播放直播流
startPlayingStream:inView:params: 指定播放参数,播放直播流
startPlayingStream:inView:extraInfo: 指定播放参数,播放直播流
updatePlayView:ofStream: 更新播放视图
stopPlayingStream: 停止播放流
takeSnapshotOfStream:withCompletionBlock: 对观看直播视图进行截图
推流基础配置
requireHardwareEncoder: 硬件编码开关
setAVConfig: 设置视频配置
setAudioBitrate: 设置音频码率
推流高级配置 以下 API 位于 ZegoLiveRoomApi-Publisher.h 中
updateStreamExtraInfo: 更新流附加信息
setPublishConfig: 自定义推流配置
addPublishTarget:streamID:completion: 添加转推地址
deletePublishTarget:streamID:completion: 删除转推地址
setVideoCodecId:ofChannel: 设置选用分层编码
setVideoEncoderRateControlConfig:encoderCRF: 设置编码器码率控制策略
enableTrafficControl:properties: 是否开启流量控制
setLatencyMode: 设置延迟模式
setAudioChannelCount: 设置推流音频声道数
setPublishQualityMonitorCycle: 设置推流质量监控周期
setMinVideoBitrateForTrafficControl: 设置TrafficControl视频码率最小值
enableDTX: 是否开启离散音频包发送
enableVAD: 是否开启语音活动检测
setVideoKeyFrameInterval:channelIndex: 设置视频关键帧间隔
pauseModule: 暂停模块
resumeModule: 恢复模块
拉流基础配置
requireHardwareDecoder: 开关硬件解码
enableSpeaker: (声音输出)静音开关
setBuiltInSpeakerOn: 手机内置扬声器开关
setPlayVolume: 统一设置所有拉流的播放音量
setPlayVolume:ofStream: 设置指定拉流的播放音量
setViewMode:ofStream: 设置观看直播的View的模式
setViewRotation:ofStream: 设置播放渲染朝向
拉流高级配置
getMaxPlayChannelCount 获取 SDK 支持的最大同时播放流数
enableCheckPoc: 帧顺序检测开关
getSoundLevelOfStream: 获取当前播放视频的音量
setPlayQualityMonitorCycle: 设置拉流质量监控周期
activateAudioPlayStream:active: 拉流是否接收音频数据
activateVideoPlayStream:active: 拉流是否接收视频数据
activateVideoPlayStream:active:videoLayer: 拉流是否接收视频数据
视频采集设置
enableCamera: 开启视频采集
setFrontCam: 是否使用前置摄像头
SetCapturePipelineScaleMode: 设置视频采集缩放时机
enableTorch: 开关手电筒
setAppOrientation: 设置手机方向
以下 API 位于 ZegoLiveRoomApi-Publisher2.h 中
enableCamera:channelIndex: 开启视频采集,适用于一端同时推两路流
setFrontCam:channelIndex: 是否使用前置摄像头,适用于一端同时推两路流
enableTorch:channelIndex: 开关手电筒,适用于一端同时推两路流,适用于一端同时推两路流
setAppOrientation:channelIndex: 设置手机方向,适用于一端同时推两路流时分别设置两路流的手机方向,适用于一端同时推两路流
视频预览设置
setPreviewView: 设置本地预览视图
startPreview 启动本地预览
stopPreview 结束本地预览
setPreviewViewMode: 设置本地预览视频视图的模式
setPreviewRotation: 设置预览渲染朝向
setVideoMirrorMode: 是否启用预览和推流镜像
takePreviewSnapshot: 预览截图
setPreviewView:channelIndex: 设置本地预览视图,适用于一端同时推两路流
startPreview: 启动本地预览,适用于一端同时推两路流
stopPreview: 结束本地预览,适用于一端同时推两路流
setPreviewViewMode:channelIndex: 设置本地预览视频视图的模式,适用于一端同时推两路流
setPreviewRotation:channelIndex: 设置预览渲染朝向,适用于一端同时推两路流
setVideoMirrorMode:channelIndex: 是否启用预览和推流镜像,适用于一端同时推两路流
音频采集设置
setAudioDeviceMode: 设置音频设备模式
enableMic: 开启麦克风
enableMicDevice: 设置是否允许SDK使用麦克风设备
setAECMode 设置回声消除模式
enableAEC: 回声消除开关
enableAGC: 音频采集自动增益开关
enableNoiseSuppress: 音频采集噪声抑制开关
enableAECWhenHeadsetDetected: 耳机插入状态下是否使用回声消除
enableLoopback: 开启采集监听
setLoopbackVolume: 设置采集监听音量
setCaptureVolume: 设置采集音量

IM

方法 描述
setIMDelegate: 设置 IM 代理对象
sendRoomMessage:type:category:completion: 房间发送广播消息
sendBigRoomMessage:type:category:completion: 房间发送不可靠信道的消息
setReliableMessageDelegate: 设置 ReliableMessage 通知的回调
sendReliableMessage:type:completion: 业务广播
自定义消息
sendCustomCommand:content:completion: 发送自定义信令

进阶功能方法

此分类下的方法主要包括了 Zego SDK 的特性,在基础的音视频通话基础上增加更丰富的功能,满足开发者的其它诉求,适用于语音通话、视频通话、互动直播、音视频录制等应用场景。

连麦

本组方法适用于互动直播场景。

方法 描述
requestJoinLive: 请求连麦
respondJoinLiveReq:result: 响应连麦请求
inviteJoinLive:responseBlock: 邀请连麦
respondInviteJoinLiveReq:result: 回应主播端的邀请连麦请求
endJoinLive:completionBlock: 结束连麦

视频外部采集

本组方法为开发者提供自定义视频采集源的功能,适用于直播场景。

方法 描述
setVideoCaptureFactory:channelIndex: 设置外部采集模块
视频外部采集工厂
zego_create: 创建采集设备
zego_destroy: 销毁采集设备
视频外部采集设备
zego_allocateAndStart: 初始化采集使用的资源(例如启动线程等)回调
zego_stopAndDeAllocate 停止并且释放采集占用的资源
zego_supportBufferType 支持的 buffer 类型
zego_startCapture 启动采集,采集的数据通过 [client -onIncomingCapturedData:withPresentationTimeStamp:] 通知 SDK
zego_stopCapture 停止采集
zego_setFrameRate: 设置视频采样帧率回调
zego_setFrontCam: 切换前后摄像头回调
zego_setView: 设置采集使用载体视图回调,移动端使用
zego_setViewMode: 设置采集预览的模式回调
zego_setViewRotation: 设置采集预览的逆时针旋转角度回调
zego_setCaptureRotation: 设置采集 buffer 的顺时针旋转角度回调
zego_startPreview 启动预览回调
zego_stopPreview 停止预览回调
zego_takeSnapshot 对采集预览进行截图回调
zego_enableTorch: 开启手电筒回调
视频外部采集设备 Client 以下 API 位于 zego-api-external-video-capture-oc.h 中的 ZegoVideoCaptureClientDelegate protocol 中
destroy 销毁
onError: 错误信息
setFillMode: 设置图像填充模式
以下 API 位于 zego-api-external-video-capture-oc.h 中的 ZegoVideoCaptureDelegate protocol 中
onIncomingCapturedData:withPresentationTimeStamp: 接收视频帧数据
onIncomingCapturedData:width:height:withPresentationTimeStamp: 接收视频帧数据
onEncodedFrame:config:bKeyframe: 接收编码后的视频帧数据

视频外部滤镜

本组方法为开发者提供可以自定义视频滤镜或者第三方视频滤镜的功能,适用于直播场景。

方法 描述
setVideoFilterFactory:channelIndex: 设置外部滤镜模块
视频外部滤镜工厂
zego_create 创建外部滤镜
zego_destroy: 销毁采集设备
滤镜设置 以下 API 位于 zego-api-external-video-filter-oc.h 中的 ZegoVideoFilter protocol 中
zego_allocateAndStart: 初始化采集使用的资源(例如启动线程等)回调
zego_stopAndDeAllocate 停止并且释放采集占用的资源
supportBufferType 支持的 buffer 类型
滤镜 Client
destroy 销毁,位于 zego-api-external-video-filter-oc.h 中的 ZegoVideoFilterClient protocol 中
onProcess:withTimeStatmp: 同步处理视频帧数据,位于 zego-api-external-video-filter-oc.h 中的 ZegoVideoFilterDelegate protocol 中
dequeueInputBuffer:height:stride: SDK 获取 CVPixelBufferRef 对象,位于 zego-api-external-video-filter-oc.h 中的 ZegoVideoBufferPool protocol 中
queueInputBuffer:timestamp: 异步处理视频帧数据,位于 zego-api-external-video-filter-oc.h 中的 ZegoVideoBufferPool protocol 中

视频外部渲染

本组方法为开发者提供可以自处理视频渲染的功能,适用于直播场景。

方法 描述
setExternalVideoRenderDelegate: 设置外部渲染回调对象
enableExternalVideoRender:type: 设置外部渲染
enableVideoRender:streamID: 设置当VideoExternalRenderType为DECODE_RENDER时,是否开启外部视频渲染(拉流)
enableVideoPreview:channelIndex: 设置当VideoExternalRenderType为DECODE_RENDER时,是否开启外部视频渲染(推流预览)

媒体播放器

方法 描述
setVideoPlayWithIndexDelegate:format: 设置视频帧数据回调
setEventWithIndexDelegate: 设置播放器事件回调
initWithPlayerType:playerIndex: 初始化
setVolume: 设置音量
start:repeat: 开始播放
stop 停止播放
pause 暂停播放
resume 恢复播放
seekTo: 设置指定的进度进行播放
getDuration 获取整个文件的播放时长
getCurrentDuration 获取当前播放的进度
setView: 设置显示视频的view
muteLocal: 设置本地静默播放
load: 预加载资源
setAudioStream: 设置播放文件的音轨
setPlayerType: 设置播放器类型
getAudioStreamCount 获取音轨个数
enableRepeatMode: 设置是否重复播放
takeSnapshot 获取当前播放视频的截图
uninit 释放播放器

媒体次要信息

本组方法为开发者提供在直播时同步其它信息的功能,适用于直播场景。

方法 描述
setMediaSideDelegate: 设置回调,接收媒体次要信息
setMediaSideFlags:onlyAudioPublish:mediaInfoType:seiSendType:channelIndex: 发送媒体次要信息开关,支持 SEI
sendMediaSideInfo:packet:channelIndex: 发送媒体次要信息

音频外部采集与渲染

本组方法为开发者提供推流时采用自定义的音频数据及拉流时自渲染音频数据的功能,适用于直播场景。

方法 描述
enableExternalAudioDevice: 启用外部音频采集
setAudioSrcForAuxiliaryPublishChannel: 选择辅助推流通道的音频采集源
getIAudioDataInOutput 获取 IAudioDataInOutput 对象
startCapture: 开始外部音频采集(通知 SDK)
stopCapture: 结束外部音频采集(通知 SDK)
startRender 开始外部音频播放(通知 SDK)
stopRender 结束外部音频播放(通知 SDK)
onRecordAudioFrame:channel: 把采集到的音频数据塞进 SDK
onPlaybackAudioFrame: 从 SDK 取音频渲染数据

音频前处理设置

本组方法为开发者提供自处理 SDK 采集的音频数据的功能,适用于直播场景。

方法 描述
setAudioPrep2:dataCallback: 设置音频前处理函数

音频加解密设置

适用于直播场景。

方法 描述
enableAudioEncryptDecrypt: 音频加密、解密开关
setAudioEncryptDecryptDelegage: 设置回调,接收音频数据进行加密或者解密后,再回传给sdk

音频录制设置

适用于直播场景。

方法 描述
setAudioRecordDelegate: 设置音频录制回调代理对象
enableSelectedAudioRecord: 音频录制开关

本地媒体录制

仅适用于推流或预览时的录制,不支持拉流时的音视频录制。

方法 描述
setMediaRecordDelegage: 设置录制回调
startRecord:recordType:storagePath:enableStatusUpdate:interval:recordFormat: 开始录制
startRecord:recordType:storagePath:enableStatusUpdate:interval:recordFormat:isFragment: 开始录制,可对音视频分片
stopRecord: 停止录制

混流设置

适用于直播场景。

方法 描述
setMixStreamExDelegate: 设置混流配置的回调,对应于 [-mixStreamEx:mixStreamID:]
setSoundLevelInMixedStreamDelegate: 设置拉取混流时带上音量信息的回调
mixStreamEx:mixStreamID: 混流接口,支持多路混流

混音设置

本组方法为开发者提供自处理 SDK 采集的音频数据的功能,适用于直播场景。

方法 描述
setDelegate: 设置混音代理
enableAux: 混音开关
setAuxVolume: 设置混音音量
muteAux: 设置混音禁音
MixEnginePlayout: 把引擎播放的声音混到推流中
enableMixSystemPlayout: 系统声卡声音采集开关,此接口仅支持 macOS

变声设置

适用于直播场景。

方法 描述
enableVirtualStereo:angle: 设置虚拟立体声
enableReverb:mode: 设置音频混响
setReverbParam:dryWetRatio: 设置音频混响参数
setReverbParam: 设置音频混响参数
setVoiceChangerParam: 设置变声器参数

美颜配置

本组方法为开发者提供调整美颜效果的功能,适用于直播场景。

方法 描述
enableBeautifying:channelIndex: 主播方开启美颜功能
setPolishStep:channelIndex: 设置美颜磨皮的采样步长
setPolishFactor:channelIndex: 设置美颜采样颜色阈值
setWhitenFactor:channelIndex: 设置美颜美白的亮度修正参数
setSharpenFactor:channelIndex: 设置锐化参数
setFilter:channelIndex: 设置滤镜,适用于一端同时推两路视频流
setFilter: 设置滤镜

频域功率谱设置

本组方法为开发者提供获取直播音频在各频点的能量的功能,适用于直播场景。

方法 描述
setFrequencySpectrumDelegate: 设置频域功率谱回调
sharedInstance 获取频域功率谱单例对象
setFrequencySpectrumMonitorCycle: 设置频域功率谱的监控周期,该设置会影响回调频率。
startFrequencySpectrumMonitor 启动频域功率谱监听
stopFrequencySpectrumMonitor 停止频域功率谱监听

音浪设置

本组方法为开发者提供获取直播音量的功能,适用于直播场景。

方法 描述
setSoundLevelDelegate: 设置代理对象
setSoundLevelMonitorCycle: 设置 soundLevel 的监控周期
startSoundLevelMonitor 启动 soundLevel 监听
stopSoundLevelMonitor 停止 soundLevel 监听

水印设置

本组方法为开发者提供加入特定水印到直播画面中的功能,适用于直播场景。

方法 描述
以下 API 位于 ZegoLiveRoomApi-Publisher.h 中
setWaterMarkImagePath: 设置水印的图片路径
setPublishWaterMarkRect: 设置水印在采集视频中的位置
setPreviewWaterMarkRect: 设置水印在预览视频中的位置
setWaterMarkImagePath:channelIndex: 设置水印的图片路径
setPublishWaterMarkRect:channelIndex: 设置水印在采集视频中的位置
setPreviewWaterMarkRect:channelIndex: 设置水印在预览视频中的位置

摄像头曝光设置

此方法仅支持 iOS。

方法 描述
setCamExposurePoint:channelIndex: 设置曝光点

设备状态管理

此组方法仅支持 macOS。

方法 描述
setDeviceEventDelegate: 设置音视频设备错误回调代理对象
视频设备状态管理
getVideoDeviceList 获取视频设备列表
setVideoDevice: 设置视频设备
getDefaultVideoDeviceId 获取默认的视频设备
音频设备状态管理
getAudioDeviceList: 获取音频设备列表
setAudioDevice:type: 设置音频设备
getMicDeviceVolume: 获取麦克风音量
setMicDevice:volume: 设置麦克风音量
getMicDeviceMute: 获取麦克风是否静音
setMicDevice:mute: 设置麦克风静音
getSpeakerDeviceVolume: 获取扬声器音量
setSpeakerDevice:volume: 设置扬声器音量
getSpeakerSimpleVolume: 获取app中扬声器音量
setSpeaker:simpleVolume: 设置app中扬声器音量
getSpeakerDeviceMute: 获取扬声器是否静音
setSpeakerDevice:mute: 设置扬声器静音
getSpeakerSimpleMute: 获取app中扬声器是否静音
setSpeaker:simpleMute: 设置app中扬声器是否静音
setAudioVolumeNotify:type: 监听设备的音量变化
stopAudioVolumeNotify:type: 停止监听设备的音量变化
getDefaultAudioDeviceId: 获取默认的音频设备

基本功能回调

音视频引擎事件回调

方法 描述
setAVEngineDelegate: 设置 AVEngine 代理对象
onAVEngineStop 音视频引擎停止时回调
onAVEngineStart 音视频引擎开始时回调,位于 ZegoLiveRoomApi.h 中的 ZegoAVEngineDelegate protocols 中

基础功能事件回调

方法 描述
登录登出相关事件回调 以下 API 位于 ZegoLiveRoomApi.h 中的 ZegoRoomDelegate protocols 中
onKickOut:roomID: 用户被踢出房间
onDisconnect:roomID: 与 server 断开通知
onReconnect:roomID: 与 server 重连成功通知
onTempBroken:roomID: 与 server 连接中断通知,SDK会尝试自动重连
流更新事件回调 以下 API 位于 ZegoLiveRoomApi.h 中的 ZegoRoomDelegate protocols 中
onStreamUpdated:streams:roomID: 流信息更新
onStreamExtraInfoUpdated:roomID: 流附加信息更新

推拉流功能事件回调

方法 描述
推流事件回调 以下 API 位于 ZegoLiveRoomApi-Publisher.h 中的 ZegoLivePublisherDelegate protocol 中
zego_onLiveEvent:info: 直播事件回调,位于 ZegoLiveRoomApi.h 中的 ZegoLiveEventDelegate protocol 中
onPublishStateUpdate:streamID:streamInfo: 推流状态更新
onPublishQualityUpdate:stream:videoFPS:videoBitrate: 发布质量更新
onPublishQualityUpdate:quality: 发布质量更新
onRelayCDNStateUpdate:streamID: 转推CDN状态信息更新
onCaptureVideoFirstFrame 采集视频的首帧通知
onCaptureVideoFirstFrame: 采集视频的首帧通知
onCaptureAudioFirstFrame 采集音频的首帧通知
拉流事件回调 以下 API 位于 ZegoLiveRoomApi-Player.h 中的 ZegoLivePlayerDelegate protocol 中
onPlayStateUpdate:streamID: 播放流事件
onPlayQualityUpdate:stream:videoFPS:videoBitrate: 观看质量更新
onPlayQualityUpate:quality: 观看质量更新
onVideoSizeChangedTo:ofStream: 视频宽高变化通知
视频采集事件回调 以下 API 位于 ZegoLiveRoomApi-Publisher.h 中的 ZegoLivePublisherDelegate protocol 中
onCaptureVideoSizeChangedTo: 采集视频的宽度和高度变化通知
onCaptureVideoSizeChangedTo:channelIndex: 采集视频的宽度和高度变化通知
onRenderRemoteVideoFirstFrame: 所拉视频流的首帧渲染完成通知
onRemoteCameraStatusUpdate:ofStream: 所拉流的摄像头状态通知
onRemoteMicStatusUpdate:ofStream: 所拉流的麦克风状态通知
onRecvRemoteAudioFirstFrame: 接收到所拉流的首帧音频的通知
onRecvRemoteVideoFirstFrame: 接收到所拉流的首帧视频的通知

IM 事件回调

方法 描述
以下 API 位于 ZegoLiveRoomApi-IM.h 中的 ZegoIMDelegate protocol 中
onRecvRoomMessage:messageList: 收到房间的广播消息
onRecvConversationMessage:conversationId:message: 收到会话消息
onRecvBigRoomMessage:messageList: 收到房间的不可靠消息广播
onRecvReliableMessage: 收到可靠消息,位于 ZegoLiveRoomApi.h 中的 ZegoReliableMessageDelegate protocol 中
自定义消息事件回调 以下 API 位于 ZegoLiveRoomApi.h 中的 ZegoRoomDelegate protocol 中
onReceiveCustomCommand:userName:content:roomID: 收到自定义消息
用户状态更新事件回调 以下 API 位于 ZegoLiveRoomApi-IM.h 中的 ZegoIMDelegate protocol 中
onUserUpdate:updateType: 房间成员更新回调
onUpdateOnlineCount:room: 收到在线人数更新

进阶功能回调

连麦事件回调

方法 描述
onJoinLiveRequest:fromUserID:fromUserName:roomID: 收到连麦请求,位于 ZegoLiveRoomApi-Publisher.h 中的 ZegoLivePublisherDelegate protocol 中
onInviteJoinLiveRequest:fromUserID:fromUserName:roomID: 收到主播端的邀请连麦请求,位于 ZegoLiveRoomApi-Player.h 中的 ZegoLivePlayerDelegate protocol 中
onEndJoinLiveCommad:userName:roomID: 收到结束连麦信令,位于 ZegoLiveRoomApi-Player.h 中的 ZegoLivePlayerDelegate protocol 中

视频外部渲染事件回调

以下 API 位于 zego-api-external-video-render-oc.h 中的 ZegoExternalVideoRenderDelegate protocol 中。

方法 描述
onCreateInputBufferWithWidth:height:cvPixelFormatType: SDK 从用户端获取 PixelBuffer 地址
onPixelBufferCopyed:streamID: SDK 拷贝视频数据完成通知

媒体播放器事件回调

以下 API 位于 zego-api-mediaplayer-oc.h 中的 ZegoMediaPlayerEventDelegate procotol 中。

方法 描述
onPlayStart: 开始播放
onPlayError:playerIndex: 播放错误
onVideoBegin: 开始播放视频
onAudioBegin: 开始播放音频
onPlayEnd: 播放结束
onSeekComplete:when:playerIndex: 快进到指定时刻
onPlayPause: 暂停播放
onPlayResume: 恢复播放
onPlayStop: 用户停止播放的回调
onBufferBegin: 网络音乐资源播放不畅,开始尝试缓存数据。
onBufferEnd: 网络音乐资源可以顺畅播放。
onSnapshot:playerIndex: 截图
onLoadComplete: 预加载完成
onPlayVideoData:size:format: 视频帧数据回调,位于 zego-api-mediaplayer-oc.h 中的 ZegoMediaPlayerVideoPlayDelegate protocol 中

媒体次要信息事件回调

以下 API 位于 zego-api-defines-oc.h 中的 ZegoMediaSideDelegate protocol 中。

方法 描述
onRecvMediaSideInfo:ofStream: 媒体次要信息回调

音频加解密事件回调

以下 API 位于 zego-api-audio-encrypt-decrypt-oc.h 中的 ZegoAudioEncryptDecryptDelegate 中。

方法 描述
onAudioEncryptDecrypt:inData:inDataLen:outData:outDataLen:maxOutBufLen: 音频加密、解密回调

音频录制事件回调

以下 API 位于 ZegoLiveRoomApi-Player.h 中的 ZegoLiveApiAudioRecordDelegate protocol 中。

方法 描述
onAudioRecord:sampleRate:numOfChannels:bitDepth:type: 音频录制回调

本地媒体录制事件回调

以下 API 位于 zego-api-media-recorder-oc.h 中的 ZegoMediaRecordDelegage procotol 中。

方法 描述
onMediaRecord:channelIndex:storagePath: 媒体录制回调
onRecordStatusUpdateFromChannel:storagePath:duration:fileSize: 录制信息更新回调

混流事件回调

方法 描述
onMixStreamExConfigUpdate:mixStream:streamInfo: 混流配置更新结果回调,位于 zego-api-mix-stream-oc.h 中的 ZegoMixStreamExDelegate protocol 中
onMixStreamRelayCDNStateUpdate:mixStreamID: 混流转推CDN的状态回调,位于 zego-api-mix-stream-oc.h 中的 ZegoMixStreamExDelegate protocol 中
onSoundLevelInMixedStream: 混流音量回调,位于 zego-api-mix-stream-oc.h 中的 ZegoLiveSoundLevelInMixedStreamDelegate protocol 中

混音事件回调

以下 API 位于 zego-api-audio-aux-oc.h 中的 ZegoAudioAuxDelgate procotol 中。

方法 描述
onAuxCallback:dataLen:sampleRate:channelCount: 混音音频数据输入回调
onAuxCallback:dataLen:sampleRate:channelCount:sideInfo:sideInfoLen:packet: 混音音频数据输入回调

频域功率谱设置事件回调

以下 API 位于 zego-api-frequency-spectrum-oc.h 中的 ZegoFrequencySpectrumDelegate protocol 中。

方法 描述
onCaptureFrequencySpectrumUpdate: 获取采集的频域功率谱信息
onFrequencySpectrumUpdate: 获取拉流的频域功率谱信息

音浪设置事件回调

以下 API 位于 zego-api-sound-level-oc.h 中的 ZegoSoundLevelDelegate protocol 中。

方法 描述
onSoundLevelUpdate: soundLevel 更新回调
onCaptureSoundLevelUpdate: captureSoundLevel 更新回调

设备状态管理事件回调

此组方法仅支持 macOS。以下 API 位于 ZegoLiveRoomApi.h 的 ZegoDeviceEventDelegate protocol 中。

方法 描述
zego_onDevice:error: 设备事件回调,也支持 iOS
视频设备状态管理事件回调
zego_onVideoDevice:deviceName:changeState: 视频设备改变状态的回调
音频设备状态管理事件回调
zego_onAudioDevice:deviceName:deviceType:changeState: 音频设备改变状态的回调
zego_onAudioDevice:deviceType:changeVolume:volumeType:mute: 音频设备音量变化的回调