网络
虚拟私有云 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
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
文档首页/ 实时音视频 SparkRTC/ 客户端SDK参考/ Web SDK/ 接口参考/ 客户端事件通知(ClientEvent)

客户端事件通知(ClientEvent)

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

本章节介绍了Web SDK的ClientEvent事件。

表1 ClientEvent事件

接口

描述

peer-join

远端用户进入房间事件。

peer-leave

远端用户退出房间事件。

stream-added

远端流添加事件。

stream-removed

远端流删除事件。

stream-updated

远端流更新事件。

stream-subscribed

远端流订阅成功事件。

client-banned

用户被踢,离开房间事件。

kick-room

解散房间

Error

客户端出现错误事件。

connection-state-changed

Client连接状态变更事件。

mute-audio

远端流禁用音频事件。

unmute-audio

远端流启用音频事件。

mute-video

远端流禁用视频事件。

unmute-video

远端流启用视频事件。

log-upload-result

日志上传结果事件。

signature-expired

签名过期事件。该事件为2.0.8版本新增。

camera-changed

摄像头设备变更事件。

recording-device-changed

录音设备变更事件。

playback-device-changed

播放设备变更事件。

network-quality

网络上下行质量报告事件。

stream-interrupted

远端流处于无码流状态事件。该事件为1.4.0版本新增。

stream-recovered

远端流码流恢复事件。该事件为1.4.0版本新增。

volume-indicator

音频TopN(即最大三方)模式下,当前音量最大的用户提示事件。该事件为1.5.0版本新增。

remote-user-name-changed

远端用户昵称变更事件。该事件为1.5.0版本新增。

live-streaming-updated

更新旁路推流的事件。该事件为2.0.0版本新增。

rtc-stats

音视频流数据统计事件。该事件为2.0.3版本新增。

注意:

事件注册监听应在业务结束时取消注册,否则注册监听事件累积会有内存泄漏风险。

peer-join

【事件说明】

远端用户加入房间事件,远端用户加入房间后会收到该事件通知。

【回调参数】

peerJoinEvent:必选,PeerJoin类型,用户信息。

PeerJoin定义为:{

  • userId:必选,string[64]类型,用户标识。
  • userName:可选,string[256]类型,用户昵称。

}

peer-leave

事件说明

远端用户离开房间事件,远端用户离开房间后会收到该事件通知。

【回调参数

peerLeaveEvent:必选,PeerLeaveInfo 类型,用户离开信息。

PeerLeaveInfo 定义为:{

  • userId:必选,string[64]类型,用户标识。
  • userName:可选,string[256]类型,用户昵称。
  • reason:可选,HRTCLeaveReason类型。

}

HRTCLeaveReason定义为:{

  • code:number类型, 离开原因枚举,取值如表2 离开房间原因所示。
  • msg:string类型,原因描述。
}
表2 离开房间原因

枚举值

描述

0

用户主动离开

1

服务器异常

2

sfu服务故障

3

服务不可达503

4

内部错误

5

被踢出房间

6

签名过期

7

重连超时

8

网络检测,UI不需要关注该错误码,不对外体现

9

用户移除

10

房间解散

stream-added

事件说明

远端流添加事件,当远端用户发流成功后会收到该事件通知。

【回调参数

stream:必选,RemoteStream类型,远端流对象。

stream-removed

事件说明

远端流移除事件,当远端用户取消发流或者原来已经发布的远端用户退出房间后会收到该事件通知。

【回调参数

stream:必选,RemoteStream类型,远端流对象。

stream-updated

事件说明

远端流更新事件,当远端用户的流发生变化,例如添加或者移除音视频轨,视频轨规格变化时会收到该事件通知。

【回调参数

stream:必选,RemoteStream类型,远端流对象。

stream-subscribed

事件说明

远端流订阅成功事件,当订阅远端流成功后会收到该事件通知。

【回调参数

stream:必选,RemoteStream类型,远端流对象。

client-banned

事件说明

用户被踢下线事件,当用户以相同的userId 在其他Client加入相同的房间后,被踢的Client会收到该事件通知。

【回调参数

clientBannedEvent:必选,ClientBanInfo类型,

ClientBanInfo定义为:{
  • userId:必选,string[64]类型,被踢用户标识。
  • reason:必选,string类型,原因描述。

}

kick-room

事件说明

解散房间,由调用的服务端接口触发。

【回调参数

roomId:必选,string[64]类型,房间Id。

Error

事件说明

客户端错误事件,当出现不可恢复的错误后,Client会上报该事件通知。

