RTC 实时音视频

CloudHubSDK Electron

CloudHub 通过全球部署的虚拟网络，提供可以灵活搭配的 API 组合，为移动端到移动端以及移动端到 Web 端提供质量可靠的实时音视频通信。

RtcEngine 类包含应用程序调用的主要方法。
RtcEngine.on 类用于向应用程序发送回调通知。

频道管理

方法	描述
initialize	初始化SDK引擎
setChannelProfile	设置频道场景
setClientRole	设置用户角色
joinChannel	加入频道
leaveChannel	离开频道
renewToken	更新token
on	绑定监听事件
off	取消绑定监听事件
offAll	取消绑定 event 所有的监听事件
setLogFile	设置日志文件

事件	描述
onConnectionStateChanged	网络连接状态发生改变
onJoinChannel	加入频道成功
onRejoinChannel	断线后重新加入频道成功
onLeaveChannel	离开频道回调
onUserJoined	远端用户(通信场景)/主播(直播场景)加入当前频道
onUserLeaved	远端用户(通信场景)/主播(直播场景)离开当前频道
onTokenPrivilegeWillExpire	token即将过期
onRequestToken	token已经过期，需要更新
onLocaluserPerssionChanged	本地用户发布或订阅权限发生变化
onServerForceCloseChannel	频道被强制关闭

音频管理

方法	描述
setAudioQuality	设置本地发送音频质量
adjustRecordingSignalVolume	调节麦克风采集信号音量
adjustPlaybackSignalVolume	调节本地播放的所有远端用户信号音量
adjustUserPlaybackSignalVolume	调节本地播放的指定远端用户音量
enableLocalAudio	开/关本地音频采集
muteLocalAudioStream	发送/停止发送本地音频流
muteRemoteAudioStream	接收/停止接收指定的远端音频流
muteAllRemoteAudioStreams	接收/停止接收所有的远端音频流

事件	描述
onLocalAudioStateChanged	本地音频状态发生改变
onFirstLocalAudioFrame	本地音频首帧回调
onremoteaudiostatechanged	远端音频状态发生改变
onFirstRemoteAudioFrame	远端音频首帧回调
onLocalPublishFallbackToAudioOnly	本地发布流已回退为音频流回调
onRemoteSubscribeFallbackToAudioOnly	远端订阅流已回退为音频流回调

视频管理

方法	描述
enableVideo	启用视频模块
disableVideo	禁用视频模块
setVideoEncoderConfiguration	设置视频编码属性
setVideoMode	设置视频显示模式
setLocalVideoMirror	设置本地视频镜像模式
setupLocalVideo	开始播放本地视频
removeLocalVideo	停止播放本地视频
setupRemoteVideo	开始播放远端视频
removeRemoteVideo	停止播放远端视频
enableLocalVideo	开/关本地视频采集
muteLocalVideoStream	发送/停止发送本地视频流
muteRemoteVideoStream	接收/停止接收指定的远端视频流
muteAllRemoteVideoStreams	接收/停止接收所有的远端视频流

事件	描述
onLocalVideoStateChanged	本地视频状态发生改变
onFirstLocalVideoFrame	本地视频首帧回调
onRemoteVideoStateChanged	远端视频状态发生改变(远端视频可能是用户摄像头、屏幕共享、在线媒体文件、电影文件等)
onFirstRemoteVideoFrame	远端视频首帧回调

数据统计事件

加入频道后，SDK 每隔 2 秒自动触发本组回调。我们为这些回调提供了详细的功能描述、实现方法文档，详情请参考通话中质量监测

事件	描述
onRtcStats	当前通话统计
onNetworkQuality	网络上下行质量报告
onLocalVideoStats	本地视频流统计信息
onRemoteVideoStats	远端视频流统计信息
onLocalAudioStats	本地音频流统计信息
onRemoteAudioStats	远端音频流统计信息

视频前处理及后处理

方法	描述
setBeautyEffectOptions	开启或关闭本地美颜功能，并设置美颜效果选项
setVideoEffectOptions	开启或关闭高级美颜功能，并设置美颜效果选项

多频道管理

我们为该组接口提供了详细的场景描述、实现方法及开发注意事项文档，详情请参考加入多频道。

API	描述
createChannel	创建并获取一个 IChannel 对象。通过创建多个对象，用户可以同时加入多个频道
IChannel	该类提供在指定频道内实现实时音视频功能的方法
IChannelEventHandler	该类提供监听指定频道事件和数据的回调

屏幕共享

方法	描述
getScreenDisplaysInfo	获取屏幕信息该方法获取系统 ( macOS 或 Windows ) 屏幕 ID，以及相关信息
getScreenWindowsInfo	获取窗口信息该方法获取系统 ( macOS 或 Windows ) 窗口 ID，以及相关信息

主进程方法	描述
startScreenCaptureByDisplayId	开始桌面分享
startScreenCaptureByWindowId	通过窗口信息共享屏幕
stopScreenCapture	停止桌面分享
startSpeakerCaptureWhileSharing	共享桌面时开启桌面声音
stopSpeakerCaptureWhileSharing	共享桌面时关闭桌面声音

音乐文件播放

方法	描述
startPlayMovie	开始播放音乐文件
stopPlayMovie	停止播放音乐文件
pausePlayMovie	暂停播放音乐文件
resumePlayMovie	恢复播放音乐文件
setupLocalMovie	本地观看自己播放的音乐文件
removeLocalMovie	取消观看自己播放的音乐文件
setMoviePosition	设置音乐文件的播放进度
getMovieCurrentPosition	获取音乐文件的播放进度
getMovieInfo	获取音乐文件的信息
getMovieDuration	获取电影时长

