From 0976cb3b94eecb3ecffbeeb3a0a2a2b71e46d303 Mon Sep 17 00:00:00 2001 From: zhouliujun <1096432931@qq.com> Date: Thu, 14 Nov 2019 17:18:10 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E8=AF=B4=E6=98=8E=E6=96=87?= =?UTF-8?q?=E6=A1=A3,=E6=9B=B4=E6=96=B0=E9=A1=B9=E7=9B=AEdemo?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.1.md | 217 --------------------- README.md | 307 +++++++++++++++++++++++++++++- examples/App.vue | 33 ++-- images/p1.png | Bin 0 -> 28837 bytes images/p2.png | Bin 0 -> 23243 bytes images/s1.png | Bin 23697 -> 0 bytes images/s2.png | Bin 56347 -> 0 bytes images/s3.png | Bin 79942 -> 0 bytes images/s4.png | Bin 41122 -> 0 bytes images/s5.png | Bin 62880 -> 0 bytes packages/AliplayerV2/src/main.vue | 12 +- 11 files changed, 329 insertions(+), 240 deletions(-) delete mode 100644 README.1.md create mode 100644 images/p1.png create mode 100644 images/p2.png delete mode 100644 images/s1.png delete mode 100644 images/s2.png delete mode 100644 images/s3.png delete mode 100644 images/s4.png delete mode 100644 images/s5.png diff --git a/README.1.md b/README.1.md deleted file mode 100644 index 0b56493..0000000 --- a/README.1.md +++ /dev/null @@ -1,217 +0,0 @@ -# sign-canvas 一个基于canvas开发,封装于Vue组件的通用手写签名板(电子签名板),支持pc端和移动端; - -#### ┭┮﹏┭┮ 因为 vue-aliplayer-v2 的包名被占用了,只好去掉一个前缀了.... 假如此轮子对你有帮助,请顺手star一下吧.o(*￣︶￣*)o - -## 开始使用! 下载安装npm包 -```bash -npm i sign-canvas --save -``` -```javascript -//全局注册 main.js -import SignCanvas from 'sign-canvas'; - -Vue.use(SignCanvas); - -``` - -你可以这样使用:  - -### 组件模板使用 - -```html - - - - -``` -### 功能与配置 - -```javascript -props:{ - options: { //配置项 - required: false, - type: [Object], - default: () => null - } -} - -// 1. options [Object] 可选,非必传 - -// 2. v-model [String] 可选,非必传 - -``` -1. 配置项 options 属性 -```javascript -{ - lastWriteSpeed: 1, //书写速度 [Number] 可选 - lastWriteWidth: 2, //下笔的宽度 [Number] 可选 - lineCap: 'round', //线条的边缘类型 [butt]平直的边缘 [round]圆形线帽 [square] 正方形线帽 - lineJoin: 'round', //线条交汇时边角的类型 [bevel]创建斜角 [round]创建圆角 [miter]创建尖角。 - canvasWidth: 600, //canvas宽高 [Number] 可选 - canvasHeight: 600, //高度 [Number] 可选 - isShowBorder: true, //是否显示边框 [可选] 当签名模式处于false的时候此选项才生效 - bgColor: '#fcc', //背景色 [String] 可选 - borderWidth: 1, // 网格线宽度 [Number] 可选 - borderColor: "#ff787f", //网格颜色 [String] 可选 - writeWidth: 5, //基础轨迹宽度 [Number] 可选 - maxWriteWidth: 30, // 写字模式最大线宽 [Number] 可选 - minWriteWidth: 5, // 写字模式最小线宽 [Number] 可选 - writeColor: '#101010', // 轨迹颜色 [String] 可选 - isSign: false, //签名模式 [Boolean] 默认为非签名模式,有线框, 当设置为true的时候没有任何线框 - imgType:'png' //下载的图片格式 [String] 可选为 jpeg canvas本是透明背景的 -} -``` - -2. 内置方法 -```javascript -//清除画布 无返回值 [Void] -this.$refs.SignCanvas.canvasClear(); - -//清除画布 返回图片的base64编码 [String] -this.$refs.SignCanvas.saveAsImg(); - -//调用内置的下载图片方法,默认将图片保存为png格式 -this.$refs.SignCanvas.downloadSignImg(); - -``` -## [在线演示](https://langyuxiansheng.github.io/vue-aliplayer-v2/) -### 图片展示 ---- - -初始化展示 -![初始化展示](https://github.com/langyuxiansheng/vue-aliplayer-v2/blob/master/images/s1.png) - -非签名模式书写展示 -![非签名模式书写展示](https://github.com/langyuxiansheng/vue-aliplayer-v2/blob/master/images/s2.png) - -保存展示 -![保存展示](https://github.com/langyuxiansheng/vue-aliplayer-v2/blob/master/images/s3.png) - -下载的图片展示 -![下载的图片展示](https://github.com/langyuxiansheng/vue-aliplayer-v2/blob/master/images/s4.png) - -签名模式的图片展示 -![签名模式的图片展示](https://github.com/langyuxiansheng/vue-aliplayer-v2/blob/master/images/s5.png) - ---- -## 更多功能正在完善中...... -## 如果您有什么好的建议请留言 - -## 二次开发 下载项目 - -```bash -git clone https://github.com/langyuxiansheng/vue-aliplayer-v2.git -``` - -## Project setup -```bash -cd vue-aliplayer-v2 - -npm install -``` - -### Compiles and hot-reloads for development -```bash -npm run dev -``` - -### Compiles and minifies for production -```bash -npm run build -``` - -### Lints and fixes files -```bash -npm run lint -``` - -## 缺陷 & 后期计划 - -> 目前还没有撤销回到上一步的操作,一旦输入错了就只有清除重写了(这个是之前去银行的时候,那个签名板是这样设计的); -> 如果有需要还是可以考虑加上回到上一步的方法. - -### Customize configuration -See [Configuration Reference](https://cli.vuejs.org/config/). diff --git a/README.md b/README.md index e5ed273..87137bf 100644 --- a/README.md +++ b/README.md @@ -1 +1,306 @@ -## 感谢每一位开源的开发者. 这是一个基于Alipayer 开发并封装成vue组件的播放器. \ No newline at end of file +## 感谢每一位开源的开发者. 这是一个基于Alipayer 开发并封装成vue组件的播放器. +#### 假如此轮子对你有帮助,请顺手star一下吧.o(*￣︶￣*)o +## 1.安装使用! 下载安装npm包 +```bash +npm i vue-aliplayer-v2 --save +or +yarn add vue-aliplayer-v2 +``` +```javascript +//全局注册 main.js +import VueAliplayerV2 from 'vue-aliplayer-v2'; + +Vue.use(VueAliplayerV2); +``` + +## 2.组件中使用 + +### 组件模板使用,但需要注意的是,假如你的页面中有多个播放器,那么这个id需要唯一!!,ID必传,只有一个的时候,可以忽略,命名只能是有效字符开头. 下面的视频连接是无效的,需要自己去替换成有效的. +```html + + + +``` +## 3.功能与配置 + +```javascript +props:{ + options: { //配置项 + required: false, + type: [Object], + default: () => null + }, + id:{ //播放器的ID 唯一标识符 不传就是默认的 但是有多个的时候不一定是唯一的 + required: false, + type: [String], + default: `player-${Date.parse(new Date())}` + } +} +``` +### 3.1 配置项 options 属性 +可以参考 [属性和接口说明](https://help.aliyun.com/document_detail/125572.html?spm=a2c4g.11186623.6.1085.36fc6fc57WKZ5P) + +| 名称 | 类型 | 说明 | +| :- | :-: | :- | +| source | String | 视频播放地址url：单独url。默认状态，表示使用vid+playauth。source播放方式优先级最高。source支持多清晰度设置：source:’{“HD”:”address1”,”SD”:”address2”’，详情参见多清晰度播放。 | +| vid | String | 媒体转码服务的媒体Id。 | +| playauth | String | 播放权证，如何得到参见获取playauth。 | +| height | String | 播放器高度，可形如‘100%’或者‘100px’,chrome浏览器下flash播放器分别不能小于397x297。 | +| width | String | 播放器宽度，可形如‘100%’或者‘100px’,chrome浏览器下flash播放器分别不能小于397x297。 | +| videoWidth | String | 视频宽度，仅h5支持。详情参见旋转和镜像。 | +| videoHeight | String | 视频高度，仅h5支持。详情参见旋转和镜像。 | +| preload | Boolean | 播放器自动加载，目前仅h5可用。 | +| cover | String | 播放器默认封面图片，请填写正确的图片url地址。需要autoplay为’false’时，才生效。Flash播放器封面也需要开启允许跨域访问。 | +| isLive | Boolean | 播放内容是否为直播，直播时会禁止用户拖动进度条。 | +| autoplay | Boolean | 播放器是否自动播放，在移动端autoplay属性会失效。Safari11不会自动开启自动播放如何开启。 | +| rePlay | Boolean | 播放器自动循环播放。 | +| useH5Prism | Boolean | 指定使用H5播放器。 | +| useFlashPrism | Boolean | 指定使用Flash播放器。 | +| playsinline | Boolean | H5是否内置播放，有的Android浏览器不起作用。 | +| showBuffer | Boolean | 显示播放时缓冲图标，默认true。 | +| skinRes | Url | 说明：皮肤图片，不建议随意修改该字段，如要修改，请参照皮肤定制。 | +| skinLayout | Array Boolean | 说明：功能组件布局配置，不传该字段使用默认布局。传false隐藏所有功能组件，请参照皮肤定制。 | +| controlBarVisibility | String | 控制面板的实现，默认为‘hover’。可选的值为：‘click’、‘hover’、‘always’。 | +| showBarTime | String | 控制栏自动隐藏时间（ms）。 | +| extraInfo | String | 说明：JSON串用于定制性接口参数。| +| > | > | 1.“fullTitle”：“测试页面”全屏时显示视频标题（仅flash支持）。| +| > | > | 2. “m3u8BufferLength”：“30”播放m3u8时加载缓存ts文件长度单位（秒）（仅flash支持）。| +| > | > | 3. “liveStartTime”：“2016/08/17 12:00:00”,直播开始时间，用于提示直播未开始(仅flash支持)。| +| > | > | 4. “liveOverTime”：“2016/08/17 14:00:00”,直播结束时间，用于提示直播结束（仅flash支持）。| +| enableSystemMenu | Boolean | 是否允许系统右键菜单显示，默认为false。 | +| format | String | 指定播放地址格式，只有使用vid的播放方式时支持,可选值为’mp4’、’m3u8’、’flv’、’mp3’，默认为空，仅H5支持。 | +| mediaType | String | 指定返回音频还是视频，只有使用vid的播放方式时支持。可选值为’video’和’audio’，默认为’video’,‘audio’主要是针对只包含音频的视频格式，比如音频的mp4，仅H5支持。 | +| qualitySort | String | 指定排序方式，只有使用vid + plauth播放方式时支持。‘desc’表示按倒序排序（即：从大到小排序）,‘asc’表示按正序排序（即：从小到大排序）,默认值：‘asc’，仅H5支持。 | +| definition | String | 显示视频清晰度，多个用逗号分隔，比如：’FD,LD’，此值是vid对应流清晰度的一个子集，取值范围：FD（流畅）LD（标清）SD（高清）HD（超清）OD（原画）2K（2K）4K（4K），仅H5支持。 | +| defaultDefinition | String | 默认视频清晰度，此值是vid对应流的一个清晰度，取值范围：FD（流畅）LD（标清）SD（高清）HD（超清）OD（原画）2K（2K）4K（4K）,仅H5支持。| +| x5_type | String | 声明启用同层H5播放器，启用时设置的值为‘h5’,详情参见同层播放。 | +| x5_fullscreen | Boolean | 声明视频播放时是否进入到TBS的全屏模式，默认为false。当需要把视频做为背景时，设置为true,详情参见同层播放。 | +| x5_video_position | String | 声明视频播在界面上的位置，默认为“center”。可选值为：“top”，“center”,详情参见同层播放。 | +| x5_orientation | String | 声明TBS播放器支持的方向，可选值：landscape：横屏,portraint：竖屏,详情参见同层播放。 | +| x5LandscapeAsFullScreen | String | 声明TBS全屏播放是否横屏，默认值为true。 | +| autoPlayDelay | Number | 延迟播放时间，单位为秒。详情参见延迟播放 | +| autoPlayDelayDisplayText | String | 延迟播放提示文本，详情参见延迟播放。 | +| language | String | 国际化，默认为‘zh-cn’。如果未设置，则采用浏览器语言。可选值为‘zh-cn’、‘en-us’或其它值。 | +| languageTexts | JSON | 自定义国际化文本json结构，key的值需要和language属性值对应起来。例子：{jp:{Play:”Play”}},自定义值参见Json结构。 | +| snapshot | Boolean | flash启用截图功能。 | +| snapshotWatermark | Object | H5设置截图水印。 | +| useHlsPluginForSafari | Boolean | Safari浏览器可以启用Hls插件播放，Safari 11除外。 | +| enableStashBufferForFlv | Boolean | H5播放flv时，设置是否启用播放缓存，只在直播下起作用。 | +| stashInitialSizeForFlv | Number | H5播放flv时，初始缓存大小，只在直播下起作用。 | +| loadDataTimeout | Number | 缓冲多长时间后，提示用户切换低清晰度，默认：20秒。 | +| waitingTimeout | Number | 最大缓冲超时时间，超过这个时间会有错误提示，默认：60秒。 | +| liveStartTime | String | 直播开始时间，直播时移功能使用，格式为：“2018/01/04 12:00:00”。 | +| liveOverTime | String | 直播结束时间，直播时移功能使用，格式为：“2018/01/04 12:00:00”。 | +| liveTimeShiftUrl | String | 直播可用时移查询地址，详情参见直播时移。 | +| liveShiftSource | String | flv直播地址播放时，hls的流地址，详情参见直播时移。 | +| recreatePlayer | Function | flv直播和hls时移切换是，重新创建播放器方法，详情参见直播时移。 | +| diagnosisButtonVisible | Boolean | 是否显示检测按钮，默认为true。 | +| disableSeek | Boolean | 禁用进度条的Seek，默认为false，仅Flash支持。 | +| encryptType | int | 加密类型，播放点播私有加密视频时，设置值为1，默认值为0。 | +| progressMarkers | Array | 进度条打点内容数组，详情参见进度条打点。 | +| vodRetry | int | 点播失败重试次数，默认3次 | +| liveRetry | int | 直播播放失败重试次数，默认5次 | + +### 3.2 播放器方法 +2. 内置方法 +```javascript +// 暂停播放 +this.$refs.VueAliplayerV2.pause(); +``` +可以参考 [播放器接口方法](https://help.aliyun.com/document_detail/125572.html?spm=a2c4g.11186623.6.1085.36fc6fc57WKZ5P#h2-u64ADu653Eu5668u63A5u53E32) + +| 名称 | 参数 | 说明 | +| :- | :-: | :- | +| play | - | 播放视频。 | +| pause | - | 暂停视频。 | +| replay | - | 重播视频。 | +| seek | time | 跳转到某个时刻进行播放，time的单位为秒。 | +| getCurrentTime | - | 获取当前的播放时刻，返回的单位为秒。 | +| getDuration | - | 获取视频总时长，返回的单位为秒，这个需要在视频加载完成以后才可以获取到，可以在play事件后获取。 | +| getVolume | - | 获取当前的音量，返回值为0-1的实数。ios和部分android会失效。 | +| setVolume | - | 设置音量，vol为0-1的实数，ios和部分android会失效。 | +| loadByUrl | url，time | 直接播放视频url，time为可选值（单位秒）。目前只支持同种格式（mp4/flv/m3u8）之间切换。暂不支持直播rtmp流切换。 | +| replayByVidAndPlayAuth | vid：视频id,playauth：播放凭证 | 目前只支持H5播放器。暂不支持不同格式视频间的之间切换。暂不支持直播rtmp流切换。 | +| replayByVidAndAuthInfo | 仅MPS用户时使用,参数顺序为：vid、accId、accSecret、stsToken、authInfo、domainRegion | 目前只支持H5播放器。暂不支持不同格式视频间的之间切换。暂不支持直播rtmp流切换。 | +| setPlayerSize | w，h | 设置播放器大小w，h可分别为400px像素或60%百分比。chrome浏览器下flash播放器分别不能小于397x297。 | +| setSpeed | speed | 手动设置播放的倍速，倍速播放仅H5支持。移动端可能会失效，比如android微信。倍速播放UI默认是开启的。如果自定义过skinLaout属性，需要添加speedButton项到数组里： +{name：“speedButton”，align：“tr”，x：10，y：23} | +| setSanpshotProperties | width：宽度,height：高度,rate：截图质量| 设置截图参数。 | +| requestFullScreen | - | 播放器全屏，仅H5支持。 | +| cancelFullScreen | - | 播放器退出全屏，iOS调用无效，仅H5支持。 | +| getIsFullScreen | - | 获取播放器全屏状态，仅H5支持。 | +| getStatus | - | 获取播放器状态，包含的值：‘init’,‘ready’,‘loading’,‘play’,‘pause’,‘playing’,‘waiting’,‘error’,‘ended’ | +| setLiveTimeRange | 开始时间,结束时间 | 设置直播的开始结束时间，开启直播时移功能时使用。例子：player.liveShiftSerivce.setLiveTimeRange(“”，‘2018/01/04 20:00:00’) | +| setRotate | rotate 旋转角度 | 参数为旋转角度， 正数为正时针旋转， 负数为逆时针旋转。例如: setRotate(90)。详情参见旋转和镜像。 | +| getRotate | - | 获取旋转角度。详情参见旋转和镜像。 | +| setImage | image：镜像类型,可选值为：horizon,vertical | 设置镜像，例如: setImage(‘horizon’)。详情参见旋转和镜像。 | +| dispose | - | 播放器销毁 | +| setCover | cover封面地址 | 设置封面 | +| setProgressMarkers | markers打点数据集合 | 设置打点数据 | +| setPreviewTime | time试看时间 | 设置试看时间，单位为秒，详情参见试看 | +| getPreviewTime | - | 获取试看时间 | +| isPreview | - | 是否试看 | +| off | ev:事件名[String],handle,事件回调方法[Function] | 通过播放器实例的off方法取消绑定的方法 | + +## 4.播放器事件 + +```html + + +``` +可以参考 [播放器事件](https://help.aliyun.com/document_detail/125572.html?spm=a2c4g.11186623.6.1085.36fc6fc57WKZ5P#h2-u64ADu653Eu5668u4E8Bu4EF63) + +| 名称 | 说明 | +| :- | :- | +| ready | 播放器视频初始化按钮渲染完毕。播放器UI初始设置需要此事件后触发，避免UI被初始化所覆盖。播放器提供的方法需要在此事件发生后才可以调用。 | +| play | 视频由暂停恢复为播放时触发。 | +| pause | 视频暂停时触发。 | +| canplay | 能够开始播放音频/视频时发生，会多次触发，仅H5播放器。 | +| playing | 播放中，会触发多次。 | +| ended | 当前视频播放完毕时触发。 | +| liveStreamStop | 直播流中断时触发。m3u8/flv/rtmp在重试5次未成功后触发。提示上层流中断或需要重新加载视频。PS：m3u8一直自动重试，不需要上层添加重试。 | +| onM3u8Retry | m3u8直播流中断后重试事件，每次断流只触发一次。 | +| hideBar | 控制栏自动隐藏事件。 | +| showBar | 控制栏自动显示事件。 | +| waiting | 数据缓冲事件。 | +| timeupdate | 播放位置发生改变时触发，仅H5播放器。可通过getCurrentTime方法，得到当前播放时间。 | +| snapshoted | 截图完成事件。 | +| requestFullScreen | 全屏事件，仅H5支持。 | +| cancelFullScreen | 取消全屏事件，iOS下不会触发，仅H5支持。 | +| error | 错误事件。 | +| startSeek | 开始拖拽，参数返回拖拽点的时间。 | +| completeSeek | 完成拖拽，参数返回拖拽点的时间。 | + +## [本项目在线演示](https://langyuxiansheng.github.io/vue-aliplayer-v2/) +## [阿里云播放器在线演示](https://player.alicdn.com/aliplayer/index.html) +--- +## 5. 图片展示 + +![图片1](https://github.com/langyuxiansheng/vue-aliplayer-v2/blob/master/images/p1.png) +![图片2](https://github.com/langyuxiansheng/vue-aliplayer-v2/blob/master/images/p2.png) +--- +## 如果您有什么好的建议请留言 + +## 二次开发 下载项目 + +```bash +git clone https://github.com/langyuxiansheng/vue-aliplayer-v2.git +``` + +## Project setup +```bash +cd vue-aliplayer-v2 + +npm install +``` + +### Compiles and hot-reloads for development +```bash +npm run dev +``` + +### Compiles and minifies for production +```bash +npm run build +``` + +### Lints and fixes files +```bash +npm run lint +``` + +## 缺陷 & 后期计划 + +> 您有功能建议,或者bug反馈请留言. + +### Customize configuration +See [Configuration Reference](https://cli.vuejs.org/config/). diff --git a/examples/App.vue b/examples/App.vue index 8eb67b1..e1f0d13 100644 --- a/examples/App.vue +++ b/examples/App.vue @@ -1,19 +1,21 @@