uniapp之video组件和video API用法示例

7,379 阅读10分钟

video视频组件 - uniapp

组件: video

视频播放组件

属性说明

属性名类型默认值说明平台差异说明
srcString要播放视频的资源地址
autoplayBooleanfalse是否自动播放
loopBooleanfalse是否循环播放
mutedBooleanfalse是否静音播放飞书小程序不支持
initial-timeNumber指定视频初始播放位置,单位为秒(s)。飞书小程序不支持
durationNumber指定视频时长,单位为秒(s)。抖音小程序、飞书小程序、快手小程序、京东小程序不支持
controlsBooleantrue是否显示默认播放控件(播放/暂停按钮、播放进度、时间)快手小程序不支持
danmu-listObject Array弹幕列表抖音小程序、飞书小程序、快手小程序、京东小程序不支持
danmu-btnBooleanfalse是否显示弹幕按钮,只在初始化时有效,不能动态变更抖音小程序、飞书小程序、快手小程序、京东小程序不支持
enable-danmuBooleanfalse是否展示弹幕,只在初始化时有效,不能动态变更抖音小程序、飞书小程序、快手小程序、京东小程序不支持
page-gestureBooleanfalse在非全屏模式下,是否开启亮度与音量调节手势微信小程序、H5
directionNumber设置全屏时视频的方向,不指定则根据宽高比自动判断。有效值为 0(正常竖向), 90(屏幕逆时针90度), -90(屏幕顺时针90度)H5、飞书小程序、快手小程序、京东小程序不支持
show-progressBooleantrue若不设置,宽度大于240时才会显示抖音小程序、飞书小程序、快手小程序、京东小程序不支持
show-fullscreen-btnBooleantrue是否显示全屏按钮京东小程序不支持
show-play-btnBooleantrue是否显示视频底部控制栏的播放按钮京东小程序不支持
show-center-play-btnBooleantrue是否显示视频中间的播放按钮抖音小程序、京东小程序不支持
show-loadingBooleantrue是否显示loading控件仅app 2.8.12+
enable-progress-gestureBooleantrue是否开启控制进度的手势抖音小程序、京东小程序不支持
object-fitStringcontain当视频大小与 video 容器大小不一致时,视频的表现形式。contain:包含,fill:填充,cover:覆盖App、微信小程序、抖音小程序、飞书小程序、H5、京东小程序
posterString视频封面的图片网络资源地址,如果 controls 属性值为 false 则设置 poster 无效
show-mute-btnBooleanfalse是否显示静音按钮微信小程序、抖音小程序、App-nvue
titleString视频的标题,全屏时在顶部展示微信小程序、App(3.6.7+)
play-btn-positionStringbottom播放按钮的位置微信小程序、抖音小程序、飞书小程序
mobilenet-hint-typenumber1移动网络提醒样式:0是不提醒,1是提醒,默认值为1京东小程序
enable-play-gestureBooleanfalse是否开启播放手势,即双击切换播放/暂停微信小程序、快手小程序
auto-pause-if-navigateBooleantrue当跳转到其它小程序页面时,是否自动暂停本页面的视频微信小程序
auto-pause-if-open-nativeBooleantrue当跳转到其它微信原生页面时,是否自动暂停本页面的视频微信小程序
vslide-gestureBooleanfalse在非全屏模式下,是否开启亮度与音量调节手势(同 page-gesture)微信小程序、App(3.4.0+)、快手小程序
vslide-gesture-in-fullscreenBooleantrue在全屏模式下,是否开启亮度与音量调节手势微信小程序、App(3.4.0+)、快手小程序
ad-unit-idString视频前贴广告单元ID,更多详情可参考开放能力视频前贴广告微信小程序
poster-for-crawlerString用于给搜索等场景作为视频封面展示,建议使用无播放 icon 的视频封面图,只支持网络地址微信小程序
codecStringhardware解码器选择,hardware:硬解码(硬解码可以增加解码算力,提高视频清晰度。少部分老旧硬件可能存在兼容性问题);software:ffmpeg 软解码;App-Android 3.1.0+
http-cacheBooleantrue是否对 http、https 视频源开启本地缓存。缓存策略:开启了此开关的视频源,在视频播放时会在本地保存缓存文件,如果本地缓存池已超过100M,在进行缓存前会清空之前的缓存(不适用于m3u8等流媒体协议)App-Android 3.1.0+
play-strategyNumber0播放策略,0:普通模式,适合绝大部分视频播放场景;1:平滑播放模式(降级),增加缓冲区大小,采用open sl解码音频,避免音视频脱轨的问题,可能会降低首屏展现速度、视频帧率,出现开屏音频延迟等。 适用于高码率视频的极端场景;2: M3U8优化模式,增加缓冲区大小,提升视频加载速度和流畅度,可能会降低首屏展现速度。 适用于M3U8在线播放的场景App-Android 3.1.0+
headerObjectHTTP 请求 HeaderApp 3.1.19+
is-liveBooleanfalse是否为直播源App 3.7.2+、微信小程序(2.28.1+)
@playEventHandle当开始/继续播放时触发play事件飞书小程序不支持
@pauseEventHandle当暂停播放时触发 pause 事件飞书小程序不支持
@endedEventHandle当播放到末尾时触发 ended 事件飞书小程序不支持
@timeupdateEventHandle播放进度变化时触发,event.detail = {currentTime, duration} 。触发频率 250ms 一次飞书小程序不支持
@fullscreenchangeEventHandle当视频进入和退出全屏时触发,event.detail = {fullScreen, direction},direction取为 vertical 或 horizontal飞书小程序不支持
@waitingEventHandle视频出现缓冲时触发飞书小程序、快手小程序不支持
@errorEventHandle视频播放出错时触发飞书小程序不支持
@progressEventHandle加载进度变化时触发,只支持一段加载。event.detail = {buffered},百分比微信小程序、抖音小程序、H5
@loadeddataEventHandle视频资源开始加载时触发京东小程序
@loadstartEventHandle开始加载数据京东小程序
@seekedEventHandle拖动进度条结束京东小程序
@seekingEventHandle正在拖动进度条京东小程序
@loadedmetadataEventHandle视频元数据加载完成时触发。event.detail = {width, height, duration}微信小程序、H5、抖音小程序、京东小程序
@fullscreenclickEventHandle视频播放全屏播放时点击事件。event.detail = { screenX:"Number类型,点击点相对于屏幕左侧边缘的 X 轴坐标", screenY:"Number类型,点击点相对于屏幕顶部边缘的 Y 轴坐标", screenWidth:"Number类型,屏幕总宽度", screenHeight:"Number类型,屏幕总高度"}App 2.6.3+
@controlstoggleEventHandle切换 controls 显示隐藏时触发。event.detail = {show}微信小程序2.9.5

