文档首页 > > SDK参考> Web SDK> 接口参考>

主入口(HRTC)

主入口(HRTC)

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

本章节介绍了Web SDK的HRTC接口详情。

表1 主入口接口

接口

描述

checkSystemRequirements

检测浏览器是否兼容RTC Web SDK。

VERSION

获取RTC Web SDK版本。

getDevices

获取媒体输入输出设备列表。

getCameras

获取摄像头设备列表。

getMicrophones

获取麦克风设备列表。

getSpeakers

获取扬声器设备列表。

isScreenShareSupported

检查是否支持屏幕共享。

createClient

创建一个实时音视频通话的客户端对象。

createStream

创建一个本地流对象。

setLogLevel

设置日志级别。

checkSystemRequirements

(static) checkSystemRequirements(): Promise.<boolean>

功能说明

检测浏览器是否兼容RTC Web SDK。

请求参数

返回参数
  • true:浏览器兼容RTC Web SDK。
  • false:浏览器不兼容RTC Web SDK。

VERSION

VERSION

功能说明

获取RTC Web SDK版本。

请求参数

返回参数

字符串,SDK当前版本号。

getDevices

(static) getDevices(): Promise.<Array.<MediaDeviceInfo>>

功能说明

获取媒体输入输出设备列表。在用户未授权摄像头或麦克风访问权限之前,“label”“deviceId”可能为空。建议在用户授权访问后,再调用此接口获取设备列表。

请求参数

返回参数

Promise.<Array.<MediaDeviceInfo>>:媒体输入输出设备列表。

getCameras

(static) getCameras(): Promise.<Array.<MediaDeviceInfo>>

功能说明

获取摄像头设备列表。在用户未授权摄像头访问权限之前,“label”“deviceId”可能为空。建议在用户授权访问后,再调用此接口获取设备列表

请求参数

返回参数

Promise.<Array.<MediaDeviceInfo>>:摄像头设备列表。

getMicrophones

(static) getMicrophones(): Promise.<Array.<MediaDeviceInfo>>

功能说明

获取麦克风设备列表。在用户未授权麦克风访问权限之前,“label”“deviceId”可能为空。建议在用户授权访问后,再调用此接口获取设备列表。

请求参数

返回参数

Promise.<Array.<MediaDeviceInfo>>:麦克风设备列表。MediaDeviceInfo为Web API基本接口。

getSpeakers

(static) getSpeakers(): Promise.<Array.<MediaDeviceInfo>>

功能说明

获取扬声器设备列表。

请求参数

返回参数

Promise.<Array.<MediaDeviceInfo>>:扬声器设备列表。MediaDeviceInfo为Web API基本接口。

isScreenShareSupported

(static) isScreenShareSupported(): boolean

功能说明

检查是否支持屏幕共享。

请求参数

返回参数

boolean:true表示支持,false表示不支持。

createClient

(static)createClient(config: ClientConfig): Client

功能说明

创建一个实时音视频通话的客户端对象

请求参数
  • config:必选,ClientConfig类型, 客户端对象配置信息
  • ClientConfig:{
    • appId:必选,string[128]类型,应用的APP ID请提交工单申请。
    • domain:必选,string[128]类型,服务器的域名。需要与注册到RTC平台的合法企业域名保持一致

    }

返回参数

Client:客户端对象

createStream

(static) createStream(config: StreamConfig): Stream

功能说明

创建本地流对象。

请求参数

  • config: StreamConfig类型
  • StreamConfig: {
    • audio:可选, boolean类型,指定是否采集音频。默认值为false。
    • microphoneId:可选, string类型,在audio为true的时候有效,表示采集音频的源麦克风设备Id。如果不传,系统自动设置默认值。
    • video:可选,boolean类型,指定是否采集主流的视频,主流即摄像头的流。默认值为false。
    • cameraId:可选,string类型,在video为true的时候有效,表示采集视频的摄像头设备Id。如果不传系统自动设置默认值。
    • facingMode:可选, string类型,在video为true的时候有效,"user"表示前置摄像头,"environment"表示后置摄像头。
    • screen:可选,boolean类型,指定是否采集辅流视频。辅流即共享屏幕的流。默认值为false。
    • audioSource:可选,MediaStreamTrack类型,表示输入音轨对象。通过指定Track设置音频。
    • videoSource:可选,MediaStreamTrack类型,表示输入视轨对象。通过指定Track设置主流视频。
    • mirror:可选,boolean类型,表示主流的本地视频是否镜像。默认值为false。

    }

    • 可以通过“audioSource”“videoSource”设置音频和视频主流。也可以通过“audio/microphoneId”“video/cameraId/facingMode”设置音频和视频主流。
    • 如果未指定任何的音频源和视频源,则创建的流对象不包含音频流和视频流,无法播放。
    • 如果采集视频,同一个Stream对象不能同时采集主流和辅流

返回参数

Stream:流对象。

setLogLevel

(static) setLogLevel(level: LogLevel): void

功能说明

设置日志输出等级。默认输出INFO等级日志

请求参数

  • level:必选,,LogLevel对象类型, 设置日志级别
  • LogLevel:日志级别,取值如下:

    {‘none’、‘error’、‘warn’、‘info’、‘debug’}

返回参数

分享:

    相关文档

    相关产品

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

智能客服提问云社区提问