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

RTS 实时流直播


CloudHubRTS CPP

IUpStream接口

getStreamID

获取 流ID

const char* getStreamID()

返回

推流

请确保在调用其他 API 前先调用 createUpStream 创建推流器

startPush

开始推流

int startPush(const char* url)

参数

参数描述
url推流地址。该字符长度不能超过 1024 字节。url 不支持中文字符等特殊字符

返回

stopPush

停止推流

int stopPush()

返回

getUrl

获取url地址

const char* getUrl()

返回

getClientID

获取Client ID

const char* getClientID()

返回

isPushing

是否正在推流

bool isPushing()

返回

视频推流

getVideoDeviceManager

获取视频设备

cloudhub::IVideoDeviceManager* getVideoDeviceManager()

返回

setRenderView

设置预览窗口

int setRenderView(void* view)

参数

参数描述
view用于预览视频的窗口句柄

返回

setVideoQuality

设置推流视频质量

int setVideoQuality(int width,int height,
                              cloudhub::FRAME_RATE fr)

参数

参数描述
width视频宽
height视频高
fr视频帧率 详见 FRAME_RATE

返回

setBeautyEffectOptions

设置美颜

int setBeautyEffectOptions(bool enabled, const cloudhub::BeautyOptions* options)

参数

参数说明
enabled是否开启美颜功能:

* true:开启
* false:(默认)关闭
options美颜选项,详细定义见 BeautyOptions。如果options为NULL,表示只控制美颜的打开或关闭,不调整之前设置过的美颜选项的参数值

返回

setVideoEffectOptions

设置高级美颜和贴纸

int setVideoEffectOptions(bool enabled, const cloudhub::VideoEffectOptions* options)

参数

参数说明
enabled是否开启高级美颜功能:

* true:开启
* false:(默认)关闭
options美颜选项,详细定义见 VideoEffectOptions。如果options为NULL,表示只控制美颜的打开或关闭,不调整之前设置过的美颜选项的参数值

返回

startCamera

开始摄像头采集

int startCamera()

返回

stopCamera

停止摄像头采集

void stopCamera()

媒体文件

startMediaFile

开始播放媒体文件

int startMediaFile(const char* mediaFile)

参数

参数描述
mediaFile媒体文件

返回

stopMediaFile

停止播放媒体文件

void stopMediaFile(const char* mediaFile)

参数

参数描述
mediaFile媒体文件

pauseMediaFile

暂停播放媒体文件

void pauseMediaFile(const char* mediaFile)

参数

参数描述
mediaFile媒体文件

resumeMediaFile

恢复播放媒体文件

void resumeMediaFile(const char* mediaFile)

参数

参数描述
mediaFile媒体文件

屏幕共享

getValidWindowList

获取用于进行屏幕共享的窗口列表

int getValidWindowList(cloudhub::RtcValidWindow** windows,
                                 int& count,
                                 cloudhub::DESKTOP_SOURCETYPE type)

参数

参数描述
windows详见 RtcValidWindow
count窗口数量
type详见 DESKTOP_SOURCETYPE

返回

详情

destroyValidWindowList

销毁窗口列表数据

int destroyValidWindowList(cloudhub::RtcValidWindow* windows)

参数

参数描述
windows窗口列表指针,详见 RtcValidWindow

返回

startScreenCaptureByDisplayId

通过屏幕 ID 共享屏幕

int startScreenCaptureByDisplayId(intptr_t displayId,
      const cloudhub::ScreenCaptureParameters& captureParams)

参数

参数描述
displayId指定待共享的屏幕 ID。开发者需要通过该参数指定你要共享的那个屏幕
captureParams屏幕共享的参数配置。默认的分辨率为 1920 x 1080,即 2073600 像素,详见 ScreenCaptureParameters

返回

详情

共享一个屏幕或该屏幕的部分区域。用户需要在该方法中指定想要共享的屏幕 ID

startScreenCaptureByWindowId

通过窗口 ID 共享窗口

int startScreenCaptureByWindowId(intptr_t displayId,
      const cloudhub::ScreenCaptureParameters& captureParams)

参数

参数描述
windowId指定待共享的窗口 ID。开发者需要通过该参数指定你要共享的那个窗口
captureParams窗口共享的参数配置。默认的分辨率为 1920 x 1080,即 2073600 像素,详见 ScreenCaptureParameters

返回

详情

共享一个窗口或该窗口的部分区域。用户需要在该方法中指定想要共享的窗口 ID

stopScreenCapture

停止屏幕共享

int stopScreenCapture()

返回

视频自采集(仅 Push 模式)

addExternalVideoSource

添加视频设备

int addExternalVideoSource(const char* sourceID)

参数

参数描述
sourceID设备 Id

返回

deleteExternalVideoSource

移除视频设备

int deleteExternalVideoSource(const char* sourceID)

参数

参数描述
sourceID设备 Id

返回

pushFrame

输入一帧外部视频源数据

int pushFrame(const char* sourceID, const VideoFrame& frame)

参数

参数描述
sourceID设备 Id
frame视频帧,详见 VideoFrame

返回

音频推流

getAudioDeviceManager

获取音频设备

cloudhub::IAudioDeviceManager* getAudioDeviceManager()

返回

一个包含系统中所有音频设备的 IAudioDeviceManager 对象

addExternalAudioSource

添加外部音频源 (目前只支持添加一路)

int addExternalAudioSource(const char* sourceID, int flags = 0)

参数

参数描述
sourceID音频源id, 非空
flags保留,不使用

返回

deleteExternalAudioSource

删除外部音频源

int deleteExternalAudioSource(const char* sourceID)

参数

参数描述
sourceID音频源id, 非空

返回

pushAudioFrame

为音频源添加数据

int pushAudioFrame(const char* sourceID, const cloudhub::AudioFrame& frame)

参数

参数描述
sourceID音频源id, 非空
frame音频数据, 同一路源不同frame的采样率和声道数(1或者2)必须保持不变.目前仅支持s16格式

返回

startMicrophone

开启音频采集

void startMicrophone()

stopMicrophone

停止音频采集

void stopMicrophone()

setAudioQuality

设置本地发送音频质量

int setAudioQuality(cloudhub::AUDIO_QUALITY quality)

参数

参数描述
quality音频质量,详见 AUDIO_QUALITY

返回

enableVolumeIndication

启用用户音量提示

int enableVolumeIndication(int interval)

参数

参数描述
interval指定音量提示的时间间隔:
• ≤ 0: 禁用音量提示功能
• > 0: 返回音量提示的间隔,单位为毫秒。建议设置到大于 200 毫秒。最小不得少于 10 毫秒,否则会 收不到 onAudioVolumeIndication 回调

返回

详情

该方法允许 SDK 定期向 app 报告本地发流用户和瞬时音量最高的远端用户(最多 3 位)的音量相关信息。启用该方法后,只要频道内有发流用户, SDK 会在加入频道后按设置的时间间隔触发 onAudioVolumeIndication 回调

回调监听

registerFrameObserver

注册FrameObserver

int registerFrameObserver(cloudhub::IFrameObserver* observer)

参数

参数描述
observer详见 IFrameObserver

返回

unRegisterFrameObserver

注销FrameObserver

int unRegisterFrameObserver(cloudhub::IFrameObserver* observer)

参数

参数描述
observer详见 IFrameObserver

返回

enableDeepLearningDenoise

开启或关闭 AI 降噪模式。

int enableDeepLearningDenoise(bool enabled) = 0;

参数

参数描述
enabled是否开启 AI 降噪模式:
true: (默认)开启。
false: 关闭。

返回