云服务器内容精选

  • on on(event: string, handler: function, withTimeout?: boolean): void 【功能说明】 注册客户端对象事件回调接口。 【请求参数】 event:必选,string类型,事件名称。具体请参见HWLLSClientEvent。 handler:必选,function类型,事件处理方法。 withTimeout:选填,boolean类型,是否超时报错 【返回参数】 无
  • 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表示失败。 Android端QQ浏览器不支持该功能。
  • streamStatistic streamStatistic(enable: boolean, interval: number): void 【功能说明】 设置是否开启流信息统计。 【请求参数】 enable:必选,boolean类型,是否开启流信息统计,true表示开启统计。 interval:必选,number类型,设置统计间隔,单位为秒,取值范围为[1, 60],默认值为1。 【返回参数】 无
  • network-quality 【事件说明】 网络质量报告事件。 【回调参数】 NetworkQualityTypes:NetworkQualityTypes类型,网络质量详情。 NetworkQualityTypes枚举值参考如下: NETWORK_QUALITY_UNKNOW = 0,网络质量未知。 NETWORK_QUALITY_GREAT = 1,网络质量极好。 NETWORK_QUALITY_GOOD = 2,用户主观感觉和极好差不多,但码率可能略低于极好。 NETWORK_QUALITY_DEFE CTS = 3,网络质量一般,用户主观感受有瑕疵但不影响观看。 NETWORK_QUALITY_WEAK = 4,网络质量差,勉强能观看但不流畅。 NETWORK_QUALITY_BAD = 5,网络质量很差,严重影响用户观看体验。 NETWORK_QUALITY_DISCONNECT = 6,网络质量非常差甚至链接断开,无法观看。
  • Error 【事件说明】 客户端错误事件,当出现不可恢复的错误后,Client会上报该事件通知。 【回调参数】 errorInfo:必选,ErrorInfo类型,错误信息。 ErrorInfo定义为:{ errorCode:必选,string类型,错误码。 errorMsg:必选,string类型,错误描述。 } 在网络防火墙限制(UDP端口限制)或者低时延直播多次重试播放失败的场景下,可根据特定错误码(HWLLS_MEDIA_NETWORK_ERROR、HWLLS_PLAY_WEBRTC_RETRY_FAILED),进行播放降级,请参考SDK使用。
  • media-statistic 【事件说明】 媒体统计事件。此事件配合streamStatistic方法使用。 【回调参数】 StatisticInfo:StatisticInfo类型,媒体统计信息。 StatisticInfo定义为:{ video:{ mediaType:MediaType媒体类型。 frameRate:number类型,视频帧率。 width:number类型,视频宽度。 height:number类型,视频高度。 jitter:number类型,抖动值。 bitRate:number类型,码率,单位:kbps。 bytesReceived:number类型,已接收字节数。 packetsReceived:number类型,已接收包数。 packetsLost:number类型,丢包数。 } audio:{ mediaType:MediaType媒体类型。 jitter:number类型,抖动值。 bitRate:number类型,码率,单位:kbps。 bytesReceived:number类型,已接收字节数。 packetsReceived:number类型,已接收包数。 packetsLost:number类型,丢包数。 } }
  • on on(event: string, handler: function, withTimeout?: boolean): void 【功能说明】 注册客户端对象事件回调接口。 【请求参数】 event:必选,string类型,事件名称, 注册Error事件,监听打点或者日志上传的错误信息。 handler:必选,function类型,事件处理方法。 withTimeout:选填,boolean类型,是否超时报错 【返回参数】 无
  • setLogLevel setLogLevel(level: string): boolean 【功能说明】 设置Console上打印的日志级别,如不设置日志级别,则console日志打印级别默认为error。 【请求参数】 level:string类型,必选,日志级别标识。 none:关闭全部级别的日志打印。 error:打印error级别日志。 warn:打印warn级别及更高级别日志。 info:打印info级别及更高级别日志。 debug:打印debug级别及更高级别日志。 【返回参数】 boolean:设置日志级别结果。true表示日志级别设置成功,false表示日志级别设置失败。
  • setReportConfig setReportConfig(reportConfig:ReportConfig):boolear 【功能说明】 设置打点能力以及打点和日志上传的认证策略。 【请求参数】 reportConfig:ReportConfig类型,必选。ReportConfig定义如下所示: enable:必选,布尔类型,true表示开启打点,false表示关闭打点。默认true。 tokenConfig:可选,对象定义如下所示: enable:布尔类型,true表示开启认证,false表示关闭认证。默认false。 tokenInfo:数组类型,数组内部ReportTokenInfo类。ReportTokenInfo定义如下所示: appid:string类型。传入appid。 expTimestamp:string类型。过期时间戳,系统当前UNIX时间戳加上鉴权过期时间(推荐7200秒,最长需要小于43200秒,即12个小时)。 例如:当前UNIX时间戳为:1708531200,鉴权过期时间自定义为7200秒,那么过期的时间戳为:1708538400,即表示该校验字符串在2024-02-22 02:00:00过期。 token:string类型。hmac_sha256生成的字符串。hmac_sha256(共享密钥, 过期的时间戳 + appID)。共享密钥由用户控制获取。 【返回参数】 返回值布尔值, true表示设置成功,false表示设置失败。 开启了认证策略,实际请求状态会通过on函数注册Error回调获得。
  • setParameter setParameter(parameterKey: string, parameterValue: any): boolean 【功能说明】 设置全局配置参数。 【请求参数】 参数名称 参数值 LOADING_CONFIG LoadingConfig类型,定义如下: { netQualityLoading:可选,boolean类型。true表示开启根据网络质量进行loading效果展示,默认值为false,关闭。 netQualityLoadingThreshold:可选,number类型。展示loading效果的网络质量(network-quality)的阈值,默认网络质量等级为5。 frameStuckLoading:可选,boolean类型。true表示开启根据帧卡顿时长进行loading效果展示,默认值为false frameStuckThreshold:可选,number类型。展示loading效果帧卡顿时长的阈值,单位为100ms。默认值为10,表示帧卡顿时长为1000ms。 } 注意: 需要在起播之前进行设置。 DNS_QUERY_ENABLE boolean类型,可选,默认为false,true表示开启DNS结果解析,false表示关闭DNS结果解析。 AC CES S_DOMAIN string类型,可选,默认为空,主要用于拉流环境配置,沟通华为工程师填入。 GLSB_DOMAIN string类型,可选,默认为空,主要用于GSLB环境配置,沟通华为工程师填入。 BACKGROUND_PLAY boolean类型,可选,默认为false,true表示开启后台播放,false表示关闭后台播放 AUTO_DOWNGRADE boolean类型,可选,默认为true,true表示开启自动降级,false表示关闭自动降级 【返回参数】 boolean:配置参数设置结果。true表示参数设置成功,false表示参数设置失败。
  • createClient createClient(type: string): HWLLSClient | HWFlvClient | HWHlsClient 【功能说明】 创建一个直播拉流客户端对象,如果需要拉取多个直播流则需要创建多个客户端对象。 【请求参数】 type:string类型,可选。创建的拉流客户端类型。 低时延直播拉流客户端类型:webrtc。 flv直播拉流客户端类型:flv。 HLS直播拉流客户端类型:hls(预留,暂未开放)。 缺省值:webrtc。 【返回参数】 client:拉流客户端对象。
  • 软件包完整性校验 用户可对下载的SDK包进行完整性校验,判断下载过程中是否存在篡改和丢包现象。 详细操作如下所示: 在表1中下载SDK包及其完整性校验sha256包至本地。 打开本地命令提示符框,输入如下命令,在本地生成已下载SDK包的SHA256值。 其中,“D:\HWLLS_SDK_Web_2.6.0.tar.gz”为SDK包本地存放路径和SDK包名,请根据实际情况修改。 certutil -hashfile D:\HWLLS_SDK_Web_2.6.0.tar.gz SHA256 命令执行结果示例,如下所示: SHA256 的 D:\HWLLS_SDK_Web_2.6.0.tar.gz 哈希: 3ac83be852e8dcc9e90f236801fd4c494983073543e1ae66ee4d0c29043dccd1 CertUtil: -hashfile 命令成功完成。 比对查询出的SDK包SHA256值和下载后的SDK包SHA256值。 如果一致,说明下载过程中不存在篡改和丢包现象。
  • 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表示失败。
  • 修订记录 表1 修订记录 修改时间 修改说明 2024-12-02 低时延直播Web SDK更新点,如下所示: 支持自动降级和指定降级。 支持移动端后台播放音频。 解决设备兼容性问题。 支持多实例video标签id。 2024-11-12 新增最佳实践及其相关的代码示例。 2024-06-27 新增setReportConfig接口,更新SDK。 2024-03-19 1、新增SDK包下载路径及其完整性校验方法。 2、新增FLV、HLS等相关资料。 2023-10-30 第一次正式发布。 父主题: Web SDK