文档管理中心

视频播放 (Video)

Video组件用于播放视频文件并控制其播放状态,常用于为短视频和应用内部视频的列表页面。当视频完整出现时会自动播放,用户点击视频区域则会暂停播放,同时显示播放进度条,通过拖动播放进度条指定视频播放到具体位置。具体用法请参考Video

创建视频组件

Video通过调用接口来创建,接口调用形式如下:

Video(value: VideoOptions)

加载视频资源

Video组件支持加载本地视频和网络视频。

加载本地视频

  • 普通本地视频。

    加载本地视频时,首先在本地rawfile目录指定对应的文件,如下图所示。

    再使用资源访问符$rawfile()引用视频资源。

    收起
    自动换行
    深色代码主题
    复制
    1. // xxx.ets
    2. @Component
    3. export struct VideoPlayer {
    4. private controller: VideoController = new VideoController()
    5. private previewUris: Resource = $r('app.media.preview')
    6. private innerResource: Resource = $rawfile('videoTest.mp4')
    7. build() {
    8. Column() {
    9. Video({
    10. src: this.innerResource,
    11. previewUri: this.previewUris,
    12. controller: this.controller
    13. })
    14. }
    15. }
    16. }
  • Data Ability提供的视频路径带有dataability://前缀,使用时确保对应视频资源存在即可。

    收起
    自动换行
    深色代码主题
    复制
    1. // xxx.ets
    2. @Component
    3. export struct VideoPlayer {
    4. private controller: VideoController = new VideoController()
    5. private previewUris: Resource = $r('app.media.preview')
    6. private videoSrc: string = 'dataability://device_id/com.domainname.dataability.videodata/video/10'
    7. build() {
    8. Column() {
    9. Video({
    10. src: this.videoSrc,
    11. previewUri: this.previewUris,
    12. controller: this.controller
    13. })
    14. }
    15. }
    16. }

加载沙箱路径视频

支持file://路径前缀的字符串,用于读取应用沙箱路径内的资源,需要保证应用沙箱目录路径下的文件存在并且有可读权限。

收起
自动换行
深色代码主题
复制
  1. // xxx.ets
  2. @Component
  3. export struct VideoPlayer {
  4. private controller: VideoController = new VideoController()
  5. private videoSrc: string = 'file:///data/storage/el2/base/haps/entry/files/show.mp4'
  6. build() {
  7. Column() {
  8. Video({
  9. src: this.videoSrc,
  10. controller: this.controller
  11. })
  12. }
  13. }
  14. }

加载网络视频

加载网络视频时,需要申请权限ohos.permission.INTERNET,具体申请方式请参考声明权限。此时,Video的src属性为网络视频的链接。

收起
自动换行
深色代码主题
复制
  1. // xxx.ets
  2. @Component
  3. export struct VideoPlayer {
  4. private controller: VideoController = new VideoController()
  5. private previewUris: Resource = $r('app.media.preview')
  6. private videoSrc: string = 'https://www.example.com/example.mp4' // 使用时请替换为实际视频加载网址
  7. build() {
  8. Column() {
  9. Video({
  10. src: this.videoSrc,
  11. previewUri: this.previewUris,
  12. controller: this.controller
  13. })
  14. }
  15. }
  16. }

添加属性

Video组件属性主要用于设置视频的播放形式。例如设置视频播放是否静音、播放是否显示控制条等。

收起
自动换行
深色代码主题
复制
  1. // xxx.ets
  2. @Component
  3. export struct VideoPlayer {
  4. private controller: VideoController = new VideoController()
  5. build() {
  6. Column() {
  7. Video({
  8. controller: this.controller
  9. })
  10. .muted(false) // 设置是否静音
  11. .controls(false) // 设置是否显示默认控制条
  12. .autoPlay(false) // 设置是否自动播放
  13. .loop(false) // 设置是否循环播放
  14. .objectFit(ImageFit.Contain) // 设置视频适配模式
  15. }
  16. }
  17. }

事件调用

Video组件回调事件主要为播放开始、暂停结束、播放失败、播放停止、视频准备和操作进度条等事件,除此之外,Video组件也支持通用事件的调用,如点击、触摸等事件的调用。详细事件请参考事件说明

