Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
c64c7d6c
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,发现更多精彩内容 >>
提交
c64c7d6c
编写于
8月 30, 2022
作者:
Z
zhujie81
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
add requestIndependentInterrupt interface docs
Signed-off-by:
N
zhujie81
<
zhujie81@huawei.com
>
上级
eec432f9
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
135 addition
and
11 deletion
+135
-11
zh-cn/application-dev/reference/apis/js-apis-audio.md
zh-cn/application-dev/reference/apis/js-apis-audio.md
+135
-11
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-audio.md
浏览文件 @
c64c7d6c
...
...
@@ -335,8 +335,8 @@ audio.createAudioCapturer(audioCapturerOptions).then((data) => {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Device
| 名称
| 默认值 | 描述
|
| ---------------------------
----| ------ |
---------- |
| 名称
| 默认值 | 描述
|
| ---------------------------
---- | ------ | ---------------------------------------
---------- |
| NONE_DEVICES_FLAG
<sup>
9+
</sup>
| 0 | 无
<br/>
此接口为系统接口,三方应用不支持调用。 |
| OUTPUT_DEVICES_FLAG | 1 | 输出设备。 |
| INPUT_DEVICES_FLAG | 2 | 输入设备。 |
...
...
@@ -489,6 +489,8 @@ audio.createAudioCapturer(audioCapturerOptions).then((data) => {
表示焦点类型的枚举。
**系统接口:**
该接口为系统接口
**系统能力:**
: SystemCapability.Multimedia.Audio.Core
| 名称 | 默认值 | 描述 |
...
...
@@ -2169,7 +2171,130 @@ async function getGroupManager(){
}
}
```
### requestIndependentInterrupt<sup>9+</sup>
requestIndependentInterrupt(focusType: FocusType, callback: AsyncCallback<boolean
\>\)
: void
申请独立焦点,获取独立SessionID,使用callback方式异步返回结果。
**系统接口:**
该接口为系统接口
**系统能力:**
SystemCapability.Multimedia.Audio.Renderer
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | ----------------- |
| focusType |
[
FocusType
](
#focustype
)
| 是 | 焦点类型的枚举。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调,返回焦点申请成功/失败状态。 |
**示例:**
```
js
async
function
requestIndependentInterrupt
(){
let
value
=
await
audioManager
.
requestIndependentInterrupt
(
audio
.
FocusType
.
FOCUS_TYPE_RECORDING
);
if
(
value
)
{
console
.
info
(
'
requestIndependentInterrupt interface for result callback: SUCCESS
'
);
}
else
{
console
.
error
(
'
Result ERROR
'
);
}
}
```
### requestIndependentInterrupt<sup>9+</sup>
requestIndependentInterrupt(focusType: FocusType: Promise<boolean
\>
申请独立焦点,获取独立SessionID,使用promise方式异步返回结果。
**系统接口:**
该接口为系统接口
**系统能力:**
SystemCapability.Multimedia.Audio.Renderer
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | ---- |
| focusType |
[
FocusType
](
#focustype
)
| 是 | 焦点类型的枚举。 |
**返回值:**
| 类型 | 说明 |
| --------------------------------------------------------- | ------------ |
| Promise
<
boolean
>
| 返回申请焦点成功/失败状态。 |
**示例:**
```
js
async
function
requestIndependentInterrupt
(){
audioManager
.
requestIndependentInterrupt
(
audio
.
FocusType
.
FOCUS_TYPE_RECORDING
).
then
((
value
)
=>
{
console
.
info
(
'
Promise returned to succeed
'
);
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to requestIndependentInterrupt
'
);
});
}
```
### abandonIndependentInterrupt<sup>9+</sup>
abandonIndependentInterrupt(focusType: FocusType, callback: AsyncCallback<boolean
\>\)
: void
废除独立焦点,使用callback方式异步返回结果。
**系统接口:**
该接口为系统接口
**系统能力:**
SystemCapability.Multimedia.Audio.Renderer
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | ----------------- |
| focusType |
[
FocusType
](
#focustype
)
| 是 | 焦点类型的枚举。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调,返回废除焦点成功/失败状态。 |
**示例:**
```
js
async
function
abandonIndependentInterrupt
(){
let
value
=
await
audioManager
.
abandonIndependentInterrupt
(
audio
.
FocusType
.
FOCUS_TYPE_RECORDING
);
if
(
value
)
{
console
.
info
(
'
abandonIndependentInterrupt interface for result callback: SUCCESS
'
);
}
else
{
console
.
error
(
'
Result ERROR
'
);
}
}
```
### abandonIndependentInterrupt<sup>9+</sup>
abandonIndependentInterrupt(focusType: FocusType]: Promise<boolean
\>
废除独立焦点,使用promise方式异步返回结果。
**系统接口:**
该接口为系统接口
**系统能力:**
SystemCapability.Multimedia.Audio.Renderer
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | ---- |
| focusType |
[
FocusType
](
#focustype
)
| 是 | 焦点类型的枚举。 |
**返回值:**
| 类型 | 说明 |
| --------------------------------------------------------- | ------------ |
| Promise
<
boolean
>
| 返回废除焦点成功/失败状态。 |
**示例:**
```
js
async
function
abandonIndependentInterrupt
(){
audioManager
.
abandonIndependentInterrupt
(
audio
.
FocusType
.
FOCUS_TYPE_RECORDING
).
then
((
value
)
=>
{
console
.
info
(
'
Promise returned to succeed
'
);
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to abandonIndependentInterrupt
'
);
});
}
```
## AudioGroupManager<sup>9+</sup>
管理音频组音量。在调用AudioGroupManager的接口前,需要先通过
[
getGroupManager
](
#getgroupmanager9
)
创建实例。
...
...
@@ -2916,7 +3041,6 @@ audioStreamManager.off('audioCapturerChange');
console
.
info
(
'
######### CapturerChange Off is called #########
'
);
```
## AudioRoutingManager<sup>9+</sup>
音频路由管理。在使用AudioRoutingManager的接口前,需要使用
[
getRoutingManager
](
#getroutingmanager9
)
获取AudioRoutingManager实例。
...
...
@@ -4317,7 +4441,7 @@ audioRenderer.on('interrupt', async(interruptEvent) => {
### on('markReach')<sup>8+</sup>
on(type:
'markReach', frame: number, callback: (position: number) => {}
): void
on(type:
"markReach", frame: number, callback: Callback
<number>
): void
订阅到达标记的事件。 当渲染的帧数达到 frame 参数的值时,回调被调用。
...
...
@@ -4329,7 +4453,7 @@ on(type: 'markReach', frame: number, callback: (position: number) => {}): void
| :------- | :----------------------- | :--- | :---------------------------------------- |
| type | string | 是 | 事件回调类型,支持的事件为:'markReach'。 |
| frame | number | 是 | 触发事件的帧数。 该值必须大于 0。 |
| callback |
(position: number) => {}
| 是 | 触发事件时调用的回调。 |
| callback |
Callback
<number>
| 是 | 触发事件时调用的回调。 |
**示例:**
...
...
@@ -4364,7 +4488,7 @@ audioRenderer.off('markReach');
### on('periodReach') <sup>8+</sup>
on(type: "periodReach", frame: number, callback:
(position: number) => {}
): void
on(type: "periodReach", frame: number, callback:
Callback
<number>
): void
订阅到达标记的事件。 当渲染的帧数达到 frame 参数的值时,回调被循环调用。
...
...
@@ -4376,7 +4500,7 @@ on(type: "periodReach", frame: number, callback: (position: number) => {}): void
| :------- | :----------------------- | :--- | :------------------------------------------ |
| type | string | 是 | 事件回调类型,支持的事件为:'periodReach'。 |
| frame | number | 是 | 触发事件的帧数。 该值必须大于 0。 |
| callback |
(position: number) => {}
| 是 | 触发事件时调用的回调。 |
| callback |
Callback
<number>
| 是 | 触发事件时调用的回调。 |
**示例:**
...
...
@@ -4943,7 +5067,7 @@ audioCapturer.getBufferSize().then((data) => {
### on('markReach')<sup>8+</sup>
on(type:
'markReach', frame: number, callback: (position: number) => {}
): void
on(type:
"markReach", frame: number, callback: Callback
<number>
): void
订阅标记到达的事件。 当采集的帧数达到 frame 参数的值时,回调被触发。
...
...
@@ -4955,7 +5079,7 @@ on(type: 'markReach', frame: number, callback: (position: number) => {}): void
| :------- | :---------------------- | :--- | :----------------------------------------- |
| type | string | 是 | 事件回调类型,支持的事件为:'markReach'。 |
| frame | number | 是 | 触发事件的帧数。 该值必须大于0。 |
| callback |
(position: number) => {}
| 是 | 使用callback方式异步返回被触发事件的回调。 |
| callback |
Callback
<number>
| 是 | 使用callback方式异步返回被触发事件的回调。 |
**示例:**
...
...
@@ -4989,7 +5113,7 @@ audioCapturer.off('markReach');
### on('periodReach')<sup>8+</sup>
on(type: "periodReach", frame: number, callback:
(position: number) => {}
): void
on(type: "periodReach", frame: number, callback:
Callback
<number>
): void
订阅到达标记的事件。 当采集的帧数达到 frame 参数的值时,回调被循环调用。
...
...
@@ -5001,7 +5125,7 @@ on(type: "periodReach", frame: number, callback: (position: number) => {}): void
| :------- | :----------------------- | :--- | :------------------------------------------ |
| type | string | 是 | 事件回调类型,支持的事件为:'periodReach'。 |
| frame | number | 是 | 触发事件的帧数。 该值必须大于0。 |
| callback |
(position: number) => {}
| 是 | 使用callback方式异步返回被触发事件的回调 |
| callback |
Callback
<number>
| 是 | 使用callback方式异步返回被触发事件的回调 |
**示例:**
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录