一、概述
Video组件用于播放视频文件并控制其播放状态,常用于为短视频和应用内部视频的列表页面。当视频完整出现时会自动播放,用户点击视频区域则会暂停播放,同时显示播放进度条,通过拖动播放进度条指定视频播放到具体位置。
二、创建视频组件
Video通过调用接口来创建,接口调用形式如下:
Video(value: VideoOptions)
三、加载视频资源
Video组件支持加载本地视频和网络视频。
3.1 加载本地视频
普通本地视频。
加载本地视频时,首先在本地rawfile目录指定对应的文件,如下图所示
再使用资源访问符$rawfile()引用视频资源。
ini
private innerResource: Resource = $rawfile('test.mp4')
播放界面
日志
加载本地视频 TestVideo.ets示例代码
typescript
@Entry
@Component
struct TestVideo {
@State message: string = '视频播放';
private controller: VideoController = new VideoController()
private previewUris: Resource = $r('app.media.test_preview')
private innerResource: Resource = $rawfile('test.mp4')
private videoSrc: string = 'file://media/Photo/53/VID_1749798168_005/VID_20250613_150129.mp4'// 图库里的视频
build() {
Column({ space: 10 }) {
Text(this.message)
.fontSize($r('app.float.page_text_font_20fp'))
.fontWeight(FontWeight.Bold)
.margin({ top: 10 })
Video({
// src: this.innerResource, // 设置视频源
src: this.videoSrc, // 设置视频源
previewUri: this.previewUris, // 设置预览图
controller: this.controller, //设置视频控制器,可以控制视频的播放状态
currentProgressRate: PlaybackSpeed.Speed_Forward_1_00_X, // 视频播放倍速,默认值:1.0 | PlaybackSpeed.Speed_Forward_1_00_X
})
.width('100%')
.height(300)
.loop(false)// 设置是否单个视频循环播放。
.muted(false)// 设置是否静音
.autoPlay(false)// 设置是否自动播放
.controls(true)// 设置控制视频播放的控制栏是否显示。
.objectFit(ImageFit.Cover)// 设置视频显示模式,视频显示模式。默认值:Cover
.enableShortcutKey(true)// 设置组件支持快捷键响应。目前支持在组件获焦后响应空格键播放/暂停、上下方向键调整视频音量、左右方向键快进/快退。
.onPrepared(event => { // 视频准备完成时触发该事件。
console.log(`onPrepared 视频准备完 , 当前视频的时长: ${event.duration} 秒`)
})
.onFullscreenChange(event => { // 在全屏播放与非全屏播放状态之间切换时触发该事件。
// 当前视频是否进入全屏播放状态。 true:进入全屏播放状态;false:未进入全屏播放状态。 默认值:false
console.log('onFullscreenChange 是否进入全屏播放状态:', event.fullscreen)
})
.onStart(() => {
console.log('onStart 开始播放')
})
.onPause(() => {
console.log('onPause 暂停播放')
})
.onStop(() => {
console.log('onPause 停止播放')
})
.onFinish(() => {
console.log('onFinish 播放结束')
})
.onError(() => {
console.log('onError 播放失败了')
})
Row({ space: 10 }) {
Button('播放')
.fontColor(Color.Black)
.fontSize(20)
.fontWeight(FontWeight.Medium)
.onClick(() => {
console.log('点击 播放 按钮了')
this.controller.start()
})
Button('暂停')
.fontColor(Color.Black)
.fontSize(20)
.fontWeight(FontWeight.Medium)
.onClick(() => {
console.log('点击 暂停 按钮了')
this.controller.pause()
})
Button('停止')
.fontColor(Color.Black)
.fontSize(20)
.fontWeight(FontWeight.Medium)
.onClick(() => {
// 停止播放,显示当前帧,再次播放时从头开始播放
console.log('点击 停止 按钮了')
this.controller.stop()
})
Button('重新播放')
.fontColor(Color.Black)
.fontSize(20)
.fontWeight(FontWeight.Medium)
.onClick(() => {
console.log('点击 重新播放 按钮了')
this.controller.reset()
})
}
.margin({ top: 16 })
}
.height('100%')
.width('100%')
}
}
Data Ability提供的视频路径带有dataability://前缀,使用时确保对应视频资源存在即可。
typescript
// xxx.ets
@Component
export struct VideoPlayer {
private controller: VideoController = new VideoController()
private previewUris: Resource = $r('app.media.preview')
private videoSrc: string = 'dataability://device_id/com.domainname.dataability.videodata/video/10'
build() {
Column() {
Video({
src: this.videoSrc,
previewUri: this.previewUris,
controller: this.controller
})
}
}
}
3.2 加载沙箱路径视频
支持file://路径前缀的字符串,用于读取应用沙箱路径内的资源,需要保证应用沙箱目录路径下的文件存在并且有可读权限。
typescript
// xxx.ets
@Component
export struct VideoPlayer {
private controller: VideoController = new VideoController()
private videoSrc: string = 'file:///data/storage/el2/base/haps/entry/files/show.mp4'
private videoSrc2: string = 'file://media/Photo/53/VID_1749798168_005/VID_20250613_150129.mp4' // 图库里的视频
build() {
Column() {
Video({
src: this.videoSrc,
controller: this.controller
})
}
}
}
3.3 加载网络视频
加载网络视频时,需要申请权限ohos.permission.INTERNET,具体申请方式请参考声明权限。此时,Video的src属性为网络视频的链接。
typescript
// xxx.ets
@Component
export struct VideoPlayer {
private controller: VideoController = new VideoController()
private previewUris: Resource = $r('app.media.preview')
private videoSrc: string = 'https://www.example.com/example.mp4' // 使用时请替换为实际视频加载网址
build() {
Column() {
Video({
src: this.videoSrc,
previewUri: this.previewUris,
controller: this.controller
})
}
}
}
四、添加属性
Video组件属性主要用于设置视频的播放形式。例如设置视频播放是否静音、播放是否显示控制条等。
scss
// xxx.ets
@Component
export struct VideoPlayer {
private controller: VideoController = new VideoController()
build() {
Column() {
Video({
controller: this.controller
})
.muted(false) // 设置是否静音
.controls(false) // 设置是否显示默认控制条
.autoPlay(false) // 设置是否自动播放
.loop(false) // 设置是否循环播放
.objectFit(ImageFit.Contain) // 设置视频填充模式
}
}
}
五、事件调用
Video组件回调事件主要为播放开始、暂停结束、播放失败、播放停止、视频准备和操作进度条等事件,除此之外,Video组件也支持通用事件的调用,如点击、触摸等事件的调用。详细事件请参考事件说明。
typescript
// xxx.ets
@Entry
@Component
struct VideoPlayer {
private controller: VideoController = new VideoController()
private previewUris: Resource = $r('app.media.preview')
private innerResource: Resource = $rawfile('videoTest.mp4')
build() {
Column() {
Video({
src: this.innerResource,
previewUri: this.previewUris,
controller: this.controller
})
.onUpdate((event) => { // 更新事件回调
console.info("Video update.");
})
.onPrepared((event) => { // 准备事件回调
console.info("Video prepared.");
})
.onError(() => { // 失败事件回调
console.error("Video error.");
})
.onStop(() => { // 停止事件回调
console.info("Video stopped.");
})
}
}
}
六、Video控制器使用
Video控制器主要用于控制视频的状态,包括播放、暂停、停止以及设置进度等。
默认控制器默认的控制器支持视频的开始、暂停、进度调整、全屏显示四项基本功能。
less
// xxx.ets
@Entry
@Component
struct VideoGuide {
@State videoSrc: Resource = $rawfile('videoTest.mp4')
@State previewUri: string = 'common/videoIcon.png'
@State curRate: PlaybackSpeed = PlaybackSpeed.Speed_Forward_1_00_X
build() {
Row() {
Column() {
Video({
src: this.videoSrc,
previewUri: this.previewUri,
currentProgressRate: this.curRate // 设置视频播放倍速
})
}
.width('100%')
}
.height('100%')
}
}
自定义控制器
使用自定义的控制器,先将默认控制器关闭掉,之后可以使用button以及slider等组件进行自定义的控制与显示,适合自定义较强的场景下使用。
less
// xxx.ets
@Entry
@Component
struct VideoGuide {
@State videoSrc: Resource = $rawfile('videoTest.mp4')
@State previewUri: string = 'common/videoIcon.png'
@State curRate: PlaybackSpeed = PlaybackSpeed.Speed_Forward_1_00_X
@State isAutoPlay: boolean = false
@State showControls: boolean = true
@State sliderStartTime: string = ''
@State currentTime: number = 0
@State durationTime: number = 0
@State durationStringTime: string = ''
controller: VideoController = new VideoController()
build() {
Row() {
Column() {
Video({
src: this.videoSrc,
previewUri: this.previewUri,
currentProgressRate: this.curRate,
controller: this.controller
})
.controls(false)
.autoPlay(true)
.onPrepared((event) => {
if (event) {
this.durationTime = event.duration
}
})
.onUpdate((event) => {
if (event) {
this.currentTime = event.time
}
})
Row() {
Text(JSON.stringify(this.currentTime) + 's')
Slider({
value: this.currentTime,
min: 0,
max: this.durationTime
})
.onChange((value: number, mode: SliderChangeMode) => {
this.controller.setCurrentTime(value); // 设置视频播放的进度跳转到value处
})
.width("90%")
Text(JSON.stringify(this.durationTime) + 's')
}
.opacity(0.8)
.width("100%")
}
.width('100%')
}
.height('40%')
}
}