鸿蒙（HarmonyOS）项目方舟框架（ArkUI）之Video媒体组件

一、操作环境

操作系统: Windows 10 专业版、IDE:DevEco Studio 3.1、SDK:HarmonyOS 3.1

二、Video媒体组件

用于播放视频文件并控制其播放状态的组件。

子组件

无

接口

Video(value: {src?: string | Resource, currentProgressRate?: number | string | PlaybackSpeed, previewUri?: string | PixelMap | Resource, controller?: VideoController})

构造参数

参数名	参数类型	必填	参数描述
src	string \| Resource	否	视频播放源的路径，支持本地视频路径和网络路径。支持在resources下面的video或rawfile文件夹里放置媒体资源。支持dataability://的路径前缀，用于访问通过Data Ability提供的视频路径，具体路径信息详见DataAbility说明。支持file:///data/storage路径前缀的字符串，用于读取应用沙箱路径内的资源。需要保证目录包路径下的文件有可读权限。说明：视频支持的格式是：mp4、mkv、webm、TS。
currentProgressRate	number \| string \| PlaybackSpeed8+	否	视频播放倍速。说明： number取值仅支持：0.75，1.0，1.25，1.75，2.0。默认值：1.0 \| PlaybackSpeed.Speed_Forward_1_00_X
previewUri	string \| PixelMap8+ \| Resource	否	视频未播放时的预览图片路径，默认不显示图片。
controller	VideoController	否	设置视频控制器，可以控制视频的播放状态。

PlaybackSpeed8+枚举说明

名称	描述
Speed_Forward_0_75_X	0.75倍速播放。
Speed_Forward_1_00_X	1倍速播放。
Speed_Forward_1_25_X	1.25倍速播放。
Speed_Forward_1_75_X	1.75倍速播放。
Speed_Forward_2_00_X	2倍速播放。

属性

除支持通用属性外，还支持以下属性：

名称	参数类型	描述
muted	boolean	是否静音。默认值：false
autoPlay	boolean	是否自动播放。默认值：false
controls	boolean	控制视频播放的控制栏是否显示。默认值：true
objectFit	ImageFit	设置视频显示模式。默认值：Cover
loop	boolean	是否单个视频循环播放。默认值：false

事件

名称	功能描述
onStart(event:() => void)	播放时触发该事件。
onPause(event:() => void)	暂停时触发该事件。
onFinish(event:() => void)	播放结束时触发该事件。
onError(event:() => void)	播放失败时触发该事件。
onPrepared(callback:(event?: { duration: number }) => void)	视频准备完成时触发该事件。 duration：当前视频的时长，单位为秒(s)。
onSeeking(callback:(event?: { time: number }) => void)	操作进度条过程时上报时间信息。 time：当前视频播放的进度，单位为s。
onSeeked(callback:(event?: { time: number }) => void)	操作进度条完成后，上报播放时间信息。 time：当前视频播放的进度，单位为s。
onUpdate(callback:(event?: { time: number }) => void)	播放进度变化时触发该事件。 time：当前视频播放的进度，单位为s。
onFullscreenChange(callback:(event?: { fullscreen: boolean }) => void)	在全屏播放与非全屏播放状态之间切换时触发该事件。 fullscreen：返回值为true表示进入全屏播放状态，为false则表示非全屏播放。

VideoController

一个VideoController对象可以控制一个或多个video，可用视频播放实例请参考media.createAVPlayer。

导入对象

controller: VideoController = new VideoController()

start

start(): void

开始播放。

pause

pause(): void

暂停播放，显示当前帧，再次播放时从当前位置继续播放。

stop

stop(): void

停止播放，显示当前帧，再次播放时从头开始播放。

setCurrentTime

setCurrentTime(value: number)

指定视频播放的进度位置。

参数：

参数名	参数类型	必填	参数描述
value	number	是	视频播放进度位置，单位为s。

requestFullscreen

requestFullscreen(value: boolean)

请求全屏播放。

参数：

参数名	参数类型	必填	参数描述
value	boolean	是	是否全屏（填充满应用窗口）播放。

exitFullscreen

exitFullscreen()

退出全屏播放。

setCurrentTime

setCurrentTime(value: number, seekMode: SeekMode)

指定视频播放的进度位置，并指定跳转模式。

参数：

参数名	参数类型	必填	参数描述
value	number	是	视频播放进度位置，单位为s。
seekMode	SeekMode	是	跳转模式。

SeekMode枚举说明

名称	描述
PreviousKeyframe	跳转到前一个最近的关键帧。
NextKeyframe	跳转到后一个最近的关键帧。
ClosestKeyframe	跳转到最近的关键帧。
Accurate	精准跳转，不论是否为关键帧。

三、示例

代码

// xxx.ets
@Entry
@Component
struct VideoCreateComponent {
  @State videoSrc: Resource = $rawfile('video1.mp4')
  @State previewUri: Resource = $r('app.media.poster1')
  @State curRate: PlaybackSpeed = PlaybackSpeed.Speed_Forward_1_00_X
  @State isAutoPlay: boolean = false
  @State showControls: boolean = true
  controller: VideoController = new VideoController()

  build() {
    Column() {
      Video({
        src: this.videoSrc,
        previewUri: this.previewUri,
        currentProgressRate: this.curRate,
        controller: this.controller
      }).width('100%').height(600)
        .autoPlay(this.isAutoPlay)
        .controls(this.showControls)
        .onStart(() => {
          console.info('onStart')
        })
        .onPause(() => {
          console.info('onPause')
        })
        .onFinish(() => {
          console.info('onFinish')
        })
        .onError(() => {
          console.info('onError')
        })
        .onPrepared((e) => {
          console.info('onPrepared is ' + e.duration)
        })
        .onSeeking((e) => {
          console.info('onSeeking is ' + e.time)
        })
        .onSeeked((e) => {
          console.info('onSeeked is ' + e.time)
        })
        .onUpdate((e) => {
          console.info('onUpdate is ' + e.time)
        })
      
      Row() {
        Button('src').onClick(() => {
          this.videoSrc = $rawfile('video2.mp4') // 切换视频源
        }).margin(5)
        Button('previewUri').onClick(() => {
          this.previewUri = $r('app.media.poster2') // 切换视频预览海报
        }).margin(5)
        Button('controls').onClick(() => {
          this.showControls = !this.showControls // 切换是否显示视频控制栏
        }).margin(5)
      }

      Row() {
        Button('start').onClick(() => {
          this.controller.start() // 开始播放
        }).margin(5)
        Button('pause').onClick(() => {
          this.controller.pause() // 暂停播放
        }).margin(5)
        Button('stop').onClick(() => {
          this.controller.stop() // 结束播放
        }).margin(5)
        Button('setTime').onClick(() => {
          this.controller.setCurrentTime(10, SeekMode.Accurate) // 精准跳转到视频的10s位置
        }).margin(5)
      }

      Row() {
        Button('rate 0.75').onClick(() => {
          this.curRate = PlaybackSpeed.Speed_Forward_0_75_X // 0.75倍速播放
        }).margin(5)
        Button('rate 1').onClick(() => {
          this.curRate = PlaybackSpeed.Speed_Forward_1_00_X // 原倍速播放
        }).margin(5)
        Button('rate 2').onClick(() => {
          this.curRate = PlaybackSpeed.Speed_Forward_2_00_X // 2倍速播放
        }).margin(5)
      }
    }
  }
}

你有时间常去我家看看我在这里谢谢你啦...

我家地址:亚丁号

最后送大家一首诗:

山高路远坑深,

大军纵横驰奔,

谁敢横刀立马？

惟有点赞加关注大军。