You need to enable JavaScript to run this app.
导航

概览

最近更新时间2024.02.27 19:05:54

首次发布时间2022.06.23 19:44:25

引擎管理

方法描述
createRTCVideo创建引擎对象
destroyRTCVideo销毁引擎实例对象
feedback将用户反馈的问题上报到 RTC
setBusinessId设置业务标识参数
onLogReport端监控日志回调。当产生一个端监控事件时触发该回调。
onWarning当内部发生警告事件时触发该回调
onError当内部发生不可逆转错误时触发该回调
onLicenseWillExpirelicense过期时间提醒
onSysStats周期性地发出回调,报告当前cpu与memory使用率
static getSDKVersion获取当前 SDK 版本信息
static setLogConfig设置日志文件
static getErrorDescription获取错误码的描述
static getCurrentProcessId获取加载引擎进程的 ID 方便调试
static setRenderType设置渲染类型
static getTimestampMs获取时间戳, 单位毫秒
static getTimestampUs获取时间戳, 单位微秒

房间管理

方法描述
createRTCRoom创建房间
onCreateRoomStateChanged创建房间失败回调。
onRoomStats房间通话统计信息回调。
用户进房开始通话后,每 2s 收到一次本回调。
destroy退出并销毁房间。
getRoomId获取房间 ID
onRoomStateChanged房间状态改变回调,加入房间、离开房间、发生房间相关的警告或错误时会收到此回调。
joinRoom加入房间。
onUserJoined可见用户加入房间,或房内不可见用户切换为可见的回调。
1.远端可见用户调用 setUserVisibility 方法将自身设为可见后加入房间时,房间内其他用户将收到该事件。
2.远端可见用户断网后重新连入房间时,房间内其他用户将收到该事件。
3.房间内不可见远端用户调用 setUserVisibility 方法切换至可见时,房间内其他用户将收到该事件。
4.新进房用户也会收到进房前已在房内的可见角色用户的进房回调通知。
leaveRoom离开房间。
onLeaveRoom离开房间成功回调。
onUserLeave远端用户离开房间,或切至不可见时,本地用户会收到此事件
setRoomExtraInfo设置/更新房间附加信息,可用于标识房间状态或属性,或灵活实现各种业务逻辑。
onSetRoomExtraInfoResult调用 setRoomExtraInfo 设置房间附加信息结果的回调。
onRoomExtraInfoUpdate接收同一房间内,其他用户调用 setRoomExtraInfo 设置的房间附加信息的回调。
setUserVisibility设置用户可见性。未调用该接口前,本地用户默认对他人可见。
onUserVisibilityChanged用户调用 setUserVisibility 设置用户可见性的回调。
updateToken更新 Token。Token 中同时包含进房、发布和订阅权限,各权限有一定的有效期,并且到期前 30 秒会触发回调,提示用户更新 Token 相关权限。此时需要重新获取 Token,并调用此方法更新 Token,以保证通话的正常进行。
onTokenWillExpireToken 过期前 30 秒将触发该回调。
onPublishPrivilegeTokenWillExpireToken 发布权限过期前 30 秒将触发该回调。
onSubscribePrivilegeTokenWillExpireToken 订阅权限过期前 30 秒将触发该回调。

音频管理

