API 概览

声网通过全球部署的 SD-RTN™，提供可以灵活搭配的 API 组合，实现质量可靠的实时音视频通信。

初始化相关

方法/回调	描述
sharedEngineWithAppId:delegate:	创建并初始化 AgoraRtcEngineKit。
sharedEngineWithConfig:delegate:	创建并初始化 AgoraRtcEngineKit。
destroy	销毁 AgoraRtcEngineKit 对象。
destroy:	销毁 AgoraRtcEngineKit 实例并释放相关资源。

频道相关

方法/回调	描述
setChannelProfile:	设置频道场景。
joinChannelByToken:channelId:info:uid:joinSuccess:	加入频道。
joinChannelByToken:channelId:uid:mediaOptions:joinSuccess:	设置媒体选项并加入频道。
joinChannelExByToken:connection:delegate:mediaOptions:joinSuccess:	加入频道。
updateChannelWithMediaOptions:	加入频道后更新频道媒体选项。
updateChannelExWithMediaOptions:connection:	加入频道后更新频道媒体选项 。
leaveChannel:	离开频道。
leaveChannelEx:leaveChannelBlock:	离开频道。
leaveChannel:leaveChannelBlock:	设置频道选项并离开频道。
leaveChannelEx:options:leaveChannelBlock:	设置频道选项并离开频道。
preloadChannelByToken:channelId:uid:	使用 token、channelId、uid 预加载频道。
preloadChannelByTokenWithUserAccount:channelId:userAccount:	使用 token、channelId、userAccount 预加载频道。
updatePreloadChannelToken:	更新预加载频道的通配 Token。
renewToken:	更新 Token。
setClientRole:	设置用户角色。
setClientRole:options:	设置直播场景下的用户角色和观众端延时级别。
rtcEngine:didJoinChannel:withUid:elapsed:	成功加入频道回调。
rtcEngine:didRejoinChannel:withUid:elapsed:	成功重新加入频道回调。
rtcEngine:didClientRoleChanged:newRole:newRoleOptions:	用户角色、观众端延时级别已切换回调。
rtcEngine:didClientRoleChangeFailed:currentRole:	用户角色切换失败回调。
rtcEngine:didLeaveChannelWithStats:	离开频道回调。
rtcEngine:didJoinedOfUid:elapsed:	远端用户（通信场景）/主播（直播场景）加入当前频道回调。
rtcEngine:didOfflineOfUid:reason:	远端用户（通信场景）/主播（直播场景）离开当前频道回调。
rtcEngine:networkTypeChanged:	本地网络类型发生改变回调。
rtcEngine:uplinkNetworkInfoUpdate:	上行网络信息变化回调。
rtcEngineConnectionDidLost:	网络连接中断，且 SDK 无法在 10 秒内连接服务器回调。
rtcEngine:connectionChangedToState:reason:	网络连接状态已改变回调。
rtcEngine:renewTokenResult:code:	renewToken: 调用结果回调。
rtcEngineRequestToken:	Token 已过期回调。
rtcEngine:tokenPrivilegeWillExpire:	Token 即将在 30s 内过期回调。
rtcEngine:didOccurError:	发生错误回调。

发布和订阅

方法/回调	描述
muteLocalAudioStream:	取消或恢复发布本地音频流。
muteLocalAudioStreamEx:connection:	取消或恢复发布本地音频流。
muteRemoteAudioStream:mute:	取消或恢复订阅指定远端用户的音频流。
muteRemoteAudioStreamEx:mute:connection:	停止/恢复接收指定的音频流。
muteAllRemoteAudioStreams:	取消或恢复订阅所有远端用户的音频流。
muteAllRemoteAudioStreamsEx:connection:	取消或恢复订阅所有远端用户的音频流。
muteLocalVideoStream:	取消或恢复发布本地视频流。
muteLocalVideoStreamEx:connection:	取消或恢复发布本地视频流。
muteRemoteVideoStream:mute:	取消或恢复订阅指定远端用户的视频流。
muteRemoteVideoStreamEx:mute:connection:	停止/恢复接收指定的视频流。
muteAllRemoteVideoStreams:	取消或恢复订阅所有远端用户的视频流。
muteAllRemoteVideoStreamsEx:connection:	取消或恢复订阅所有远端用户的视频流。
setRemoteVideoSubscriptionOptions:options:	设置远端视频流的订阅选项。
setRemoteVideoSubscriptionOptionsEx:options:connection:	设置远端视频流的订阅选项。
setSubscribeAudioBlocklist:	设置音频订阅黑名单。
setSubscribeAudioBlocklistEx:connection:	设置音频订阅黑名单。
setSubscribeAudioAllowlist:	设置音频订阅白名单。
setSubscribeAudioAllowlistEx:connection:	设置音频订阅白名单。
setSubscribeVideoBlocklist:	设置视频订阅黑名单。
setSubscribeVideoBlocklistEx:connection:	设置视频订阅黑名单。
setSubscribeVideoAllowlist:	设置视频订阅白名单。
setSubscribeVideoAllowlistEx:connection:	设置视频订阅白名单。
setRemoteVideoStream:type:	设置订阅的视频流类型。
setRemoteVideoStreamEx:type:connection:	设置订阅的视频流类型。
setRemoteDefaultVideoStreamType:	设置默认订阅的视频流类型。
setDualStreamMode:	在发送端设置双流模式。
setDualStreamMode:streamConfig:	在发送端设置双流模式并设置视频小流。
setDualStreamModeEx:streamConfig:connection:	在发送端设置双流模式。
rtcEngine:didAudioPublishStateChange:oldState:newState:elapseSinceLastState:	音频发布状态改变回调。
rtcEngine:didAudioSubscribeStateChange:uid:oldState:newState:elapseSinceLastState:	音频订阅状态发生改变回调。
rtcEngine:didVideoSubscribeStateChange:uid:oldState:newState:elapseSinceLastState:	视频订阅状态发生改变回调。

