HarmonyOS API:媒体组件

joytrian
发布于 2023-3-24 17:12
浏览
0收藏

版本:v3.1 Beta

Video

更新时间: 2023-02-17 09:19


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


说明

该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

权限列表

使用网络视频时,需要申请权限ohos.permission.INTERNET。具体申请方式请参考​​权限申请声明​​。

子组件

不支持子组件。

接口

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说明​​。

说明:

视频支持的格式是: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)

操作进度条过程时上报时间信息,单位为s。

onSeeked(callback:(event?: { time: number }) => void)

操作进度条完成后,上报播放时间信息,单位为s。

onUpdate(callback:(event?: { time: number }) => void)

播放进度变化时触发该事件,单位为s,更新时间间隔为250ms。

onFullscreenChange(callback:(event?: { fullscreen: boolean }) => void)

在全屏播放与非全屏播放状态之间切换时触发该事件,返回值为true表示进入全屏播放状态,为false则表示非全屏播放。

VideoController

一个VideoController对象可以控制一个或多个video。

导入对象

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

是否全屏播放。

默认值:false

exitFullscreen

exitFullscreen()

退出全屏播放。

setCurrentTime8+

setCurrentTime(value: number, seekMode: SeekMode)

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


参数:


参数名

参数类型

必填

参数描述

value

number

视频播放进度位置,单位为s。

seekMode

SeekMode

跳转模式。

SeekMode8+枚举说明

名称

描述

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(800).height(600)
        .autoPlay(this.isAutoPlay)
        .controls(this.showControls)
        .onStart(() => {
          console.info('onStart')
        })
        .onPause(() => {
          console.info('onPause')
        })
        .onFinish(() => {
          console.info('onFinish')
        })
        .onError(() => {
          console.info('onFinish')
        })
        .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)
      }
    }
  }
}


文章转载自:​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/ts-media-components-video-0000001427902484-V3?catalogVersion=V3​

收藏
回复
举报
回复
    相关推荐