方法描述
enumerateAudioPlaybackDevices获取当前系统内音频播放设备列表。如果后续设备有变更,你会收到 onAudioDeviceStateChanged 回调通知,然后需要重新调用本接口以获得新的设备列表。
enumerateAudioCaptureDevices获取当前系统内音频采集设备列表。如果后续设备有变更,你需要重新调用本接口以获得新的设备列表。
setAudioPlaybackDevice设置音频播放设备。
setAudioCaptureDevice设置音频采集设备。
getAudioPlaybackDevice获取当前音频播放设备 ID。
getAudioCaptureDevice获取当前音频采集设备 ID。
followSystemPlaybackDevice设置音频播放路由是否跟随系统。
followSystemCaptureDevice设置音频采集路由是否跟随系统。
onAudioDeviceWarning音频设备警告回调。音频设备包括音频采集设备和音频渲染设备。
onAudioDeviceStateChanged音频设备状态回调。提示音频采集、音频播放等设备设备的状态。
setAudioPlaybackDeviceVolume设置当前音频播放设备音量
getAudioPlaybackDeviceVolume获取当前音频播放设备音量
onAudioStreamBanned通过调用服务端 BanUserStream/UnbanUserStream 方法禁用/解禁指定房间内指定用户音频流的发送时,触发此回调。
setAudioCaptureDeviceVolume设置当前音频采集设备音量
getAudioCaptureDeviceVolume获取当前音频采集设备音量
setAudioPlaybackDeviceMute设置当前音频播放设备静音状态,默认为非静音。
getAudioPlaybackDeviceMute获取当前音频播放设备是否静音的信息。
setAudioCaptureDeviceMute设置当前音频采集设备静音状态,默认为非静音。
getAudioCaptureDeviceMute获取当前音频采集设备是否静音的信息。
onAudioDeviceVolumeChanged音频设备音量改变回调。当通过系统设置,改变音频设备音量或静音状态时,触发本回调。本回调无需手动开启。
startAudioPlaybackDeviceTest启动音频播放设备测试。 该方法测试播放设备是否能正常工作。SDK 播放指定的音频文件,测试者如果能听到声音,说明播放设备能正常工作。
stopAudioPlaybackDeviceTest停止音频播放设备测试。
initAudioPlaybackDeviceForTest尝试初始化音频播放设备,可检测出设备不存在、权限被拒绝/禁用等异常问题。
enableVocalInstrumentBalance开启/关闭音量均衡功能。
initAudioCaptureDeviceForTest尝试初始化音频播放设备,可检测出设备不存在、权限被拒绝/禁用等异常问题。
setCaptureVolume调节音频采集音量
setPlaybackVolume调节本地播放的所有远端用户音频混音后的音量,混音内容包括远端人声、音乐、音效等。播放音频前或播放音频时,你都可以使用此接口设定播放音量。
setRemoteAudioPlaybackVolume调节来自远端用户的音频播放音量
onStreamSyncInfoReceived音频流同步信息回调。可以通过此回调,在远端用户调用 sendStreamSyncInfo 发送音频流同步消息后,收到远端发送的音频流同步信息。
setRemoteRoomAudioPlaybackVolume调节某个房间内所有远端用户的音频播放音量。
enableAudioPropertiesReport启用音频信息提示。
onLocalAudioPropertiesReport调用 enableAudioPropertiesReport 后,根据设置的 interval 值,你会周期性地收到此回调,了解本地音频的相关信息。
onRemoteAudioPropertiesReport远端用户进房后,本地调用 enableAudioPropertiesReport,根据设置的 interval 值,本地会周期性地收到此回调,了解订阅的远端用户的音频信息。
onActiveSpeaker调用 enableAudioPropertiesReport 后,根据设置的 config.interval,你会周期性地收到此回调,获取房间内的最活跃用户信息。
onUserStartAudioCapture房间内的用户调用 startAudioCapture 开启音频采集时,房间内其他用户会收到此回调。
startAudioCapture开启内部音频采集。默认为关闭状态。
onUserStopAudioCapture房间内的用户调用 stopAudioCapture 关闭音频采集时,房间内其他用户会收到此回调。
stopAudioCapture关闭内部音频采集。默认为关闭状态。
setAudioProfile设置音质档位。
startAudioDeviceRecordTest开始音频采集设备和音频播放设备测试。
stopAudioDeviceRecordAndPlayTest停止采集本地音频,并开始播放采集到的声音。录音播放完毕后,设备测试流程结束。
stopAudioDevicePlayTest停止由调用 startAudioDeviceRecordTest 开始的音频播放设备测试。
enableExternalSoundCard启用匹配外置声卡的音频处理模式
enableAGC打开/关闭 AGC(Automatic Gain Control) 自动增益控制功能。开启该功能后,SDK 会自动调节麦克风的采集音量,确保音量稳定。
startHardwareEchoDetection开启通话前回声检测
stopHardwareEchoDetection停止通话前回声检测
onAudioPlaybackDeviceTestVolume回调音频设备测试时的播放音量
onHardwareEchoDetectionResult通话前回声检测结果回调。
setAudioSelectionConfig设置本端发布流在音频选路中的优先级。

视频管理

方法描述
startVideoCapture开启内部视频采集。默认为关闭状态。
stopVideoCapture关闭内部视频采集。默认为关闭状态。
onUserStartVideoCapture房间内的用户调用 startVideoCapture 开启视频采集时,房间内其他用户会收到此回调。
onUserStopVideoCapture房间内的用户调用 stopVideoCapture 关闭视频采集时,房间内其他用户会收到此回调。
setVideoCaptureConfig设置 RTC SDK 内部采集时的视频采集参数。指定视频采集参数包括模式、分辨率、帧率。
setupLocalScreen为本地屏幕共享流绑定视图,实现预览
removeLocalScreen解绑屏幕共享流已绑定的视图
setVideoEncoderConfig视频发布端设置推送多路流时各路流的参数,包括最大分辨率、帧率、码率、网络不佳时的回退策略等。
setupRemoteScreen为远端屏幕共享流绑定本地视图
removeRemoteScreen解绑远端屏幕共享流已绑定的本地视图
enumerateVideoCaptureDevices获取当前系统内视频采集设备列表。
setVideoCaptureDevice设置当前视频采集设备
getVideoCaptureDevice获取当前 SDK 正在使用的视频采集设备 ID
onVideoDeviceStateChanged视频频设备状态回调。提示摄像头视频采集、屏幕视频采集等设备的状态。
onVideoDeviceWarning视频设备警告回调,包括视频采集设备等。
setupLocalVideo设置本地视频渲染时使用的视图,并设置渲染模式。
setMaxVideoEncoderConfig视频发布端设置期望发布的最大分辨率视频流参数,包括分辨率、帧率、码率、缩放模式、网络不佳时的回退策略等。
removeLocalVideo解绑本地视频流已绑定的渲染视图
setupRemoteVideo为远端视频流绑定本地渲染视图,并设置渲染模式。
onFirstLocalVideoFrameCaptured第一帧本地采集的视频/屏幕共享画面在本地视图渲染完成时,收到此回调。
removeRemoteVideo解绑指定远端视频流已绑定的本地视图
removeAllRemoteVideo解绑所有已绑定本地视图的指定远端视频流
onLocalVideoStateChanged本地视频流的状态发生改变时,收到该事件。

