CloudHub 文档中心
下载中心 文档中心

RTS 实时流直播


CloudHubRTS CPP

CloudHubRTS C++ 版接口概览

CloudHubRTS C++ 版接口,提供更底层的操作接口和更丰富的数据回调接口。支持windows和MAC平台。

接口类定义

IEngine接口管理

方法类别描述
createUpStreamRTS 推流器创建 RTS 推流器
deleteUpStreamRTS 推流器删除 RTS 推流器
createMixingUpStreamRTS 客户端混流推流器创建 RTS 客户端混流推流器
deleteMixingUpStreamRTS 客户端混流推流器删除 RTS 客户端混流推流器
createDownStreamRTS 拉流器创建 RTS 拉流器
deleteDownStreamRTS 拉流器删除 RTS 拉流器
startServerStreamMixingRTS 服务器流混开始 RTS 服务器流混
configServerStreamMixingRTS 服务器流混配置 RTS 服务器流混的配置项
stopServerStreamMixingRTS 服务器流混停止 RTS 服务器流混
getAudioDeviceManagerIEngine获取音频设备
getVideoDeviceManagerIEngine获取视频设备
GetSdkVersionIEngine获取SDK版本

RTS 推流器 接口管理

推流管理

方法描述
getStreamID获取流ID
startPush开始推流
stopPush停止推流
getUrl获取url地址
getClientID获取ClientID
isPushing是否正在推流

推流视频管理

方法描述
getVideoDeviceManager获取视频设备
setRenderView设置渲染view
setVideoQuality设置本地视频质量
setBeautyEffectOptions设置美颜
setVideoEffectOptions设置高级美颜
startCamera开始视频采集
stopCamera停止视频采集

推流媒体文件管理

方法描述
startMediaFile开始播放媒体文件
stopMediaFile停止播放媒体文件
pauseMediaFile暂停播放媒体文件
resumeMediaFile恢复播放媒体文件

推流屏幕共享

方法描述
getValidWindowList获取用于进行屏幕共享的窗口列表
destroyValidWindowList销毁窗口列表数据
startScreenCaptureByDisplayId通过屏幕 ID 共享屏幕
startScreenCaptureByWindowId通过窗口 ID 共享窗口
stopScreenCapture停止屏幕共享

推流视频自采集(仅 Push 模式)

方法描述
addExternalVideoSource添加视频设备
deleteExternalVideoSource移除视频设备
pushFrame输入一帧外部视频源数据

推流音频管理

方法描述
getAudioDeviceManager获取音频设备
startMicrophone开启音频采集
stopMicrophone停止音频采集
setAudioQuality设置本地发送音频质量
enableVolumeIndication启用用户音量提示

外部音频源

方法描述
addExternalAudioSource添加外部音频源 (目前只支持添加一路)
deleteExternalAudioSource删除外部音频源
pushAudioFrame为音频源添加数据

推流音视频数据回调监听

方法描述
registerFrameObserver注册FrameObserver
unRegisterFrameObserver注销FrameObserver

推流回调事件

事件描述
onCaptureFirstAudioFrame捕获本地音频首帧回调
onCaptureFirstVideoFrame捕获本地视频首帧回调
onPushStatusUpdate推流连接状态回调
onLocalAudioStateChanged本地音频状态改变回调
onLocalVideoStateChanged本地视频状态发生改变回调
onStatisticsUpdate统计信息回调
onAudioVolumeIndication音量回调
onVideoDeviceStateChanged视频设备变化回调
onAudioDeviceStateChanged音频设备变化回调
onError发生错误回调

人声效果

方法描述
enableDeepLearningDenoise开启/关闭 AI 降噪模式

RTS 拉流器 接口管理

拉流管理

方法描述
startPull开始拉流
stopPull停止拉流
getUrl获取url地址
isPulling是否正在拉流

拉流视频管理

方法描述
setRenderView设置渲染view
pauseVideo暂停拉取视频
resumeVideo恢复拉取视频

拉流音频管理