direction合法值

说明
0正常竖向
90屏幕逆时针90°
-90屏幕顺时针90°

object-fit合法值

说明
contain包含
fill填充
cover覆盖

play-btn-position合法值

说明
bottomcontrols bar上
center视频中间

注:play-btn-position属性对app无效

api: uni.createVideoContext()

方法

方法参数说明平台差异说明
play播放
pause暂停
seekposition跳转到指定位置,单位 s
stop停止视频微信小程序
sendDanmudanmu发送弹幕,danmu 包含两个属性 text, color
playbackRaterate设置倍速播放,支持的倍率有 0.5/0.8/1.0/1.25/1.5。微信基础库2.6.3 起支持 2.0 倍速
requestFullScreen进入全屏,可传入{direction}参数,详见 video 组件文档H5和抖音小程序不支持{direction}参数
exitFullScreen退出全屏
showStatusBar显示状态栏,仅在iOS全屏下有效微信小程序、百度小程序、QQ小程序
hideStatusBar隐藏状态栏,仅在iOS全屏下有效微信小程序、百度小程序、QQ小程序

实战案例

  1. video视频组件属性用法案例
  2. video视频API方法用法案例
  3. videoAPI加组件用法案例
  4. 多个视频控制案例

video视频组件属性用法案例

技术栈:

