- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 产品彩页
- 计费说明
- 云直播
- 媒体直播
- 最佳实践
- 云直播API参考
- 媒体直播API参考
- 云直播服务端SDK参考
- 低时延客户端SDK参考
- 场景代码示例
-
常见问题
- 高频问题导航
- 产品咨询
-
计费购买
- 点播的流量包直播服务能用吗?
- 如何查看直播套餐包的使用详情?
- 直播套餐包是否支持退订?
- 直播套餐包使用完之后会被停服吗?
- 购买了直播CDN出流包,为什么还会从账户余额扣费?
- 购买云直播转码套餐后,产生的转码费用未从套餐包中抵扣?
- 如何估算视频直播的流量消耗?
- 云直播录制需要收取哪些费用?
- 视频直播有哪些计费项?如何知道自己需要支付哪些费用?
- 如何查看直播按需资源的使用量和消费金额?
- 如何修改直播服务的计费方式?
- 不使用时是否需要停用或删除直播服务?
- 直播流量计费是按下行流量还是上行流量?
- 为什么账户欠费后仍一直产生直播费用?
- 视频直播服务的Key防盗链功能是否收费?
- 云直播转码是如何计费的?
- 如何知道账户是否欠费?
- 日峰值带宽是指上行带宽还是下行带宽?
- 为什么每月1号都会扣除一笔录制费用?
-
域名管理
- 什么是ICP备案?
- ICP备案是否是必须的?
- 如何进行ICP备案?
- 为什么要进行资质审核?审核未通过有什么影响?
- 域名已备案,如何在直播中添加域名?
- 直播服务许可证是否是必须的?如何办理?
- 添加域名时,提示“ICP编号不存在”怎么办?
- 域名管理中的消息订阅界面为什么操作不了?
- 一个租户最多可以添加多少个直播域名?
- 添加的播放域名和推流域名有什么要求?
- 域名管理界面的CNAME的作用是什么?
- 添加域名时,提示“添加失败,用户处于删除状态”怎么办?
- 为什么域名状态会从“正常”变为“配置中”?
- 配置CNAME域名解析,提示冲突?
- 播放域名和推流域名可以为二级域名吗?
- 一个域名是否可以同时添加在多个区域的直播服务中?
- 如何验证直播域名是否启动加速?
- 欠费后,域名是否会被清除掉?
- 更改了推拉流配置后,需要断流多长时间才能重新推流生效?
- 为什么直播控制台创建域名后,我的资源中未展示?
- 为什么直播控制台删除域名后,我的资源中仍展示?
- 如何查看我的资源?
-
直播录制
- 直播录制支持什么录制格式和播放格式?
- 直播录制后,为什么在控制台和回调信息中无播放地址?
- 是否支持直播录制存储至OBS桶中?
- 直播录制周期最多支持录制多长时间?
- 是否支持为每个直播流配置录制模板?
- 直播录制是否会录制转码流?
- 直播录制支持的ts分片大小是多少?
- 一次直播录制会生成几个录制文件?
- 已经删除录制规则,为什么还会生成录制文件?
- 为什么直播推流未中断,录制文件分成了两个?
- 直播录制后,如何获取录制文件地址?
- 是否支持通过调用API进行直播录制?
- 配置了录制至OBS模板,为什么未生成录制文件?
- 录制至OBS模板中,流名称是否支持通配符?
- 如何删除录制文件?
- 直播录制是否支持按需启停?
- 直播录制为什么无法收到RECORD_FILE_COMPLETE回调?
- 直播录制流名StreamName是否支持正则表达式的配置?
- 为什么直播录制生成的download_url无法下载视频?
- 修改了录制规则及文件存储路径,为什么没有生效?
- 直播中断流多次,可以录制成一个文件吗?
- 直播转码
- 直播截图
- 直播安全
- 直播推流
- 直播播放
- 直播回调
- API使用
- 统计分析
- 第三方工具使用
- 故障排除
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
客户端对象(HWHlsClient)
本章节介绍了低时延直播Web SDK的HWHlsClient接口详情。
接口 |
描述 |
---|---|
开始播放,客户端根据输入的URL到服务端拉取对应的主播流。 |
|
快速切换下一路流播放。 |
|
停止播放。 |
|
重新播放。 |
|
恢复播放。 |
|
暂停播放。 |
|
暂停视频。 |
|
恢复视频。 |
|
暂停音频。 |
|
恢复音频。 |
|
设置播放音量。 |
|
获取音频音量。 |
|
静音。 |
|
设置是否开启流信息统计。 |
|
开启/关闭音视频码流状态探测功能。 |
|
销毁客户端对象。 |
|
开启关闭全屏。 |
startPlay
startPlay(url: string, options: StartPlayOptions): Promise<void>
【功能说明】
开始播放,客户端根据输入的URL到服务端拉取对应的主播流。
【请求参数】
- url:必选,string类型。拉流URL,是以m3u8结尾的播放地址
- 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进行设置。
- Android端QQ浏览器不支持该功能。
- 建议showLoading不设置,或者设置为false。
- 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,是以m3u8结尾的播放地址
- 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对象。
replay
replay(): Promise<boolean>
【功能说明】
重新播放。
【请求参数】
无
【返回参数】
Promise<boolean>:重新播放的结果。true表示成功,false表示失败。
resume
resume(): Promise<boolean>
【功能说明】
恢复播放。
【请求参数】
无
【返回参数】
Promise<boolean>:恢复音视频播放的结果。true表示成功,false表示失败。
resumeAudio
resumeAudio(): Promise<boolean>
【功能说明】
恢复音频。
【请求参数】
无
【返回参数】
Promise<boolean>:恢复音频播放的结果。true表示成功,false表示失败。
setPlayoutVolume
setPlayoutVolume(volume: number): boolean
【功能说明】
设置音频音量,会开启声音。
【请求参数】
volume:必选,number类型,音频的音量值。取值范围为[0,100]。
【返回参数】
boolean:设置音频音量是否成功。true表示成功,false表示失败。
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表示失败。
![](https://support.huaweicloud.com/llsdk-live/public_sys-resources/caution_3.0-zh-cn.png)
Android端QQ浏览器不支持该功能。