音频基础功能

方法/回调	描述
adjustUserPlaybackSignalVolume:volume:	调节本地播放的指定远端用户信号音量。
adjustUserPlaybackSignalVolumeEx:volume:connection:	调节本地播放的指定远端用户信号音量。
adjustPlaybackSignalVolume:	调节本地播放的所有远端用户信号音量。
enableAudio	启用音频模块。
disableAudio	关闭音频模块。
enableAudioVolumeIndication:smooth:reportVad:	启用用户音量提示。
enableAudioVolumeIndicationEx:smooth:reportVad:connection:	启用用户音量提示。
setAudioProfile:	设置音频编码属性。
setAudioScenario:	设置音频场景。
setAudioSessionOperationRestriction:	设置 SDK 对 Audio Session 的操作权限。
rtcEngine:reportAudioVolumeIndicationOfSpeakers:totalVolume:	用户音量提示回调。
rtcEngine:activeSpeaker:	监测到远端最活跃用户回调。
rtcEngine:localAudioStateChanged:reason:	本地音频状态发生改变回调。
rtcEngine:firstLocalAudioFramePublished:	已发布本地音频首帧回调。
rtcEngine:firstRemoteAudioFrameOfUid:elapsed:	已接收远端音频首帧回调。
rtcEngine:didAudioMuted:byUid:	远端用户（通信场景）/主播（直播场景）停止或恢复发送音频流回调。
rtcEngine:remoteAudioStateChangedOfUid:state:reason:elapsed:	远端音频流状态发生改变回调。
rtcEngine:localAudioStats:	通话中本地音频流的统计信息回调。
rtcEngine:remoteAudioStats:	通话中远端音频流的统计信息回调。

音频采集

方法/回调	描述
enableLocalAudio:	开启或关闭本地音频采集。
adjustRecordingSignalVolume:	调节音频采集信号音量。
enableInEarMonitoring:	开启耳返功能。
enableInEarMonitoring:includeAudioFilters:	开启耳返功能。
setInEarMonitoringVolume:	设置耳返音量。

音频前处理和后处理

方法/回调	描述
enableVoiceAITuner:type:	开启或关闭 AI 调音器功能。
setAdvancedAudioOptions:	设置音频的高级选项。
setAINSMode:mode:	设置是否开启 AI 降噪功能并设置降噪模式。
setLocalVoiceEqualizationOfBandFrequency:withGain:	设置本地语音音效均衡。
setLocalVoicePitch:	设置本地语音音调。
setLocalVoiceReverbOfType:withValue:	设置本地音效混响。
setVoiceBeautifierPreset:	设置预设的美声效果。
setVoiceBeautifierParameters:param1:param2:	设置预设美声效果的参数。
setAudioEffectPreset:	设置 SDK 预设的人声音效。
setAudioEffectParameters:param1:param2:	设置 SDK 预设人声音效的参数。
setVoiceConversionPreset:	设置预设的变声效果。
setLocalVoiceFormant:	设置共振峰比率以改变语音的音色。
enableSoundPositionIndication:	开启/关闭远端用户的语音立体声。
setRemoteVoicePosition:pan:gain:	设置远端用户声音的 2D 位置，即水平面位置。
setRemoteVoicePosition:pan:gain:connection:	设置远端用户声音的 2D 位置，即水平面位置。
sharedLocalSpatialAudioWithConfig:	初始化 AgoraLocalSpatialAudioKit。
destroy	销毁 AgoraLocalSpatialAudioKit。
updateSelfPosition:axisForward:axisRight:axisUp:	更新本地用户的空间位置。
updateRemotePosition:positionInfo:	更新远端用户的空间位置信息。
removeRemotePosition:	删除指定远端用户的空间位置信息。
clearRemotePositions	删除所有远端用户的空间位置信息。
setHeadphoneEQParameters:highGain:	设置耳机均衡器的低频和高频参数。
setHeadphoneEQPreset:	设置预设的耳机均衡效果。
updateSelfTransform:	更新坐标转换。
startLocalAudioMixer	开启本地音频合流。
updateLocalAudioMixerConfiguration	更新本地音频合流的配置。
stopLocalAudioMixer	停止本地音频合流。

