Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
b6828d12
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看板
提交
b6828d12
编写于
8月 24, 2022
作者:
W
wangtao
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
add docs for distributed audio getDevice...
Signed-off-by:
N
wangtao
<
wangtao468@huawei.com
>
上级
4fc94f66
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
151 addition
and
1 deletion
+151
-1
zh-cn/application-dev/reference/apis/js-apis-audio.md
zh-cn/application-dev/reference/apis/js-apis-audio.md
+151
-1
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-audio.md
浏览文件 @
b6828d12
...
...
@@ -300,9 +300,13 @@ const localNetworkId = audio.LOCAL_NETWORK_ID;
| 名称 | 默认值 | 描述 |
| ------------------- | ------ | ---------- |
| NONE_DEVICES_FLAG
<sup>
9+
</sup>
| 0 | 无 |
| OUTPUT_DEVICES_FLAG | 1 | 输出设备。 |
| INPUT_DEVICES_FLAG | 2 | 输入设备。 |
| ALL_DEVICES_FLAG | 3 | 所有设备。 |
| DISTRIBUTED_OUTPUT_DEVICES_FLAG
<sup>
9+
</sup>
| 4 | 分布式输出设备。 |
| DISTRIBUTED_INPUT_DEVICES_FLAG
<sup>
9+
</sup>
| 8 | 分布式输入设备。 |
| ALL_DISTRIBUTED_DEVICES_FLAG
<sup>
9+
</sup>
| 12 | 分布式输入和输出设备。 |
## DeviceRole
...
...
@@ -2052,6 +2056,12 @@ getVolumeGroups(networkId: string\): Promise<VolumeGroupInfos\>
| ---------- | ------------------------------------------------------------ | ---- | -------------------- |
| networkId | string | 是 | 设备的网络id。本地设备audio.LOCAL_NETWORK_ID ,也可以通过getRoutingManager().getDevices()获取全部networkId。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ----------------------------- |
| Promise
<
[VolumeGroupInfos](#volumegroupinfos9)
>
| 音量组信息列表。 |
**示例:**
```
js
...
...
@@ -2076,7 +2086,7 @@ getGroupManager(groupId: number, callback: AsyncCallback<AudioGroupManager\>\):
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | -------------------- |
| networkId | string | 是 | 设备的网络id。 |
| callback | AsyncCallback
<
[
AudioGroupManager
](
#audiogroupmanager9
)
>
| 是 | 回调,返回一个音量组
音量组
实例。 |
| callback | AsyncCallback
<
[
AudioGroupManager
](
#audiogroupmanager9
)
>
| 是 | 回调,返回一个音量组实例。 |
**示例:**
...
...
@@ -2113,6 +2123,12 @@ getGroupManager(groupId: number\): Promise<AudioGroupManager\>
| ---------- | ------------------------------------------------------------ | ---- | -------------------- |
| networkId | string | 是 | 设备的网络id。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ----------------------------- |
| Promise
<
[
AudioGroupManager
](
#audiogroupmanager9
)
>
| 音量组实例。 |
**示例:**
```
js
...
...
@@ -2859,6 +2875,140 @@ console.info(`isAudioRendererLowLatencySupported success var ${result}`);
音频路由管理。在使用AudioRoutingManager的接口前,需要使用
[
getRoutingManager
](
#getroutingmanager9
)
获取AudioRoutingManager实例。
### getDevices<sup>9+</sup>
getDevices(deviceFlag: DeviceFlag, callback: AsyncCallback
<
AudioDeviceDescriptors
>
): void
获取音频设备列表,使用callback方式异步返回结果。
**系统能力:**
SystemCapability.Multimedia.Audio.Device
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | -------------------- |
| deviceFlag |
[
DeviceFlag
](
#deviceflag
)
| 是 | 设备类型的flag。 |
| callback | AsyncCallback
<
[AudioDeviceDescriptors](#audiodevicedescriptors)
>
| 是 | 回调,返回设备列表。 |
**示例:**
```
js
audioManager
.
getRoutingManager
((
err
,
AudioRoutingManager
)
=>
{
if
(
err
)
{
console
.
error
(
`AudioFrameworkTest:Callback:failed to get RoutingManager
${
err
.
message
}
`
);
}
else
{
AudioRoutingManager
.
getDevices
(
audio
.
DeviceFlag
.
OUTPUT_DEVICES_FLAG
,
(
err
,
value
)
=>
{
if
(
err
)
{
console
.
error
(
`Failed to obtain the device list.
${
err
.
message
}
`
);
return
;
}
console
.
log
(
`Callback invoked to indicate that the device list is obtained.`
);
});
}
})
```
### getDevices<sup>9+</sup>
getDevices(deviceFlag: DeviceFlag): Promise
<
AudioDeviceDescriptors
>
获取音频设备列表,使用Promise方式异步返回结果。
**系统能力:**
SystemCapability.Multimedia.Audio.Device
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ---------------- |
| deviceFlag |
[
DeviceFlag
](
#deviceflag
)
| 是 | 设备类型的flag。 |
**返回值:**
| 类型 | 说明 |
| ------------------------------------------------------------ | ------------------------- |
| Promise
<
[AudioDeviceDescriptors](#audiodevicedescriptors)
>
| Promise回调返回设备列表。 |
**示例:**
```
js
audioManager
.
getRoutingManager
((
err
,
AudioRoutingManager
)
=>
{
if
(
err
)
{
console
.
error
(
`AudioFrameworkTest:Callback:failed to get RoutingManager
${
err
.
message
}
`
);
}
else
{
AudioRoutingManager
.
getDevices
(
audio
.
DeviceFlag
.
OUTPUT_DEVICES_FLAG
).
then
((
data
)
=>
{
console
.
log
(
`Promise returned to indicate that the device list is obtained.`
);
});
}
});
```
### on<sup>9+</sup>
on(type: 'deviceChange', deviceFlag: DeviceFlag,, callback: Callback<DeviceChangeAction
\>
): void
设备更改。音频设备连接状态变化。
**系统能力:**
SystemCapability.Multimedia.Audio.Device
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| :------- | :--------------------------------------------------- | :--- | :----------------------------------------- |
| type | string | 是 | 订阅的事件的类型。支持事件:'deviceChange' |
| deviceFlag |
[
DeviceFlag
](
#deviceflag
)
| 是 | 设备类型的flag。 |
| callback | Callback<
[
DeviceChangeAction
](
#devicechangeaction
)
\>
| 是 | 获取设备更新详情。 |
**示例:**
```
js
audioManager
.
getRoutingManager
((
err
,
AudioRoutingManager
)
=>
{
if
(
err
)
{
console
.
error
(
`AudioFrameworkTest:Callback:failed to get RoutingManager
${
err
.
message
}
`
);
}
else
{
AudioRoutingManager
.
on
(
'
deviceChange
'
,
audio
.
DeviceFlag
.
OUTPUT_DEVICES_FLAG
,
(
deviceChanged
)
=>
{
console
.
info
(
'
device change type :
'
+
deviceChanged
.
type
);
console
.
info
(
'
device descriptor size :
'
+
deviceChanged
.
deviceDescriptors
.
length
);
console
.
info
(
'
device change descriptor :
'
+
deviceChanged
.
deviceDescriptors
[
0
].
deviceRole
);
console
.
info
(
'
device change descriptor :
'
+
deviceChanged
.
deviceDescriptors
[
0
].
deviceType
);
});
}
});
```
### off<sup>9+</sup>
off(type: 'deviceChange', callback?: Callback<DeviceChangeAction
\>
): void
取消订阅音频设备连接变化事件。
**系统能力:**
SystemCapability.Multimedia.Audio.Device
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------ |
| type | string | 是 | 订阅的事件的类型。支持事件:'deviceChange' |
| deviceFlag |
[
DeviceFlag
](
#deviceflag
)
| 是 | 设备类型的flag。 |
| callback | Callback
<
[
DeviceChangeAction
](
#devicechangeaction
)
>
| 否 | 获取设备更新详情。 |
**示例:**
```
js
audioManager
.
getRoutingManager
((
err
,
AudioRoutingManager
)
=>
{
if
(
err
)
{
console
.
error
(
`AudioFrameworkTest:Callback:failed to get RoutingManager
${
err
.
message
}
`
);
}
else
{
AudioRoutingManager
.
off
(
'
deviceChange
'
,
audio
.
DeviceFlag
.
OUTPUT_DEVICES_FLAG
,
(
deviceChanged
)
=>
{
console
.
log
(
'
Should be no callback.
'
);
});
}
});
```
### selectOutputDevice<sup>9+</sup>
selectOutputDevice(audiodevicedescriptors: AudioDeviceDescriptors, callback: AsyncCallback
<
void
>
): void
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录