OpenHarmony視頻播放器

作者“堅果，華為云享專家，InfoQ簽約作者，潤和軟件KOL專家，電子發燒友鴻蒙MVP，51CTO博客專家博主，阿里云博客專家，開源項目gin-vue-admin成員之一

由于視頻資源在項目中使用較為頻繁，于是有了這個教程，本教程在最后也是實現了一個簡單的播放器。

效果預覽

Video

由于使用本地視頻文件會影響App的包大小，所以通常我們的視頻文件來源于網絡地址，需要在config或者module.json對應的"abilities"中添加網絡使用權限ohos.permission.INTERNET。我是為了測試方便用的本地視頻，大家別嫌棄。

"abilities":[

{

"permissions": ["ohos.permission.INTERNET"],

}

]

在使用的時候一個VideoController對象可以控制一個或多個video。

//一個VideoController對象可以控制一個或多個video。

controller: VideoController = new VideoController();

接口

declare interface VideoOptions {

src?: string | Resource;

?

currentProgressRate?: number | string | PlaybackSpeed;

previewUri?: string | PixelMap | Resource;

?

controller?: VideoController;

}

其中僅src( 視頻播放源的路徑 )這個參數是必填的。

支持本地視頻路徑和網絡路徑。

支持在resources下面的video或rawfile文件夾里放置媒體資源。

支持dataability://的路徑前綴，用于訪問通過Data Ability提供的視頻路徑

currentProgressRate:number 視頻播放倍速，支持0.75，1.0，1.25，1.75，2.0。

previewUri:string 預覽圖片的路徑，可以作為視頻未播放時的封面。

controller:VideoController 控制器。一個VideoController對象可以控制一個或多個video。如果需要通過代碼控制視頻的播放、暫停等，可以給Video組件設置這個參數，然后通過控制器的如下接口控制視頻播放狀態：

這兒我需要將PlaybackSpeed和VideoController單獨拎出來做一個解釋。

PlaybackSpeed類型接口說明

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倍速播放。
名稱	描述

declare

enum

PlaybackSpeed

{

?

Speed_Forward_0_75_X

,

?

Speed_Forward_1_00_X

,

?

Speed_Forward_1_25_X

,

?

?

Speed_Forward_1_75_X

,

?

Speed_Forward_2_00_X

,

}

VideoController

一個VideoController對象可以控制一個或多個video。

start() : void 開始播放。

pause() : void 暫停播放。

stop() : void 停止播放。

setCurrentTime(value: number, seekMode: SeekMode)指定視頻播放的進度位置，并指定跳轉模式。value是進度，seekMode是跳轉模式

requestFullscreen() : boolean() 請求全屏播放，true是橫屏，false豎屏。

exitFullscreen() : void 退出全屏。

在這兒，我同樣需要將setCurrentTime單獨拎出

setCurrentTime8+

setCurrentTime(value: number, seekMode: SeekMode)

指定視頻播放的進度位置，并指定跳轉模式。

參數

SeekMode8+類型接口說明

?

declare enum SeekMode {

?

PreviousKeyframe,

?

?

NextKeyframe,

?

?

ClosestKeyframe,

?

Accurate,

}

?

Video屬性

muted（是否靜音）、autoPlay（自動播放）、controls（控制欄）、objectFit（顯示模式）、loop（是否循環播放）。其中，objectFit參數設置值為ImageFit.Cover則鋪滿整個容器。

詳細介紹

.muted(boolean) 默認值false 是否靜音。

.autoPlay(boolean) 默認值false 是否自動播放。

.controls(boolean) 默認值true 控制視頻播放的控制欄是否顯示。

.loop(boolean) 是否單個視頻循環播放。

.objectFit(ImageFit) 默認值Cover 設置視頻顯示模式。ImageFit有如下枚舉值可選

ImageFit枚舉說明

名稱	描述
Cover	保持寬高比進行縮小或者放大，使得圖片兩邊都大于或等于顯示邊界。
Contain	保持寬高比進行縮小或者放大，使得圖片完全顯示在顯示邊界內。
Fill	不保持寬高比進行放大縮小，使得圖片填充滿顯示邊界。
None	保持原有尺寸顯示。通常配合objectRepeat屬性一起使用。
ScaleDown	保持寬高比顯示，圖片縮小或者保持不變。

事件

onStart() => void 播放時觸發該事件。

onPause() => void 暫停時觸發該事件。

onFinish() => void 播放結束時觸發該事件。

onError() => void 播放失敗時觸發該事件。

onFullscreenChange(event?: { fullscreen: boolean }) => void) 視頻進入和退出全屏時觸發該事件。

onPrepared(event?: { duration: number }) => void 視頻準備完成時觸發該事件，通過duration可以獲取視頻時長，單位為秒(s)。

onSeeking(event?: { time: number }) => void 操作進度條過程時上報時間信息，單位為s。

onSeeked(event?: { time: number }) => void 操作進度條完成后，上報播放時間信息，單位為s。

onUpdate(event?: { time: number }) => void 播放進度變化時觸發該事件，單位為s，更新時間間隔為250ms。

表格

