NERTC macOS/Windows SDK V5.6.40
|
网易云信音视频通话 SDK(简称 NERTC SDK)为运行在 macOS 系统上的桌面应用 提供完善的音视频通话开发框架,提供基于网络的点对点视频通话和语音通话功能,还提供多人视频和音频会议功能,支持通话中音视频设备控制和实时音视频模式切换,支持视频采集数据回调以实现美颜等自定义功能。
在调用 SDK API 的过程中,SDK 可能会返回错误码或状态码,您可以根据错误码或状态码判断当前 SDK 或任务的状态。如果遇到未知的错误码,请 提交工单 联系网易云信技术支持工程师排查。
当前 SDK API 的错误码如下:
nertc::NERtcErrorCode
nertc::NERtcAudioMixingErrorCode
nertc::NERtcLocalVideoWatermarkState
nertc::NERtcWarnCode
方法 | 功能 | 起始版本 |
---|---|---|
createNERtcEngine | 创建 RTC 引擎对象。 | V3.5.0 |
destroyNERtcEngine | 销毁 RTC 引擎对象。 | V3.5.0 |
initialize | 初始化 NERTC SDK 服务。 | V3.5.0 |
release | 销毁 IRtcEngine 对象。 | V3.5.0 |
getVersion | 查询 SDK 版本号。 | V3.5.0 |
setChannelProfile | 设置房间场景。 | V3.6.0 |
setClientRole | 设置用户角色。 | V3.9.0 |
joinChannel | 加入房间。 | V3.5.0 |
joinChannel | 加入房间,可以携带鉴权密钥等特定参数。 | V4.6.29 |
leaveChannel | 离开房间。 | V3.5.0 |
switchChannel | 快速切换房间。 | V3.5.0 |
getConnectionState | 获取房间连接状态。 | V3.5.0 |
queryInterface | 获取设备管理员对象的指针。 | V3.5.0 |
setParameters | 设置音视频通话的相关参数。 | V3.5.0 |
updatePermissionKey | 更新权限密钥。 | V4.6.29 |
事件 | 描述 | 起始版本 |
---|---|---|
onClientRoleChanged | 用户角色已切换回调。 | V3.9.0 |
onJoinChannel | 加入房间回调。 | V3.5.0 |
onRejoinChannel | 重新加入房间回调。 | V3.5.0 |
onLeaveChannel | 离开房间回调。 | V3.5.0 |
onUserJoined | 远端用户加入当前房间回调。 | V3.5.0 |
onUserJoined | 远端用户加入当前房间回调。 | V4.6.29 |
onUserLeft | 远端用户离开当前房间回调。 | V3.5.0 |
onUserLeft | 远端用户离开当前房间回调。 | V4.6.29 |
onDisconnect | 服务器连接断开回调。 | V3.5.0 |
onReconnectingStart | 开始重连回调。 | V3.7.0 |
onConnectionStateChange | 房间连接状态已改变回调。 | V3.8.1 |
onReleasedHwResources | 通话结束设备资源释放回调。 | V3.5.0 |
onPermissionKeyWillExpire | 权限密钥即将过期事件回调。 | V4.6.29 |
onUpdatePermissionKey | 更新权限密钥事件回调。 | V4.6.29 |
方法 | 功能 | 起始版本 |
---|---|---|
setAudioProfile | 设置音频编码配置。 | V3.5.0 |
adjustRecordingSignalVolume | 调节采集信号音量。 | V3.5.0 |
adjustPlaybackSignalVolume | 调节本地播放音量。 | V3.5.0 |
adjustUserPlaybackSignalVolume | 调节本地播放的指定远端用户的信号音量。 | V4.2.1 |
enableLocalAudio | 开关本地音频采集。 | V3.5.0 |
muteLocalAudioStream | 开关本地音频发送。 | V3.5.0 |
subscribeRemoteAudioStream | 订阅/取消订阅指定音频流。 | V3.5.0 |
subscribeAllRemoteAudioStream | 订阅或取消订阅所有音频流。 | V4.5.0 |
enableLoopbackRecording | 开启声卡采集。 | V4.4.0 |
adjustLoopbackRecordingSignalVolume | 调节声卡采集信号音量。 | V4.4.0 |
setRemoteHighPriorityAudioStream | 设置远端用户音频流为高优先级。 | V4.6.0 |
enableLocalSubStreamAudio | 开启或关闭音频辅流。 | V4.6.10 |
subscribeRemoteSubStreamAudio | 订阅远端用户辅流。 | V4.6.10 |
muteLocalSubStreamAudio | 静音本地音频辅流。 | V4.6.10 |
setAudioSubscribeOnlyBy | 设置本地用户音频只能被房间内其他指定用户订阅。 | V4.6.10 |
enableMediaPub | 发布或停止发布本地音频。 | V4.6.10 |
方法 | 功能 | 起始版本 |
---|---|---|
enableLocalVideo | 开启/关闭本地视频主流的采集与发送。 | V3.5.0 |
enableLocalVideo | 开启/关闭本地视频主流或辅流的采集与发送。 | V4.6.20 |
setCameraCaptureConfig | 设置摄像头采集配置。 | V4.5.0 |
setVideoConfig | 设置视频主流的编码属性。 | V3.5.0 |
setVideoConfig | 设置视频主流或辅流编码属性。 | V4.6.20 |
setCameraCaptureConfig | 设置视频主流的摄像头采集配置。 | V4.5.0 |
setCameraCaptureConfig | 设置视频主流或辅流的摄像头采集配置。 | V4.6.20 |
setupLocalVideoCanvas | 设置本地用户视图。 | V3.5.0 |
setupRemoteVideoCanvas | 设置远端用户视图。 | V3.5.0 |
setLocalRenderMode | 设置本地视图显示模式。 | V3.5.0 |
setRemoteRenderMode | 设置远端视图显示模式。 | V3.5.0 |
startVideoPreview | 开启视频主流的预览。 | V3.5.0 |
startVideoPreview | 开启视频主流或辅流的预览。 | V4.6.20 |
stopVideoPreview | 停止视频主流的预览。 | V3.5.0 |
stopVideoPreview | 停止视频主流或辅流的预览。 | V4.6.20 |
muteLocalVideoStream | 取消/恢复发布本地视频主流。 | V3.5.0 |
muteLocalVideoStream | 取消/恢复发布本地视频主流或辅流。 | V4.6.20 |
subscribeRemoteVideoStream | 订阅/取消订阅指定远端用户的视频流。 | V3.5.0 |
setLocalVideoMirrorMode | 设置本地视频镜像模式。 | V3.5.0 |
setLocalVideoMirrorMode | 设置本地视频主流或辅流的镜像模式。 | V4.6.20 |
enableSuperResolution | 启用或停止 AI 超分。 | V4.4.0 |
方法 | 功能 | 起始版本 |
---|---|---|
startPushStreaming | 将 RTMP 流推到指定的地址。 | V5.6.10 |
stopPushStreaming | 停止当前正在进行的 RTMP 推流。 | V5.6.10 |
事件 | 描述 | 起始版本 |
---|---|---|
onStartPushStreaming | startPushStreaming 开始推流的结果回调。 | V5.6.10 |
onStopPushStreaming | 停止 RTMP 推流的结果回调。 | V5.6.10 |
onPushStreamingChangeToReconnecting | 推流过程中推流状态变为重连中的回调。 | V5.6.10 |
onPushStreamingReconnectedSuccess | 推流过程中重连成功的回调。 | V5.6.10 |
方法 | 功能 | 起始版本 |
---|---|---|
onFirstVideoDataReceived | 已显示远端主流视频首帧的回调。 | V3.5.0 |
onFirstVideoDataReceived | 已显示远端主流或辅流视频首帧的回调。 | V4.6.20 |
onFirstAudioDataReceived | 已接收到远端音频首帧回调。 | V3.5.0 |
onFirstAudioFrameDecoded | 已解码远端音频首帧的回调。 | V3.5.0 |
onFirstVideoFrameDecoded | 已接收到远端主流视频首帧并完成解码的回调。 | V3.5.0 |
onFirstVideoFrameDecoded | 已接收到远端主流或辅流视频首帧并完成解码的回调。 | V4.6.20 |
onMediaRightChange | 服务端禁言音视频权限变化回调。 | V4.6.0 |
方法 | 功能 | 起始版本 |
---|---|---|
onUserAudioStart | 远端用户开启音频主流回调。 | V3.5.0 |
onUserSubStreamAudioStart | 远端用户开启音频辅流回调。 | V4.6.10 |
onUserAudioStop | 远端用户停用音频主流回调。 | V3.5.0 |
onUserSubStreamAudioStop | 远端用户停用音频辅流回调。 | V4.6.10 |
onUserVideoStart | 远端用户开启视频回调。 | V3.5.0 |
onUserVideoStop | 远端用户停用视频回调。 | V3.5.0 |
onUserVideoProfileUpdate | 远端用户视频配置更新回调。 | V3.5.0 |
onUserAudioMute | 远端用户是否静音主流回调。 | V3.5.0 |
onUserSubStreamAudioMute | 远端用户是否静音辅流回调。 | V4.6.10 |
onUserVideoMute | 远端用户暂停或恢复发送视频主流的回调。 | V3.5.0 |
onUserVideoMute | 远端用户暂停或恢复发送视频主流或辅流的回调。 | V4.6.20 |
方法 | 功能 | 起始版本 |
---|---|---|
onRemoteAudioStats | 通话中远端音频流的统计信息回调。 | V3.5.0 |
onRtcStats | 当前通话统计回调。 | V3.5.0 |
onNetworkQuality | 通话中每个用户的网络上下行质量报告回调。 | V3.5.0 |
onLocalAudioStats | 本地音频流统计信息回调。 | V3.5.0 |
onLocalVideoStats | 本地视频流统计信息回调。 | V3.5.0 |
onRemoteVideoStats | 通话中远端视频流的统计信息回调。 | V3.5.0 |
setStatsObserver | 注册统计信息观测器。 | V3.5.0 |
方法 | 功能 | 起始版本 |
---|---|---|
startScreenCaptureByDisplayId | 开启屏幕共享,共享范围为指定屏幕的指定区域。该方法仅适用于 macOS 和 Windows 平台。 | V3.5.0 |
startScreenCaptureByScreenRect | 开启屏幕共享,共享范围为指定屏幕的指定区域。该方法仅适用于 Windows 平台。 | V3.5.0 |
startScreenCaptureByWindowId | 开启屏幕共享,共享范围为指定窗口的指定区域。 | V3.5.0 |
setExcludeWindowList | 设置共享指定屏幕或屏幕区域时,需要屏蔽的窗口列表。 | V4.2.0 |
updateScreenCaptureRegion | 更新屏幕共享区域。 | V3.5.0 |
pauseScreenCapture | 暂停屏幕共享。 | V3.7.0 |
resumeScreenCapture | 恢复屏幕共享。 | V3.7.0 |
stopScreenCapture | 停止屏幕共享。 | V3.5.0 |
setupLocalSubStreamVideoCanvas | 设置本端的辅流视频回放画布。 | V3.9.0 |
setLocalSubStreamRenderMode | 设置本端的辅流渲染缩放模式。 | V3.9.0 |
setupRemoteSubStreamVideoCanvas | 设置远端的辅流视频回放画布。 | V3.9.0 |
setRemoteSubSteamRenderMode | 设置远端的屏幕共享辅流视频渲染缩放模式。 | V3.9.0 |
subscribeRemoteVideoSubStream | 订阅或取消订阅远端的屏幕共享辅流视频,订阅之后才能接收远端的辅流视频数据。 | V3.9.0 |
setScreenCaptureMouseCursor | 设置共享屏幕时是否显示鼠标。 | V4.6.10 |
方法 | 功能 | 起始版本 |
---|---|---|
startBeauty | (仅 Windows)开启美颜功能模块。 | V4.6.10 |
startBeauty | (仅 macOS)开启美颜功能模块。 | V4.6.10 |
stopBeauty | (仅 Windows)结束美颜功能模块。 | V4.6.10 |
stopBeauty | (仅 macOS)结束美颜功能模块。 | V4.6.10 |
enableBeauty | (仅 Windows)暂停或恢复美颜效果。 | V4.6.10 |
isOpenBeauty | (仅 macOS)暂停或恢复美颜效果。 | V4.6.10 |
setBeautyEffect | (仅 Windows)设置美颜效果。 | V4.6.10 |
NERtcBeauty#setBeautyEffectWithValue:atType: | (仅 macOS)设置美颜效果。 | V4.6.10 |
NERtcBeauty#addTempleteWithPath:andName: | (仅 macOS)导入美颜资源或模型。 | V4.6.10 |
getBeautyEffect | (仅 Windows)获取指定美颜类型的强度设置。 | V4.6.10 |
addBeautyFilter | (仅 Windows)添加滤镜效果。 | V4.6.10 |
NERtcBeauty#addBeautyFilterWithPath:andName: | (仅 macOS)添加滤镜效果。 | V4.6.10 |
removeBeautyFilter | (仅 Windows)移除滤镜。 | V4.6.10 |
removeBeautyFilter | (仅 macOS)移除滤镜。 | V4.6.10 |
setBeautyFilterLevel | (仅 Windows)设置滤镜强度。 | V4.6.10 |
事件 | 描述 | 起始版本 |
---|---|---|
onUserSubStreamVideoStart | 远端用户开启屏幕共享辅流通道的回调。 | V3.9.0 |
onUserSubStreamVideoStop | 远端用户停止屏幕共享辅流通道的回调。 | V3.9.0 |
onScreenCaptureStatus | 屏幕共享状态变化回调。该方法仅适用于 Windows 平台。 | V4.2.0 |
方法 | 功能 | 起始版本 |
---|---|---|
createChannel | 创建并获取一个 NERtcChannel 对象。通过创建多个对象,用户可以同时加入多个频道。 | V4.5.0 |
IRtcChannel | 该类提供在指定频道内实现实时音视频功能的方法。 | V4.5.0 |
IRtcChannelEventHandler | 该类提供监听指定频道事件和数据的回调。 | V4.5.0 |
方法 | 功能 | 起始版本 |
---|---|---|
startAudioMixing | 开始播放伴音。 | V3.5.0 |
stopAudioMixing | 停止播放伴音。 | V3.5.0 |
pauseAudioMixing | 暂停播放伴音。 | V3.5.0 |
resumeAudioMixing | 恢复播放伴音。 | V3.5.0 |
setAudioMixingPlaybackVolume | 设置伴音的播放音量。 | V3.5.0 |
setAudioMixingSendVolume | 设置伴音的发送音量。 | V3.5.0 |
setAudioMixingPitch | 设置伴音的音调。 | V4.6.29 |
getAudioMixingPitch | 获取伴音的音调。 | V4.6.29 |
getAudioMixingSendVolume | 获取伴音的发送音量。 | V3.5.0 |
getAudioMixingDuration | 获取伴音的总长度。 | V3.5.0 |
getAudioMixingCurrentPosition | 获取伴音的播放进度。 | V3.5.0 |
setAudioMixingPosition | 设置伴音的播放进度。 | V3.5.0 |
事件 | 描述 | 起始版本 |
---|---|---|
onAudioMixingStateChanged | 本地用户的音乐文件播放状态改变回调。 | V3.5.0 |
onAudioMixingTimestampUpdate | 本地用户的音乐文件播放进度回调。 | V3.5.0 |
方法 | 功能 | 起始版本 |
---|---|---|
getEffectPlaybackVolume | 获取音效文件播放音量。 | V3.5.0 |
setEffectPlaybackVolume | 设置音效文件播放音量。 | V3.5.0 |
playEffect | 播放指定音效文件。 | V3.5.0 |
stopEffect | 停止播放指定音效文件。 | V3.5.0 |
stopAllEffects | 停止播放所有音效文件。 | V3.5.0 |
pauseEffect | 暂停音效文件播放。 | V3.5.0 |
pauseAllEffects | 暂停所有音效文件播放。 | V3.5.0 |
resumeEffect | 恢复播放指定音效文件。 | V3.5.0 |
resumeAllEffects | 恢复播放所有音效文件。 | V3.5.0 |
setEffectSendVolume | 调节音效文件发送音量。 | V3.5.0 |
getEffectSendVolume | 获取音效文件发送音量。 | V3.5.0 |
setEffectPitch | 设置音效文件音调。 | V4.6.29 |
getEffectPitch | 获取音效文件音调。 | V4.6.29 |
getEffectDuration | 获取音效文件的总长度。 | V4.6.29 |
getEffectCurrentPosition | 获取音效文件的播放进度。 | V4.6.29 |
setEffectPosition | 设置音效文件的播放进度。 | V4.6.29 |
事件 | 描述 | 起始版本 |
---|---|---|
onAudioEffectFinished | 本地音效文件播放已结束回调。 | V3.5.0 |
onAudioEffectTimestampUpdate | 本地音效文件播放进度回调。 | V4.6.29 |
方法 | 功能 | 起始版本 |
---|---|---|
setAudioEffectPreset | 设置 SDK 预设的人声的变声音效。 | 4.1.0 |
setVoiceBeautifierPreset | 设置 SDK 预设的美声效果。 | 4.0.0 |
setLocalVoiceEqualization | 设置本地语音音效均衡,即自定义设置本地人声均衡波段的中心频率。 | 4.0.0 |
setLocalVoicePitch | 设置本地语音音调。 | 4.1.0 |
setLocalVoiceReverbParam | 开启本地语音混响效果。 | 4.6.10 |
注意:该组方法仅适用于互动直播 2.0。
方法 | 功能 | 起始版本 |
---|---|---|
addLiveStreamTask | 添加房间推流任务。 | V3.5.0 |
updateLiveStreamTask | 更新修改房间推流任务。 | V3.5.0 |
removeLiveStreamTask | 删除房间推流任务。 | V3.5.0 |
事件 | 描述 | 起始版本 |
---|---|---|
onAddLiveStreamTask | 通知添加直播任务结果。 | V3.5.0 |
onUpdateLiveStreamTask | 通知更新直播任务结果。 | V3.5.0 |
onRemoveLiveStreamTask | 通知删除直播任务结果。 | V3.5.0 |
onLiveStreamState | 通知直播推流状态。 | V3.5.0 |
方法 | 功能 | 起始版本 |
---|---|---|
startChannelMediaRelay | 开始跨房间媒体流转发。 | V4.3.0 |
updateChannelMediaRelay | 更新媒体流转发的目标房间。 | V4.3.0 |
stopChannelMediaRelay | 停止跨房间媒体流转发。 | V4.3.0 |
事件 | 描述 | 起始版本 |
---|---|---|
onMediaRelayStateChanged | 跨房间媒体流转发状态发生改变回调。 | V4.3.0 |
onMediaRelayEvent | 媒体流相关转发事件回调。 | V4.3.0 |
方法 | 功能 | 起始版本 |
---|---|---|
sendSEIMsg [1/2] | 通过主流通道发送媒体补充增强信息。 | V4.0.0 |
sendSEIMsg [2/2] | 发送媒体补充增强信息。 通过本接口可指定发送 SEI 时使用主流或辅流通道。 | V4.0.0 |
事件 | 描述 | 起始版本 |
---|---|---|
onRecvSEIMsg | 收到远端流的媒体补充增强信息回调。 | V4.0.0 |
方法 | 功能 | 起始版本 |
---|---|---|
enableAudioVolumeIndication | 启用说话者音量提示。 | V3.5.0 |
enableAudioVolumeIndication | 启用说话者音量及本地是否有人声提示。 | V4.6.10 |
事件 | 描述 | 起始版本 |
---|---|---|
onRemoteAudioVolumeIndication | 提示房间内谁正在说话及说话者音量的回调。 | V3.5.0 |
onLocalAudioVolumeIndication | 提示房间内本地用户瞬时音量的回调。 | V3.5.0 |
onLocalAudioVolumeIndication | 提示房间内本地用户瞬时音量及是否存在人声的回调。 | V4.6.10 |
方法 | 功能 | 起始版本 |
---|---|---|
enableEarback | 开启耳返功能。 | V3.5.0 |
setEarbackVolume | 设置耳返音量。 | V3.5.0 |
方法 | 功能 | 起始版本 |
---|---|---|
enableDualStreamMode | 设置是否开启视频大小流模式。 | V3.5.0 |
方法 | 功能 | 起始版本 |
---|---|---|
setLocalPublishFallbackOption | 设置弱网条件下发布的音视频流回退选项。 | V4.3.0 |
setRemoteSubscribeFallbackOption | 设置弱网条件下订阅的音视频流回退选项。 | V4.3.0 |
setLocalMediaPriority | 设置本地用户的媒体流优先级。 | V4.2.0 |
事件 | 描述 | 起始版本 |
---|---|---|
onLocalPublishFallbackToAudioOnly | 本地发布流已回退为音频流或恢复为音视频流回调。 | V4.3.0 |
onRemoteSubscribeFallbackToAudioOnly | 远端订阅流已回退为音频流或恢复为音视频流回调。 | V4.3.0 |
方法 | 功能 | 起始版本 |
---|---|---|
startLastmileProbeTest | 开始通话前网络质量探测。 | V4.5.0 |
stopLastmileProbeTest | 停止通话前网络质量探测。 | V4.5.0 |
事件 | 描述 | 起始版本 |
---|---|---|
onLastmileQuality | 报告本地用户的网络质量。 | V4.5.0 |
onLastmileProbeResult | 报告通话前网络上下行 last mile 质量。 | V4.5.0 |
方法 | 功能 | 起始版本 |
---|---|---|
setExternalAudioSource | 启用外部自定义音频数据主流输入功能,并设置采集参数。 | V3.9.0 |
setExternalSubStreamAudioSource | 启用外部自定义音频数据辅流输入功能,并设置采集参数。 | V4.6.10 |
pushExternalAudioFrame | 将外部音频主流数据帧推送给内部引擎。 | V3.9.0 |
pushExternalSubStreamAudioFrame | 将外部音频辅流数据帧推送给内部引擎。 | V4.6.10 |
setExternalAudioRender | 设置外部音频渲染。 | V4.0.0 |
pullExternalAudioFrame | 拉取外部音频数据。 | V4.0.0 |
setStreamAlignmentProperty | 对齐本地系统时间与服务端时间。 | V4.6.10 |
getNtpTimeOffset | 获取本地系统时间与服务端时间的差值。 | V4.6.10 |
方法 | 功能 | 起始版本 |
---|---|---|
setExternalVideoSource | 开启/关闭外部视频源数据输入主流通道。 | V3.5.0 |
setExternalVideoSource | 开启/关闭外部视频源数据输入主流或辅流通道。 | V4.6.20 |
pushExternalVideoFrame | 推送外部视频帧至主流通道。 | V3.5.0 |
pushExternalVideoFrame | 推送外部视频帧至主流或辅流通道。 | V4.6.20 |
方法 | 功能 | 起始版本 |
---|---|---|
setPreDecodeObserver | 注册解码前媒体数据观测器。 | V4.6.29 |
pushExternalAudioEncodedFrame | 推送外部音频主流编码帧。 | V4.6.29 |
pushExternalSubStreamAudioEncodedFrame | 推送外部音频辅流编码帧。 | V4.6.29 |
pushExternalVideoEncodedFrame | 推送外部视频编码帧。 | V4.6.29 |
setVideoEncoderQosObserver | 注册视频编码 QoS 信息监听器。 | V4.6.29 |
事件 | 描述 | 起始版本 |
---|---|---|
onFrame | 解码前媒体数据回调。 | V4.6.29 |
onRequestSendKeyFrame | I 帧请求事件回调。 | V4.6.29 |
onVideoCodecUpdated | 视频编码器类型信息回调。 | V4.6.29 |
onBitrateUpdated | 码率信息回调。 | V4.6.29 |
方法 | 功能 | 起始版本 |
---|---|---|
setRecordingAudioFrameParameters | 设置录制的声音格式。 | V3.5.0 |
setPlaybackAudioFrameParameters | 设置播放的声音格式。 | V3.5.0 |
setAudioFrameObserver | 注册语音观测器对象。 | V3.5.0 |
setMixedAudioFrameParameters | 设置采集和播放后的混合后的采样率。需要在加入房间之前调用该接口。 | V3.5.0 |
事件 | 描述 | 起始版本 |
---|---|---|
onAudioFrameDidRecord | 采集音频数据回调。 | V3.5.0 |
onAudioFrameWillPlayback | 播放音频数据回调。 | V3.5.0 |
onMixedAudioFrame | 音频采集与播放混合后数据帧回调。 | V3.5.0 |
onPlaybackAudioFrameBeforeMixing [1/2] | 某一远端用户的原始音频帧回调。 该接口即将废弃,请改用 onPlaybackAudioFrameBeforeMixing [2/2]。 | V3.5.0 |
onPlaybackAudioFrameBeforeMixing [2/2] | 某一远端用户的原始音频帧回调。 | V4.5.0 |
事件 | 描述 | 起始版本 |
---|---|---|
onCaptureVideoFrame | 采集视频数据回调。 | V3.5.0 |
方法 | 功能 | 起始版本 |
---|---|---|
takeLocalSnapshot | 本地视频画面截图。 | V4.2.0 |
takeRemoteSnapshot | 远端视频画面截图。 | V4.2.0 |
事件 | 描述 | 起始版本 |
---|---|---|
onTakeSnapshotResult | 截图结果回调。 | V4.2.0 |
方法 | 功能 | 起始版本 |
---|---|---|
setLocalVideoWatermarkConfigs | 添加本地视频水印。 | V4.6.10 |
事件 | 描述 | 起始版本 |
---|---|---|
onLocalVideoWatermarkState | 水印结果回调。 | V4.6.10 |
方法 | 功能 | 起始版本 |
---|---|---|
enableEncryption | 开启或关闭媒体流加密。 | V4.4.0 |
方法 | 功能 | 起始版本 |
---|---|---|
startAudioRecording | 开始客户端录音。 | V4.2.0 |
startAudioRecordingWithConfig | 开始客户端录音。 | V4.6.0 |
stopAudioRecording | 停止客户端录音。 | V4.2.0 |
事件 | 描述 | 起始版本 |
---|---|---|
onAudioRecording | 音频录制状态回调。 | V4.2.0 |
方法 | 功能 | 起始版本 |
---|---|---|
enableVirtualBackground | 开启或关闭虚拟背景。 | V4.6.0 |
getFeatureSupportedType | 查询当前设备是否支持开启指定功能(例如虚拟背景功能)。 | V5.6.30 |
事件 | 描述 | 起始版本 |
---|---|---|
onVirtualBackgroundSourceEnabled | 通知虚拟背景功能是否成功启用的回调。 | V4.6.0 |
方法 | 功能 | 起始版本 |
---|---|---|
setCloudProxy | 开启并设置云代理服务。 | V4.6.0 |
方法 | 功能 | 起始版本 |
---|---|---|
enumerateRecordDevices | 枚举音频采集设备。 | V3.5.0 |
setRecordDevice | 设置音频采集设备。 | V3.5.0 |
getRecordDevice | 获取当前音频采集设备。 | V3.5.0 |
enumeratePlayoutDevices | 枚举音频播放设备。 | V3.5.0 |
setPlayoutDevice | 设备音频播放设备。 | V3.5.0 |
getPlayoutDevice | 获取当前音频播放设备。 | V3.5.0 |
setRecordDeviceVolume | 设置当前音频采集设备音量。 | V3.5.0 |
getRecordDeviceVolume | 获取当前音频采集设备音量。 | V3.5.0 |
setPlayoutDeviceVolume | 设置当前音频播放设备音量。 | V3.5.0 |
getPlayoutDeviceVolume | 获取当前音频播放设备音量。 | V3.5.0 |
setPlayoutDeviceMute | 设置当前播放设备静音状态。 | V3.5.0 |
getPlayoutDeviceMute | 获取当前播放设备静音状态。 | V3.5.0 |
setRecordDeviceMute | 设置当前采集设备静音状态。 | V3.5.0 |
getRecordDeviceMute | 获取当前采集设备静音状态。 | V3.5.0 |
startRecordDeviceTest | 开始测试音频采集设备。 | V3.5.0 |
stopRecordDeviceTest | 停止测试音频采集设备。 | V3.5.0 |
startPlayoutDeviceTest | 开始测试音频播放设备。 | V3.5.0 |
stopPlayoutDeviceTest | 停止测试音频播放设备。 | V3.5.0 |
startAudioDeviceLoopbackTest | 开始音频采集播放设备回路测试。 | V3.5.0 |
stopAudioDeviceLoopbackTest | 停止音频采集播放设备回路测试。 | V3.5.0 |
事件 | 描述 | 起始版本 |
---|---|---|
onAudioHowling | 检测到啸叫回调。 | V3.9.0 |
方法 | 功能 | 起始版本 |
---|---|---|
enumerateCaptureDevices | 枚举视频采集设备。 | V3.5.0 |
setDevice | 设置视频采集设备。 | V4.6.20 |
getDevice | 获取当前视频采集设备。 | V4.6.20 |
方法 | 功能 | 起始版本 |
---|---|---|
onAudioDeviceStateChanged | 音频设备状态更改回调。 | V3.5.0 |
onAudioDefaultDeviceChanged | 音频默认设备更改回调。 | V3.5.0 |
onVideoDeviceStateChanged | 视频设备状态更改回调。 | V3.5.0 |
方法 | 功能 | 起始版本 |
---|---|---|
initSpatializer | 初始化空间音效。 | V5.5.10 |
enableSpatializer | 开启/关闭空间音效。 | V5.4.0 |
setAudioRecvRange | 设置空间音效的距离衰减属性和语音范围。 | V5.4.0 |
setSpatializerRoomProperty | 设置房间混响属性。 | V5.4.0 |
enableSpatializerRoomEffects | 开启或关闭空间音效的房间混响效果。 | V5.4.0 |
updateSelfPosition | 设置说话者和接收者的位置信息。 | V5.5.10 |
setSpatializerRenderMode | 设置渲染模式。 | V5.4.0 |
setRangeAudioTeamID | 设置范围语音的队伍号。 | V5.5.10 |
setRangeAudioMode | 设置范围语音的模式。 | V5.5.10 |
setSubscribeAudioAllowlist | 设置只订阅指定用户的音频流。 | V5.5.10 |
setSubscribeAudioBlocklist | 设置不订阅指定用户的音频流。 | V5.5.10 |
方法 | 功能 | 起始版本 |
---|---|---|
startAudioDump | 开始记录音频 dump。 | V3.5.0 |
startAudioDump | 开始记录音频 dump。 | V4.6.10 |
stopAudioDump | 结束记录音频 dump | V3.5.0 |
getErrorDescription | 获取错误信息。 | V3.5.0 |
uploadSdkInfo | 上传 SDK 日志信息。 | V3.5.0 |
事件 | 描述 | 起始版本 |
---|---|---|
onError | 发生错误回调。 | V3.5.0 |
onWarning | 发生警告回调。 | V3.5.0 |