原始音频数据

方法/回调	描述
setAudioFrameDelegate:	注册音频观测器对象。
setEarMonitoringAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:	设置耳返的音频数据格式。
setRecordingAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:	设置采集的原始音频数据格式。
setPlaybackAudioFrameBeforeMixingParametersWithSampleRate	设置 onPlaybackAudioFrameBeforeMixing:channelId:uid: 回调中音频数据的播放格式。
setPlaybackAudioFrameParametersWithSampleRate:channel:mode:samplesPerCall:	设置播放的原始音频数据格式。
setMixedAudioFrameParametersWithSampleRate:channel:samplesPerCall:	设置采集和播放音频混音后的原始音频数据格式。
setPlaybackAudioFrameBeforeMixingParametersWithSampleRate:channel:	设置混音前的原始音频播放数据格式。
onEarMonitoringAudioFrame:	获得耳返的原始音频数据。
onRecordAudioFrame:channelId:	获得采集的原始音频数据。
onPlaybackAudioFrame:	获得播放的原始音频数据。
onPlaybackAudioFrameBeforeMixing:channelId:uid:	获取所订阅的远端用户混音前的声音。
onMixedAudioFrame:channelId:	获取采集和播放音频混音后的数据。
getEarMonitoringAudioParams	设置 onEarMonitoringAudioFrame: 回调数据的格式。
getObservedAudioFramePosition	设置音频观测位置。
getRecordAudioParams	设置 onRecordAudioFrame:channelId: 回调数据的格式。
getPlaybackAudioParams	设置 onPlaybackAudioFrame: 回调数据的格式。
getMixedAudioParams	设置 onMixedAudioFrame:channelId: 回调数据的格式。

已编码音频数据

方法/回调	描述
setAudioEncodedFrameDelegate:config:	注册音频编码数据观测器。
onRecordEncodedAudioFrame:info:	获取本地用户的音频编码数据。
onPlaybackEncodedAudioFrame:info:	获取所有远端用户的音频编码数据。
onMixedEncodedAudioFrame:info:	获取本地和所有远端用户混音后的音频编码数据。

自定义音频采集和渲染

方法/回调	描述
createCustomAudioTrack:config:	创建一个自定义音频采集轨道。
destroyCustomAudioTrack:	销毁指定的音频轨道。
enableExternalAudioSink:sampleRate:channels:	设置外部音频渲染。
pullPlaybackAudioFrameRawData:lengthInByte:	拉取远端音频数据。
pushExternalAudioFrameSampleBuffer:sampleRate:channels:trackId:	将外部 CMSampleBuffer 音频帧通过自定义音频轨道推送到频道中。
pushExternalAudioFrameRawData:samples:sampleRate:channels:trackId:timestamp:	推送外部音频数据。
pullPlaybackAudioFrameSampleBufferByLengthInByte:	拉取 SampleBuffer 格式的远端音频数据。
adjustCustomAudioPlayoutVolume:volume:	调节自定义音频采集轨道在本地播放的音量。
adjustCustomAudioPublishVolume:volume:	调节自定义音频采集轨道在远端播放的音量。
enableCustomAudioLocalPlayback:enabled:	设置是否在本地播放外部音频源。

音频频谱

方法/回调	描述
registerAudioSpectrumDelegate:	注册音频频谱观测器。
enableAudioSpectrumMonitor:	开启音频频谱监测。
disableAudioSpectrumMonitor	关闭音频频谱监测。
unregisterAudioSpectrumDelegate:	取消注册音频频谱观测器。
onLocalAudioSpectrum:	获取本地音频频谱。
onRemoteAudioSpectrum:	获取远端音频频谱。

视频基础功能

方法/回调	描述
enableVideo	启用视频模块。
disableVideo	关闭视频模块。
setVideoScenario:	设置视频业务场景。
setVideoEncoderConfiguration:	设置视频编码属性。
setVideoEncoderConfigurationEx:connection:	设置视频编码属性。
startPreview	开启视频预览。
stopPreview	停止视频预览。
startPreview:	开启视频预览并指定预览的视频源。
stopPreview:	停止视频预览。
rtcEngine:localVideoStateChangedOfState:reason:sourceType:	本地视频状态发生改变回调。
rtcEngine:localVideoStats:sourceType:	本地视频流统计信息回调。
rtcEngine:firstLocalVideoFramePublishedWithElapsed:sourceType:	已发布本地视频首帧回调。
rtcEngine:didVideoPublishStateChange:sourceType:oldState:newState:elapseSinceLastState:	视频发布状态改变回调。
rtcEngine:videoSizeChangedOfSourceType:uid:size:rotation:	本地或远端视频大小和旋转信息发生改变回调。
rtcEngine:remoteVideoStateChangedOfUid:state:reason:elapsed:	远端视频状态发生改变回调。
rtcEngine:remoteVideoStats:	通话中远端视频流的统计信息回调。
rtcEngine:firstLocalVideoFrameWithSize:elapsed:sourceType:	已显示本地视频首帧回调。
rtcEngine:firstRemoteVideoFrameOfUid:size:elapsed:	渲染器已接收首帧远端视频回调。
rtcEngine:firstRemoteVideoDecodedOfUid:size:elapsed:	已接收到远端视频并完成解码回调。
rtcEngine:didVideoMuted:byUid:	远端用户取消或恢复发布视频流回调。
rtcEngine:didVideoEnabled:byUid:	远端用户开/关视频模块回调。