音视频传输

方法描述
publishStream在当前所在房间内发布本地通过摄像头/麦克风采集的媒体流
unpublishStream停止将本地摄像头/麦克风采集的媒体流发布到当前所在房间中
setDummyCaptureImagePath摄像头处于关闭状态时,使用静态图片填充本地推送的视频流。可重复调用该接口来更新图片。若要停止发送图片,可传入空字符串或启用内部摄像头采集。
subscribeStream订阅房间内指定的通过摄像头/麦克风采集的媒体流,或更新对指定远端用户的订阅选项
unsubscribeStream取消订阅房间内指定的通过摄像头/麦克风采集的媒体流。该方法对自动订阅和手动订阅模式均适用。
subscribeAllStreams订阅房间内所有通过摄像头/麦克风采集的媒体流,或更新订阅选项。
unsubscribeAllStreams取消订阅房间内所有的通过摄像头/麦克风采集的媒体流。
onStreamStateChanged流状态改变回调,发生流相关的警告或错误时会收到此回调。
onRemoteAudioStateChanged用户订阅来自远端的音频流状态发生改变时,会收到此回调,了解当前的远端音频流状态。
onUserPublishStream房间内新增远端麦克风采集的音频流的回调。
onUserUnpublishStream房间内远端麦克风采集的音频流移除的回调。
onStreamSubscribed关于订阅媒体流状态改变的回调
onFirstLocalAudioFrame本地采集到第一帧音频帧时,收到该回调
onFirstRemoteAudioFrame收到房间内每一路音频流的第一帧时,收到该回调。
onAudioFrameSendStateChanged音频首帧发送状态改变回调
onVideoFrameSendStateChanged视频首帧发送状态改变回调
onAudioFramePlayStateChanged音频首帧播放状态改变回调
onVideoFramePlayStateChanged视频首帧播放状态改变回调
onLocalStreamStats反映通话中本地设备发送音/视频流的统计信息以及网络状况的回调。
本地用户发布音视频流成功后,每隔 2s 收到此回调。
onRemoteStreamStats反映通话中本地设备接收订阅的远端音/视频流的统计信息以及网络状况的回调。每隔 2s 收到此回调。
onStreamSubscribed当订阅一个流成功的时候回调该事件
onNetworkQuality加入房间后, 以 2 秒 1 次的频率,报告用户的网络质量信息
onLocalVideoSizeChanged本地视频大小或旋转配置发生改变时,收到此回调。
onRemoteVideoSizeChanged远端视频大小或旋转配置发生改变时,房间内订阅此视频流的用户会收到此回调。
onRemoteVideoStateChanged远端视频流的状态发生改变时,房间内订阅此流的用户会收到该事件。
onFirstRemoteVideoFrameRendered第一帧远端视频流在视图上渲染成功后,收到此回调。
onVideoStreamBanned通过调用服务端 BanUserStream/UnbanUserStream 方法禁用/解禁指定房间内指定用户视频流的发送时,触发此回调。
onFirstRemoteVideoFrameDecodedSDK 接收并解码远端视频流首帧后,收到此回调。
startForwardStreamToRooms开始跨房间转发媒体流。
stopForwardStreamToRooms停止跨房间媒体流转发。
updateForwardStreamToRooms更新跨房间媒体流转发信息。
pauseForwardStreamToAllRooms暂停跨房间媒体流转发。
resumeForwardStreamToAllRooms恢复跨房间媒体流转发。
pauseAllSubscribedStream暂停接收来自远端的媒体流。
resumeAllSubscribedStream恢复接收来自远端的媒体流
onForwardStreamStateChanged跨房间媒体流转发状态和错误回调
onForwardStreamEvent跨房间媒体流转发事件回调
setMultiDeviceAVSync设置发流端音画同步。
onAVSyncStateChange发布端调用 setMultiDeviceAVSync 后音视频同步状态发生改变时,会收到此回调。

视频处理

