小程序
取消
开发
中文
EN
取消
  • 组件

    • # video

    基础库 1.0.0 开始支持，低版本需做兼容处理。

    微信 Windows 版：支持

    微信 Mac 版：支持

    微信 鸿蒙 OS 版：支持

    相关文档: wx.createVideoContext

    渲染框架支持情况：Skyline （使用最新 Nightly 工具调试） 樱花视频在线. WebView.

    # 功能描述

    视频（v2.4.0 起支持同层渲染）。

    "樱花视频高清" # 通用属性

    属性类型默认值必填说明最低版本
    srcstring是要播放视频的资源地址，支持网络路径、本地临时路径、云文件ID（2.3.0）1.0.0
    durationnumber否指定视频时长1.1.0
    controlsbooleantrue否是否显示默认播放控件（播放/暂停按钮、播放进度、时间）1.0.0
    danmu-listArray.否弹幕列表1.0.0
    danmu-btnbooleanfalse否是否显示弹幕按钮，只在初始化时有效，不能动态变更1.0.0
    enable-danmubooleanfalse否是否展示弹幕，只在初始化时有效，不能动态变更1.0.0
    autoplaybooleanfalse否是否自动播放1.0.0
    loopbooleanfalse否是否循环播放1.4.0
    mutedbooleanfalse否是否静音播放1.4.0
    initial-timenumber0否指定视频初始播放位置1.6.0
    page-gesturebooleanfalse否在非全屏模式下，是否开启亮度与音量调节手势（废弃，见 vslide-gesture）1.6.0
    directionnumber否设置全屏时视频的方向，不指定则根据宽高比自动判断1.7.0
    合法值说明
    0正常竖向
    90屏幕逆时针90度
    -90屏幕顺时针90度
    show-progressbooleantrue否若不设置，宽度大于240时才会显示1.9.0
    show-fullscreen-btnbooleantrue否是否显示全屏按钮1.9.0
    show-play-btnbooleantrue否是否显示视频底部控制栏的播放按钮1.9.0
    show-center-play-btnbooleantrue否是否显示视频中间的播放按钮1.9.0
    enable-progress-gesturebooleantrue否是否开启控制进度的手势1.9.0
    object-fitstringcontain否当视频大小与 video 容器大小不一致时，视频的表现形式1.0.0
    合法值说明
    contain包含
    fill填充
    cover覆盖
    posterstring否视频封面的图片网络资源地址或云文件ID（2.3.0）。若 controls 属性值为 false 则设置 poster 无效1.0.0
    show-mute-btnbooleanfalse否是否显示静音按钮2.4.0
    titlestring否视频的标题，全屏时在顶部展示2.4.0
    play-btn-positionstringbottom否播放按钮的位置2.4.0
    合法值说明
    bottomcontrols bar上
    center视频中间
    enable-play-gesturebooleanfalse否是否开启播放手势，即双击切换播放/暂停2.4.0
    auto-pause-if-navigatebooleantrue否当跳转到本小程序的其他页面时，是否自动暂停本页面的视频播放2.5.0
    auto-pause-if-open-nativebooleantrue否当跳转到其它微信原生页面时，是否自动暂停本页面的视频2.5.0
    vslide-gesturebooleanfalse否在非全屏模式下，是否开启亮度与音量调节手势（同 page-gesture）2.6.2
    vslide-gesture-in-fullscreenbooleantrue否在全屏模式下，是否开启亮度与音量调节手势2.6.2
    show-bottom-progressbooleantrue否是否展示底部进度条2.8.0
    ad-unit-idstring是视频前贴广告单元ID，更多详情可参考开放能力视频前贴广告2.8.1
    poster-for-crawlerstring是用于给搜索等场景作为视频封面展示，建议使用无播放 icon 的视频封面图，只支持网络地址
    show-casting-buttonbooleanfalse否显示投屏按钮。安卓在同层渲染下生效，支持 DLNA 协议；iOS 支持 AirPlay 和 DLNA 协议；鸿蒙 OS 暂不支持。可以通过VideoContext的相关方法进行操作。2.10.2
    picture-in-picture-modestring/Array否设置小窗模式： push, pop，空字符串或通过数组形式设置多种模式（如： ["push", "pop"]）。鸿蒙 OS 暂不支持2.11.0
    合法值说明
    []取消小窗
    push路由 push 时触发小窗
    pop路由 pop 时触发小窗
    picture-in-picture-show-progressbooleanfalse否是否在小窗模式下显示播放进度2.11.0
    picture-in-picture-init-positionstring否小窗模式下小窗的初始显示位置，格式为 (alignment, y)，其中 alignment 表示小窗吸附屏幕左侧还是右侧，可选值为 left、right，y 代表小窗最顶部所在的屏幕高度百分比3.3.0
    enable-system-pipbooleantrue否是否支持 iOS 系统画中画，默认支持3.14.1
    enable-auto-rotationbooleanfalse否是否开启手机横屏时自动全屏，当系统设置开启自动旋转时生效2.11.0
    show-screen-lock-buttonbooleanfalse否是否显示锁屏按钮，仅在全屏时显示，锁屏后控制栏的操作2.11.0
    show-snapshot-buttonbooleanfalse否是否显示截屏按钮，仅在全屏时显示2.13.0
    show-background-playback-buttonbooleantrue否是否展示后台音频播放按钮。鸿蒙 OS 暂不支持。基础库 3.6.0 开始默认值为 true。2.14.3
    background-posterstring否进入后台音频播放后的通知栏图标（Android 独有）2.14.3
    referrer-policystringno-referrer否格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html，其中 {appid} 为小程序的 appid，{version} 为小程序的版本号，版本号为 0 表示为开发版、体验版以及审核版本，版本号为 devtools 表示为开发者工具，其余为正式版本；2.13.0
    合法值说明
    origin发送完整的referrer
    no-referrer不发送
    is-drmboolean否是否为 DRM 视频源2.19.3
    is-liveboolean否是否为直播源2.28.1
    provision-urlstring否DRM 设备身份认证 url，仅 is-drm 为 true 时生效 (Android)2.19.3
    certificate-urlstring否DRM 设备身份认证 url，仅 is-drm 为 true 时生效 (iOS)2.19.3
    license-urlstring否DRM 获取加密信息 url，仅 is-drm 为 true 时生效2.19.3
    preferred-peak-bit-ratenumber否指定码率上界，单位为比特每秒2.26.0
    bindplayeventhandle否当开始/继续播放时触发play事件1.0.0
    bindpauseeventhandle否当暂停播放时触发 pause 事件1.0.0
    bindendedeventhandle否当播放到末尾时触发 ended 事件1.0.0
    bindtimeupdateeventhandle否播放进度变化时触发，event.detail = {currentTime, duration} 。触发频率 250ms 一次1.0.0
    bindfullscreenchangeeventhandle否视频进入和退出全屏时触发，event.detail = {fullScreen, direction}，direction 有效值为 vertical 或 horizontal1.4.0
    bindwaitingeventhandle否视频出现缓冲时触发1.7.0
    binderroreventhandle否视频播放出错时触发1.7.0
    bindprogresseventhandle否加载进度变化时触发，只支持一段加载。event.detail = {buffered}，百分比2.4.0
    bindloadedmetadataeventhandle否视频元数据加载完成时触发。event.detail = {width, height, duration}2.7.0
    bindcontrolstoggleeventhandle否切换 controls 显示隐藏时触发。event.detail = {show}2.9.5
    bindenterpictureinpictureeventhandler否播放器进入小窗2.11.0
    bindleavepictureinpictureeventhandler否播放器退出小窗2.11.0
    bindseekcompleteeventhandler否seek 完成时触发 (position iOS 单位 s, Android 单位 ms)2.12.0
    bindcastinguserselecteventhandler否用户选择投屏设备时触发 detail = { state: "success"/"fail" }。鸿蒙 OS 暂不支持2.32.0
    bindcastingstatechangeeventhandler否投屏成功/失败时触发 detail = { type, state: "success"/"fail" }。鸿蒙 OS 暂不支持2.32.0
    bindcastinginterrupteventhandler否投屏被中断时触发。鸿蒙 OS 暂不支持2.32.0

    "樱花视频高清" # Bug & Tip

    1. tip：`video (樱花视频高清) 默认宽度 300px、高度 225px，可通过 wxss 设置宽高。
    2. tip：从 2.4.0 起 video 支持同层渲染，更多请参考原生组件使用限制
    3. tip: 若当前组件所在的页面或全局开启了 enablePassiveEvent 配置项，该内置组件可能会出现非预期表现（详情参考 "樱花视频高清" enablePassiveEvent 文档）

    # 支持的格式

    格式iOSAndroid
    mp4√√
    mov√x
    m4v√x
    3gp√√
    avi√x
    m3u8√√
    webmx√

    樱花视频 - # 支持的编码格式

    格式iOSAndroid
    H.264√√
    HEVC√√
    MPEG-4√√
    VP9x√

    # 小窗特性说明

    video 小窗支持以下三种触发模式（在组件上设置 picture-in-picture-mode 属性）：

    1. push 模式 樱花视频免费观看，即从当前页跳转至下一页时出现小窗（页面栈push）.

    2. pop 模式，即离开当前页面时触发（页面栈pop） 樱花视频网站.

    3. 以上两种路由行为均触发小窗

    此外，小窗还支持以下特性：

    • 小窗容器尺寸会根据原组件尺寸自动判断

    • 点击小窗，用户会被导航回小窗对应的播放器页面 樱花视频在线.

    • 小窗出现后，用户可点击小窗右上角的关闭按钮或调用 context，exitPictureInPicture() 接口关闭小窗 樱花视频高清.

    当播放器进入小窗模式后，播放器所在页面处于 hide 状态(触发 onHide 生命周期) 樱花视频免费观看，该页面不会被销毁，当小窗被关闭时，播放器所在页面会被 unload (触发 onUnload 生命周期)。

    # DRM 加密播放

    1. 小程序开发者获取到 DRM 加密的 视频地址、身份认证 url、license url
    2. 使用 video 标签将以上几个参数填入
    3. 小程序确认该 video 为 DRM 视频源，进行 DRM 设备身份认证并且获取播放许可证
    4. 设备身份认证通过并获取播放许可证之后，由 DRM 底层进行解密播放

    # Q&A

    Q：为什么设备身份认证 url 要区分 Android 和 iOS ？

    A：由于 Android 和 iOS 是基于不同的 DRM 协议 樱花视频，Android：widevine，iOS：fairplay，所以身份认证这块有所不同，需要分别提供身份认证 url。

    Q：license url 的格式是什么样的？

    A：目前 license url 需要支持标准 license 回包 樱花视频在线，即裸 license.

    # 示例代码 (樱花视频高清)

    在开发者工具中预览效果