视频采集

方法/回调	描述
enableLocalVideo:	开关本地视频采集。
startCameraCapture:config:	开始通过摄像头采集视频。
stopCameraCapture:	停止通过摄像头采集视频。
setCameraStabilizationMode:	设置摄像头防抖模式。

屏幕共享

方法/回调	描述
queryScreenCaptureCapability	查询设备在屏幕共享时支持的最高帧率。
startScreenCapture:	开始屏幕采集。
updateScreenCapture:	更新屏幕采集的参数配置。
stopScreenCapture	停止屏幕采集。
setScreenCaptureScenario:	设置屏幕共享的场景。

视频前处理和后处理

方法/回调	描述
enableContentInspect:config:	开启/关闭本地截图上传。
takeSnapshot:filePath:	对视频截图。
takeSnapshotWithConfig:config:	在指定观测位置进行视频截图。
takeSnapshotEx:uid:filePath:	使用连接 ID 获取视频截图。
takeSnapshotExWithConfig:uid:config:	使用连接 ID 获取指定观测位置的视频截图。
enableVirtualBackground:backData:segData:	开启/关闭虚拟背景。
enableVirtualBackground:backData:segData:sourceType:	开启虚拟背景并指定媒体源，或关闭虚拟背景。
setVideoEffectBoolParamWithOption	设置视频特效的布尔参数。
setVideoEffectFloatParamWithOption	设置视频特效的浮点参数。
setVideoEffectIntParamWithOption	设置视频特效的整数参数。
startLocalVideoTranscoder:	开启本地合图。
stopLocalVideoTranscoder	停止本地合图。
updateLocalTranscoderConfiguration:	更新本地合图配置。
rtcEngine:didLocalVideoTranscoderErrorWithStream:errorCode:	本地合图发生错误回调。
enableVideoImageSource:options:	设置是否开启垫片推流功能。
removeVideoEffectWithNodeId	移除指定节点 ID 的视频特效。
removeVideoWatermark	从本地视频中移除水印图像。
removeVideoWatermarkEx	从本地或远端视频流中移除指定的水印图像。
setBeautyEffectOptions:options:	设置美颜效果选项。
setBeautyEffectOptions:options:sourceType:	设置美颜效果选项并指定媒体源。
setColorEnhanceOptions:options:	设置色彩增强功能。
setColorEnhanceOptions:options:sourceType:	设置色彩增强功能并指定媒体源。
setLowlightEnhanceOptions:options:	设置暗光增强功能。
setLowlightEnhanceOptions:options:sourceType:	设置暗光增强功能并指定媒体源。
setVideoDenoiserOptions:options:	设置视频降噪功能。
setVideoDenoiserOptions:options:sourceType:	设置视频降噪功能并指定媒体源。
setFilterEffectOptions:options:sourceType:	设置滤镜效果选项并指定媒体源。
setFilterEffectOptions:options:	设置滤镜效果选项。
setFaceShapeBeautyOptions:options:	设置美型效果选项并指定媒体源。
setFaceShapeBeautyOptions:options:sourceType:	设置美型效果选项。
setFaceShapeAreaOptions:	设置美型部位选项并指定媒体源。
setFaceShapeAreaOptions:sourceType:	设置美型部位选项。
getFaceShapeBeautyOptions:	获取美型效果选项。
getFaceShapeBeautyOptions	获取美型效果选项。
getFaceShapeAreaOptions:sourceType:	获取美型部位选项。
getFaceShapeAreaOptions:	获取美型部位选项。
enableFaceDetection:	开启/关闭本地人脸检测。
rtcEngine:facePositionDidChangeWidth:previewHeight:faces:	报告本地人脸检测结果。
getVideoEffectBoolParamWithOption:key:	获取视频特效中的布尔参数。
getVideoEffectFloatParamWithOption:key:	获取视频特效中的 float 类型参数。
getVideoEffectIntParamWithOption:key:	获取视频特效中的整数参数。
isCameraCenterStageSupported	查询摄像头是否支持人像锁定。
createVideoEffectObjectWithBundlePath	创建一个视频特效对象。
destroyVideoEffectObject	销毁一个视频特效对象。
enableCameraCenterStage:	开启或关闭人像锁定功能。
rtcEngine:snapshotTaken:filePath:width:height:errCode:	视频截图结果回调。
addOrUpdateVideoEffectWithNodeId	添加或更新指定节点 ID 和模板的视频特效。
addVideoWatermarkWithConfig	向本地视频添加水印图像。
addVideoWatermarkEx3	向本地视频添加水印图像。
addVideoWatermark:	添加本地视频水印。
addVideoWatermark:options:	添加本地视频水印。
addVideoWatermarkEx:options:connection:	添加本地视频水印。
clearVideoWatermarks	删除已添加的视频水印。
clearVideoWatermarkEx:	删除已添加的视频水印。
performVideoEffectActionWithNodeId:actionId:	对指定的视频特效节点执行操作。