方法描述
setLocalVideoMirrorType为采集到的视频流开启镜像
setVideoWatermark在指定视频流上添加水印。
clearVideoWatermark移除指定视频流的水印。
setRemoteVideoSuperResolution设置远端视频超分模式。
enableEffectBeauty开启/关闭基础美颜
setBeautyIntensity调整基础美颜强度
initCVResource视频特效许可证检查
enableVideoEffect开启高级美颜、滤镜等视频特效。
disableVideoEffect关闭视频特效。
getAuthMessage从 CV SDK 获取授权消息,用于获取在线许可证。
setEffectNodes设置视频特效素材包,支持同时设置多个素材包
updateEffectNode设置特效强度
setColorFilter设置颜色滤镜
setColorFilterIntensity设置已启用颜色滤镜的强度
enableVirtualBackground将摄像头采集画面中的人像背景替换为指定图片或纯色背景。
disableVirtualBackground关闭虚拟背景。
setVideoCaptureRotation设置本端采集的视频帧的旋转角度。当外接摄像头倒置或者倾斜安装时,调用本接口进行调整。
setVideoDigitalZoomConfig设置本地摄像头数码变焦参数,包括缩放倍数,移动步长。
setVideoDigitalZoomControl控制本地摄像头数码变焦,缩放或移动一次。设置对本地预览画面和发布到远端的视频都生效。
startVideoDigitalZoomControl开启本地摄像头持续数码变焦,缩放或移动。设置对本地预览画面和发布到远端的视频都生效。
setLowLightAdjusted设置视频暗光增强模式。


对于光线不足、照明不均匀或背光等场景下推荐开启,可有效改善画面质量。 |
| enableFaceDetection | 开启人脸识别功能,并设置人脸检测结果回调观察者。 |
| disableFaceDetection | 关闭人脸识别功能。 |
| onFaceDetectResult | 特效 SDK 进行人脸检测结果的回调。
调用 enableFaceDetection 注册了回调,并使用 RTC SDK 中包含的特效 SDK 进行视频特效处理时,你会收到此回调。 |
| stopVideoDigitalZoomControl | 停止本地摄像头持续数码变焦。 |

音频处理

方法描述
setVoiceChangerType设置变声特效类型
setVoiceReverbType设置混响特效类型
setLocalVoicePitch开启本地语音变调功能,多用于 K 歌场景。使用该方法,你可以对本地语音的音调进行升调或降调等调整。
setLocalVoiceReverbParam设置本地采集音频的混响效果。包含内部采集和外部采集,但不包含混音音频文件。
enableLocalVoiceReverb开启本地音效混响效果
setLocalVoiceEqualization设置本地采集语音的均衡效果。包含内部采集和外部采集,但不包含混音音频文件。
enablePlaybackDucking打开/关闭音量闪避功能,适用于在 RTC 通话过程中会同时播放短视频或音乐的场景,如“一起看”、“在线 KTV”等。开启该功能后,当检测到远端人声时,本地的媒体播放音量会自动减弱,从而保证远端人声的清晰可辨;当远端人声消失时,本地媒体音量会恢复到闪避前的音量水平。

自定义流处理

方法描述
setVideoSourceType设置向 SDK 输入的视频源,包括屏幕流
默认使用内部采集。内部采集指:使用 RTC SDK 内置的视频采集机制进行视频采集。
pushExternalVideoFrame推送外部视频帧。
setAudioSourceType切换音频采集方式
pushExternalAudioFrame推送自定义采集的音频数据到 RTC SDK。
setLocalVideoSink获取本地视频流。
unsetLocalVideoSink停止获取本地视频流。
setRemoteVideoSink获取远端视频流。
unsetRemoteVideoSink停止获取远端视频流。
onLocalVideoFrame获取采集成功的本地摄像头流视频帧,用于自定义处理或渲染。
onRemoteVideoFrame获取采集成功的远端摄像头流视频帧,用于自定义处理或渲染。
enableAudioFrameCallback设置并开启指定的音频数据帧回调。
disableAudioFrameCallback关闭音频回调
onRecordAudioFrame返回麦克风录制的音频数据
onPlaybackAudioFrame返回远端所有用户混音后的音频数据
onRemoteUserAudioFrame返回远端单个用户的音频数据
onMixedAudioFrame返回本地麦克风录制和远端所有用户混音后的音频数据
onRecordScreenAudioFrame返回本地屏幕录制的音频数据

网络管理