方法描述
getAudioDeviceManager获取音频设备
pauseAudio暂停拉取音频
resumeAudio恢复拉取音频
enableVolumeIndication启用用户音量提示

拉流音视频数据回调监听

方法描述
registerFrameObserver注册FrameObserver
unRegisterFrameObserver注销FrameObserver

拉流回调事件

事件描述
onFirstRemoteAudioFrame远端音频首帧回调
onFirstRemoteVideoFrame首帧远端视频回调
onRemoteVideoSizeChange远端视频尺寸变更回调
onPullStatusUpdate拉流连接状态回调
onRemoteVideoStateChanged远端视频状态发生改变回调
onRemoteAudioStateChanged远端音频流状态发生改变回调
onAudioVolumeIndication音量回调
onStatisticsUpdate统计信息回调
onError发生错误回调

RTS 客户端混流推流器 接口管理

客户端混流推流管理

方法描述
startPush开始推流
stopPush停止推流
getUrl获取url地址
getClientID获取ClientID
configMixing混流配置
isPushing是否正在推流

客户端混流推流数据回调监听

方法描述
registerFrameObserver注册FrameObserver
unRegisterFrameObserver注销FrameObserver

客户端混流推流回调事件

事件描述
onPushStatusUpdate混流推流状态回调
onStatisticsUpdate统计信息回调
onError发生错误回调

RTS 服务器端混流 接口管理

服务器端混流回调事件

事件描述
onError发生错误回调

IFrameObserver音视频数据回调 接口管理

音视频数据回调事件

事件描述
onLocalAudioFrame本地音频数据回调
onLocalMixedAudioFrame本地混流音频数据回调
onLocalVideoFrame本地视频数据回调
onLocalMixedVideoFrame本地混流视频数据回调
onRemoteAudioFrame远端音频数据回调
onRemoteVideoFrame远端视频数据回调

音视频设备 接口管理

视频设备管理

该组方法仅适用于 Windows。

方法描述
enumerateVideoDevices获取系统中所有的视频设备列表
startDeviceTest启动视频采集设备测试
stopDeviceTest停止视频采集设备测试
getDevice获取某个被索引的视频采集设备的指定信息
setDevice指定设备
CaptureStarted开始视频捕获
release释放设备

视频设备收集器

该组方法仅适用于 Windows。

方法描述
getCount获取系统中被索引的视频采集或播放设备的总数
getDevice获取某个被索引的视频采集设备的指定信息
setDevice指定设备
release释放设备

音频设备管理

该组方法仅适用于 Windows。

方法描述
enumeratePlaybackDevices获取系统中所有的播放设备
enumerateRecordingDevices获取系统中所有的录音设备
setPlaybackDevice指定播放设备
setRecordingDevice指定录音设备
startPlaybackDeviceTest启动播放设备测试
stopPlaybackDeviceTest停止播放设备测试
setPlaybackDeviceVolume设置播放设备音量
getPlaybackDeviceVolume获取播放设备音量
setRecordingDeviceVolume设置录音设备音量
getRecordingDeviceVolume获取录音设备音量
setPlaybackDeviceMute静音播放设备
getPlaybackDeviceMute获取播放设备静音状态
setRecordingDeviceMute静音录音设备
getRecordingDeviceMute获取录音设备静音状态
startRecordingDeviceTest启动录音设备测试
stopRecordingDeviceTest停止录音设备测试
getPlaybackDevice获取播放设备
getPlaybackDeviceInfo获取播放设备信息
getRecordingDevice获取麦克风设备
getRecordingDeviceInfo获取麦克风设备信息
startAudioDeviceLoopbackTest开始音频设备回路测试
stopAudioDeviceLoopbackTest停止音频设备回路测试
release释放设备

音频设备收集器

该组方法仅适用于 Windows。

方法描述
getCount获取音频设备数量
getDevice获取某个被索引的音频采集设备的指定信息
setDevice指定设备
release释放设备
setApplicationVolume设置应用音量
getApplicationVolume获取应用音量
setApplicationMute设置静音
isApplicationMute应用是否静音状态
release释放设备