Back to Uni App

Create Video Context

docs/api/create-video-context.md

2.3.37.5 KB
Original Source
<!-- ## uni.createVideoContext(videoId, component?) @createvideocontext -->

::: sourceCode

uni.createVideoContext(videoId, component?) @createvideocontext

GitCode: https://gitcode.com/dcloud/uni-component/tree/alpha/uni_modules/uni-video

GitHub: https://github.com/dcloudio/uni-component/tree/alpha/uni_modules/uni-video

:::

创建并返回 video 上下文 videoContext 对象

参考:video组件

createVideoContext 兼容性

Web微信小程序AndroidiOSHarmonyOSHarmonyOS(Vapor)
4.04.414.114.615.0

参数

名称类型必填默认值兼容性描述
videoIdstring.VideoIdString-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -
componentComponentPublicInstance-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -

在video组件上设置id属性,即可通过本API获取该组件的上下文对象(videoContext )。

在不传入第2个component参数时,默认从页面栈顶的页面来查找这个video。

js
let v1 = uni.createVideoContext("video1")

但在页面、组件,可能出现id重复的情况,还可能因为调用时机的不同,想定位不同页面的video id。此时就需要传入第2个参数component。

所有vue组件都有ComponentPublicInstance实例,页面上也有组件实例。

如果传入组件实例,就从这个组件中查询指定的id。这样查找范围更小、查找速度也更快。

在选项式和组合式中,获取组件实例略有差别。

  • 选项式中,this代表当前vue实例。如果是在页面的export default内、函数外使用this,即代表该页面的组件实例。
js
let v1 = uni.createVideoContext("video1", this)
  • 组合式中,通过getCurrentInstance()!.proxy! 获取当前页面的组件实例。
js
let v1 = uni.createVideoContext("video1", getCurrentInstance()!.proxy!)

返回值

类型描述必备
VideoContextvideo组件上下文对象

VideoContext 的方法 @videocontext-values

play(): void; @play

play 播放

play 兼容性
Web微信小程序AndroidiOSHarmonyOSHarmonyOS(Vapor)
4.04.413.9.04.114.615.0

pause(): void; @pause

pause 暂停

pause 兼容性
Web微信小程序AndroidiOSHarmonyOSHarmonyOS(Vapor)
4.04.413.9.04.114.615.0

seek(position: number): void; @seek

seek 跳转到指定位置

seek 兼容性
Web微信小程序AndroidiOSHarmonyOSHarmonyOS(Vapor)
4.04.413.9.04.114.615.0
参数
名称类型必填默认值兼容性描述
positionnumber-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -跳转到指定位置(秒)

stop(): void; @stop

stop 停止视频

stop 兼容性
Web微信小程序AndroidiOSHarmonyOSHarmonyOS(Vapor)
4.04.413.9.04.114.615.0

sendDanmu(danmu: Danmu): void; @senddanmu

sendDanmu 发送弹幕

sendDanmu 兼容性
Web微信小程序AndroidiOSHarmonyOSHarmonyOS(Vapor)
4.04.413.9.04.114.615.0
参数
名称类型必填默认值兼容性描述
danmuDanmu-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -text, color

danmu 的属性描述

名称类型必备默认值兼容性描述
textstring-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -弹幕文字
colorstring-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -弹幕颜色
timenumber-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -显示时刻

playbackRate(rate: number): void; @playbackrate

playbackRate 设置倍速播放

playbackRate 兼容性
Web微信小程序AndroidiOSHarmonyOSHarmonyOS(Vapor)
4.04.413.9.04.114.615.0
参数
名称类型必填默认值兼容性描述
ratenumber-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -, 支持倍率 0.5/0.8/1.0/1.25/1.5

requestFullScreen(direction?: RequestFullScreenOptions | null): void; @requestfullscreen

requestFullScreen 进入全屏

requestFullScreen 兼容性
Web微信小程序AndroidiOSHarmonyOSHarmonyOS(Vapor)
4.04.413.9.04.114.615.0
参数
名称类型必填默认值兼容性描述
directionRequestFullScreenOptions-Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: -, 0|正常竖向, 90|屏幕逆时针90度, -90|屏幕顺时针90度

direction 的属性描述

名称类型必备默认值兼容性描述
direction90 | any-Web: x; 微信小程序: 4.41; Android: 3.9.0; iOS: 4.11; HarmonyOS: -direction

exitFullScreen(): void; @exitfullscreen

exitFullScreen 退出全屏

exitFullScreen 兼容性
Web微信小程序AndroidiOSHarmonyOSHarmonyOS(Vapor)
4.04.413.9.04.114.615.0
<!-- UTSAPIJSON.createVideoContext.example -->

参见

通用类型

GeneralCallbackResult

名称类型必备默认值兼容性描述
errMsgstring-Web: -; 微信小程序: 4.41; Android: -; iOS: -; HarmonyOS: -错误信息

示例代码另见video组件