方法描述
enableSimulcastMode该方法设置视频流发布端是否开启发布多路编码参数不同的视频流的模式。
onSimulcastSubscribeFallback因发布/订阅性能回退或退出回退状态,订阅的音视频流,发生流的切换时,收到该回调。
setRemoteVideoConfig设置期望订阅的远端视频流的参数。
setPublishFallbackOption设置发布的音视频流回退选项 。你可以调用这个接口来设置网络情况不佳或设备性能不足时只发送小流,以保证通话质量。
setSubscribeFallbackOption设置订阅的音视频流回退选项。 你可以通过调用该接口来设置网络情况不佳或性能不足时只订阅小流或音频流,以保证通话质量。
setRemoteUserPriority设置用户优先级
onPerformanceAlarms本地未通过 setPublishFallbackOption 开启发布性能回退,检测到设备性能不足时,收到此回调。本地通过 setPublishFallbackOption 开启发布性能回退,因设备性能/网络原因,造成发布性能回退/恢复时,收到此回调。
startNetworkDetection开启通话前网络探测
stopNetworkDetection停止通话前网络探测
onConnectionStateChangedSDK 与信令服务器连接状态改变回调。连接状态改变时触发。
onNetworkTypeChangedSDK 当前网络连接类型改变回调。当 SDK 的当前网络连接类型发生改变时回调该事件。
onNetworkDetectionResult成功调用 startNetworkDetection 接口开始探测后,会在 3s 内首次收到该回调,之后每 2s 收到一次该回调。
onNetworkDetectionStopped通话前网络探测结束
startEchoTest开始音频设备回路测试。
stopEchoTest停止音频设备回路测试。
onEchoTestResult通话前网络探测结束
getNetworkTimeInfo通过 NTP 协议,获取网络时间。
onNetworkTimeSynchronized首次调用 getNetworkTimeInfo 后,SDK 内部启动网络时间同步,同步完成时会触发此回调。

消息

方法描述
login登录 RTS 服务器。
必须先登录,才能发送房间外点对点消息和向应用服务器发送消息
logout登出 RTS 服务器。
调用本接口登出后,无法调用房间外消息以及端到服务器消息相关的方法或收到相关回调。
onLoginResult调用 login 后,会收到此回调。
onLogout登出结果回调
updateLoginToken更新用户用于登录的 Token。
sendRoomMessage给房间内的所有其他用户群发文本消息。
onRoomMessageSendResult调用 sendRoomMessagesendRoomBinaryMessage 向房间内群发文本或二进制消息后,消息发送方会收到该消息发送结果回调。
onRoomMessageReceived接收到房间内广播消息的回调。
sendRoomBinaryMessage给房间内的所有其他用户群发二进制消息。
onRoomBinaryMessageReceived接收到房间内广播二进制消息的回调。
getPeerOnlineStatus查询对端用户或本端用户的登录状态
onGetPeerOnlineStatus查询对端或本端用户登录状态的返回结果
sendUserMessage给房间内指定的用户发送点对点文本消息
onUserMessageReceived收到来自房间中其他用户通过 sendUserMessage 发来的点对点文本消息时,会收到此回调。
onUserMessageSendResult当调用 sendMessageToUser 函数发送消息后,回调此条消息的发送结果(反馈)。
onUserMessageSendResult向房间内单个用户发送点对点文本或点对点二进制消息后,消息发送方会收到该消息发送结果回调。
sendUserBinaryMessage给房间内指定的用户发送点对点二进制消息。
onServerMessageSendResult给业务服务器发送消息的回调
onServerParamsSetResult设置业务服务器参数的返回结果
onUserBinaryMessageReceived单个用户接收到同一房间内其他 uid 所属用户发来二进制消息的回调(P2P)。
onUserBinaryMessageReceived收到来自房间中其他用户通过 sendUserBinaryMessage 发来的点对点二进制消息时,会收到此回调。
sendUserMessageOutsideRoom给房间外指定的用户发送文本消息(P2P)
onUserMessageSendResultOutsideRoom给房间外指定的用户发送消息的回调
sendUserBinaryMessageOutsideRoom给房间外指定的用户发送二进制消息(P2P)
onUserMessageReceivedOutsideRoom收到房间外用户调用 sendUserMessageOutsideRoom 发来的文本消息时,会收到此回调
onUserBinaryMessageReceivedOutsideRoom收到房间外用户调用 sendUserBinaryMessageOutsideRoom 发来的二进制消息时,会收到此回调
setServerParams设置业务服务器参数。
sendServerMessage客户端给业务服务器发送文本消息(P2Server)
sendServerBinaryMessage客户端给业务服务器发送二进制消息(P2Server)
sendStreamSyncInfo发送音频流同步信息。将消息通过音频流发送到远端,并实现与音频流同步。
sendSEIMessage通过视频帧发送 SEI 数据。
onSEIStreamUpdate黑帧视频流发布状态回调。
在语音通话场景下,本地用户调用 sendSEIMessage 通过黑帧视频流发送 SEI 数据时,流的发送状态会通过该回调通知远端用户。
你可以通过此回调判断携带 SEI 数据的视频帧为黑帧,从而不对该视频帧进行渲染。
onSEIMessageReceived收到通过 sendSEIMessage 发送的带有 SEI 消息的视频帧时,收到此回调

CDN 推流

