OpenHarmony应用开发- 媒体组件 Video与绘制组件 Circle/ Ellips
版本:v3.2 Release
Video
用于播放视频文件并控制其播放状态的组件。
说明:
该组件从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 | 否 | 设置视频控制器。 |
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 | 设置视频显示模式。 默认值: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('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)
}
}
}
}
Circle
用于绘制圆形的组件。
说明:
该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
子组件
无
接口
Circle(options?: {width?: string | number, height?: string | number})
从API version 9开始,该接口支持在ArkTS卡片中使用。
参数:
参数名 | 参数类型 | 必填 | 参数描述 |
width | string | number | 否 | 宽度。 默认值:0 |
height | string | number | 否 | 高度。 默认值:0 |
属性
除支持通用属性外,还支持以下属性:
名称 | 类型 | 描述 |
fill | 设置填充区域颜色。 默认值:Color.Black 从API version 9开始,该接口支持在ArkTS卡片中使用。 | |
fillOpacity | number | string | Resource | 设置填充区域透明度。 默认值:1 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
stroke | 设置边框颜色,不设置时,默认没有边框。 从API version 9开始,该接口支持在ArkTS卡片中使用。 | |
strokeDashArray | Array<Length> | 设置边框间隙。 默认值:[] 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
strokeDashOffset | number | string | 边框绘制起点的偏移量。 默认值:0 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
strokeLineCap | 设置边框端点绘制样式。 默认值:LineCapStyle.Butt 从API version 9开始,该接口支持在ArkTS卡片中使用。 | |
strokeLineJoin | 设置边框拐角绘制样式。 默认值:LineJoinStyle.Miter 从API version 9开始,该接口支持在ArkTS卡片中使用。 说明: Circle组件无法形成拐角,该属性设置无效。 | |
strokeMiterLimit | number | string | 设置斜接长度与边框宽度比值的极限值。 默认值:4 从API version 9开始,该接口支持在ArkTS卡片中使用。 说明: Circle组件无法设置尖角图形,该属性设置无效。 |
strokeOpacity | number | string | Resource | 设置边框透明度。 默认值:1 从API version 9开始,该接口支持在ArkTS卡片中使用。 说明: 该属性的取值范围是[0.0, 1.0],若给定值小于0.0,则取值为0.0;若给定值大于1.0,则取值为1.0。 |
strokeWidth | Length | 设置边框宽度。 默认值:1 从API version 9开始,该接口支持在ArkTS卡片中使用。 说明: 该属性若为string类型, 暂不支持百分比。 |
antiAlias | boolean | 是否开启抗锯齿效果。 默认值:true 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
示例
// xxx.ets
@Entry
@Component
struct CircleExample {
build() {
Column({ space: 10 }) {
// 绘制一个直径为150的圆
Circle({ width: 150, height: 150 })
// 绘制一个直径为150、线条为红色虚线的圆环(宽高设置不一致时以短边为直径)
Circle()
.width(150)
.height(200)
.fillOpacity(0)
.strokeWidth(3)
.stroke(Color.Red)
.strokeDashArray([1, 2])
}.width('100%')
}
}
Ellipse
椭圆绘制组件。
说明:
该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
子组件
无
接口
Ellipse(options?: {width?: string | number, height?: string | number})
从API version 9开始,该接口支持在ArkTS卡片中使用。
参数:
参数名 | 参数类型 | 必填 | 参数描述 |
width | string | number | 否 | 宽度。 默认值:0 |
height | string | number | 否 | 高度。 默认值:0 |
属性
除支持通用属性外,还支持以下属性:
名称 | 类型 | 默认值 | 描述 |
fill | Color.Black | 设置填充区域颜色。 从API version 9开始,该接口支持在ArkTS卡片中使用。 | |
fillOpacity | number | string | Resource | 1 | 设置填充区域透明度。 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
stroke | - | 设置边框颜色,不设置时,默认没有边框。 从API version 9开始,该接口支持在ArkTS卡片中使用。 | |
strokeDashArray | Array<Length> | [] | 设置边框间隙。 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
strokeDashOffset | number | string | 0 | 边框绘制起点的偏移量。 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
strokeLineCap | LineCapStyle.Butt | 设置边框端点绘制样式。 从API version 9开始,该接口支持在ArkTS卡片中使用。 | |
strokeLineJoin | LineJoinStyle.Miter | 设置边框拐角绘制样式。 从API version 9开始,该接口支持在ArkTS卡片中使用。 说明: Ellipse组件无法形成拐角,该属性设置无效。 | |
strokeMiterLimit | number | string | 4 | 设置斜接长度与边框宽度比值的极限值。 从API version 9开始,该接口支持在ArkTS卡片中使用。 说明: Ellipse组件无法设置尖角图形,该属性设置无效。 |
strokeOpacity | number | string | Resource | 1 | 设置边框透明度。 从API version 9开始,该接口支持在ArkTS卡片中使用。 说明: 该属性的取值范围是[0.0, 1.0],若给定值小于0.0,则取值为0.0;若给定值大于1.0,则取值为1.0。 |
strokeWidth | Length | 1 | 设置边框宽度。 从API version 9开始,该接口支持在ArkTS卡片中使用。 说明: 该属性若为string类型, 暂不支持百分比。 |
antiAlias | boolean | true | 是否开启抗锯齿效果。 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
示例
// xxx.ets
@Entry
@Component
struct EllipseExample {
build() {
Column({ space: 10 }) {
// 绘制一个 150 * 80 的椭圆
Ellipse({ width: 150, height: 80 })
// 绘制一个 150 * 100 、线条为蓝色的椭圆环
Ellipse()
.width(150)
.height(100)
.fillOpacity(0)
.stroke(Color.Blue)
.strokeWidth(3)
}.width('100%')
}
}