CloudHubRTS Electron
- 概览
- RtsEngine
- RtsUpStream
- RtsUpStreamEventHandler
- RtsDownStream
- RtsDownStreamEventHandler
- RtsMixingUpstream
- RtsMixingUpstreamEventHandler
- RtsServerStreamMixing
- RtsServerStreamMixingEventHandler
- RtsDevicesManager
- 更新日志
概览
接口类定义
- RtsEngine 推拉流器管理
- RtsUpStream 包含推流器的主要方法
- RtsUpStreamEventHandler 用于推流器回调通知
- RtsDownStream 包含拉流器的主要方法
- RtsDownStreamEventHandler 用于拉流器回调通知
- RtsMixingUpstream 包含客户端混流推流器的主要方法
- RtsMixingUpstreamEventHandler 用于客户端混流推流器的回调通知
- RtsServerStreamMixing 包含服务器端混流的主要方法
- RtsServerStreamMixingEventHandler 用于服务器端混流的回调通知
- RtsDevicesManager 设备管理
推拉流器管理
| 方法 | 描述 |
|---|---|
| RtsUpStream | 初始化推流器 |
| RtsDownStream | 初始化拉流器 |
| RtsMixingUpstream | 初始化客户端混流推流器 |
| RtsServerStreamMixing | 初始化服务器端混流 |
推流器管理
推流方法
| 方法 | 描述 |
|---|---|
| getVersion | 获取版本 |
| getStreamID | 获取流id |
| getClientId | 获取获取用户id |
| startPush | 开始推流 |
| stopPush | 停止推流 |
| isPushing | 是否正在推流 |
| setVideoQuality | 设置推流视频质量 |
| startCamera | 开始摄像头采集 |
| stopCamera | 停止摄像头采集 |
| startMicrophone | 开启音频采集 |
| stopMicrophone | 停止音频采集 |
| setAudioQuality | 设置本地发送音频质量 |
| enableVolumeIndication | 启用用户音量提示 |
| setupLocalVideo | 播放本地视频 |
| removeLocalVideo | 停止播放本地视频 |
| getSourceId | 推流id |
| getUrl | 获取url地址 |
| setBeautyEffectOptions | 开启或关闭本地美颜功能，并设置美颜效果选项 |
| setVideoEffectOptions | 开启或关闭高级美颜，并设置美颜效果选项 |
| startPlayMovie | 播放本地视频 |
| setupLocalMovie | 观看本地视频 |
| removeLocalMovie | 停止本地播放 |
| stopPlayMovie | 停止本地视频 |
| pauseMediaFile | 暂停播放本地视频 |
| getMovieInfo | 获取本地电影的基本信息 |
| resumeMediaFile | 恢复播放本地电影 |
| getMovieDuration | 获取电影时长 |
| getMovieCurrentPosition | 获取本地电影的进度 |
| setMoviePosition | 设置本地电影播放进度 |
| getScreenWindowsInfo | 获取应用窗口信息 |
| getScreenDisplaysInfo | 获取屏幕信息 |
| startScreenCaptureByDisplayId | 开始屏幕共享 |
| startScreenCaptureByWindowId | 通过窗口信息共享屏幕。app |
| stopScreenCapture | 停止屏幕共享 |
| startSpeakerCaptureWhileSharing | 共享桌面开启桌面声音 |
| stopSpeakerCaptureWhileSharing | 共享桌面关闭桌面声音 |
| getDeviceManager | 获取设备管理对象 |
| 事件 | 描述 |
|---|---|
| onFirstlocalvideoframe | 本地视频首帧回调 |
| onApierror | 调用参数错误的回调 |
| onVolumeindication | 说话者音量提示回调。该回调报告频道内每个发布音频数据的用户的音量 |
| onRtsstats | 当前通话统计，通话统计信息 |
| onAudiodevicestatechanged | 音频设备状态变化回调 |
| onVideodevicestatechanged | 视频设备状态变化回调 |
| onVideosizechanged | 视频尺寸改变回调 |
| onPushstateupdated | 推流状态变化回调 |
| onFirstlocalaudioframe | 本地音频首帧回调 |
| onLocalVideoStateChanged | 本地视频状态改变回调,本地视频的状态发生改变时，SDK 会触发该回调报告当前的本地视频状态 |
| onLocalAudioStateChanged | 本地音频状态改变回调。,本地音频的状态发生改变时，（包括本地麦克风录制状态和音频编码状态） |
| onError | 发生错误回调 |
人声效果
| 事件 | 描述 |
|---|---|
| enableDeepLearningDenoise | 开启/关闭 AI 降噪模式 |
拉流器管理
拉流方法
| 方法 | 描述 |
|---|---|
| getVersion | 获取版本 |
| getClientId | 获取获取用户id |
| startPull | 开始拉流 |
| stopPull | 停止拉流 |
| isPulling | 是否正在拉流 |
| resumeAudio | 恢复播放音频 |
| pauseAudio | 暂停播放音频 |
| pauseVideo | 停止播放视频 |
| resumeVideo | 恢复播放视频 |
| enableVolumeIndication | 启用用户音量提示 |
| getUrl | 获取url地址 |
| setupRemoteVideo | 设置远端流 |
| removeRemoteVideo | 停止播放远端视频 |
| getSourceId | 拉流id |
| setStreamConfigs | 设置流配置项 |
| getDeviceManager | 获取设备管理对象 |
| 事件 | 描述 |
|---|---|
| onVolumeindication | 说话者音量提示回调 |
| onRtsstats | 当前通话统计，通话统计信息 |
| onPullstateupdated | 拉流状态变化 |
| onVideosizechanged | 视频尺寸改变 |
| onRemoteVideoStateChanged | 远端视频流状态已变化回调 |
| onFirstremotevideoframe | 远端视频首帧回调 |
| onFirstremoteaudioframe | 本地音频首帧回调 |
| onRemoteAudioStateChanged | 远端音频流状态已变化回调 |
客户端混流推流管理
推流方法
| 方法 | 描述 |
|---|---|
| startPush | 开始推流 |
| stopPush | 停止推流 |
| getUrl | 获取url地址 |
| getClientId | 获取获取用户id |
| configMixing | 混流配置 |
| isPushing | 是否正在推流 |
| setupLocalVideo | 播放本地视频 |
| removeLocalVideo | 停止播放本地视频 |
| 事件 | 描述 |
|---|---|
| onPushstateupdated | 混流推流状态回调 |
| onRtsstats | 统计信息回调 |
| onError | 发生错误回调 |
服务器端混流管理
混流方法
| 方法 | 描述 |
|---|---|
| startMixing | 开始混流 |
| stopMixing | 停止混流 |
| configMixing | 混流配置 |
| 事件 | 描述 |
|---|---|
| onError | 发生错误回调 |
设备管理
设备管理
| 方法 | 描述 |
|---|---|
| getVideoDevices | 获取摄像头列表 |
| getCurrentVideoDevice | 获取当前的摄像头 |
| setVideoDevice | 设置摄像头 |
| getAudioPlaybackDevices | 获取扬声器列表 |
| setAudioPlaybackDevice | 设置扬声器 |
| getPlaybackDeviceInfo | 获取播放设备信息（扬声器） |
| getCurrentAudioPlaybackDevice | 获取当前的扬声器 |
| setAudioPlaybackVolume | 设置音频播放设备的音量 |
| getAudioPlaybackVolume | 获取音频播放设备的音量 |
| getAudioRecordingDevices | 获取麦克风列表 |
| setAudioRecordingDevice | 设置麦克风 |
| getRecordingDeviceInfo | 获取录制设备信息 (麦克风) |
| getCurrentAudioRecordingDevice | 获取当前的麦克风 |
| getAudioRecordingVolume | 获取录音设备的音量 |
| setAudioRecordingVolume | 设置录音设备的音量 |
| startAudioPlaybackDeviceTest | 测试扬声器 |
| stopAudioPlaybackDeviceTest | 停止测试扬声器 |
| startAudioRecordingDeviceTest | 开始测试麦克风 |
| stopAudioRecordingDeviceTest | 停止测试麦克风 |
| getAudioPlaybackDeviceMute | 获取音频播放设备的静音状态(无返回值) |
| setAudioPlaybackDeviceMute | 静音/取消静音音频播放设备 |
| getAudioRecordingDeviceMute | 获取录音设备的静音状态 |
| setAudioRecordingDeviceMute | 静音/取消静音录音设备 |