文档首页 > > SDK参考> Electron SDK> 接口参考> HRTCEngine> 接口总览

接口总览

分享
更新时间:2021/01/07 GMT+08:00

本章节介绍了Electron SDK的HRTCEngine接口详情。

基础接口

表1 基础接口

接口

描述

initialize

初始化RTCEngine实例。

release

释放RTCEngine实例。

getVersion

获取SDK版本号。

joinRoom

加入房间。

leaveRoom

离开房间。

setUserRole

设置用户角色。

renewSignature

更新签名。

setupLocalView

设置本地视图及本地视图的显示模式。

startRemoteStreamView

订阅远端主流。

stopRemoteStreamView

取消订阅远端主流。

startRemoteSubStreamView

订阅远端辅流。

stopRemoteSubStreamView

取消订阅远端辅流。

on

监听运行时的事件。

off

取消监听运行时的事件。

日志管理

表2 日志管理接口

接口

描述

setLogParam

设置日志文件,日志级别。

logUpload

日志上传接口。

音频设备管理

表3 音频设备管理接口

接口

描述

setAudioRecordingDevice

设置音频采集设备。

getAudioRecordingDevices

获取音频采集设备列表。

getCurrentAudioRecordingDevice

获取当前的音频采集设备。

setAudioRecordingDeviceMute

设置音频采集设备静音。

getAudioRecordingDeviceMute

获取音频采集设备静音状态。

setAudioRecordingVolume

设置音频采集设备的音量。

getAudioRecordingVolume

获取音频采集的音量。

setAudioPlaybackDevice

设置音频播放设备。

getAudioPlaybackDevices

获取音频播放设备。

getCurrentAudioPlaybackDevice

获取当前的音频播放设备。

setAudioPlaybackDeviceMute

设置音频播放设备静音。

getAudioPlaybackDeviceMute

获取音频播放设备静音状态。

setAudioPlaybackVolume

设置音频播放设备的音量。

getAudioPlaybackVolume

获取音频播放设备的音量。

视频设备管理

表4 视频设备管理接口

接口

描述

setVideoDevice

设置视频采集设备。

getVideoDevices

获取视频采集设备列表。

getCurrentVideoDevice

获取当前的视频采集设备。

setLocalVideoMirror

设置本地视频镜像模式。

音频基础功能

表5 音频基础功能接口

接口

描述

muteLocalAudioStream

停止/恢复发送本地音频流。

muteRemoteAudioStream

停止/恢复接收指定音频流。

muteAllRemoteAudioStreams

停止/恢复接收所有音频流。

setRemoteAudioTopNVoice

设置接收音量最大的N方的音频流。

enableLocalAudio

开启/关闭本地音频采集。

enableUserVolumeNotify

设置远端用户音量上报周期。

音频增强功能

表6 音频增强功能接口

接口

描述

adjustRecordingVolume

调节音频采集音量。

adjustPlaybackVolume

调节音频播放音量。

视频基础功能

表7 视频基础功能接口

接口

描述

enableLocalVideo

开关本地视频采集。

muteLocalVideoStream

停止/恢复发送本地音视频流。

setVideoEncParam

设置视频流的编码参数。

enableSmallVideoStream

是否开启视频大小流功能,并设置小流的编码参数。

setPriorRemoteVideoStreamType

设置默认选看的视频流类型。

setRemoteVideoStreamType

设置当前选看的视频流类型。

setViewDisplayMode

设置视频显示窗口的显示模式。

startPreview

开启视频预览。

stopPreview

停止视频预览。

视频增强功能

表8 视频增强功能接口

接口

描述

startScreenCapture

开始共享屏幕。

stopScreenCapture

停止共享屏幕。

检测功能

表9 检测功能接口

接口

描述

startNetworkTest

开始通话前网络质量探测。

stopNetworkTest

停止通话前网络质量探测。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问