Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
e7a3ad60
D
Docs
项目概览
OpenHarmony
/
Docs
12 个月 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
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,发现更多精彩内容 >>
未验证
提交
e7a3ad60
编写于
9月 15, 2022
作者:
O
openharmony_ci
提交者:
Gitee
9月 15, 2022
浏览文件
操作
浏览文件
下载
差异文件
!9470 文档资料完整性问题修改
Merge pull request !9470 from 一杯丞丞汁儿/master
上级
9c782ec1
f1e7f1e8
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
100 addition
and
66 deletion
+100
-66
zh-cn/application-dev/reference/apis/js-apis-audio.md
zh-cn/application-dev/reference/apis/js-apis-audio.md
+100
-66
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-audio.md
浏览文件 @
e7a3ad60
...
...
@@ -54,60 +54,6 @@ getAudioManager(): AudioManager
var
audioManager
=
audio
.
getAudioManager
();
```
## audio.getStreamManager<sup>9+</sup>
getStreamManager(callback: AsyncCallback
\<
AudioStreamManager>): void
获取音频流管理器实例。使用callback方式异步返回结果。
**系统能力:**
SystemCapability.Multimedia.Audio.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ---------------- |
| callback | AsyncCallback
<
[
AudioStreamManager
](
#audiostreammanager9
)
>
| 是 | 返回音频流管理器实例。 |
**示例:**
```
js
audio
.
getStreamManager
((
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
`getStreamManager : Error:
${
err
}
`
);
}
else
{
console
.
info
(
'
getStreamManager : Success : SUCCESS
'
);
let
audioStreamManager
=
data
;
}
});
```
## audio.getStreamManager<sup>9+</sup>
getStreamManager(): Promise<AudioStreamManager
\>
获取音频流管理器实例。使用Promise方式异步返回结果。
**系统能力:**
SystemCapability.Multimedia.Audio.Core
**返回值:**
| 类型 | 说明 |
| ---------------------------------------------------- | ---------------- |
| Promise
<
[
AudioStreamManager
](
#audiostreammanager9
)
>
| 返回音频流管理器实例。 |
**示例:**
```
js
var
audioStreamManager
;
audio
.
getStreamManager
().
then
((
data
)
=>
{
audioStreamManager
=
data
;
console
.
info
(
'
getStreamManager: Success!
'
);
}).
catch
((
err
)
=>
{
console
.
error
(
`getStreamManager: ERROR :
${
err
}
`
);
});
```
## audio.createAudioRenderer<sup>8+</sup>
createAudioRenderer(options: AudioRendererOptions, callback: AsyncCallback
\<
AudioRenderer>): void
...
...
@@ -667,6 +613,8 @@ audio.createAudioCapturer(audioCapturerOptions).then((data) => {
枚举,设备连接类型。
**系统接口:**
该接口为系统接口
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Device
| 名称 | 默认值 | 描述 |
...
...
@@ -1950,6 +1898,7 @@ setAudioScene\(scene: AudioScene, callback: AsyncCallback<void\>\): void
**示例:**
```
js
var
audioManager
=
audio
.
getAudioManager
();
audioManager
.
setAudioScene
(
audio
.
AudioScene
.
AUDIO_SCENE_PHONE_CALL
,
(
err
)
=>
{
if
(
err
)
{
console
.
error
(
`Failed to set the audio scene mode.
${
err
}
`
);
...
...
@@ -1984,6 +1933,7 @@ setAudioScene\(scene: AudioScene\): Promise<void\>
**示例:**
```
js
var
audioManager
=
audio
.
getAudioManager
();
audioManager
.
setAudioScene
(
audio
.
AudioScene
.
AUDIO_SCENE_PHONE_CALL
).
then
(()
=>
{
console
.
info
(
'
Promise returned to indicate a successful setting of the audio scene mode.
'
);
}).
catch
((
err
)
=>
{
...
...
@@ -2008,6 +1958,7 @@ getAudioScene\(callback: AsyncCallback<AudioScene\>\): void
**示例:**
```
js
var
audioManager
=
audio
.
getAudioManager
();
audioManager
.
getAudioScene
((
err
,
value
)
=>
{
if
(
err
)
{
console
.
error
(
`Failed to obtain the audio scene mode.
${
err
}
`
);
...
...
@@ -2035,6 +1986,7 @@ getAudioScene\(\): Promise<AudioScene\>
**示例:**
```
js
var
audioManager
=
audio
.
getAudioManager
();
audioManager
.
getAudioScene
().
then
((
value
)
=>
{
console
.
info
(
`Promise returned to indicate that the audio scene mode is obtained
${
value
}
.`
);
}).
catch
((
err
)
=>
{
...
...
@@ -2061,6 +2013,7 @@ getVolumeGroups(networkId: string, callback: AsyncCallback<VolumeGroupInfos\>\):
**示例:**
```
js
var
audioManager
=
audio
.
getAudioManager
();
audioManager
.
getVolumeGroups
(
audio
.
LOCAL_NETWORK_ID
,
(
err
,
value
)
=>
{
if
(
err
)
{
console
.
error
(
`Failed to obtain the volume group infos list.
${
err
}
`
);
...
...
@@ -2121,6 +2074,7 @@ getGroupManager(groupId: number, callback: AsyncCallback<AudioGroupManager\>\):
**示例:**
```
js
var
audioManager
=
audio
.
getAudioManager
();
async
function
getGroupManager
(){
let
value
=
await
audioManager
.
getVolumeGroups
(
audio
.
LOCAL_NETWORK_ID
);
if
(
value
.
length
>
0
)
{
...
...
@@ -2162,6 +2116,7 @@ getGroupManager(groupId: number\): Promise<AudioGroupManager\>
**示例:**
```
js
var
audioManager
=
audio
.
getAudioManager
();
async
function
getGroupManager
(){
let
value
=
await
audioManager
.
getVolumeGroups
(
audio
.
LOCAL_NETWORK_ID
);
if
(
value
.
length
>
0
)
{
...
...
@@ -2171,6 +2126,63 @@ async function getGroupManager(){
}
}
```
### getStreamManager<sup>9+</sup>
getStreamManager(callback: AsyncCallback
\<
AudioStreamManager>): void
获取音频流管理器实例。使用callback方式异步返回结果。
**系统能力:**
SystemCapability.Multimedia.Audio.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ---------------- |
| callback | AsyncCallback
<
[
AudioStreamManager
](
#audiostreammanager9
)
>
| 是 | 返回音频流管理器实例。 |
**示例:**
```
js
var
audioManager
=
audio
.
getAudioManager
();
audioManager
.
getStreamManager
((
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
`getStreamManager : Error:
${
err
}
`
);
}
else
{
console
.
info
(
'
getStreamManager : Success : SUCCESS
'
);
let
audioStreamManager
=
data
;
}
});
```
### getStreamManager<sup>9+</sup>
getStreamManager(): Promise<AudioStreamManager
\>
获取音频流管理器实例。使用Promise方式异步返回结果。
**系统能力:**
SystemCapability.Multimedia.Audio.Core
**返回值:**
| 类型 | 说明 |
| ---------------------------------------------------- | ---------------- |
| Promise
<
[
AudioStreamManager
](
#audiostreammanager9
)
>
| 返回音频流管理器实例。 |
**示例:**
```
js
var
audioManager
=
audio
.
getAudioManager
();
var
audioStreamManager
;
audioManager
.
getStreamManager
().
then
((
data
)
=>
{
audioStreamManager
=
data
;
console
.
info
(
'
getStreamManager: Success!
'
);
}).
catch
((
err
)
=>
{
console
.
error
(
`getStreamManager: ERROR :
${
err
}
`
);
});
```
### requestIndependentInterrupt<sup>9+</sup>
requestIndependentInterrupt(focusType: FocusType, callback: AsyncCallback<boolean
\>\)
: void
...
...
@@ -2202,7 +2214,7 @@ async function requestIndependentInterrupt(){
```
### requestIndependentInterrupt<sup>9+</sup>
requestIndependentInterrupt(focusType: FocusType: Promise<boolean
\>
requestIndependentInterrupt(focusType: FocusType
)
: Promise<boolean
\>
申请独立焦点,获取独立SessionID,使用promise方式异步返回结果。
...
...
@@ -2264,7 +2276,7 @@ async function abandonIndependentInterrupt(){
```
### abandonIndependentInterrupt<sup>9+</sup>
abandonIndependentInterrupt(focusType: FocusType
]
: Promise<boolean
\>
abandonIndependentInterrupt(focusType: FocusType
)
: Promise<boolean
\>
废除独立焦点,使用promise方式异步返回结果。
...
...
@@ -2312,6 +2324,8 @@ setVolume(volumeType: AudioVolumeType, volume: number, callback: AsyncCallback&l
仅设置铃声(即volumeType为AudioVolumeType.RINGTONE)在静音和非静音状态切换时需要该权限。
**系统接口:**
该接口为系统接口
**系统能力:**
SystemCapability.Multimedia.Audio.Volume
**参数:**
...
...
@@ -2344,6 +2358,8 @@ setVolume(volumeType: AudioVolumeType, volume: number): Promise<void>
仅设置铃声(即volumeType为AudioVolumeType.RINGTONE)在静音和非静音状态切换时需要该权限。
**系统接口:**
该接口为系统接口
**系统能力:**
SystemCapability.Multimedia.Audio.Volume
**参数:**
...
...
@@ -2373,6 +2389,8 @@ getVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>): v
获取指定流的音量,使用callback方式异步返回结果。
**系统接口:**
该接口为系统接口
**系统能力:**
SystemCapability.Multimedia.Audio.Volume
**参数:**
...
...
@@ -2400,6 +2418,8 @@ getVolume(volumeType: AudioVolumeType): Promise<number>
获取指定流的音量,使用Promise方式异步返回结果。
**系统接口:**
该接口为系统接口
**系统能力:**
SystemCapability.Multimedia.Audio.Volume
**参数:**
...
...
@@ -2428,6 +2448,8 @@ getMinVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>)
获取指定流的最小音量,使用callback方式异步返回结果。
**系统接口:**
该接口为系统接口
**系统能力:**
SystemCapability.Multimedia.Audio.Volume
**参数:**
...
...
@@ -2455,6 +2477,8 @@ getMinVolume(volumeType: AudioVolumeType): Promise<number>
获取指定流的最小音量,使用Promise方式异步返回结果。
**系统接口:**
该接口为系统接口
**系统能力:**
SystemCapability.Multimedia.Audio.Volume
**参数:**
...
...
@@ -2483,6 +2507,8 @@ getMaxVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>)
获取指定流的最大音量,使用callback方式异步返回结果。
**系统接口:**
该接口为系统接口
**系统能力:**
SystemCapability.Multimedia.Audio.Volume
**参数:**
...
...
@@ -2510,6 +2536,8 @@ getMaxVolume(volumeType: AudioVolumeType): Promise<number>
获取指定流的最大音量,使用Promise方式异步返回结果。
**系统接口:**
该接口为系统接口
**系统能力:**
SystemCapability.Multimedia.Audio.Volume
**参数:**
...
...
@@ -2542,6 +2570,8 @@ mute(volumeType: AudioVolumeType, mute: boolean, callback: AsyncCallback<void
仅设置铃声(即volumeType为AudioVolumeType.RINGTONE)在静音和非静音状态切换时需要该权限。
**系统接口:**
该接口为系统接口
**系统能力:**
SystemCapability.Multimedia.Audio.Volume
**参数:**
...
...
@@ -2574,6 +2604,8 @@ mute(volumeType: AudioVolumeType, mute: boolean): Promise<void>
仅设置铃声(即volumeType为AudioVolumeType.RINGTONE)在静音和非静音状态切换时需要该权限。
**系统接口:**
该接口为系统接口
**系统能力:**
SystemCapability.Multimedia.Audio.Volume
**参数:**
...
...
@@ -2603,6 +2635,8 @@ isMute(volumeType: AudioVolumeType, callback: AsyncCallback<boolean>): voi
获取指定音量流是否被静音,使用callback方式异步返回结果。
**系统接口:**
该接口为系统接口
**系统能力:**
SystemCapability.Multimedia.Audio.Volume
**参数:**
...
...
@@ -2630,6 +2664,8 @@ isMute(volumeType: AudioVolumeType): Promise<boolean>
获取指定音量流是否被静音,使用Promise方式异步返回结果。
**系统接口:**
该接口为系统接口
**系统能力:**
SystemCapability.Multimedia.Audio.Volume
**参数:**
...
...
@@ -2654,7 +2690,7 @@ audioGroupManager.isMute(audio.AudioVolumeType.MEDIA).then((value) => {
## AudioStreamManager<sup>9+</sup>
管理音频流。在使用AudioStreamManager的API前,需要使用
[
getStreamManager
](
#
audio
getstreammanager9
)
获取AudioStreamManager实例。
管理音频流。在使用AudioStreamManager的API前,需要使用
[
getStreamManager
](
#getstreammanager9
)
获取AudioStreamManager实例。
### getCurrentAudioRendererInfoArray<sup>9+</sup>
...
...
@@ -3528,13 +3564,11 @@ promise.then(function (value) {
**系统接口:**
该接口为系统接口
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Device
| 名称 | 类型 | 必填 | 说明 |
| -------------| ---------------------------------------- | ---- | -------------- |
| uid | number | 是 | 表示应用ID。
<br>
系统能力:
SystemCapability.Multimedia.Audio.Core|
| rendererInfo |
[
AudioRendererInfo
](
#audiorendererinfo8
)
| 否 | 表示渲染器信息。
<br>
系统能力:
SystemCapability.Multimedia.Audio.Renderer|
| rendererId | number | 否 | 音频流唯一id。
<br>
系统能力:
SystemCapability.Multimedia.Audio.Renderer|
| uid | number | 是 | 表示应用ID。
<br>
**系统能力:**
SystemCapability.Multimedia.Audio.Core|
| rendererInfo |
[
AudioRendererInfo
](
#audiorendererinfo8
)
| 否 | 表示渲染器信息。
<br>
**系统能力:**
SystemCapability.Multimedia.Audio.Renderer|
| rendererId | number | 否 | 音频流唯一id。
<br>
**系统能力:**
SystemCapability.Multimedia.Audio.Renderer|
**示例:**
...
...
@@ -4441,7 +4475,7 @@ audioRenderer.on('interrupt', async(interruptEvent) => {
### on('markReach')<sup>8+</sup>
on(type: "markReach", frame: number, callback: Callback
<number>
): void
on(type: "markReach", frame: number, callback: Callback
<
number
>
): void
订阅到达标记的事件。 当渲染的帧数达到 frame 参数的值时,回调被调用。
...
...
@@ -4488,7 +4522,7 @@ audioRenderer.off('markReach');
### on('periodReach') <sup>8+</sup>
on(type: "periodReach", frame: number, callback: Callback
<number>
): void
on(type: "periodReach", frame: number, callback: Callback
<
number
>
): void
订阅到达标记的事件。 当渲染的帧数达到 frame 参数的值时,回调被循环调用。
...
...
@@ -5067,7 +5101,7 @@ audioCapturer.getBufferSize().then((data) => {
### on('markReach')<sup>8+</sup>
on(type: "markReach", frame: number, callback: Callback
<number>
): void
on(type: "markReach", frame: number, callback: Callback
<
number
>
): void
订阅标记到达的事件。 当采集的帧数达到 frame 参数的值时,回调被触发。
...
...
@@ -5113,7 +5147,7 @@ audioCapturer.off('markReach');
### on('periodReach')<sup>8+</sup>
on(type: "periodReach", frame: number, callback: Callback
<number>
): void
on(type: "periodReach", frame: number, callback: Callback
<
number
>
): void
订阅到达标记的事件。 当采集的帧数达到 frame 参数的值时,回调被循环调用。
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录