【回调参数

errorInfo:必选,ErrorInfo类型,错误信息。

ErrorInfo 定义为:{
  • errorCode:必选,string类型,错误码。
  • errorMsg:必选,string类型,错误描述。

}

connection-state-changed

事件说明

Client连接状态变更事件,Client连接状态变更会收到该事件通知。

【回调参数

  • ConnectionStateInfoEvent:{
    • prevState:必选,ConnectionState类型,变更前状态。
    • curState:必选,ConnectionState类型,变更后状态。

}

连接状态ConnectionState的取值如下所示:
  • CONNECTING:连接建立中。
  • CONNECTED:连接已连接。
  • RECONNECTING:重新连接中。
  • DISCONNECTED:连接已断开。

mute-audio

事件说明

远端用户禁用音频通知事件,当远端用户禁用音频后,流接收端会收到该事件通知。

【回调参数

mediaStatus:必选,MediaStatusNotifyInfo类型。

MediaStatusNotifyInfo包含如下属性:

  • roomId:必选,string[64]类型。
  • userId:必选,string[64]类型。
  • status:必选,MediaStatusAction类型。MediaStatusAction枚举值定义如下所示:
    • 1:媒资状态可用。
    • 2:媒资状态不可用。
  • reason:必选,MediaStatusReason类型。MediaStatusReason枚举值定义如下所示:
    • 0:媒体离线。
    • 1:媒体静音。
    • 2:媒体不静音。

unmute-audio

事件说明

远端用户启用音频通知事件,当远端用户启用音频后,流接收端会收到该事件通知。

【回调参数

mediaStatus:必选,MediaStatusNotifyInfo类型。

mute-video

事件说明

远端用户禁用视频通知事件,当远端用户禁用视频后,流接收端会收到该事件通知。

【回调参数

mediaStatus:必选,MediaStatusNotifyInfo类型。

unmute-video

事件说明

远端用户启用视频通知事件,当远端用户启用视频后,流接收端会收到该事件通知。

【回调参数

mediaStatus:必选,MediaStatusNotifyInfo类型。

log-upload-result

事件说明

日志上传结果事件。

【回调参数

status:必选,number类型,日志上传结果,200表示成功,其余表示失败。

signature-expired

事件说明

签名过期事件。

回调参数

errorInfo:错误信息。必选,ErrorInfo类型。

ErrorInfo 定义为:{
  • errorCode:错误码。必选,string类型。
  • errorMsg:必选,string类型。取值如下面的取值示例中所示。

}

取值示例,如下所示:

  • 签名过期:{

    errorCode: '90100030'

    errorMsg: 'signature expired'

    }

  • 签名无效:{

    errorCode: '90100031'

    errorMsg: 'signature invalid'

    }

注意:

监听到签名过期事件后可通过错误码区分是签名无效还是签名过期,签名过期后可通过renewSignature接口更新签名。

camera-changed

事件说明

本地摄像头设备变更事件,当插、拔本地摄像头时触发。

【回调参数

DeviceChangedEvent:必选,DeviceChangedInfo类型,设备变更详情。

DeviceChangedInfo 定义为:{
  • deviceId:必选,string类型,设备deviceId。
  • state:必选,DeviceChangeMode类型,DeviceChangeMode枚举值定义如下:
    • ADD:设备添加。
    • REMOVE:设备移除。

}

注意:

视频采集设备,拔插后需要应用层进行相应的处理,如:拔除摄像头的时候是否切换其他视频采集设备重新采集;插入摄像头的时候是否使用新插入设备进行重新采集。

recording-device-changed

事件说明

本地录音设备变更事件,当本地录音设备变更时触发。

【回调参数

DeviceChangedEvent:必选,DeviceChangedInfo类型,设备变更详情。DeviceChangedInfo定义参考camera-changed中的说明。

注意:

麦克风采集设备,拔插后需要应用层进行相应的处理,如:拔除麦克风的时候是否切换其他麦克风采集设备重新采集;插入麦克风的时候是否使用新插入设备进行重新采集。

playback-device-changed

事件说明

本地音频播放设备变更事件,当本地音频播放设备变更时触发。

【回调参数

DeviceChangedEvent:必选,DeviceChangedInfo类型,设备变更详情。DeviceChangedInfo定义参考camera-changed中的说明。

network-quality

事件说明

网络上下行质量报告事件,用户加入房间后,SDK在网络质量变化的时候会触发一次该事件,报告用户的本地网络上下行质量情况。

【回调参数

