Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

未验证 提交 e7a3ad60 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!9470 文档资料完整性问题修改 

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