1.0.8 • Published 8 months ago

@whale-labs/whale-web-player v1.0.8

Weekly downloads
-
License
ISC
Repository
-
Last release
8 months ago

whale-web-player, 帷幄音视频 player 组件, 主要提供实时视频播放等功能。

Player API

参数说明类型默认值
company_id公司id,用于初始化player(必填参数)string
id设备相关的唯一id,也可理解为设备的sn号 (必填参数)string
name支持左上角设备信息的填入(非必填参数)stringundefined
height用于player展示高度,展示的为pxnumber默认为100%,根据外围容器来定
width用于player展示宽度,展示的为pxnumber默认为100%,根据外围容器来定
baseURI用于请求openapi的域名hoststringhttps://open-api.test.meetwhale.com
refplayer相关的ref,用于取whale-player中的一些视频操作方法,比如seek、play、pause、changeResolution、refresh、destroyPlayer 等方法, seek方法传入为时间戳,毫秒值refuseRef返回值
progressColor用于传入进度条颜色color string'D2EAFF'
closeFnplayer 右上角关闭 icon, 默认为空,不展示关闭按钮,有方法传入则展示funcundefined
seekTime用于初始化开始播放的时间,number(时间戳、毫秒)默认值为空或者为0表示为直播
leftTime用于x分钟断流时间number(分钟)默认值为空,不进行断流操作
tipLeftTime用于断流时间到了之后,提示多少秒结束断流number(秒)默认值为60秒
autoPlay用于初始化时候,是否自动播放boolean默认值为true
backgroundColor用于播放器container背景色string默认值为 #000
OSSConfig用于截图时上传使用的ALI-OSS配置Options默认值为空Object, 截图会warning"请配置OSS参数"

playerInstance

名称说明类型
seek用于操作设备播放的时间,传入时间戳(毫秒),返回直播,传入time为0即可 。 (传入type progress,为当天内时间毫秒,默认不需要)seek(time: string, type?: 'progress'undefined) => void
play用于操作设备播放操作,无需传入参数() => void
pause用于操作设备暂停操作,无需传入参数() => void
changeResolution用于切换清晰度(quality: StreamQuality) => void
refresh用于刷新播放器,刷新会重新请求、销毁播放器并重新拉起播放器() => void
destoryPlayer用于销毁播放器() => void

其他

名称说明类型
StreamQuality操作设备清晰度 enum, 1 为标清、 2 为高清enum
1.0.8

8 months ago

1.0.7

9 months ago

1.0.6

12 months ago

1.0.5-alpha.8

1 year ago

1.0.5-alpha.7

1 year ago

1.0.5-alpha.9

1 year ago

1.0.5-alpha.6

1 year ago

1.0.5-alpha.5

1 year ago

1.0.5-alpha.4

1 year ago

1.0.5-alpha.3

1 year ago

1.0.5-alpha.2

1 year ago

1.0.5-alpha.1

1 year ago

1.0.5-alpha.0

1 year ago

1.0.5

1 year ago

1.0.4

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0-alpha.0

1 year ago

1.0.0

1 year ago