NetworkQualityEvent:必选, NetworkQualityInfo类型,网络上下行质量详情。

NetworkQualityInfo定义为:{
  • uplinkNetworkQuality:必选,number类型,上行网络质量。枚举值如下:
    • 0:质量未知。
    • 1:质量极好。
    • 2:质量较好。
    • 3:质量一般。
    • 4:质量差。
    • 5:质量极差。
    • 6:网络连接断开。
  • downlinkNetworkQuality:必选,number类型,下行网络质量。枚举值如下:
    • 0:质量未知。
    • 1:质量极好。
    • 2:质量较好。
    • 3:质量一般。
    • 4:质量差。
    • 5:质量极差。
    • 6:网络连接断开。

}

stream-interrupted

事件说明

远端流的码流中断事件。中断表示在 enableStreamStateDetection 接口参数 interval 设置的统计周期内未接收到有效视频帧。该事件为 1.4.0 版本新增。

【回调参数

streamInterruptedEvent:必选,UserList[]类型,已订阅且无视频码流的用户列表。

UserList定义为:{
  • userId:必选,string类型,用户Id。
  • isScreen:必选,boolean类型,true表示对应用户的辅流,false表示对应用户的主流。

}

stream-recovered

事件说明

远端流的码流恢复事件。

【回调参数

streamRecoveredEvent:必选,UserList[]类型,已订阅且视频码流恢复的用户列表。UserList参考stream-interrupted中的定义。该事件为1.4.0版本新增。

volume-indicator

事件说明

音频TopN模式下,房间中当前音量最大的用户提示事件。

【回调参数

userVolumeInfos:必选, UserVolumeInfo[]类型。

UserVolumeInfo定义为:{
  • user_id:必选,string类型,用户Id。
  • volume:可选,number类型,取值范围为[0,100]。

}

注意:

该事件仅在音频TopN模式下生效,1.5.0版本新增。

remote-user-name-changed

事件说明

远端用户昵称变更事件。该事件为1.5.0版本新增。

【回调参数

userNameChangedEvent:必选, UserNameInfo类型。

UserNameInfo定义为:{
  • roomId:必选,string[64]类型,房间Id。
  • userId:必选,string[64]类型,用户Id。
  • userName:必选, string[256]类型,修改后的用户昵称。

}

live-streaming-updated

事件说明

旁路推流状态更新事件。该事件为2.0.1版本新增。

回调参数

urlStatus:UrlStatus[]类型,所有CDN推流状态更新。UrlStatus定义如下:

  • url:必选,string类型,表示CDN推流URL
  • status:必选,number类型,表示当前推流状态。
    • 0:初始化。
    • 1:链接正常且有流。
    • 2:链接正常但无流。
    • 3:异常重试。
    • 4:处理失败。
  • errorCode:可选,number类型,表示详细的失败原因,支持的枚举值如下:
    • 0: 正常。
    • 1: 内部错误。
    • 2: 地址解析失败。
    • 3: 连接失败。
    • 4: RTMP握手失败。
    • 5: 内存错误。
    • 6: 参数错误。
    • 7: 重试失败。
    • 8: 响应超时失败。

rtc-stats

事件说明

音视频流数据统计事件。该事件为2.0.3版本新增。

【回调参数

rtcStatsInfo:必选, rtcStatsInfo[]类型。

rtcStatsInfo定义为:{
  • userName:必选,string类型,用户昵称。
  • isRemote:必选,boolean类型,是否为远端流,true表示远端流,false表示本地流。
  • streamType:必选,ContentType类型,流类型。ContentType类型的枚举值如下:{
    • main:string类型,表示主流。
    • middle1:string类型,表示主流,middle1~middle4码流依次降低。
    • middle2:string类型,表示主流,middle1~middle4码流依次降低。
    • middle3:string类型,表示主流,middle1~middle4码流依次降低。
    • middle4:string类型,表示主流,middle1~middle4码流依次降低。
    • slides:string类型,表示主流视频分辨率最小的流。
    • desktop:string类型,表示共享流。

      }

  • mediaType:必选,MediaType类型,媒体类型,音频或视频。
  • bitrate:必选,number类型,音视频流码率,单位为kbps。
  • frameRate:必选,number类型,视频帧率,单位为帧/秒。
  • rtt:必选,number类型,表示SDK到边缘服务器的RTT (Round-Trip Time),单位毫秒。只有本地流才有rtt 值。
  • jitter:必选,number类型,音视频流抖动值。
  • pktLossRate:必选,number类型,音视频流丢包率。

}

提示

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

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容