视频渲染

方法/回调	描述
setRenderMode:	设置播放器视图的渲染模式。
setLocalRenderMode:mirror:	更新本地视图显示模式。
setRemoteRenderMode:mode:mirror:	更新远端视图显示模式。
setRemoteRenderModeEx:mode:mirror:connection:	设置远端视图显示模式。
setLocalRenderTargetFps	设置本地视频渲染的最大帧率。
setRemoteRenderTargetFps	设置视频在远端渲染的最大帧率。
setView:	设置播放器渲染视图。
setupLocalVideo:	初始化本地视图。
setupRemoteVideo:	初始化远端用户视图。
setupRemoteVideoEx:connection:	初始化远端用户视图。
enableInstantMediaRendering	开启音视频帧加速渲染。
startMediaRenderingTracing	开启视频帧渲染数据打点。
startMediaRenderingTracingEx:	开启视频帧渲染数据打点。
rtcEngine:didTranscodedStreamLayoutInfoUpdatedWithUserId:videoLayoutInfo:	已接收携带布局信息的合图视频流回调。
rtcEngine:videoRenderingTracingResultOfUid:currentEvent:tracingInfo:	视频帧渲染事件回调。

原始视频数据

方法/回调	描述
setVideoFrameDelegate:	注册原始视频观测器对象。
onCaptureVideoFrame:sourceType:	获取本地设备采集到的视频数据。
AgoraRtcMediaPlayer:didReceiveVideoFrame:	已获取视频帧回调。
onPreEncodeVideoFrame:sourceType:	获取本地视频编码前的视频数据。
onRenderVideoFrame:uid:channelId:	获取远端发送的视频数据。
getObservedFramePosition	设置视频观测位置。
getVideoFrameProcessMode	设置视频处理模式。
getMirrorApplied	设置视频数据镜像。
getRotationApplied	设置视频数据旋转。
getVideoFormatPreference	设置 SDK 输出的原始视频数据格式。

已编码视频数据

方法/回调	描述
setEncodedVideoFrameDelegate:	为编码后的视频图像注册视频帧接收观测器。
onEncodedVideoFrameReceived:length:info:	报告接收端已收到远端发送的待解码视频帧。

自定义视频采集和渲染

方法/回调	描述
createCustomVideoTrack	创建一个自定义的视频轨道。
destroyCustomVideoTrack:	销毁指定的视频轨道。
setExternalVideoSource:useTexture:sourceType:	设置外部视频源。
pushExternalVideoFrame:videoTrackId:	将外部原始视频帧通过自定义视频轨道发布到频道中。
pushExternalVideoFrame:	推送外部原始视频帧到 SDK。

音乐文件播放

方法/回调	描述
startAudioMixing:loopback:cycle:	开始播放音乐文件。
startAudioMixing:loopback:cycle:startPos:	开始播放音乐文件。
stopAudioMixing	停止播放音乐文件。
pauseAudioMixing	暂停播放音乐文件。
resumeAudioMixing	恢复播放音乐文件。
adjustAudioMixingVolume:	调节音乐文件的播放音量。
adjustAudioMixingPlayoutVolume:	调节音乐文件在本地播放的音量。
adjustAudioMixingPublishVolume:	调节音乐文件远端播放音量。
getAudioMixingPlayoutVolume	获取音乐文件的本地播放音量。
getAudioMixingPublishVolume	获取音乐文件的远端播放音量。
setAudioMixingPlaybackSpeed:	设置当前音乐文件的播放速度。
getAudioMixingDuration	获取音乐文件总时长。
getAudioMixingCurrentPosition	获取音乐文件的播放进度。
setAudioMixingPitch:	调整本地播放的音乐文件的音调。
setAudioMixingPosition:	设置音乐文件的播放位置。
setAudioMixingDualMonoMode:	设置当前音频文件的声道模式。
getAudioTrackCount	获取当前音乐文件的音轨索引。
selectAudioTrack:	指定当前音乐文件的播放音轨。
selectMultiAudioTrack:publishTrackIndex:	选择本地播放和发送至远端的音轨。
rtcEngine:audioMixingStateChanged:reasonCode:	音乐文件的播放状态已改变回调。
rtcEngine:audioMixingPositionChanged:	音乐文件播放进度回调。

音效文件播放

