网络
虚拟私有云 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
网络
虚拟私有云 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
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
更新时间:2024-12-06 GMT+08:00
分享

客户端对象(HWFlvClient)

本章节介绍了低时延直播Web SDK的HWFlvClient接口详情。

表1 主入口接口

接口

描述

startPlay

开始播放,客户端根据输入的URL到服务端拉取对应的主播流。

switchPlay

快速切换下一路流播放。

stopPlay

停止播放。

replay

重新播放。

resume

恢复播放。

pause

暂停播放。

pauseVideo

暂停视频。

resumeVideo

恢复视频。

pauseAudio

暂停音频。

resumeAudio

恢复音频。

setPlayoutVolume

设置播放音量。

getPlayoutVolume

获取音频音量。

muteAudio

静音。

streamStatistic

设置是否开启流信息统计。

enableStreamStateDetection

开启/关闭音视频码流状态探测功能。

destroyClient

销毁客户端对象。

fullScreenToggle

开启关闭全屏。

startPlay

startPlay(url: string, options: StartPlayOptions): Promise<void>

功能说明

开始播放,客户端根据输入的URL到服务端拉取对应的主播流。

请求参数

  • url:必选,string类型。拉流URL,是以flv结尾的播放地址。
  • options:可选,StartPlayOptions类型。播放配置参数,如果不携带该参数,则复用首次起播携带的options数据。StartPlayOptions定义如下:{
    • elementId:必选,播放DOM标识ID。
    • objectFit:可选,string类型,默认值为cover。支持的枚举值如下:
      • contain:优先保证视频内容全部显示。视频尺寸等比缩放,直至视频窗口的一边与视窗边框对齐。如果视频尺寸与显示视窗尺寸不一致,在保持长宽比的前提下,将视频进行缩放后填满视窗,缩放后的视频四周会有一圈黑边。
      • cover:优先保证视窗被填满。视频尺寸等比缩放,直至整个视窗被视频填满。如果视频长宽与显示窗口不同,则视频流会按照显示视窗的比例进行周边裁剪或图像拉伸后填满视窗。
      • fill:视频内容完全填充视窗。如果视频的宽高比与视窗不相匹配,那么视频将被拉伸以适应视窗。
    • muted:可选,boolean类型,true表示静音,false表示不静音。默认值为false。
    • sessionId:不需要传。
    • showLoading:可选,boolean类型,true表示开启loading的展示效果,默认为false。当该参数设置为true时,起播loading效果同步开启,播放过程中发生缓冲时loading的效果,需根据setParameter接口中的LOADING_CONFIG进行设置。
    • autoPlay:可选,boolean类型,true表示开启自动起播功能,false表示非自动起播,需要人为触发播放,默认为true。
    • poster:可选,对象定义如下:{
      • url:可选,string类型。设置播放封面图片完整地址,图片格式限JPGPNG和静态GIF格式,大小不超过1MB,尺寸不超过1920 x 1080,文件名不得含有中文字符。
      • mode:可选,string类型。默认值为cover。支持的枚举值如下:{
        • fill:视频内容完全填充视窗,如果视频的宽高比与视窗不相匹配,那么视频将被拉伸以适应视窗。
        • crop:海报(即视频播放封面)原始尺寸大小展示,如果超出播放区域,则会对超出部分进行裁剪,否则在播放窗口居中展示。

        }

      • startEnable:可选,boolean类型。启动播放时是否展示播放封面,true表示展示,false表示不展示播放封面,默认值false。该参数只在设置非自动播放场景下生效。
      • pauseEnable:可选,boolean类型。触发暂停操作时,是否在播放页面展示播放封面,true表示展示播放封面,false表示不展示,默认值false。

      }

    • webrtcConfig:不需要传。
    • schedulePolicy:不需要传。
    • domainPolicy:不需要传。
    • downgradeUrl:不需要传。

返回参数

Promise<void>:返回一个Promise对象。

switchPlay

switchPlay(url: string, options: StartPlayOptions): Promise<void>

功能说明

起播成功后,快速切换下一路流播放。

请求参数

  • url:必选,string类型。拉流URL,是以flv结尾的播放地址。
  • options:可选,StartPlayOptions类型。播放配置参数,如果不携带该参数,则复用首次起播携带的options数据。StartPlayOptions定义如下:{
    • elementId:必选,播放DOM标识ID。
    • objectFit:可选,string类型,默认值为cover。支持的枚举值如下:
      • contain:优先保证视频内容全部显示。视频尺寸等比缩放,直至视频窗口的一边与视窗边框对齐。如果视频尺寸与显示视窗尺寸不一致,在保持长宽比的前提下,将视频进行缩放后填满视窗,缩放后的视频四周会有一圈黑边。
      • cover:优先保证视窗被填满。视频尺寸等比缩放,直至整个视窗被视频填满。如果视频长宽与显示窗口不同,则视频流会按照显示视窗的比例进行周边裁剪或图像拉伸后填满视窗。
      • fill:视频内容完全填充视窗。如果视频的宽高比与视窗不相匹配,那么视频将被拉伸以适应视窗。
    • muted:可选,boolean类型,true表示静音,false表示不静音。默认值为false。
    • sessionId:不需要传。
    • showLoading:可选,boolean类型,true表示开启loading的展示效果,默认为false。当该参数设置为true时,起播loading效果同步开启,播放过程中发生缓冲时loading的效果,需根据setParameter接口中的LOADING_CONFIG进行设置。
    • autoPlay:可选,boolean类型,true表示开启自动起播功能,false表示非自动起播,需要人为触发播放,默认为true。
    • poster:可选,对象定义如下:{
      • url:可选,string类型。设置播放封面图片完整地址,图片格式限JPGPNG和静态GIF格式,大小不超过1MB,尺寸不超过1920 x 1080,文件名不得含有中文字符。
      • mode:可选,string类型。默认值为cover。支持的枚举值如下:{
        • fill:视频内容完全填充视窗,如果视频的宽高比与视窗不相匹配,那么视频将被拉伸以适应视窗。
        • crop:海报(即视频播放封面)原始尺寸大小展示,如果超出播放区域,则会对超出部分进行裁剪,否则在播放窗口居中展示。

        }

      • startEnable:可选,boolean类型。启动播放时是否展示播放封面,true表示展示,false表示不展示播放封面,默认值false。该参数只在设置非自动播放场景下生效。
      • pauseEnable:可选,boolean类型。触发暂停操作时,是否在播放页面展示播放封面,true表示展示播放封面,false表示不展示,默认值false。

      }

    • webrtcConfig:不需要传。
    • schedulePolicy:不需要传。
    • domainPolicy:不需要传。
    • downgradeUrl:不需要传。

返回参数

Promise<void>:返回一个Promise对象。

stopPlay

stopPlay(): boolean

功能说明

停止播放。

请求参数

返回参数

boolean:停止播放的结果。true表示成功,false表示失败。

replay

replay(): Promise<boolean>

功能说明

重新播放。

请求参数

返回参数

Promise<boolean>:重新播放的结果。true表示成功,false表示失败。

resume

resume(): Promise<boolean>

功能说明

恢复播放。

请求参数

返回参数

Promise<boolean>:恢复音视频播放的结果。true表示成功,false表示失败。

pause

pause(): boolean

功能说明

暂停音视频播放。

请求参数

返回参数

boolean:暂停播放的结果。true表示成功,false表示失败。

pauseVideo

pauseVideo(): boolean

功能说明

该接口不支持。

请求参数

返回参数

boolean:只返回false。

resumeVideo

resumeVideo(): Promise<boolean>

功能说明

该接口不支持。

请求参数

返回参数

boolean:只返回false。

pauseAudio

pauseAudio(): boolean

功能说明

暂停音频。

请求参数

返回参数

boolean:暂停音频播放的结果。true表示成功,false表示失败。

resumeAudio

resumeAudio(): Promise<boolean>

功能说明

恢复音频。

请求参数

返回参数

Promise<boolean>:恢复音频播放的结果。true表示成功,false表示失败。

setPlayoutVolume

setPlayoutVolume(volume: number): boolean

功能说明

设置音频音量,会开启声音。

请求参数

volume:必选,number类型,音频的音量值。取值范围为[0,100]。

返回参数

boolean:设置音频音量是否成功。true表示成功,false表示失败。

getPlayoutVolume

getPlayoutVolume(): number

功能说明

获取音频音量。

请求参数

返回参数

number:音量值,取值范围为[0,100]。

muteAudio

muteAudio(isMute: boolean): void

功能说明

静音。

请求参数

isMute:必选,boolean类型,是否静音。true表示静音,false表示取消静音。

返回参数

streamStatistic

streamStatistic(enable: boolean, interval: number): void

功能说明

设置是否开启流信息统计。

请求参数

  • enable:必选,boolean类型,是否开启流信息统计,true表示开启统计。
  • interval:必选,number类型,设置统计间隔,单位为秒,取值范围为[1, 60],默认值为1。

返回参数

enableStreamStateDetection

enableStreamStateDetection(enable: boolean, interval: number, interruptRetry:StreamInterruptRetry): boolean

功能说明

开启/关闭音、视频码流状态探测功能,开启后可探测推流侧是否处于断流的状态。

请求参数

  • enable:必选,boolean类型,true表示开启音视频码流状态探测,false表示关闭音视频码流状态探测。默认值为false。
  • interval:必选,number类型,单位为秒,取值范围为[1,60]。音视频无码流状态的判断时间。默认值为3,推荐设置为3。
  • interruptRetry:可选,StreamInterruptRetry类型。断流重试播放配置参数,StreamInterruptRetry定义为:{

    enable:boolean类型,开启断流后尝试自动恢复播放。默认值为false,即不开启自动重试。

    retryInterval:number类型,拉流播放的重试周期,单位为秒。最小值10,最大值建议不超过60,默认值为30。

    retryTimes:number类型,尝试重新恢复播放的最大重试次数。最小值1,默认值为30。

    }

返回参数

boolean:是否成功,true表示成功,false表示失败。

destroyClient

destroyClient(): void

功能说明

销毁客户端对象。

请求参数

返回参数

fullScreenToggle

fullScreenToggle(isExit: boolean): void

功能说明

开启关闭全屏。

请求参数

isExit:必选,布尔类型,默认false。

返回参数

相关文档