方法描述
startPushMixedStreamToCDN新增转推直播任务(新),并设置合流的图片、视频视图布局和音频属性。
updatePushMixedStreamToCDN更新转推直播参数。
setupMixingVideo为客户端合流绑定本地视图
removeMixingVideo为合流转推解绑本地视图
setAudioAlignmentProperty在听众端,设置订阅的所有远端音频流精准对齐后播放。
startPushSingleStreamToCDN新增单流转推直播任务。
onStreamPushEvent单流转推直播状态回调
onMixingEvent转推直播状态回调
onMixingVideoFrame合流视频回调,运行在视频回调线程
stopPushStreamToCDN停止转推直播。
onMixingAudioFrame合流音频回调,运行在音频回调线程
onMixingDataFrame视频 SEI 帧回调,运行在视频回调线程

音效播放

方法描述
getAudioEffectPlayer创建音效播放器实例。
start开始播放音效文件。
可以通过传入不同的 ID 和 filepath 多次调用本方法,以实现同时播放多个音效文件,实现音效叠加。
stop停止播放音效文件。
stopAll停止播放所有音效文件。
preload预加载指定音乐文件到内存中,以避免频繁播放同一文件时的重复加载,减少 CPU 占用。
unload卸载指定音效文件。
unloadAll卸载所有音效文件。
pause暂停播放音效文件。
pauseAll暂停播放所有音效文件。
resume恢复播放音效文件。
resumeAll恢复播放所有音效文件。
setPosition设置音效文件的起始播放位置。
getPosition获取音效文件播放进度。
setVolume调节指定音效的音量大小,包括音效文件和 PCM 音频。
setVolumeAll设置所有音效的音量大小,包括音效文件和 PCM 音效。
getVolume获取当前音量。
getDuration获取音效文件时长。
setEventHandler设置回调句柄。
onAudioEffectPlayerStateChanged播放状态改变时回调。

音乐播放

方法描述
getMediaPlayer创建音乐播放器实例。
open打开音乐文件。
一个播放器实例仅能够同时打开一个音乐文件。如果需要同时打开多个音乐文件,请创建多个音乐播放器实例。
start播放音乐。你仅需要在调用 open,且未开启自动播放时,调用此方法。
stop调用 openstart 开始播放后,可以调用本方法停止。
pause调用 open,或 start 开始播放音频文件后,调用本方法暂停播放。
resume调用 pause 暂停音频播放后,调用本方法恢复播放。
setVolume调节指定混音的音量大小,包括音乐文件混音和 PCM 混音。
getVolume获取当前音量
getTotalDuration获取音乐文件时长。
getPlaybackDuration获取混音音乐文件的实际播放时长,单位为毫秒。
getPosition获取音乐文件播放进度。
setPosition设置音乐文件的起始播放位置。
setAudioPitch开启变调功能,多用于 K 歌场景。
setAudioDualMonoMode设置当前音乐文件的声道模式
getAudioTrackCount获取当前音乐文件的音轨数
selectAudioTrack指定当前音乐文件的播放音轨
setPlaybackSpeed设置播放速度
setProgressInterval设置音频文件混音时,收到 onMediaPlayerPlayingProgress 的间隔。
setLoudness如果你需要使用 enableVocalInstrumentBalance 对音频文件/PCM 音频数据设置音量均衡,你必须通过此接口传入其原始响度。
setEventHandler注册回调句柄以在本地音乐文件混音时,收到相关回调。
onMediaPlayerStateChanged播放状态改变时回调。
onMediaPlayerPlayingProgress播放进度周期性回调。回调周期通过 [setAudioMixingProgressInterval] 设置。
openWithCustomSource启动音频裸数据混音。
pushExternalAudioFrame推送用于混音的 PCM 音频帧数据

屏幕分享

方法描述
startScreenVideoCapture采集屏幕视频流,用于共享。屏幕视频流包括:屏幕上显示的内容,应用窗口中显示的内容,或虚拟屏幕中显示的内容。其中,虚拟屏幕中显示的内容仅在 Windows 平台上支持。
stopScreenVideoCapture停止屏幕视频流采集。
updateScreenCaptureMouseCursor通过 RTC SDK 提供的采集模块采集屏幕视频流时,更新对鼠标的处理设置。默认采集鼠标。
setScreenVideoEncoderConfig为发布的屏幕共享视频流设置期望的编码参数,包括分辨率、帧率、码率、网络不佳时的回退策略等。
publishScreen在当前所在房间内发布本地屏幕共享音视频流
updateScreenCaptureRegion更新屏幕共享区域。
unpublishScreen停止将本地屏幕共享音视频流发布到当前所在房间中
updateScreenCaptureHighlightConfig通过 RTC SDK 提供的采集模块采集屏幕视频流时,更新边框高亮设置。默认展示表框。
updateScreenCaptureFilterConfig通过 RTC SDK 提供的采集模块采集屏幕视频流时,设置需要过滤的窗口。
getScreenCaptureSourceList获取屏幕采集对象列表。
getThumbnail获取共享对象缩略图
getWindowAppIcon获取应用窗体所属应用的图标。
subscribeScreen订阅房间内指定的远端屏幕共享音视频流,或更新对指定远端用户的订阅选项
unsubscribeScreen取消订阅房间内指定的远端屏幕共享音视频流。
startScreenAudioCapture在屏幕共享时,开始使用 RTC SDK 内部采集方式,采集屏幕音频
onUserPublishScreen房间内新增远端屏幕共享音视频流的回调。
stopScreenAudioCapture在屏幕共享时,停止使用 RTC SDK 内部采集方式,采集屏幕音频。
onUserUnpublishScreen房间内远端屏幕共享音视频流移除的回调。
onScreenVideoFrameSendStateChanged屏幕共享流视频首帧发送状态改变回调
onScreenVideoFramePlayStateChanged屏幕共享流视频首帧播放状态改变回调
onScreenAudioFrameSendStateChanged屏幕音频首帧发送状态改变回调
onScreenAudioFramePlayStateChanged屏幕音频首帧播放状态改变回调
onLocalScreenFrame获取采集成功的本地屏幕视频帧,用于自定义处理或渲染。
onRemoteScreenFrame视频管理获取采集成功的远端屏幕视频帧,用于自定义处理或渲染。
setScreenAudioChannel在屏幕共享时,设置屏幕音频流的声道数
setScreenAudioStreamIndex在屏幕共享时,设置屏幕音频流和麦克风采集到的音频流的混流方式

