Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
56889b28
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
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看板
提交
56889b28
编写于
8月 22, 2023
作者:
M
magekkkk
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
fix js reference for audio apis change
Signed-off-by:
N
magekkkk
<
lixin113@huawei.com
>
上级
5b561d9f
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
43 addition
and
17 deletion
+43
-17
zh-cn/application-dev/reference/apis/js-apis-audio.md
zh-cn/application-dev/reference/apis/js-apis-audio.md
+43
-17
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-audio.md
浏览文件 @
56889b28
...
...
@@ -4310,9 +4310,9 @@ async function selectOutputDeviceByFilter(){
}
```
### getPreferOutputDeviceForRendererInfo<sup>10+</sup>
### getPrefer
red
OutputDeviceForRendererInfo<sup>10+</sup>
getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback: AsyncCallback
<
AudioDeviceDescriptors
>
): void
getPrefer
red
OutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback: AsyncCallback
<
AudioDeviceDescriptors
>
): void
根据音频信息,返回优先级最高的输出设备,使用callback方式异步返回结果。
...
...
@@ -4325,6 +4325,15 @@ getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback:
| rendererInfo |
[
AudioRendererInfo
](
#audiorendererinfo8
)
| 是 | 表示渲染器信息。 |
| callback | AsyncCallback
<
[AudioDeviceDescriptors](#audiodevicedescriptors)
>
| 是 | 回调,返回优先级最高的输出设备信息。 |
**错误码:**
以下错误码的详细介绍请参见
[
音频错误码
](
../errorcodes/errorcode-audio.md
)
。
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | if input parameter value error. Return by callback. |
| 6800301 | System error. Return by callback. |
**示例:**
```
js
let
rendererInfo
=
{
...
...
@@ -4332,8 +4341,8 @@ let rendererInfo = {
usage
:
audio
.
StreamUsage
.
STREAM_USAGE_MEDIA
,
rendererFlags
:
0
}
async
function
getPreferOutputDevice
()
{
audioRoutingManager
.
getPreferOutputDeviceForRendererInfo
(
rendererInfo
,
(
err
,
desc
)
=>
{
async
function
getPrefer
red
OutputDevice
()
{
audioRoutingManager
.
getPrefer
red
OutputDeviceForRendererInfo
(
rendererInfo
,
(
err
,
desc
)
=>
{
if
(
err
)
{
console
.
error
(
`Result ERROR:
${
err
}
`
);
}
else
{
...
...
@@ -4343,8 +4352,8 @@ async function getPreferOutputDevice() {
}
```
### getPreferOutputDeviceForRendererInfo<sup>10+</sup>
getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise
<
AudioDeviceDescriptors
>
### getPrefer
red
OutputDeviceForRendererInfo<sup>10+</sup>
getPrefer
red
OutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise
<
AudioDeviceDescriptors
>
根据音频信息,返回优先级最高的输出设备,使用promise方式异步返回结果。
...
...
@@ -4368,7 +4377,8 @@ getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise&l
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | if input parameter value error |
| 6800101 | if input parameter value error. Return by promise. |
| 6800301 | System error. Return by promise. |
**示例:**
...
...
@@ -4378,8 +4388,8 @@ let rendererInfo = {
usage
:
audio
.
StreamUsage
.
STREAM_USAGE_MEDIA
,
rendererFlags
:
0
}
async
function
getPreferOutputDevice
()
{
audioRoutingManager
.
getPreferOutputDeviceForRendererInfo
(
rendererInfo
).
then
((
desc
)
=>
{
async
function
getPrefer
red
OutputDevice
()
{
audioRoutingManager
.
getPrefer
red
OutputDeviceForRendererInfo
(
rendererInfo
).
then
((
desc
)
=>
{
console
.
info
(
`device descriptor:
${
desc
}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`Result ERROR:
${
err
}
`
);
...
...
@@ -4387,9 +4397,9 @@ async function getPreferOutputDevice() {
}
```
### on('preferOutputDeviceChangeForRendererInfo')<sup>10+</sup>
### on('prefer
red
OutputDeviceChangeForRendererInfo')<sup>10+</sup>
on(type: 'preferOutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererInfo, callback: Callback<AudioDeviceDescriptors
\>
): void
on(type: 'prefer
red
OutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererInfo, callback: Callback<AudioDeviceDescriptors
\>
): void
订阅最高优先级输出设备变化事件,使用callback获取最高优先级输出设备。
...
...
@@ -4399,7 +4409,7 @@ on(type: 'preferOutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererI
| 参数名 | 类型 | 必填 | 说明 |
| :------- | :--------------------------------------------------- | :--- | :----------------------------------------- |
| type | string | 是 | 订阅的事件的类型。支持事件:'preferOutputDeviceChangeForRendererInfo' |
| type | string | 是 | 订阅的事件的类型。支持事件:'prefer
red
OutputDeviceChangeForRendererInfo' |
| rendererInfo |
[
AudioRendererInfo
](
#audiorendererinfo8
)
| 是 | 表示渲染器信息。 |
| callback | Callback<
[
AudioDeviceDescriptors
](
#audiodevicedescriptors
)
\>
| 是 | 获取优先级最高的输出设备信息。 |
...
...
@@ -4419,14 +4429,14 @@ let rendererInfo = {
usage
:
audio
.
StreamUsage
.
STREAM_USAGE_MEDIA
,
rendererFlags
:
0
}
audioRoutingManager
.
on
(
'
preferOutputDeviceChangeForRendererInfo
'
,
rendererInfo
,
(
desc
)
=>
{
audioRoutingManager
.
on
(
'
prefer
red
OutputDeviceChangeForRendererInfo
'
,
rendererInfo
,
(
desc
)
=>
{
console
.
info
(
`device descriptor:
${
desc
}
`
);
});
```
### off('preferOutputDeviceChangeForRendererInfo')<sup>10+</sup>
### off('prefer
red
OutputDeviceChangeForRendererInfo')<sup>10+</sup>
off(type: 'preferOutputDeviceChangeForRendererInfo', callback?: Callback<AudioDeviceDescriptors
\>
): void
off(type: 'prefer
red
OutputDeviceChangeForRendererInfo', callback?: Callback<AudioDeviceDescriptors
\>
): void
取消订阅最高优先级输出音频设备变化事件。
...
...
@@ -4436,7 +4446,7 @@ off(type: 'preferOutputDeviceChangeForRendererInfo', callback?: Callback<AudioDe
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------ |
| type | string | 是 | 订阅的事件的类型。支持事件:'preferOutputDeviceChangeForRendererInfo' |
| type | string | 是 | 订阅的事件的类型。支持事件:'prefer
red
OutputDeviceChangeForRendererInfo' |
| callback | Callback
<
[
AudioDeviceDescriptors
](
#audiodevicedescriptors
)
>
| 否 | 监听方法的回调函数。 |
**错误码:**
...
...
@@ -4450,7 +4460,7 @@ off(type: 'preferOutputDeviceChangeForRendererInfo', callback?: Callback<AudioDe
**示例:**
```
js
audioRoutingManager
.
off
(
'
preferOutputDeviceChangeForRendererInfo
'
);
audioRoutingManager
.
off
(
'
prefer
red
OutputDeviceChangeForRendererInfo
'
);
```
## AudioRendererChangeInfoArray<sup>9+</sup>
...
...
@@ -4830,6 +4840,14 @@ setAudioEffectMode(mode: AudioEffectMode, callback: AsyncCallback\<void>): void
| mode |
[
AudioEffectMode
](
#audioeffectmode10
)
| 是 | 音效模式。 |
| callback | AsyncCallback
\<
void> | 是 | 用于返回执行结果的回调。 |
**错误码:**
以下错误码的详细介绍请参见
[
音频错误码
](
../errorcodes/errorcode-audio.md
)
。
| 错误码ID | 错误信息 |
| ------- | ----------------------------------------------|
| 6800101 | Invalid parameter error. Return by callback. |
**示例:**
```
js
...
...
@@ -4862,6 +4880,14 @@ setAudioEffectMode(mode: AudioEffectMode): Promise\<void>
| -------------- | ------------------------- |
| Promise
\<
void> | Promise用于返回执行结果。 |
**错误码:**
以下错误码的详细介绍请参见
[
音频错误码
](
../errorcodes/errorcode-audio.md
)
。
| 错误码ID | 错误信息 |
| ------- | ---------------------------------------------|
| 6800101 | Invalid parameter error. Return by promise. |
**示例:**
```
js
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录