方法/回调	描述
getEffectsVolume	获取音效文件的播放音量。
setEffectsVolume:	设置音效文件的播放音量。
getVolumeOfEffect:	获取指定音效文件的播放音量。
setVolumeOfEffect:withVolume:	设置指定音效文件的播放音量。
playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:publish:startPos:	播放指定音效到指定频道。
playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:publish:	播放指定音效到指定频道。
playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:startPos:	播放指定音效到指定频道。
playEffectEx:soundId:filePath:loopCount:pitch:pan:gain:	播放指定音效到指定频道。
preloadEffect:filePath:	将音效文件加载至内存。
playEffect:filePath:loopCount:pitch:pan:gain:	播放指定的本地或在线音效文件。
playEffect:filePath:loopCount:pitch:pan:gain:publish:	播放指定的本地或在线音效文件。
playEffect:filePath:loopCount:pitch:pan:gain:publish:startPos:	播放指定的本地或在线音效文件。
pauseEffect:	暂停音效文件播放。
pauseAllEffects	暂停所有音效文件播放。
resumeEffect:	恢复播放指定音效文件。
preloadEffectEx	预加载指定音效到指定频道。
preloadEffectEx	预加载指定音效到指定频道。
resumeAllEffects	恢复播放所有音效文件。
stopEffect:	停止播放指定音效文件。
stopAllEffects	停止播放所有音效文件。
unloadEffect:	从内存释放某个预加载的音效文件。
getEffectDuration:	获取指定音效文件总时长。
getEffectCurrentPosition:	获取指定音效文件的播放进度。
setEffectPosition:pos:	设置指定音效文件的播放位置。
rtcEngineDidAudioEffectFinish:soundId:	本地音效文件播放已结束回调。

虚拟节拍器

方法/回调	描述
startRhythmPlayer:sound2:config:	开启虚拟节拍器。
stopRhythmPlayer	关闭虚拟节拍器。
configRhythmPlayer:	配置虚拟节拍器。
rtcEngine:didRhythmPlayerStateChanged:reason:	虚拟节拍器状态发生改变回调。

媒体播放器

更多有关媒体播放器的方法，详见内置媒体播放器。

方法/回调	描述
createMediaPlayerWithDelegate:	创建媒体播放器实例。
createMediaPlayerCacheManager	创建 AgoraRtcMediaPlayerCacheManagerProtocol 实例。
AgoraRtcMediaPlayerProtocol	提供媒体播放器功能的类，支持多实例。
AgoraRtcMediaPlayerCacheManagerProtocol	该类提供管理媒体播放器中缓存媒体文件的方法。
AgoraRtcMediaPlayerDelegate	提供媒体播放器的回调。

媒体播放器缓存

方法/回调	描述
enableAutoRemoveCache:	设置是否开启自动清除缓存文件功能。
removeAllCaches	删除媒体播放器中所有已缓存的媒体文件。
removeCacheByUri:	删除指定的已缓存媒体文件。
removeOldCache	删除媒体播放器中近期最少使用的一个缓存媒体文件。
setCacheDir:	设置待缓存的媒体文件的储存路径。
setMaxCacheFileCount:	设置缓存媒体文件数量的上限。
setMaxCacheFileSize:	设置缓存媒体文件的总缓存大小的上限。
sharedInstance	获取 AgoraRtcMediaPlayerCacheManagerProtocol 实例。
cacheDir	获取缓存文件的储存路径。
cacheFileCount	获取当前已缓存的媒体文件的总数量。
maxCacheFileCount	获取所设置的缓存文件数量上限。
maxCacheFileSize	获取所设置的缓存文件总缓存的上限。
AgoraRtcMediaPlayer:cacheStats:	报告当前缓存中的媒体资源的相关信息。

版权音乐

方法/回调	描述
sharedContentCenterWithConfig:	初始化 AgoraMusicContentCenter。
createMusicPlayerWithDelegate:	创建音乐播放器。
destroyMusicPlayer:	销毁音乐播放器对象。
preloadWithSongCode:jsonOption:	预加载音乐资源。
preloadWithSongCode:	预加载音乐资源。
isPreloadedWithSongCode:	检测音乐资源是否已被预加载。
openMediaWithSongCode:startPos:	通过音乐资源编号打开音乐资源。
registerEventDelegate:	注册音乐内容中心回调事件。
renewToken:	更新 Token。
enableMainQueueDispatch:	是否分发回调至主队列。
getCaches	获取已缓存的音乐资源信息。
removeCacheWithSongCode:	删除已缓存的音乐资源。
getMusicCharts	获取全部音乐榜单。
getMusicCollectionWithMusicChartId:page:pageSize:jsonOption:	通过音乐榜单的 ID 获取指定榜单的音乐资源列表。
searchMusicWithKeyWord:page:pageSize:jsonOption:	搜索音乐资源。
setPlayMode:	设置音乐资源的播放模式。
renewToken:	更新 Token。
getLyricWithSongCode:lyricType:	获取音乐资源的歌词下载地址。
getInternalSongCode:jsonOption:	创建音乐资源的副歌片段编号。
getSongSimpleInfoWithSongCode:	获取某一音乐资源的详细信息。
enableMainQueueDispatch:	是否分发回调至主队列。
onPreLoadEvent:songCode:percent:lyricUrl:state:reason:	报告预加载音乐资源的事件。
onLyricResult:songCode:lyricUrl:reason:	歌词下载地址回调。
onMusicChartsResult:result:reason:	获取音乐榜单回调。
onMusicCollectionResult:result:reason:	获取音乐资源列表回调。
onSongSimpleInfoResult:songCode:simpleInfo:reason:	音乐资源的详细信息回调。