安全与加密

方法描述
startCloudProxy开启云代理
stopCloudProxy关闭云代理
onCloudProxyConnected调用 startCloudProxy 开启云代理,SDK 首次成功连接云代理服务器时,回调此事件。
setEncryptInfo设置传输时使用内置加密的方式
setLocalProxy设置本地代理。
onLocalProxyStateChanged本地代理状态发生改变回调。调用 setLocalProxy 设置本地代理后,SDK 会触发此回调,返回代理连接的状态。
onHttpsProxyStateHTTPS 代理连接状态改变时,收到该回调。
onHttpProxyStateHTTP 代理连接状态改变时,收到该回调。
onSocks5ProxyStateSOCKS5 代理状态改变时,收到该回调。

录制

方法描述
startFileRecording该方法将通话过程中的音视频数据录制到本地的文件中。
stopFileRecording停止本地录制
startAudioRecording开启录制语音通话,生成本地文件。
stopAudioRecording停止音频文件录制
onRecordingStateUpdate获取本地录制状态回调。
onRecordingProgressUpdate本地录制进度回调。
onAudioRecordingStateUpdate调用 startAudioRecordingstopAudioRecording 改变音频文件录制状态时,收到此回调。

空间音频

方法描述
enableSpatialAudio开启/关闭空间音频功能。
disableRemoteOrientation参与通话的各端调用本接口后,将忽略远端用户的朝向,认为所有远端用户都面向本地用户。
updateListenerOrientation更新在房间内收听音频时的朝向。
通过此接口,你可以设定本地用户的发声朝向和收听朝向不同。
updateListenerPosition更新在房间内收听音频时的位置。
通过此接口,你可以设定本地发声位置和收听位置不同。
updateSpatialPosition更新本地用户在房间内空间直角坐标系中的位置坐标。
updateSelfPosition设置本地用户在自建空间直角坐标系中的收听坐标和收听朝向,以实现本地用户预期的空间音频收听效果。
updateSelfOrientation更新本地用户在空间音频坐标系下的朝向。
updateRemotePosition设置房间内某一远端用户在本地用户自建的空间音频坐标系中的发声位置和发声朝向,以实现本地用户预期的空间音频收听效果。
removeRemotePosition移除调用 updateRemotePosition 为某一远端用户设置的空间音频效果。
removeAllRemotePosition移除调用 updateRemotePosition 为所有远端用户设置的空间音频效果。

范围语音

方法描述
enableRangeAudio开启/关闭范围语音功能。
setAttenuationModel设置范围语音的音量衰减模式。
setNoAttenuationFlags添加标签组,用于标记相互之间通话不衰减的用户组。
在同一个 RTC 房间中,如果多个用户的标签组之间有交集,那么,他们之间互相通话时,通话不衰减。
比如,用户身处多个队伍,队伍成员间通话不衰减。那么,可以为每个队伍绑定专属标签,每个用户的标签组包含用户所属各个队伍的标签。
updateRangePosition更新本地用户在房间内空间直角坐标系中的位置坐标。
updateReceiveRange更新本地用户的音频收听范围。

音乐和打分

