实时互动 API

  • iOS

更新时间不可用

本页展示 PaaS 方案中高频调用的实时互动 SDK API。

API 名称描述
sharedEngineWithAppId创建并初始化 AgoraRtcEngineKit。
sharedEngineWithConfig创建并初始化 AgoraRtcEngineKit。
destroy销毁 AgoraRtcEngineKit 对象。
joinChannelByToken [1/4]加入频道。
joinChannelByToken [2/4]设置媒体选项并加入频道。
joinChannelExByToken [1/2]加入多个频道。
updateChannelWithMediaOptions加入频道后更新频道媒体选项。
updateChannelExWithMediaOptions加入多个频道后更新频道媒体选项。
leaveChannel [2/2]设置频道选项并离开频道。
leaveChannelEx [2/2]设置频道选项并离开多个频道。
renewToken更新 Token。
setClientRole [1/2]设置用户角色。
setClientRole [2/2]设置直播场景下的用户角色和观众端延时级别。
enableAudio启用音频模块。
enableAudioVolumeIndication启用用户音量提示。
setAudioProfile [2/2]设置音频编码属性。
setAudioScenario设置音频场景。
muteLocalAudioStream取消或恢复发布本地音频流。
adjustRecordingSignalVolume调节音频采集信号音量。
enableInEarMonitoring [2/2]开启耳返功能。
sendStreamMessage发送数据流。
createDataStream [1/2]创建数据流。
createDataStream [2/2]创建数据流。
setAudioDualMonoMode设置当前音频文件的声道模式。
setAudioEffectPreset设置 SDK 预设的人声音效。
createMediaPlayerWithDelegate创建媒体播放器实例。媒体播放器全部接口详见 AgoraRtcMediaPlayerProtocol。
selectAudioTrack指定当前音频文件的播放音轨。
sharedContentCenterWithConfig初始化音乐内容中心。音乐内容中心全部接口详见 AgoraMusicContentCenter。
setPlayMode设置音乐资源的播放模式。音乐播放器全部接口详见 AgoraMusicPlayerProtocol。
didJoinChannel成功加入频道回调。
didRejoinChannel成功重新加入频道回调。
didClientRoleChanged用户角色、观众端延时级别已切换回调。
didLeaveChannelWithStats离开频道回调。
didJoinedOfUid远端用户(通信场景)/主播(直播场景)加入当前频道回调。
didOfflineOfUid远端用户(通信场景)/主播(直播场景)离开当前频道回调。
rtcEngineRequestTokenToken 已过期回调。
tokenPrivilegeWillExpireToken 即将在 30s 内过期回调。
reportAudioVolumeIndicationOfSpeakers用户音量提示回调。
receiveStreamMessageFromUid接收到对方数据流消息的回调。
didOccurStreamMessageErrorFromUid接收对方数据流消息发生错误的回调。
表格内容超出当前宽度,可横向滚动查看更多列。