一款使用typescript开发的react播放器插件
? 特性
- 开箱即用的高质量 React 组件。
- 使用 TypeScript 开发,提供完整的类型定义文件。
- 国际化语言支持。
- 主题,组件,定制能力。
- 强大的 API 和回调函数
- 体积小,80kb?
- 支持
HLS
(.m3u8
)格式,支持H264
格式
npm install jol-player --save
示例
import JoLPlayer from "jol-player";
const App = () => (
<>
>
);
【一款使用typescript开发的react播放器插件】demo案例
文档 属性/配置项 如下属性来自
option
属性配置项.参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
width | 视频容器的 width(必传) | number |
必传 |
height | 视频容器的 height(必传) | number |
必传 |
videoSrc | 视频地址(必传) | string |
必传 |
theme | 主题 | string |
\#ffb821 |
poster | 视频封面图 | string |
- |
setEndPlayContent | 自定义视频结束时显示的内容 | React.ReactNode |
- |
setBufferContent | 自定义视频缓冲加载组件 | React.ReactNode |
- |
pausePlacement | 暂停键的位置 | bottomRight ,center |
bottomRight |
hideMouseTime | 多少毫秒,无任何操作,隐藏鼠标和控制器/ms | number |
2000 |
isShowMultiple | 是否显示播放倍数功能 | boolean |
true |
isShowSet | 是否显示设置功能 | boolean |
true |
isShowScreenshot | 是否显示截图功能 | boolean |
true |
isShowPicture | 是否显示画中画 | boolean |
true |
isShowWebFullScreen | 是否显示网页全屏 | boolean |
true |
language | 语言 | zh ,en |
zh |
isShowPauseButton | 是否显示暂停键 | boolean |
true |
quality | 视频质量清晰度的选择列表 | qualityAttributes[] |
- |
videoType | 视频播放格式,支持h264(.mp4 ,.webm ,.ogg ),hls(.m3u8 ) |
h264 ,hls |
h264 |
isToast | 是否显示toast | boolean |
false |
toastPosition | toast的位置,此值只有isToast 为true时,才有效果 |
leftTop ,rightTop ,leftBottom ,rightBottom ,center |
leftTop |
isProgressFloat | 是否显示进度条浮层提示 | boolean |
false |
progressFloatPosition | 进度条浮层提示的位置,此值只有isProgressFloa t为true时,才有效果 |
tp ,bt |
bt |
温馨提示:
qualityAttributes
接口声明如下:
/**
* 标清 360P SD
* 高清 540P HD
* 超清 720P FHD
* 蓝光 1080P BD
*/
export type qualityName = 'SD' | 'HD' | 'FHD' | 'BD';
export type qualityKey = '360P' | '540P' | '720P' | '1080P';
export interface qualityAttributes {
name: T;
url: string;
}
方法
名称 | 说明 | 类型 |
---|---|---|
load | 重新加载 | () => void |
pause | 暂停 | () => void |
play | 开始播放 | () => void |
setVolume | 设置音量,[0-100] | (par:number ) => void |
seek | 设置指定视频的播放位置/s | (par:number ) => void |
setVideoSrc | 设置播放视频的地址 src | (par:string ) => void |
提示:
如上方法要借助ref
才能调用,如:xxx.current.load()具体请参看,demo案例
回调函数
export interface videoAttributes {
/**
* @description 是否播放
*/
isPlay: K;
/**
* @description 当前时间/s
*/
currentTime: T;
/**
* @description 总时长
*/
duration: T;
/**
* @description 缓存时长/s
*/
bufferedTime: T;
/**
* @description 是否开启画中画
*/
isPictureinpicture: K;
/**
* @description 音量
*/
volume: T;
/**
* @description 视频播放倍数
*/
multiple: T;
/**
* @description 是否结束
*/
isEndEd: K;
/**
* @description 错误
*/
error: null | T;
}export type qualityKey = '360P' | '540P' | '720P' | '1080P';
名称 | 说明 | 类型 |
---|---|---|
onProgressMouseDown | 滑动条按下不放,拖动回调 | (e: videoAttributes) => void |
onProgressMouseUp | 滑动条按下松开回调 | (e: videoAttributes) => void |
onPlay | 视频开始播放回调 | (e: videoAttributes) => void |
onPause | 视频暂停播放的回调 | (e: videoAttributes) => void |
onTimeChange | 视频在播放,时间变化回调 | (e: videoAttributes) => void |
onEndEd | 视频结束时回调 | (e: videoAttributes) => void |
onvolumechange | 音量改变时的回调 | (e: videoAttributes) => void |
onError | 视频播放失败的回调 | () => void |
onQualityChange | 视频清晰度改变时的回调 | (e:callBackType |
JoLPlaye
r接收的参数接口如下:export interface videoparameter extends Partial {
style?: React.CSSProperties;
/**
* @description 组件的配置项
*/
option: videoOption;
className?: string;
ref?: JoLPlayerRef
}
地址 项目地址
预览地址
推荐阅读
- 由浅入深理解AOP
- 【译】20个更有效地使用谷歌搜索的技巧
- mybatisplus如何在xml的连表查询中使用queryWrapper
- MybatisPlus|MybatisPlus LambdaQueryWrapper使用int默认值的坑及解决
- MybatisPlus使用queryWrapper如何实现复杂查询
- iOS中的Block
- Linux下面如何查看tomcat已经使用多少线程
- 使用composer自动加载类文件
- android|android studio中ndk的使用
- 使用协程爬取网页,计算网页数据大小