CloudHubRTS Electron

推流音视频相关

getVersion

获取版本

getVersion(): string

getStreamID

获取流ID

getStreamID(): string

getClientId

获取用户id

getClientId(): string

startPush

开始推流

startPush(urlPush: string)

参数	说明
urlPush	要推流的地址

stopPush

停止推流

stopPush()

isPushing

是否正在推流

isPushing(): boolean

true 成功
false 失败

setVideoQuality

设置推流视频质量

setVideoQuality(width: number, height: number, fr: number): number

参数	说明
width	视频宽
height	视频高
fr	视频帧率取值：1,7,10,15,24,30

0 成功
-1 失败

startCamera

开始摄像头采集

startCamera(deviceId: string)

参数	说明
deviceId	摄像头设备id，可以不传,默认为' '

stopCamera

停止摄像头采集

stopCamera(deviceId: string)

参数	说明
deviceId	摄像头设备id，可以不传,默认为' '

startMicrophone

开启音频采集

startMicrophone()

stopMicrophone

停止音频采集

stopMicrophone()

setAudioQuality

设置本地发送音频质量

setAudioQuality(quality = 1)

参数	说明
quality	音频质量默认 1 （取值范围：0,1,2,3,4,5,6 值越大，质量越好）

enableVolumeIndication

启用用户音量提示

enableVolumeIndication(interval: number)

参数	说明
interval	指定音量提示的时间间隔： <=0 ：禁用音量提示功能。 >0 ：返回音量提示的间隔，单位为毫秒。

0 成功
非0 失败

setupLocalVideo

播放本地视频

setupLocalVideo(view: Element)

参数	说明
view	播放视频窗口元素

removeLocalVideo

停止播放本地视频

removeLocalVideo()

getSourceId

获取推流ID

getSourceId():string

推流id string类型

getUrl

获取url地址

getUrl():string

获取url地址 string类型

美颜

setBeautyEffectOptions

开启或关闭本地美颜功能，并设置美颜效果选项

setBeautyEffectOptions(enable = false, options: object, deviceId = '')

参数	说明
enable	是否开启美颜
options	设置美颜选项: lighteningContrastLevel 对比度，与 lighteningLevel 搭配使用。取值越大，明暗对比越强烈取值范围 0 \|1\| 2 lighteningLevel 亮度，可用来实现美白等视觉效果。取值范围为 [0.0, 1.0]，其中 0.0 表示原始亮度，默认值为 0.7 smoothnessLevel 红润度，可用来实现红润肤色等视觉效果。取值范围为 [0.0, 1.0]，其中 0.0 表示原始红润度，默认值为 0.1 rednessLevel 平滑度，可用来实现祛痘、磨皮等视觉效果。取值范围为 [0.0, 1.0]，其中 0.0 表示原始平滑等级，默认值为 0.5
deviceId	摄像头id

0 成功
非0 失败

setVideoEffectOptions

开启或关闭高级美颜，并设置美颜效果选项

setVideoEffectOptions(enable = false, options: object, deviceId = '')

参数	说明
enable	是否开启美颜
options	设置美颜选项: sharpLevel 锐化，取值范围为 [0.0, 1.0]，其中 0.0 表示原始效果，默认值为 0.5。可用来实现锐化等视觉效果。 thinFaceLevel 瘦脸，取值范围为 [0.0, 1.0]，其中 0.0 表示原始效果，默认值为 0.5。可用来实现瘦脸等视觉效果。 bigEyesLevel 大眼，取值范围为 [0.0, 1.0]，其中 0.0 表示原始效果，默认值为 0.5。可用来实现大眼等视觉效果。 sticker 贴纸 0-无 1-公主面具 2-黑猫眼镜 3-卡通男孩 4-卡通女孩 5-搞怪宝宝 6-圣诞麋鹿 7-生日快乐 8-甜甜甜筒 9-招财猫 10-可爱猪猪。 portraitBackground 虚拟背景 0-无 1-蓝天 2-草坪 3-白墙
deviceId	摄像头id

0 成功
非0 失败

视频文件相关

startPlayMovie

播放本地电影

startPlayMovie(mediaFile: string)

参数	说明
mediaFile	本地电影的绝对路径

setupLocalMovie

观看本地视频

setupLocalMovie(view: Element,movieUrl: string)

参数	说明
view	播放视频窗口元素
movieUrl	本地电影的绝对路径

removeLocalMovie

停止本地播放

removeLocalMovie()

stopPlayMovie

停止播放本地电影

stopPlayMovie(url: string)

参数	说明
url	视频文件的绝对路径

pauseMediaFile

暂停本地电影

pauseMediaFile(mediaFile: string)

参数	说明
mediaFile	本地电影的绝对路径

getMovieInfo

获取本地电影的基本信息

getMovieInfo(mediaFile: string)

参数	说明
mediaFile	本地电影的绝对路径

hasVideo :true/false hasAudio :true/false

resumeMediaFile

继续播放本地电影

resumeMediaFile(mediaFile: string)

参数	说明
mediaFile	本地电影的绝对路径

getMovieDuration

获取电影时长

 getMovieDuration(mediaFile: string)

参数	说明
mediaFile	本地电影的绝对路径

返回 number

getMovieCurrentPosition

获取本地电影的进度

getMovieCurrentPosition(mediaFile: string)

参数	说明
mediaFile	本地电影的绝对路径

返回媒体当前播放时长 number类型

setMoviePosition

设置本地电影播放进度

setMoviePosition(mediaFile: string, pos: string)

参数	说明
mediaFile	本地电影的绝对路径
pos	设置的进度,要移动的目标时间，以毫秒为单位

桌面分享

getScreenWindowsInfo

获取系统窗口ID

getScreenWindowsInfo()

返回应用窗口信息数组格式

getScreenDisplaysInfo

获取屏幕ID

getScreenDisplaysInfo()

返回屏幕信息, 数组格式

startScreenCaptureByDisplayId

开始屏幕共享

startScreenCaptureByDisplayId(
        displayId: number,
        excludeWindow: number,
        framerate: number,
        bitrate: number,
        isCaptureCursor: boolean
    )

参数	说明
displayId	共享的屏幕id
excludeWindow	不共享的窗口id 只能不共享一个窗口
framerate	帧率
bitrate	码率
isCaptureCursor	是否捕获鼠标

startScreenCaptureByWindowId

通过窗口信息共享屏幕。

startScreenCaptureByWindowId(
        windowId: number,
        excludeWindow = 0,
        framerate = 5,
        bitrate = 1200,
        isCaptureCursor = false
    )

参数	说明
displayId	共享的windowId
excludeWindow	不共享的窗口id 只能不共享一个窗口
framerate	帧率
bitrate	码率
isCaptureCursor	是否捕获鼠标

stopScreenCapture

停止屏幕共享

stopScreenCapture()

startSpeakerCaptureWhileSharing

共享桌面开启桌面声音

startSpeakerCaptureWhileSharing()

stopSpeakerCaptureWhileSharing

共享桌面关闭桌面声音

stopSpeakerCaptureWhileSharing()

getDeviceManager

获取设备管理对象

getDeviceManager()

返回对象格式,里面包含了设备管理的相关方法

enableDeepLearningDenoise

开启或关闭 AI 降噪模式。

rtcEngine.enableDeepLearningDenoise ( enabled ) ;

参数

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

0: 成功
非 0: 失败