收起
自动换行
深色代码主题
复制
  1. // xxx.ets
  2. @Entry
  3. @Component
  4. struct VideoPlayer {
  5. private controller: VideoController = new VideoController()
  6. private previewUris: Resource = $r('app.media.preview')
  7. private innerResource: Resource = $rawfile('videoTest.mp4')
  8. build() {
  9. Column() {
  10. Video({
  11. src: this.innerResource,
  12. previewUri: this.previewUris,
  13. controller: this.controller
  14. })
  15. .onUpdate((event) => { // 更新事件回调
  16. console.info("Video update.");
  17. })
  18. .onPrepared((event) => { // 准备事件回调
  19. console.info("Video prepared.");
  20. })
  21. .onError(() => { // 失败事件回调
  22. console.info("Video error.");
  23. })
  24. .onStop(() => { // 停止事件回调
  25. console.info("Video stopped.");
  26. })
  27. }
  28. }
  29. }

Video控制器使用

Video控制器主要用于控制视频的状态,包括播放、暂停、停止以及设置进度等,详细使用请参考VideoController使用说明

  • 默认控制器

    默认的控制器支持视频的开始、暂停、进度调整、全屏显示四项基本功能。

    收起
    自动换行
    深色代码主题
    复制
    1. // xxx.ets
    2. @Entry
    3. @Component
    4. struct VideoGuide {
    5. @State videoSrc: Resource = $rawfile('videoTest.mp4')
    6. @State previewUri: string = 'common/videoIcon.png'
    7. @State curRate: PlaybackSpeed = PlaybackSpeed.Speed_Forward_1_00_X
    8. build() {
    9. Row() {
    10. Column() {
    11. Video({
    12. src: this.videoSrc,
    13. previewUri: this.previewUri,
    14. currentProgressRate: this.curRate
    15. })
    16. }
    17. .width('100%')
    18. }
    19. .height('100%')
    20. }
    21. }
  • 自定义控制器

    使用自定义的控制器,先将默认控制器关闭掉,之后可以使用button以及slider等组件进行自定义的控制与显示,适合自定义较强的场景下使用。

    收起
    自动换行
    深色代码主题
    复制
    1. // xxx.ets
    2. @Entry
    3. @Component
    4. struct VideoGuide {
    5. @State videoSrc: Resource = $rawfile('videoTest.mp4')
    6. @State previewUri: string = 'common/videoIcon.png'
    7. @State curRate: PlaybackSpeed = PlaybackSpeed.Speed_Forward_1_00_X
    8. @State isAutoPlay: boolean = false
    9. @State showControls: boolean = true
    10. @State sliderStartTime: string = ''
    11. @State currentTime: number = 0
    12. @State durationTime: number = 0
    13. @State durationStringTime: string = ''
    14. controller: VideoController = new VideoController()
    15. build() {
    16. Row() {
    17. Column() {
    18. Video({
    19. src: this.videoSrc,
    20. previewUri: this.previewUri,
    21. currentProgressRate: this.curRate,
    22. controller: this.controller
    23. })
    24. .controls(false)
    25. .autoPlay(true)
    26. .onPrepared((event) => {
    27. if (event) {
    28. this.durationTime = event.duration
    29. }
    30. })
    31. .onUpdate((event) => {
    32. if (event) {
    33. this.currentTime = event.time
    34. }
    35. })
    36. Row() {
    37. Text(JSON.stringify(this.currentTime) + 's')
    38. Slider({
    39. value: this.currentTime,
    40. min: 0,
    41. max: this.durationTime
    42. })
    43. .onChange((value: number, mode: SliderChangeMode) => {
    44. this.controller.setCurrentTime(value);
    45. })
    46. .width("90%")
    47. Text(JSON.stringify(this.durationTime) + 's')
    48. }
    49. .opacity(0.8)
    50. .width("100%")
    51. }
    52. .width('100%')
    53. }
    54. .height('40%')
    55. }
    56. }

其他说明

Video组件已经封装好了视频播放的基础能力,开发者无需进行视频实例的创建,视频信息的设置获取,只需要设置数据源以及基础信息即可播放视频,相对扩展能力较弱。如果开发者想自定义视频播放,请参考视频播放

示例代码

在 指南 中进行搜索
请输入您想要搜索的关键词