网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

主入口(HRTC)

更新时间:2024-09-13 GMT+08:00
分享

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

表1 主入口接口

接口

描述

checkSystemRequirements

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

须知:

如果Web SDK版本在2.0.2到2.0.9.300之间,需要在2023年10月29日前更新至2.0.9.301及之后的版本,否则会导致checkSystemRequirements接口不可用。影响范围为微信浏览器。

VERSION

获取SparkRTC Web SDK版本。

getDevices

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

getCameras

获取摄像头设备列表。

getMicrophones

获取麦克风设备列表。

getSpeakers

获取扬声器设备列表。

isScreenShareSupported

检查是否支持屏幕共享。

createClient

创建一个实时音视频通话的客户端对象。一个Client对应于一个房间。

createStream

创建一个本地流对象。流分为主流和辅流。主流指从摄像头和麦克风采集的音视频流,辅流是从共享屏幕采集的音视频流。

setLogLevel

设置日志级别。

checkSystemRequirements

须知:

如果Web SDK版本在2.0.2到2.0.9.300之间,需要在2023年10月29日前更新至2.0.9.301及之后的版本,否则会导致checkSystemRequirements接口不可用。影响范围为微信浏览器。

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

功能说明

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

请求参数

strictCheckBrowser:可选,boolean类型,默认值为true 。true表示使用白名单放通支持的移动端浏览器(白名单由华为侧统一配置管理),false表示不使用白名单,该参数为2.0.2版本新增。

返回参数

Promise<boolean>:返回一个Promise对象,true表示浏览器兼容SparkRTC Web SDK,如果不兼容,则返回对应Error异常。

VERSION

VERSION

功能说明

获取 SparkRTC Web SDK 版本。

请求参数

返回参数

string:SDK当前版本号。

getDevices

(static) getDevices(): Promise<MediaDeviceInfo[]>

功能说明

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

授权浏览器的摄像头/麦克风访问权限的方法,请参见授权浏览器摄像头/麦克风访问权限的方法

请求参数

返回参数

Promise<MediaDeviceInfo[]>:媒体输入输出设备列表。MediaDeviceInfo为Web API基本接口。

getCameras

(static) getCameras(): Promise<MediaDeviceInfo[]>

功能说明

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

授权浏览器的摄像头/麦克风访问权限的方法,请参见授权浏览器摄像头/麦克风访问权限的方法

请求参数

返回参数

Promise<MediaDeviceInfo[]>:摄像头设备列表。MediaDeviceInfo 为Web API基本接口。

getMicrophones

(static) getMicrophones(): Promise<MediaDeviceInfo[]>

功能说明

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

授权浏览器的摄像头/麦克风访问权限的方法,请参见授权浏览器摄像头/麦克风访问权限的方法

请求参数

返回参数

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

getSpeakers

(static) getSpeakers(): Promise<MediaDeviceInfo[]>

功能说明

获取扬声器设备列表。

请求参数

返回参数

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

isScreenShareSupported

(static) isScreenShareSupported(): boolean

功能说明

检查浏览器是否支持屏幕共享。

请求参数

返回参数

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

createClient

(static)createClient(config: ClientConfig): Client

功能说明

创建一个实时音视频通话的客户端对象。一个客户端对象只能同时加入一个房间。可以创建多个客户端对象同时加入多个房间。

请求参数

config:必选,ClientConfig类型, 客户端对象配置信息。

ClientConfig定义为:{
  • appId:必选,string[128]类型,应用ID,只有App ID相同的应用程序才能进入同一个房间进行互动。应用的appId请参考应用管理进行获取。
  • domain:可选,string[128]类型,服务器的域名。需要与注册到SparkRTC平台的合法企业域名保持一致,该参数在SDK 1.0+版本中必填,SDK 2.0+版本中非必填。
  • countryCode: 可选,string[2]类型,需要满足ISO 3166-1的2位字母的国家码要求。表示业务接入点的国家码,SDK会根据设置将业务接入到对应区域的服务,如:CN表示中国大陆,US表示美国,HK表示中国香港。countryCode值的填写具体请参见国家码对照表。该参数为2.0.3版本新增,且为必选参数,从2.0.7版本开始,修改为可选参数。

}

返回参数

Client:客户端对象。

createStream

(static) createStream(config: StreamConfig): Stream

功能说明

创建本地流对象。

请求参数

config:必选,StreamConfig类型,指定创建流的参数。

StreamConfig 定义为:{
  • screen:可选,boolean类型,如果为true表示该流对象采集的是辅流音视频。辅流即共享屏幕的流。默认值为false,即该流对象采集的是主流音视频。
  • video:可选,boolean类型,指定是否采集主流的视频,主流即摄像头的流。默认值为false。
  • audio:可选,boolean类型,指定是否采集主流的音频。默认值为false。screen为false的时候该参数有效。
  • microphoneId:可选,string类型,在audio为true的时候有效,表示采集音频的源麦克风设备Id。如果不传,系统自动设置默认值。
  • cameraId:可选,string类型,在video为true的时候有效,表示采集视频的摄像头设备Id。如果不传,系统自动设置默认值。
  • facingMode:可选,string类型,在video为true的时候有效,user表示前置摄像头,environment表示后置摄像头。
  • screenAudio:可选,boolean类型,是否包含屏幕共享背景音。默认值为false。该功能仅支持Windows平台Chrome浏览器 74及以上版本。该字段为1.4.0版本新增。
  • audioSource:可选,MediaStreamTrack类型,表示输入音轨对象。通过指定Track设置音频。MediaStreamTrack为Web API基本接口。
  • videoSource:可选,MediaStreamTrack类型,表示输入视轨对象。通过指定Track设置主流视频。MediaStreamTrack为Web API基本接口。
  • mirror:可选,boolean类型,表示主流的本地视频是否镜像。默认值为false。
  • userId:可选,string类型,表示该流归属的userId。

}

返回参数

Stream:流对象。

注意:
  • 在采集主流有两种方式:
    • 通过“audioSource”“videoSource”设置音频和视频主流。这种模式下不支持大小流。
    • 通过“audio/microphoneId”“video/cameraId/facingMode”设置音频和视频主流。
  • 如果未指定任何的音频源和视频源,则创建的流对象不包含音频流和视频流,无法播放。
  • 如果采集视频,同一个Stream对象不能同时采集主流和辅流。
  • 如果需要包含屏幕共享背景音,需要设置screen和screenAudio均为true,该参数仅在1.4.0 及以上版本生效。

setLogLevel

(static) setLogLevel(level: LogLevel): void

功能说明

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

请求参数

level:必选,LogLevel类型,设置日志级别。

LogLevel表示日志级别,枚举取值如下:

  • none:string类型,表示关闭SDK日志打印。
  • error:string类型,表示开启SDK错误日志级别。
  • warn:string类型,表示开启SDK警告日志级别。
  • info:string类型,表示开启SDK信息日志级别。
  • debug:string类型,表示开启SDK调试日志级别。

返回参数

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容