音视频录制

方法/回调	描述
createMediaRecorder:	创建音视频录制对象。
setMediaRecorderDelegate:	注册 AgoraMediaRecorderDelegate 观测器。
startRecording:	开启音视频流录制。
stopRecording	停止音视频流录制。
startAudioRecording:quality:	开始客户端录音。
startAudioRecordingWithConfig:	开始客户端录音并进行录音配置。
stopAudioRecording	停止客户端录音。
enableMainQueueDispatch:	设置是否分发回调至主队列。
destroyMediaRecorder:	销毁音视频录制对象。
mediaRecorder:stateDidChanged:uid:state:reason:	录制状态发生改变回调。
mediaRecorder:informationDidUpdated:uid:info:	录制信息更新回调。

跨频道媒体流转发

方法/回调	描述
startOrUpdateChannelMediaRelay:	开始或更新跨频道媒体流转发。
startOrUpdateChannelMediaRelayEx:connection:	开始或更新跨频道媒体流转发。
stopChannelMediaRelay	停止跨频道媒体流转发。一旦停止，主播会退出所有目标频道。
stopChannelMediaRelayEx:	停止跨频道媒体流转发。一旦停止，主播会退出所有目标频道。
pauseAllChannelMediaRelay	暂停向所有目标频道转发媒体流。
pauseAllChannelMediaRelayEx:	暂停向所有目标频道转发媒体流。
resumeAllChannelMediaRelay	恢复向所有目标频道转发媒体流。
resumeAllChannelMediaRelayEx:	恢复向所有目标频道转发媒体流。
rtcEngine:channelMediaRelayStateDidChange:error:	跨频道媒体流转发状态发生改变回调。

旁路推流

方法/回调	描述
startRtmpStreamWithoutTranscoding:	开始非转码推流。
startRtmpStreamWithoutTranscodingEx:connection:	开始非转码推流。
startRtmpStreamWithTranscoding:transcoding:	开始旁路推流并设置转码属性。
startRtmpStreamWithTranscodingEx:transcoding:connection:	开始旁路推流并设置转码属性。
updateRtmpTranscoding:	更新旁路推流转码属性。
updateRtmpTranscodingEx:connection:	更新旁路推流转码属性。
stopRtmpStream:	结束旁路推流。
stopRtmpStreamEx:connection:	结束旁路推流。
rtcEngine:rtmpStreamingEventWithUrl:eventCode:	旁路推流事件回调。
rtcEngine:rtmpStreamingChangedToState:state:reason:	旁路推流状态发生改变回调。
rtcEngineTranscodingUpdated:	旁路推流转码设置已被更新回调。

直推 CDN

方法/回调	描述
startDirectCdnStreaming:publishUrl:mediaOptions:	设置主播端开始直接向 CDN 推流。
stopDirectCdnStreaming	设置主播端停止直接向 CDN 推流。
setDirectCdnStreamingAudioConfiguration:	设置主播端直接向 CDN 推流时的音频编码属性。
setDirectCdnStreamingVideoConfiguration:	设置主播端直接向 CDN 推流时的视频编码属性。
onDirectCdnStreamingStateChanged:reason:message:	CDN 推流状态改变回调。
onDirectCdnStreamingStats:	CDN 推流统计数据回调。

数据流

方法/回调	描述
createDataStream:reliable:ordered:	创建数据流。
createDataStream:config:	创建数据流。
createDataStreamEx:config:connection:	创建数据流。
sendStreamMessage:data:	发送数据流。
rtcEngine:receiveStreamMessageFromUid:streamId:data:	接收到对方数据流消息的回调。
rtcEngine:didOccurStreamMessageErrorFromUid:streamId:error:missed:cached:	接收对方数据流消息发生错误的回调。

Metadata (SEI)

方法/回调	描述
setMediaMetadataDelegate:withType:	注册媒体 metadata 观测器用于接收或发送 metadata。
setMediaMetadataDataSource:withType:	设置 metadata 的 Data source。
metadataMaxSize	请求最大的 metadata 大小。
readyToSendMetadataAtTimestamp:sourceType:	发送端已准备好发送 metadata。
AgoraRtcMediaPlayer:didReceiveData:length:	报告已获取媒体附属信息。
didMetadataReceived:	接收端已收到 metadata。

音频路由

方法/回调	描述
setDefaultAudioRouteToSpeakerphone:	设置默认的音频路由。
setEnableSpeakerphone:	开启或关闭扬声器播放。
isSpeakerphoneEnabled	检查扬声器状态启用状态。
rtcEngine:didAudioRouteChanged:	音频路由已发生变化回调。

视频设备管理