名稱	功能描述
onStart() => void	播放時觸發該事件。
onPause() => void	暫停時觸發該事件。
onFinish() => void	播放結束時觸發該事件。
onError() => void	播放失敗時觸發該事件。
onPrepared(event?: { duration: number }) => void	視頻準備完成時觸發該事件，通過duration可以獲取視頻時長，單位為秒(s)。
onSeeking(event?: { time: number }) => void	操作進度條過程時上報時間信息，單位為s。
onSeeked(event?: { time: number }) => void	操作進度條完成后，上報播放時間信息，單位為s。
onUpdate(event?: { time: number }) => void	播放進度變化時觸發該事件，單位為s，更新時間間隔為250ms。

完整示例

@

Entry

@

Component

struct

Index

{

@

State

message

:

string

=

'視頻預覽'

@

State

previewUris

:

Resource

=

$r

(

'app.media.openharmony'

);

//預覽封面

controller

:

VideoController

=

new

VideoController

();

@

State

currentProgressRate

:

number

=

1

@

State

muted

:

boolean

=

false

@

State

autoPlay

:

boolean

=

true

@

State

controls

:

boolean

=

true

@

State

startStatus

:

boolean

=

true

@

State

loop

:

boolean

=

true

?

aboutToAppear

() {

this

.

controller

.

requestFullscreen

(

true

)

this

.

controller

.

start

()

}

?

build

() {

?

Column

() {

Text

(

this

.

message

)

.

fontSize

(

50

)

.

fontWeight

(

FontWeight

.

Bold

)

Video

({

src

:

$r

(

'app.media.video'

),

previewUri

:

this

.

previewUris

,

// 視頻封面

currentProgressRate

:

this

.

currentProgressRate

,

// 視頻播放倍速

controller

:

this

.

controller

,

?

})

.

muted

(

this

.

muted

)

// 是否靜音

.

autoPlay

(

this

.

autoPlay

)

// 是否自動播放

.

controls

(

this

.

controls

)

// 控制視頻播放的控制欄是否顯示

.

objectFit

(

ImageFit

.

Contain

)

// 視頻顯示模式

.

loop

(

this

.

loop

)

// 是否單個視頻循環播放

.

height

(

"60%"

)

.

onStart

(()

=>

{

// 播放時觸發該事件

console

.

info

(

'onStart'

);

})

.

onPause

(()

=>

{

// 暫停時觸發該事件

console

.

info

(

'onPause'

);

})

.

onFinish

(()

=>

{

console

.

info

(

'onFinish'

);

?

})

.

onError

(()

=>

{

// 播放失敗時觸發該事件

console

.

error

(

'onError'

);

})

.

onFullscreenChange

((

e

)

=>

{

console

.

info

(

'視頻進入和退出全屏時觸發該事件：'

+

e

.

fullscreen

)

})

.

onPrepared

((

e

)

=>

{

console

.

info

(

'視頻準備完成時觸發該事件：'

+

e

.

duration

)

})

.

onSeeking

((

e

)

=>

{

console

.

info

(

'操作進度條過程時上報時間信息：'

+

e

.

time

)

})

.

onSeeked

((

e

)

=>

{

console

.

info

(

'操作進度條完成后，上報播放時間信息：'

+

e

.

time

)

})

.

onUpdate

((

e

)

=>

{

console

.

info

(

'播放進度變化時觸發該事件：'

+

e

.

time

)

})

Row

({}) {

Flex

({

wrap

:

FlexWrap

.

Wrap

,

justifyContent

:

FlexAlign

.

SpaceAround

,

alignItems

:

ItemAlign

.

Center

}) {

Button

(

"播放"

)

.

onClick

(()

=>

{

this

.

controller

.

start

()

}).

margin

(

8

)

Button

(

"暫停"

)

.

onClick

(()

=>

{

this

.

controller

.

pause

()

})

Button

(

"循環播放"

)

.

onClick

(()

=>

{

this

.

loop

=!

this

.

loop

})

Button

(

"2倍速"

)

.

onClick

(()

=>

{

this

.

currentProgressRate

=

2

})

Button

(

"靜音"

)

.

onClick

(()

=>

{

this

.

muted

=!

this

.

muted

})

?

Button

(

"停止"

)

.

onClick

(()

=>

{

this

.

controller

.

stop

()

})

?

Button

(

"全屏播放"

)

.

onClick

(()

=>

{

this

.

controller

.

requestFullscreen

(

true

)

})

Button

(

"退出全屏"

)

.

onClick

(()

=>

{

this

.

controller

.

exitFullscreen

()

}).

margin

(

8

)

?

Button

(

"控制欄是否顯示"

)

.

onClick

(()

=>

{

this

.

controls

=

!

this

.

controls

}).

margin

(

8

)

?

Button

(

"指定視頻播放的進度"

)

.

onClick

(()

=>

{

this

.

controller

.

setCurrentTime

(

9

)

})

}

}

}

.

width

(

'100%'

).

height

(

'100%'

)

}

}

參考文檔

video

flex

名稱	描述
PreviousKeyframe	跳轉到前一個最近的關鍵幀。
NextKeyframe	跳轉到后一個最近的關鍵幀。
ClosestKeyframe	跳轉到最近的關鍵幀。
Accurate	精準跳轉，不論是否為關鍵幀。

參數名	參數類型	必填	默認值	參數描述
value	number	是	-	視頻播放進度位置。
seekMode	SeekMode	是	-	跳轉模式。