方法描述
getMusicDetail获取音乐详细信息。
getMusicList获取歌曲列表。
searchMusic根据关键词搜索歌曲。
getHotMusic根据热榜类别获取每个榜单的歌曲列表。
downloadMusic下载音乐。
downloadLyric下载歌词。
downloadMidi下载 MIDI 文件。
cancelDownload取消下载任务。
setMaxCacheSize设置歌曲文件最大占用的本地缓存。
clearCache清除当前音乐缓存文件,包括音乐音频和歌词。
playMusic播放歌曲。
pauseMusic暂停播放歌曲。
resumeMusic继续播放歌曲。
stopMusic停止播放歌曲。
seekMusic设置音乐文件的起始播放位置。
setMusicVolume设置歌曲播放音量,只能在开始播放后进行设置。
switchAudioTrackType切换歌曲原唱伴唱。
setMusicPitch对播放中的音乐设置升降调信息。
onMusicListResult歌曲列表回调。
onSearchMusicResult搜索歌曲结果回调。
onHotMusicResult热榜歌曲结果回调。
onMusicDetailResult歌曲详细信息回调。
onDownloadSuccess下载成功回调。
onDownloadFailed下载失败回调。
onDownloadMusicProgress歌曲文件下载进度回调。
onPlayProgress音乐播放进度回调。
onPlayStateChanged音乐播放状态改变回调。
onCurrentScoringInfo实时评分信息回调。
onClearCacheResult清理文件缓存结果回调。
initSingScoring初始化 K 歌评分。
setSingScoringConfig设置 K 歌评分参数。
getStandardPitchCount获取当前系统内音视频设备数量
getStandardPitchInfo获取每句歌词的标准音高信息
startSingScoring开始 K 歌评分。
getLastSentenceScore获取上一句的演唱评分。
getTotalScore获取当前演唱总分。
getAverageScore获取当前演唱歌曲的平均分。
stopSingScoring停止 K 歌评分。

公共流

方法描述
startPushPublicStream发布一路公共流。
stopPushPublicStream停止发布当前用户发布的公共流
updatePublicStreamParam更新公共流参数
startPlayPublicStream订阅指定公共流。无论用户是否在房间内,都可以调用本接口获取和播放指定的公共流。
stopPlayPublicStream取消订阅指定公共流
setupPublicStreamVideo为公共流绑定本地视图
removePublicStreamVideo为公共流解绑本地视图
setPublicStreamVideoSink为指定公共流绑定自定义渲染器。
unsetPublicStreamVideoSink为指定公共解绑自定义渲染器。
setPublicStreamAudioPlaybackVolume调节公共流的音频播放音量。
onPushPublicStreamResult公共流发布结果回调。
调用 startPushPublicStream 接口发布公共流后,启动结果通过此回调方法通知用户。
onFirstPublicStreamVideoFrameDecoded公共流的首帧视频解码成功
onPlayPublicStreamResult订阅公共流的结果回调
通过 startPlayPublicStream 订阅公共流后,可以通过本回调获取订阅结果。
onFirstPublicStreamAudioFrame公共流的音频首帧解码成功
onPublicStreamVideoFrame公共流视频数据回调,绑定公共流到自定义渲染器后,通过该回调获取公共流视频数据。
onPublicStreamDataMessageReceived回调公共流中包含的数据信息。
通过 startPlayPublicStream 订阅公共流后,通过监听本回调获取公共流中的数据消息,包括调用 Open API 发送的 SEI 消息和音量回调。
onPublicStreamSEIMessageReceived回调公共流中包含的 SEI 信息。
调用 startPlayPublicStream 接口启动拉公共流功能后,通过此回调收到公共流中的 SEI 消息。

字幕翻译服务

方法描述
startSubtitle识别或翻译房间内所有用户的语音,形成字幕。
语音识别或翻译的结果会通过 onSubtitleMessageReceived 事件回调给你。
调用该方法后,你会收到 onSubtitleStateChanged 回调,通知字幕是否开启。
stopSubtitle关闭字幕。
调用该方法后,用户会收到 onSubtitleStateChanged 回调,通知字幕是否关闭。
onSubtitleStateChanged字幕状态发生改变回调。
当用户调用 startSubtitlestopSubtitle 使字幕状态发生改变或字幕任务出现错误时,触发该回调。
onSubtitleMessageReceived字幕相关内容回调。
当用户成功调用 startSubtitle 后会收到此回调,通知字幕的相关信息。

视频截图

方法描述
takeLocalSnapshot截取本地视频画面
takeRemoteSnapshot截取远端视频画面
onTakeLocalSnapshotResult调用 takeLocalSnapshot 截取视频画面时,收到此回调。
onTakeRemoteSnapshotResult调用 takeRemoteSnapshot 截取视频画面时,收到此回调。

插件管理器

方法描述
initializePluginManager初始化插件管理器
registerPlugin注册插件
getPlugin获取插件实例
unregisterPlugin卸载插件
releasePluginManager释放插件管理器

高级功能

方法描述
setEarMonitorMode开启/关闭耳返功能
setEarMonitorVolume设置耳返的音量
setAnsMode支持根据业务场景,设置通话中的音频降噪模式。
onRemoteVideoSuperResolutionModeChanged远端视频流的超分状态发生改变时,房间内订阅此流的用户会收到该回调。
onExtensionAccessError当访问插件失败时,收到此回调。
RTC SDK 将一些功能封装成插件。当使用这些功能时,如果插件不存在,功能将无法使用。