Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
Tonvia
Docs
提交
4a0bfd71
D
Docs
项目概览
Tonvia
/
Docs
与 Fork 源项目一致
Fork自
OpenHarmony / Docs
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
4a0bfd71
编写于
6月 28, 2022
作者:
O
openharmony_ci
提交者:
Gitee
6月 28, 2022
浏览文件
操作
浏览文件
下载
差异文件
!4577 hls资料修改
Merge pull request !4577 from hwgaizw/0528
上级
9503c250
865bd4a4
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
104 addition
and
7 deletion
+104
-7
zh-cn/application-dev/reference/apis/js-apis-media.md
zh-cn/application-dev/reference/apis/js-apis-media.md
+104
-7
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-media.md
浏览文件 @
4a0bfd71
...
...
@@ -273,7 +273,7 @@ Codec MIME类型枚举。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ |
| src | string | 是 | 是 | 音频媒体URI,支持当前主流的音频格式(mp4、aac、mp3、ogg、wav)。
<br>
**支持路径示例**
:
<br>
1、fd类型播放:fd://xx
<br>
![](
figures/zh-cn_image_url.png
)
<br>
2、http网络播放: http://xx
<br>
3、h
ls网络播放路径:开发中
<br
>
**注意事项**
:
<br>
使用媒体素材需要获取读权限,否则无法正常播放。 |
| src | string | 是 | 是 | 音频媒体URI,支持当前主流的音频格式(mp4、aac、mp3、ogg、wav)。
<br>
**支持路径示例**
:
<br>
1、fd类型播放:fd://xx
<br>
![](
figures/zh-cn_image_url.png
)
<br>
2、http网络播放: http://xx
<br>
3、h
ttps网络播放: https://xx
<br/
>
**注意事项**
:
<br>
使用媒体素材需要获取读权限,否则无法正常播放。 |
| loop | boolean | 是 | 是 | 音频循环播放属性,设置为'true'表示循环播放。 |
| currentTime | number | 是 | 否 | 音频的当前播放位置。 |
| duration | number | 是 | 否 | 音频时长。 |
...
...
@@ -665,7 +665,7 @@ audioPlayer.setVolume(3); //设置volume为无效值,触发'error'事件
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------ | ---------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| url
<sup>
8+
</sup>
| string | 是 | 是 | 视频媒体URL,支持当前主流的视频格式(mp4、mpeg-ts、webm、mkv)。
<br>
**支持路径示例**
:
<br>
1. fd类型播放:fd://xx
<br>
![](
figures/zh-cn_image_url.png
)
<br>
2、http网络播放: http://xx
<br/>
3、h
ls网络播放路径:开发中
<br/>
**注意事项**
:
<br>
使用媒体素材需要获取读权限,否则无法正常播放。 |
| url
<sup>
8+
</sup>
| string | 是 | 是 | 视频媒体URL,支持当前主流的视频格式(mp4、mpeg-ts、webm、mkv)。
<br>
**支持路径示例**
:
<br>
1. fd类型播放:fd://xx
<br>
![](
figures/zh-cn_image_url.png
)
<br>
2、http网络播放: http://xx
<br/>
3、h
ttps网络播放: https://xx
<br/>
3、hls网络播放路径:http://xx或者https://xx
<br/>
**注意事项**
:
<br>
使用媒体素材需要获取读权限,否则无法正常播放。 |
| loop
<sup>
8+
</sup>
| boolean | 是 | 是 | 视频循环播放属性,设置为'true'表示循环播放。 |
| currentTime
<sup>
8+
</sup>
| number | 是 | 否 | 视频的当前播放位置。 |
| duration
<sup>
8+
</sup>
| number | 是 | 否 | 视频时长,返回-1表示直播模式。 |
...
...
@@ -1002,7 +1002,8 @@ seek(timeMs: number, callback: AsyncCallback\<number>): void
**示例:**
```
js
videoPlayer
.
seek
((
seekTime
,
err
)
=>
{
let
seekTime
=
5000
;
videoPlayer
.
seek
(
seekTime
,
(
err
,
result
)
=>
{
if
(
typeof
(
err
)
==
'
undefined
'
)
{
console
.
info
(
'
seek success!
'
);
}
else
{
...
...
@@ -1030,7 +1031,10 @@ seek(timeMs: number, mode:SeekMode, callback: AsyncCallback\<number>): void
**示例:**
```
js
videoPlayer
.
seek
((
seekTime
,
seekMode
,
err
)
=>
{
import
media
from
'
@ohos.multimedia.media
'
let
seekTime
=
5000
;
let
seekMode
=
media
.
SeekMode
.
SEEK_NEXT_SYNC
;
videoPlayer
.
seek
(
seekTime
,
seekMode
,
(
err
,
result
)
=>
{
if
(
typeof
(
err
)
==
'
undefined
'
)
{
console
.
info
(
'
seek success!
'
);
}
else
{
...
...
@@ -1063,6 +1067,7 @@ seek(timeMs: number, mode?:SeekMode): Promise\<number>
**示例:**
```
js
let
seekTime
=
5000
;
videoPlayer
.
seek
(
seekTime
).
then
((
seekDoneTime
)
=>
{
// seekDoneTime表示seek完成后的时间点
console
.
info
(
'
seek success
'
);
}).
catch
((
error
)
=>
{
...
...
@@ -1094,7 +1099,8 @@ setVolume(vol: number, callback: AsyncCallback\<void>): void
**示例:**
```
js
videoPlayer
.
setVolume
((
vol
,
err
)
=>
{
let
vol
=
0.5
;
videoPlayer
.
setVolume
(
vol
,
(
err
,
result
)
=>
{
if
(
typeof
(
err
)
==
'
undefined
'
)
{
console
.
info
(
'
setVolume success!
'
);
}
else
{
...
...
@@ -1126,6 +1132,7 @@ setVolume(vol: number): Promise\<void>
**示例:**
```
js
let
vol
=
0.5
;
videoPlayer
.
setVolume
(
vol
).
then
()
=>
{
console
.
info
(
'
setVolume success
'
);
}).
catch
((
error
)
=>
{
...
...
@@ -1277,7 +1284,10 @@ setSpeed(speed:number, callback: AsyncCallback\<number>): void
**示例:**
```
js
videoPlayer
.
setSpeed
((
speed
:
number
,
err
)
=>
{
import
media
from
'
@ohos.multimedia.media
'
let
speed
=
media
.
PlaybackSpeed
.
SPEED_FORWARD_2_00_X
;
videoPlayer
.
setSpeed
(
speed
,
(
err
,
result
)
=>
{
if
(
typeof
(
err
)
==
'
undefined
'
)
{
console
.
info
(
'
setSpeed success!
'
);
}
else
{
...
...
@@ -1309,6 +1319,9 @@ setSpeed(speed:number): Promise\<number>
**示例:**
```
js
import
media
from
'
@ohos.multimedia.media
'
let
speed
=
media
.
PlaybackSpeed
.
SPEED_FORWARD_2_00_X
;
videoPlayer
.
setSpeed
(
speed
).
then
()
=>
{
console
.
info
(
'
setSpeed success
'
);
}).
catch
((
error
)
=>
{
...
...
@@ -1316,11 +1329,70 @@ videoPlayer.setSpeed(speed).then() => {
});
```
### selectBitrate<sup>9+</sup>
selectBitrate(bitrate:number, callback: AsyncCallback
\<
number>): void
通过回调方式设置码率。
**系统能力:**
SystemCapability.Multimedia.Media.VideoPlayer
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------------------------------------------- |
| bitrate | number | 是 | 指定码率播放,用于hls多码率场景,单位为bps。 |
| callback | AsyncCallback
\<
number> | 是 | 设置播放码率的回调方法,返回设置的值表示成功,其他则失败。 |
**示例:**
```
js
let
bitrate
=
1024000
;
videoPlayer
.
selectBitrate
(
bitrate
,
(
err
,
result
)
=>
{
if
(
typeof
(
err
)
==
'
undefined
'
)
{
console
.
info
(
'
selectBitrate success!
'
);
}
else
{
console
.
info
(
'
selectBitrate fail!
'
);
}
});
```
### selectBitrate<sup>9+</sup>
selectBitrate(bitrate:number): Promise
\<
number>
通过Promise方式设置码率,通过
[
availableBitrateCollected
](
#on('availableBitrateCollected'
)
<sup>
9+
</sup>
)获取当前码流支持的Bitrate。
**系统能力:**
SystemCapability.Multimedia.Media.VideoPlayer
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | -------------------------------------------- |
| bitrate | number | 是 | 指定码率播放,用于hls多码率场景,单位为bps。 |
**返回值:**
| 类型 | 说明 |
| ---------------- | ------------------------- |
| Promise
\<
number> | 通过Promise获取设置结果。 |
**示例:**
```
js
let
bitrate
=
1024000
;
videoPlayer
.
selectBitrate
(
bitrate
).
then
()
=>
{
console
.
info
(
'
selectBitrate success
'
);
}).
catch
((
error
)
=>
{
console
.
info
(
`video catchCallback, error:
${
error
.
message
}
`
);
});
```
### on('playbackCompleted')<sup>8+</sup>
on(type: 'playbackCompleted', callback: Callback
\<
void>): void
开始监听视频播放完成事件。
开始监听视频播放完成事件
,通过
[
availableBitrateCollected
](
#on('availableBitrateCollected'
)
<sup>
9+
</sup>
)获取当前码流支持的Bitrate
。
**系统能力:**
SystemCapability.Multimedia.Media.VideoPlayer
...
...
@@ -1436,6 +1508,31 @@ videoPlayer.on('error', (error) => { // 设置'error'事件回调
videoPlayer
.
setVolume
(
3
);
//设置volume为无效值,触发'error'事件
```
### on('availableBitrateCollected')<sup>9+</sup>
on(type: 'availableBitrateCollected', callback: (bitrates: Array
<number>
) => void): void
开始监听视频播放码率上报事件。
**系统能力:**
SystemCapability.Multimedia.Media.VideoPlayer
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 视频播放码率上报事件回调类型,支持的事件:'availableBitrateCollected',只在开始播放时候上报一次 |
| callback | function | 是 | 视频播放码率事件回调方法,使用Array数组存放支持的码率。 |
**示例:**
```
js
videoPlayer
.
on
(
'
availableBitrateCollected
'
,
(
bitrates
)
=>
{
for
(
let
i
=
0
;
i
<
bitrates
.
length
;
i
++
)
{
console
.
info
(
'
case availableBitrateCollected bitrates:
'
+
bitrates
[
i
]);
//打印支持的码率
}
});
```
## VideoPlayState<sup>8+</sup>
视频播放的状态机,可通过state属性获取当前状态。
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录