方法/回调	描述
enableMultiCamera:config:	开启或关闭多路摄像头采集。
switchCamera	切换前置/后置摄像头。
setCameraCapturerConfiguration:	设置摄像头采集配置。
isCameraZoomSupported	检测设备是否支持摄像头缩放功能。
cameraMaxZoomFactor	获取摄像头支持的最大放大倍率。
setCameraZoomFactor:	设置摄像头放大比例。
isCameraTorchSupported	检测设备是否支持闪光灯常开。
setCameraTorchOn:	设置是否打开闪光灯。
isCameraExposureSupported	查询当前摄像头是否支持曝光调节。
setCameraExposureFactor:	设置当前摄像头的曝光系数。
setCameraFocusPositionInPreview:	设置手动对焦位置，并触发对焦。
isCameraAutoFocusFaceModeSupported	检测设备是否支持人脸对焦功能。
setCameraAutoFocusFaceModeEnabled:	设置是否开启人脸对焦功能。
isCameraExposurePositionSupported	检测设备是否支持手动曝光功能。
isCameraAutoExposureFaceModeSupported	检测设备是否支持自动曝光功能。
setCameraExposurePosition:	设置手动曝光位置。
setCameraAutoExposureFaceModeEnabled	设置是否开启自动曝光功能。
rtcEngine:cameraFocusDidChangedToRect:	相机对焦区域已改变回调。
rtcEngine:cameraExposureDidChangedToRect:	摄像头曝光区域已改变回调。
queryCameraFocalLengthCapability	查询摄像头支持的焦距能力。
queryCodecCapability	查询 SDK 支持的视频编解码能力。

音频设备管理

方法/回调	描述
startPlaybackDeviceTest:	启动音频播放设备测试。
stopPlaybackDeviceTest	停止音频播放设备测试。
startRecordingDeviceTest:	启动音频采集设备测试。
stopRecordingDeviceTest	停止音频采集设备测试。

插件相关

方法/回调	描述
registerExtensionWithVendor:extension:sourceType:	注册插件。
enableExtensionWithVendor:extension:enabled:sourceType:	启用/禁用插件。
getExtensionPropertyWithVendor:extension:key:	获取插件的详细信息。
getExtensionPropertyWithVendor:extension:key:sourceType:	获取插件的详细信息。
setExtensionPropertyWithVendor:extension:key:value:	设置插件的属性。
setExtensionProviderPropertyWithVendor:key:value:	设置插件服务商的属性。
onExtensionStartedWithContext:	插件已启用成功回调。
onExtensionStoppedWithContext:	插件已禁用回调。
onEventWithContext:key:value:	插件事件回调。
onExtensionErrorWithContext:error:message:	插件出错回调。

网络及其他

方法/回调	描述
startEchoTestWithConfig:	开始音视频通话回路测试。
stopEchoTest	停止语音通话回路测试。
startLastmileProbeTest:	开始通话前网络质量探测。
stopLastmileProbeTest	停止通话前网络质量探测。
rtcEngine:lastmileQuality:	网络上下行 last mile 质量报告回调。
rtcEngine:lastmileProbeTestResult:	通话前网络上下行 Last mile 质量探测报告回调。
getCurrentMonotonicTimeInMs	获取 SDK 当前的 Monotonic Time。
queryDeviceScore	查询设备评分等级。
setAVSyncSource:uid:	设置发流端音画同步。
setCloudProxy:	设置云代理服务。
setLocalAccessPoint:	配置与声网私有媒体服务器接入模块的连接。
setParameters:	SDK 的 JSON 配置信息，用于提供技术预览或特别定制功能。
getCallId	获取通话 ID。
getCallIdEx:	使用连接 ID 获取通话 ID。
isFeatureAvailableOnDevice:	查询设备是否支持指定进阶功能。
rate:rating:description:	给通话评分。
complain:description:	投诉通话质量。
getConnectionState	获取当前网络连接状态。
getConnectionStateEx:	获取当前网络连接状态。
getSdkVersion	获取 SDK 版本。
getErrorDescription:	获取警告或错误描述。
getNativeHandle	获取 Native SDK 的 C++ 句柄。
getNetworkType	获取本地网络连接类型。
getNtpWallTimeInMs	获取当前的 NTP (网络时间协议) 时间。
enableEncryption:encryptionConfig:	开启或关闭内置加密。
enableEncryptionEx:encryptionConfig:connection:	开启或关闭内置加密。
sendCustomReportMessage:category:event:label:value:	发送自定义上报消息。
sendCustomReportMessageEx:category:event:label:value:connection:	自定义数据上报和分析服务。
setRemoteSubscribeFallbackOption:	设置弱网环境下订阅的音视频流回退选项。
rtcEngine:didRemoteSubscribeFallbackToAudioOnly:byUid:	订阅流已回退为音频流或恢复为音视频流回调。
rtcEngine:didOccurEncryptionError:	内置加密出错回调。
rtcEngine:multiPathStats:	多路径传输统计信息的回调。
rtcEngine:networkQuality:txQuality:rxQuality:	通话中每个用户的网络上下行 last mile 质量报告回调。
rtcEngine:reportRtcStats:	当前通话相关的统计信息回调。
rtcEngine:permissionError:	获取设备权限出错回调。