使用指南
多彩未来电视播放器
提醒
该库仅支持在模拟器或TV使用,播放器层级是最低的,所以不建议在当前拥有其它布局元素的页面去使用,假如要使用你的背景应该设置为透明的。建议留播放器的位置就全透明,无任何遮盖,镂空状态,给播放器留一个空区域用于展示。不要用弹窗形式展示播放器,请打开新页面使用!!!
安装
该库已经同步到npm仓库
# yarn
yarn add @ftvs/media-player
# or, pnpm
pnpm add @ftvs/media-player
使用方式
import { ftvMediaPlayer } from '@ftvs/media-player';
const _ftvMediaPlayer = new ftvMediaPlayer({
url: '播放地址',
left: 80,
top: 80,
width: 500,
height: 500
}, true)
初始化配置
属性 | 类型 | 说明 |
---|---|---|
initParams | object:{url: string,left: number,top: number,width: number,height: number} | 基础配置url:播放地址,left:相对于所在浏览器窗口左上角的右向偏移的象素点个数。top:相对于所在浏览器窗口左上角的向下偏移的象素点个数。width:显示视频的窗口宽度的象素点个数。width和height任意一个值为0,都按照全屏处理。height 显示视频的窗口高度的象素点个数。width和height任意一个值为0,都按照全屏处理。 |
isDebug | boolean | 调试模式、打印关键流程log,默认是false |
实例属性
属性名 | 类型 | 入参 | 返回值 | 说明 |
---|---|---|---|---|
canKeyOn | function | (boolean) | 是否支持按键 | |
start | function | 开始播放 | ||
stop | function | 停止播放 | ||
pause | function | 暂停播放 | ||
resume | function | 从当前媒体的暂停/快进/快退状态恢复正常播放 | ||
resetVideoShow | function | (number) | 窗口显示模式,0 按 setVideoDisplayArea()中设定的Height, Width, Left, Top 属性所指定的位置和大小来显示视频,1 全屏显示,按全屏高度和宽度显示(默认值),2 按宽度显示,指在不改变原有图像纵横比的情况下按全屏宽度显示,3 按高度显示,指在不改变原有图像纵横比的情况下按全屏高度显示,255 视频显示窗口将被关闭。它将在保持媒体流连接的前提下,隐藏视频窗口。如果流媒体播放没有被暂停,将继续播放音频。 | |
setVideoDisplayArea | function | (left, top, width, height) | 视频窗口的位置和大小 | |
fastForward | function | (boolean) | 快进 | |
fastRewind | function | (boolean) | 快退 |