video组件

cover-view组件

如果有oss视频资源的可以直接拼接字符封面(https://help.aliyun.com/zh/oss/user-guide/video-snapshots),如果没有就找视频和图片资源

<template>
    <view>
        video组件案例
    </view>
    <view class="myVideo">
        <video 
        class="videoBox" :object-fit="objectfit"
        src="视频路径"
        :controls="controls"
        :muted="muted"
        :autoplay="autoplay"
        :loop="loop"
        :direction="direction"
        :show-progress="showprogress"
        >
            <cover-view class="mask"></cover-view>
        </video>
    </view>
</template><script>
    export default {
        data() {
            return {
                objectfit:"cover",// 视频表现形式,contain/cover/fill, 默认contain
                controls:true, //   controls - 是否显示视频控制器 - 播放按钮/进度条/全屏按钮 - 默认true
                muted:true,//   muted - 是否显示静音按钮 - 默认true
                autoplay:true,// autoplay - 是否开启自动播放 - 默认false
                loop:false, // loop是否循环播放 - 默认false
                direction:0,// 设置全屏时视频方向 ,0竖屏 , 90逆时针90 , -90 顺时针90,不设置自适应
                showprogress:true,//是否显示进度条,当屏幕宽大于240时自动显示
                
            }
        },
        methods: {
            
        }
    }
</script><style>
.myVideo{
    width: 100vw;
    height:400rpx;
}
.videoBox{
    position: relative;
    width: 100%;
    height: 100%;
}
.mask{
    position: absolute;
    width: 100%;
    height: 100%;
    background: rgba(255, 0, 0, .3);
}
</style>

video视频API方法用法案例

技术栈:

uni.createVideoContext()

创建并返回 video 上下文 videoContext 对象。在自定义组件下,第二个参数传入组件实例this,以操作组件内 <video> 组件。

<template>
    <view>
        video组件案例
    </view>
    <view class="myVideo">
        <video 
        id="video1" class="videoBox" :object-fit="objectfit"
        src="视频路径"
        >
            <cover-view class="mask">
                <cover-view @tap="playVideo">播放视频</cover-view>
                <cover-view @tap="stopVideo">暂停视频</cover-view>
            </cover-view>
        </video>
    </view>
</template><script>
    export default {
        data() {
            return {
                objectfit:"cover",// 视频表现形式,contain/cover/fill, 默认contain
            }
        },
        methods: {
            playVideo(){
                this.videoContext = uni.createVideoContext("video1")
                this.videoContext.play()
            },
            stopVideo(){
                this.videoContext.pause()
            }
        }
    }
</script><style>
.myVideo{
    width: 100vw;
    height:400rpx;
}
.videoBox{
    position: relative;
    width: 100%;
    height: 100%;
}
.mask{
    position: absolute;
    width: 100%;
    height: 100%;
    background: rgba(255, 0, 0, .3);
    display: flex;
    justify-content: center;
    align-items: center;
    color: #fff;
}
</style>

videoAPI加组件用法案例

技术栈:

video组件

video API

<template>
    <view>
        video组件案例
    </view>
    <view class="myVideo">
        <video id="video1"
        class="videoBox" :object-fit="objectfit"
        src="视频路径"
        :controls="controls"
        :muted="muted"
        :autoplay="autoplay"
        :loop="loop"
        :direction="direction"
        :show-progress="showprogress"
        >
            <cover-view class="mask" @tap="playVideo">播放视频</cover-view>
        </video>
    </view>
</template><script>
    export default {
        data() {
            return {
                objectfit:"cover",// 视频表现形式,contain/cover/fill, 默认contain
                controls:true, //   controls - 是否显示视频控制器 - 播放按钮/进度条/全屏按钮 - 默认true
                muted:true,//   muted - 是否显示静音按钮 - 默认true
                autoplay:false,// autoplay - 是否开启自动播放 - 默认false
                loop:false, // loop是否循环播放 - 默认false
                direction:0,// 设置全屏时视频方向 ,0竖屏 , 90逆时针90 , -90 顺时针90,不设置自适应
                showprogress:true,//是否显示进度条,当屏幕宽大于240时自动显示
            }
        },
        methods: {
            playVideo(){
                this.videoContext = uni.createVideoContext('video1')
                this.videoContext.play()
            },
        }
    }
</script><style>
.myVideo{
    width: 100vw;
    height:400rpx;
}
.videoBox{
    position: relative;
    width: 100%;
    height: 100%;
}
.mask{
    position: absolute;
    width: 100%;
    height: 100%;
    background: rgba(255, 0, 0, .3);
    display: flex;
    justify-content: center;
    align-items: center;
}
</style>

多个视频控制案例

技术栈

video组件

video API

需求:页面存在多个视频,只能播放其中一个,自定义全屏和静音按钮

<template>
    <view>
        多视频案例
    </view>
    <view class="morevideo">
        <view class="itemBox" v-for="(item,index) in videoList">
            <video :id="item.id" class="videoItem" object-fit="cover" :src="item.src" :poster="item.poster"
                @play="playVideo(item.id)" :controls="item.controls" :muted="item.muted"
                @fullscreenchange="changeFullScreen(index)">
                <cover-view class="videoControl">
                    <cover-view class="mute" @tap="changeMuted(index)">静音</cover-view>
                    <cover-view class="fullScreen" @tap="fullScreen(item.id)">全屏</cover-view>
                </cover-view>
            </video>
        </view>
    </view>
</template><script>
    export default {
        data() {
            return {
                videoList: [{
                        id: "video_1",
                        src: "视频路径",
                        poster: "视频路径?x-oss-process=video/snapshot,t_0,f_jpg",
                        controls: false,
                        muted: true
                    },
                    {
                        id: "video_2",
                        src: "视频路径",
                        poster: "视频路径?x-oss-process=video/snapshot,t_0,f_jpg",
                        controls: false,
                        muted: true
                    },
                    {
                        id: "video_3",
                        src: "视频路径",
                        poster: "视频路径?x-oss-process=video/snapshot,t_0,f_jpg",
                        controls: false,
                        muted: true
                    },
                ]
            }
        },
        methods: {
            playVideo(videoId){
                console.log('videoId:',videoId);
                for(let i = 0 ; i<this.videoList.length ; i++){
                    if(this.videoList[i].id !== videoId){
                        uni.createVideoContext(this.videoList[i].id).pause()
                    }else{
                        uni.createVideoContext(videoId).play()
                    }
                }
            },
            // 声音开关
            changeMuted(idx) {
                this.videoList[idx].muted = !this.videoList[idx].muted
            },
            // 进入全屏
            fullScreen(videoId) {
                this.videoContext = null
                this.videoContext = uni.createVideoContext(videoId)
                this.videoContext.requestFullScreen()
            },
            changeFullScreen(idx) {
                this.videoList[idx].controls = !this.videoList[idx].controls
            }
​
        }
    }
</script><style>
    .itemBox {
​
        width: 100vw;
        height: 400rpx;
        margin-bottom: 10rpx;
    }
​
    .videoItem {
        box-sizing: border-box;
        position: relative;
        width: 100%;
        height: 100%;
    }
​
    .videoControl {
        position: absolute;
        left: 0;
        bottom: 0;
        width: 100%;
        display: flex;
        justify-content: space-between;
        color: #fff;
    }
​
    .mute {
        margin-left: 30rpx;
    }
​
    .fullScreen {
        margin-right: 30rpx;
    }
</style>