事件	描述
onMovieProgress	本地用户的音乐文件播放进度
onFirstLocalMovieFrame	本地媒体文件首帧回调
localMovieStateChanged	本地媒体文件播放状态发生改变

⾳效文件播放

方法	描述
getEffectsVolume	获取播放音效文件音量。
setEffectsVolume	设置播放音效文件音量。
setVolumeOfEffect	设置单个音效文件的音量。
playEffect	播放指定音效文件。
stopEffect	停止播放指定音效文件。
stopAllEffects	停止播放所有音效文件。
preloadEffect	预加载音效文件
unloadEffect	释放音效文件
pauseEffect	暂停音效文件播放。
pauseAllEffects	暂停所有音效文件播放。
resumeEffect	恢复播放指定音效文件。
resumeAllEffects	恢复播放所有音效文件。

人声效果

方法	描述
setLocalVoicePitch	设置本地语音音调
setLocalVoiceEqualization	设置本地语音音效均衡
setLocalVoiceReverb	设置本地音效混响
setAudioEffectPreset	设置 SDK 预设的美声效果
enableDeepLearningDenoise	开启/关闭 AI 降噪模式

CDN推流

方法	描述
addPublishStreamUrl	增加旁路推流地址。
removePublishStreamUrl	删除旁路推流地址。
setLiveTranscoding	设置直播转码。

跨频道媒体流转发 ( 仅适用于互动直播 )

方法	描述
startChannelMediaRelay	开始跨频道媒体流转发
updateChannelMediaRelay	更新媒体流转发的频道
stopChannelMediaRelay	停止跨频道媒体流转发

事件	描述
onChannelMediaRelayStateChanged	本地媒体文件播放状态改变回调

音量提示

方法	描述
enableAudioVolumeIndication	启用/禁用说话者音量提示

事件	描述
onAudioVolumeIndication	音量回调
OnActiveSpeaker	监测到最活跃用户回调。

视频双流模式

方法	描述
enableDualStreamMode	开启或关闭大小流功能
setRemoteVideoStreamType	设置订阅的视频流类型
setRemoteDefaultVideoStreamType	设置默认订阅的视频流类型

通话前网络测试

方法	描述
startLastmileProbeTest	开始通话前网络质量探测。
stopLastmileProbeTest	停止通话前 last mile 网络质量探测。

事件	描述
onLastmileQuality	通话前网络上下行 last mile 质量报告回调。

音频播放设备管理

方法	描述
setAudioPlaybackDevice	设置音频播放设备
getAudioPlaybackDevices	获取音频播放设备
getCurrentAudioPlaybackDevice	获取当前扬声器
setAudioPlaybackDeviceMute	静音/取消静音音频播放设备
getAudioPlaybackDeviceMute	获取音频播放设备的静音状态
setAudioPlaybackVolume	设置音频播放设备的音量
getAudioPlaybackVolume	获取音频播放设备的音量
startAudioPlaybackDeviceTest	开始扬声器检测
stopAudioPlaybackDeviceTest	停止扬声器检测
startAudioDeviceLoopbackTest	开始音频设备回路测试
stopAudioDeviceLoopbackTest	停止音频设备回路测试
followSystemPlaybackDevice	设置 SDK 使用的音频播放设备跟随系统默认的音频播放设备

音频采集设备管理

方法	描述
setAudioRecordingDevice	设置麦克风
getAudioRecordingDevices	获取麦克风列表
getCurrentAudioRecordingDevice	获取当前麦克风
setAudioRecordingDeviceMute	静音/取消静音录音设备
getAudioRecordingDeviceMute	获取录音设备的静音状态
setAudioRecordingVolume	设置录音设备的音量
getAudioRecordingVolume	获取录音设备的音量
startAudioRecordingDeviceTest	开始麦克风检测
stopAudioRecordingDeviceTest	停止麦克风检测
startAudioDeviceLoopbackTest	开始音频设备回路测试
stopAudioDeviceLoopbackTest	停止音频设备回路测试
followSystemRecordingDevice	设置 SDK 使用的音频采集设备跟随系统默认的音频采集设备

事件	描述
onAudioDeviceStateChanged	音频设备状态变化

视频设备管理

方法	描述
enableMultiStream	启用多摄像头
setVideoDevice	设置摄像头
getVideoDevices	获取摄像头列表
getCurrentVideoDevice	获取当前摄像头
startVideoDeviceTest	开始摄像头检测
stopVideoDeviceTest	停止摄像头检测

事件	描述
onVideoDeviceStateChanged	视频设备状态变化

发布管理

方法	描述
publish	开始发布本地音视频流
unPublish	停止发布本地音视频流

录制相关方法

方法	描述
startServerRecord	开始录制
stopServerRecord	停止录制
pauseServerRecord	暂停录制
resumeServerRecord	恢复录制

事件	描述
onRecordMsg	录制状态发生改变

高级信令

方法	描述
setProperty	为频道内某个用户设置自定义属性
sendChatMsg	发送聊天消息
pubMsg	发布一条自定义消息
delMsg	删除一条自定义消息
evictUser	将一个用户踢出房间

事件	描述
onSetProperty	用户自定义属性发生变化
onChatMsg	收到聊天消息
onPubMsg	自定义消息被发布
onDelMsg	自定义消息被删除
onLocalUserEvicted	本地用户被踢出房间

其他方法

方法	描述
getVersion	获取SDK的版本号

其他事件

事件	描述
onError	发生错误
onServerTime	服务器时间通知