Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
“7984dd93f1ba03a9c724e8c48d3deeeca803d0b6”上不存在“...mgmt/mgmt_mnode/git@gitcode.net:taosdata/tdengine.git”
提交 83fcc63e 编写于 作者: Z zengyawen
浏览文件
操作

update media english docs 

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 4acbb773
隐藏空白更改
内联 并排
Showing with 1873 addition and 525 deletion
en/application-dev/js-reference/audio-management.md
浏览文件 @ 83fcc63e
# Audio Management<a name="EN-US_TOPIC_0000001162414649"></a> # Audio Management<a name="EN-US_TOPIC_0000001149807881"></a>
- [Modules to Import](#en-us_topic_0000001149807881_s56d19203690d4782bfc74069abb6bd71) - [Modules to Import](#s56d19203690d4782bfc74069abb6bd71)
- [Required Permissions](#en-us_topic_0000001149807881_section11257113618419) - [Required Permissions](#section11257113618419)
- [Functions](#en-us_topic_0000001149807881_section1580114415416) - [getAudioManager\(\): AudioManager](#section84581011418)
- [getAudioManager\(\)](#en-us_topic_0000001149807881_section84581011418) - [AudioVolumeType](#section92261857172218)
- [Enums](#en-us_topic_0000001149807881_section115029181495) - [DeviceFlag](#section11285183164210)
- [AudioVolumeType](#en-us_topic_0000001149807881_section92261857172218) - [DeviceRole](#section380038142619)
- [DeviceFlag](#en-us_topic_0000001149807881_section11285183164210) - [DeviceType](#section11727420122710)
- [DeviceRole](#en-us_topic_0000001149807881_section380038142619) - [AudioRingMode7+](#section14948916131018)
- [DeviceType](#en-us_topic_0000001149807881_section11727420122710) - [AudioManager](#section8265143814015)
- [Appendixes](#en-us_topic_0000001149807881_section1933416317165) - [setVolume\(volumeType: AudioVolumeType, volume: number, callback: AsyncCallback<void\>\): void](#section189141826104616)
- [AudioManager](#en-us_topic_0000001149807881_section8265143814015) - [setVolume\(volumeType: AudioVolumeType, volume: number\): Promise<void\>](#section102021249114612)
- [setVolume\(AudioVolumeType, number, AsyncCallback<void\>\)](#en-us_topic_0000001149807881_section189141826104616) - [getVolume\(volumeType: AudioVolumeType, callback: AsyncCallback<number\>\): void](#section4387320194714)
- [setVolume\(AudioVolumeType, number\)](#en-us_topic_0000001149807881_section102021249114612) - [getVolume\(volumeType: AudioVolumeType\): Promise<number\>](#section04121965119)
- [getVolume\(AudioVolumeType, AsyncCallback<number\>\)](#en-us_topic_0000001149807881_section4387320194714) - [getMinVolume\(volumeType: AudioVolumeType, callback: AsyncCallback<number\>\): void](#section188714283511)
- [getVolume\(AudioVolumeType\)](#en-us_topic_0000001149807881_section04121965119) - [getMinVolume\(volumeType: AudioVolumeType\): Promise<number\>](#section41556389511)
- [getMinVolume\(AudioVolumeType, AsyncCallback<number\>\)](#en-us_topic_0000001149807881_section188714283511) - [getMaxVolume\(volumeType: AudioVolumeType, callback: AsyncCallback<number\>\): void](#section690395418516)
- [getMinVolume\(AudioVolumeType\)](#en-us_topic_0000001149807881_section41556389511) - [getMaxVolume\(volumeType: AudioVolumeType\): Promise<number\>](#section155151345217)
- [getMaxVolume\(AudioVolumeType, AsyncCallback<number\>\)](#en-us_topic_0000001149807881_section690395418516) - [mute\(volumeType: AudioVolumeType, mute: boolean, callback: AsyncCallback<void\>\): void7+](#section13516136134613)
- [getMaxVolume\(AudioVolumeType\)](#en-us_topic_0000001149807881_section155151345217) - [mute\(volumeType: AudioVolumeType, mute: boolean\): Promise<void\>7+](#section7519036144616)
- [getDevices\(DeviceFlag, AsyncCallback<AudioDeviceDescriptors\>\)](#en-us_topic_0000001149807881_section11536182020523) - [isMute\(volumeType: AudioVolumeType, callback: AsyncCallback<boolean\>\): void7+](#section10684183819585)
- [getDevices\(DeviceFlag\)](#en-us_topic_0000001149807881_section181733125210) - [isMute\(volumeType: AudioVolumeType\): Promise<boolean\>7+](#section6920211145610)
- [isActive\(volumeType: AudioVolumeType, callback: AsyncCallback<boolean\>\): void7+](#section380012544121)
- [AudioDeviceDescriptor](#en-us_topic_0000001149807881_section17427121913310) - [isActive\(volumeType: AudioVolumeType\): Promise<boolean\>7+](#section1880315481216)
- [AudioDeviceDescriptors](#en-us_topic_0000001149807881_section5181155710523) - [setRingerMode\(mode: AudioRingMode, callback: AsyncCallback<void\>\): void7+](#section18572131483613)
- [setRingerMode\(mode: AudioRingMode\): Promise<void\>7+](#section55741914143615)
>![](public_sys-resources/icon-note.gif) **NOTE:** - [getRingerMode\(callback: AsyncCallback<AudioRingMode\>\): void7+](#section149044108162)
>Due to permission issues, these feature are temporarily unavailable for the standard system. - [getRingerMode\(\): Promise<AudioRingMode\>7+](#section13908210101620)
- [setAudioParameter\(key: string, value: string, callback: AsyncCallback<void\>\): void7+](#section1691957174818)
## Modules to Import<a name="en-us_topic_0000001149807881_s56d19203690d4782bfc74069abb6bd71"></a> - [setAudioParameter\(key: string, value: string\): Promise<void\>7+](#section18121057174820)
- [getAudioParameter\(key: string, callback: AsyncCallback<string\>\): void7+](#section1415145714812)
- [getAudioParameter\(key: string\): Promise<string\>7+](#section3185577485)
- [getDevices\(deviceFlag: DeviceFlag, callback: AsyncCallback<AudioDeviceDescriptors\>\): void](#section11536182020523)
- [getDevices\(deviceFlag: DeviceFlag\): Promise<AudioDeviceDescriptors\>](#section181733125210)
- [setDeviceActive\(deviceType: DeviceType, active: boolean, callback: AsyncCallback<void\>\): void7+](#section103558400222)
- [setDeviceActive\(deviceType: DeviceType, active: boolean\): Promise<void\>7+](#section1235914401228)
- [isDeviceActive\(deviceType: DeviceType, callback: AsyncCallback<boolean\>\): void7+](#section12363240122219)
- [isDeviceActive\(deviceType: DeviceType\): Promise<boolean\>7+](#section18366184012213)
- [setMicrophoneMute\(mute: boolean, callback: AsyncCallback<void\>\): void7+](#section14703163618122)
- [setMicrophoneMute\(mute: boolean\): Promise<void\>7+](#section56287111791)
- [isMicrophoneMute\(callback: AsyncCallback<boolean\>\): void7+](#section6632141119912)
- [isMicrophoneMute\(\): Promise<boolean\>7+](#section196363111918)
- [AudioDeviceDescriptor](#section164657411927)
- [Attributes](#section4947115405)
- [AudioDeviceDescriptors](#section5181155710523)
## Modules to Import<a name="s56d19203690d4782bfc74069abb6bd71"></a>
``` ```
import audio from '@ohos.multimedia.audio'; import audio from '@ohos.multimedia.audio';
``` ```
## Required Permissions<a name="en-us_topic_0000001149807881_section11257113618419"></a> ## Required Permissions<a name="section11257113618419"></a>
None None
## Functions<a name="en-us_topic_0000001149807881_section1580114415416"></a> ## getAudioManager\(\): AudioManager<a name="section84581011418"></a>
## getAudioManager\(\)<a name="en-us_topic_0000001149807881_section84581011418"></a>
Obtains an **AudioManager** instance. Obtains an **AudioManager** instance.
**Return Values** **Return values**
<a name="en-us_topic_0000001149807881_table16391145317913"></a> <a name="table16391145317913"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row2391145319910"><th class="cellrowborder" valign="top" width="17.01%" id="mcps1.1.3.1.1"><p id="en-us_topic_0000001149807881_p13911353991"><a name="en-us_topic_0000001149807881_p13911353991"></a><a name="en-us_topic_0000001149807881_p13911353991"></a>Type</p> <table><thead align="left"><tr id="row2391145319910"><th class="cellrowborder" valign="top" width="17.01%" id="mcps1.1.3.1.1"><p id="p13911353991"><a name="p13911353991"></a><a name="p13911353991"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="82.99%" id="mcps1.1.3.1.2"><p id="en-us_topic_0000001149807881_p193911531395"><a name="en-us_topic_0000001149807881_p193911531395"></a><a name="en-us_topic_0000001149807881_p193911531395"></a>Description</p> <th class="cellrowborder" valign="top" width="82.99%" id="mcps1.1.3.1.2"><p id="p193911531395"><a name="p193911531395"></a><a name="p193911531395"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row1339114531391"><td class="cellrowborder" valign="top" width="17.01%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0000001149807881_p1338931454713"><a name="en-us_topic_0000001149807881_p1338931454713"></a><a name="en-us_topic_0000001149807881_p1338931454713"></a><a href="#en-us_topic_0000001149807881_section8265143814015">AudioManager</a></p> <tbody><tr id="row1339114531391"><td class="cellrowborder" valign="top" width="17.01%" headers="mcps1.1.3.1.1 "><p id="p1338931454713"><a name="p1338931454713"></a><a name="p1338931454713"></a><a href="#section8265143814015">AudioManager</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="82.99%" headers="mcps1.1.3.1.2 "><p id="en-us_topic_0000001149807881_p1039217531898"><a name="en-us_topic_0000001149807881_p1039217531898"></a><a name="en-us_topic_0000001149807881_p1039217531898"></a>Audio manager</p> <td class="cellrowborder" valign="top" width="82.99%" headers="mcps1.1.3.1.2 "><p id="p1039217531898"><a name="p1039217531898"></a><a name="p1039217531898"></a>Audio manager</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
...@@ -67,278 +84,315 @@ Obtains an **AudioManager** instance. ...@@ -67,278 +84,315 @@ Obtains an **AudioManager** instance.
var audioManager = audio.getAudioManager(); var audioManager = audio.getAudioManager();
``` ```
## Enums<a name="en-us_topic_0000001149807881_section115029181495"></a> ## AudioVolumeType<a name="section92261857172218"></a>
## AudioVolumeType<a name="en-us_topic_0000001149807881_section92261857172218"></a>
Enumerates audio stream types. Enumerates audio stream types.
<a name="en-us_topic_0000001149807881_table689215633911"></a> <a name="table689215633911"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row19892165613399"><th class="cellrowborder" valign="top" width="30.380000000000003%" id="mcps1.1.4.1.1"><p id="en-us_topic_0000001149807881_p148924564394"><a name="en-us_topic_0000001149807881_p148924564394"></a><a name="en-us_topic_0000001149807881_p148924564394"></a>Name</p> <table><thead align="left"><tr id="row19892165613399"><th class="cellrowborder" valign="top" width="30.380000000000003%" id="mcps1.1.4.1.1"><p id="p148924564394"><a name="p148924564394"></a><a name="p148924564394"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="9.950000000000001%" id="mcps1.1.4.1.2"><p id="en-us_topic_0000001149807881_aace9cae4ba0d4939bfa048460f61c3c7"><a name="en-us_topic_0000001149807881_aace9cae4ba0d4939bfa048460f61c3c7"></a><a name="en-us_topic_0000001149807881_aace9cae4ba0d4939bfa048460f61c3c7"></a>Default Value</p> <th class="cellrowborder" valign="top" width="9.950000000000001%" id="mcps1.1.4.1.2"><p id="aace9cae4ba0d4939bfa048460f61c3c7"><a name="aace9cae4ba0d4939bfa048460f61c3c7"></a><a name="aace9cae4ba0d4939bfa048460f61c3c7"></a>Default Value</p>
</th> </th>
<th class="cellrowborder" valign="top" width="59.67%" id="mcps1.1.4.1.3"><p id="en-us_topic_0000001149807881_p19892145616392"><a name="en-us_topic_0000001149807881_p19892145616392"></a><a name="en-us_topic_0000001149807881_p19892145616392"></a>Description</p> <th class="cellrowborder" valign="top" width="59.67%" id="mcps1.1.4.1.3"><p id="p19892145616392"><a name="p19892145616392"></a><a name="p19892145616392"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row1389215612395"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="en-us_topic_0000001149807881_p52851329122117"><a name="en-us_topic_0000001149807881_p52851329122117"></a><a name="en-us_topic_0000001149807881_p52851329122117"></a>MEDIA</p> <tbody><tr id="row1389215612395"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="p52851329122117"><a name="p52851329122117"></a><a name="p52851329122117"></a>RINGTONE</p>
</td> </td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="en-us_topic_0000001149807881_p2282152962115"><a name="en-us_topic_0000001149807881_p2282152962115"></a><a name="en-us_topic_0000001149807881_p2282152962115"></a>1</p> <td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="p2282152962115"><a name="p2282152962115"></a><a name="p2282152962115"></a>2</p>
</td> </td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="en-us_topic_0000001149807881_p328012293211"><a name="en-us_topic_0000001149807881_p328012293211"></a><a name="en-us_topic_0000001149807881_p328012293211"></a>Audio streams for media purpose</p> <td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p328012293211"><a name="p328012293211"></a><a name="p328012293211"></a>Audio stream for ringtones</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001149807881_row6892145616397"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="en-us_topic_0000001149807881_p027662952110"><a name="en-us_topic_0000001149807881_p027662952110"></a><a name="en-us_topic_0000001149807881_p027662952110"></a>RINGTONE</p> <tr id="row6892145616397"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="p027662952110"><a name="p027662952110"></a><a name="p027662952110"></a>MEDIA</p>
</td> </td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="en-us_topic_0000001149807881_p17273229192113"><a name="en-us_topic_0000001149807881_p17273229192113"></a><a name="en-us_topic_0000001149807881_p17273229192113"></a>2</p> <td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="p17273229192113"><a name="p17273229192113"></a><a name="p17273229192113"></a>3</p>
</td> </td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="en-us_topic_0000001149807881_p182452299212"><a name="en-us_topic_0000001149807881_p182452299212"></a><a name="en-us_topic_0000001149807881_p182452299212"></a>Audio streams for ring tones</p> <td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p182452299212"><a name="p182452299212"></a><a name="p182452299212"></a>Audio stream for media purpose</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
## DeviceFlag<a name="en-us_topic_0000001149807881_section11285183164210"></a> ## DeviceFlag<a name="section11285183164210"></a>
Enumerates audio device flags. Enumerates audio device flags.
<a name="en-us_topic_0000001149807881_table162856320422"></a> <a name="table162856320422"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row928593124213"><th class="cellrowborder" valign="top" width="30.380000000000003%" id="mcps1.1.4.1.1"><p id="en-us_topic_0000001149807881_p628553124216"><a name="en-us_topic_0000001149807881_p628553124216"></a><a name="en-us_topic_0000001149807881_p628553124216"></a>Name</p> <table><thead align="left"><tr id="row928593124213"><th class="cellrowborder" valign="top" width="30.380000000000003%" id="mcps1.1.4.1.1"><p id="p628553124216"><a name="p628553124216"></a><a name="p628553124216"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="9.950000000000001%" id="mcps1.1.4.1.2"><p id="en-us_topic_0000001149807881_p1828512314213"><a name="en-us_topic_0000001149807881_p1828512314213"></a><a name="en-us_topic_0000001149807881_p1828512314213"></a>Default Value</p> <th class="cellrowborder" valign="top" width="9.950000000000001%" id="mcps1.1.4.1.2"><p id="p1828512314213"><a name="p1828512314213"></a><a name="p1828512314213"></a>Default Value</p>
</th> </th>
<th class="cellrowborder" valign="top" width="59.67%" id="mcps1.1.4.1.3"><p id="en-us_topic_0000001149807881_p1228612334216"><a name="en-us_topic_0000001149807881_p1228612334216"></a><a name="en-us_topic_0000001149807881_p1228612334216"></a>Description</p> <th class="cellrowborder" valign="top" width="59.67%" id="mcps1.1.4.1.3"><p id="p1228612334216"><a name="p1228612334216"></a><a name="p1228612334216"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row2286435427"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="en-us_topic_0000001149807881_p19184101242511"><a name="en-us_topic_0000001149807881_p19184101242511"></a><a name="en-us_topic_0000001149807881_p19184101242511"></a>OUTPUT_DEVICES_FLAG</p> <tbody><tr id="row2286435427"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="p19184101242511"><a name="p19184101242511"></a><a name="p19184101242511"></a>OUTPUT_DEVICES_FLAG</p>
</td> </td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="en-us_topic_0000001149807881_p172861314213"><a name="en-us_topic_0000001149807881_p172861314213"></a><a name="en-us_topic_0000001149807881_p172861314213"></a>1</p> <td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="p172861314213"><a name="p172861314213"></a><a name="p172861314213"></a>1</p>
</td> </td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="en-us_topic_0000001149807881_p5286133134212"><a name="en-us_topic_0000001149807881_p5286133134212"></a><a name="en-us_topic_0000001149807881_p5286133134212"></a>Output devices</p> <td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p5286133134212"><a name="p5286133134212"></a><a name="p5286133134212"></a>Output device</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001149807881_row2286163194220"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="en-us_topic_0000001149807881_p5514162412251"><a name="en-us_topic_0000001149807881_p5514162412251"></a><a name="en-us_topic_0000001149807881_p5514162412251"></a>INPUT_DEVICES_FLAG</p> <tr id="row2286163194220"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="p5514162412251"><a name="p5514162412251"></a><a name="p5514162412251"></a>INPUT_DEVICES_FLAG</p>
</td> </td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="en-us_topic_0000001149807881_p112863354219"><a name="en-us_topic_0000001149807881_p112863354219"></a><a name="en-us_topic_0000001149807881_p112863354219"></a>2</p> <td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="p112863354219"><a name="p112863354219"></a><a name="p112863354219"></a>2</p>
</td> </td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="en-us_topic_0000001149807881_p1328617334214"><a name="en-us_topic_0000001149807881_p1328617334214"></a><a name="en-us_topic_0000001149807881_p1328617334214"></a>Input devices</p> <td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p1328617334214"><a name="p1328617334214"></a><a name="p1328617334214"></a>Input device</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001149807881_row10631228192520"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="en-us_topic_0000001149807881_p1731716317259"><a name="en-us_topic_0000001149807881_p1731716317259"></a><a name="en-us_topic_0000001149807881_p1731716317259"></a>ALL_DEVICES_FLAG</p> <tr id="row10631228192520"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="p1731716317259"><a name="p1731716317259"></a><a name="p1731716317259"></a>ALL_DEVICES_FLAG</p>
</td> </td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="en-us_topic_0000001149807881_p1364628102517"><a name="en-us_topic_0000001149807881_p1364628102517"></a><a name="en-us_topic_0000001149807881_p1364628102517"></a>3</p> <td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="p1364628102517"><a name="p1364628102517"></a><a name="p1364628102517"></a>3</p>
</td> </td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="en-us_topic_0000001149807881_p1864182814256"><a name="en-us_topic_0000001149807881_p1864182814256"></a><a name="en-us_topic_0000001149807881_p1864182814256"></a>All devices</p> <td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p1864182814256"><a name="p1864182814256"></a><a name="p1864182814256"></a>All devices</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
## DeviceRole<a name="en-us_topic_0000001149807881_section380038142619"></a> ## DeviceRole<a name="section380038142619"></a>
Enumerates device roles. Enumerates audio device roles.
<a name="en-us_topic_0000001149807881_table48001786268"></a> <a name="table48001786268"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row138007814267"><th class="cellrowborder" valign="top" width="30.380000000000003%" id="mcps1.1.4.1.1"><p id="en-us_topic_0000001149807881_p1980068112616"><a name="en-us_topic_0000001149807881_p1980068112616"></a><a name="en-us_topic_0000001149807881_p1980068112616"></a>Name</p> <table><thead align="left"><tr id="row138007814267"><th class="cellrowborder" valign="top" width="30.380000000000003%" id="mcps1.1.4.1.1"><p id="p1980068112616"><a name="p1980068112616"></a><a name="p1980068112616"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="9.950000000000001%" id="mcps1.1.4.1.2"><p id="en-us_topic_0000001149807881_p28003819263"><a name="en-us_topic_0000001149807881_p28003819263"></a><a name="en-us_topic_0000001149807881_p28003819263"></a>Default Value</p> <th class="cellrowborder" valign="top" width="9.950000000000001%" id="mcps1.1.4.1.2"><p id="p28003819263"><a name="p28003819263"></a><a name="p28003819263"></a>Default Value</p>
</th> </th>
<th class="cellrowborder" valign="top" width="59.67%" id="mcps1.1.4.1.3"><p id="en-us_topic_0000001149807881_p3800118112615"><a name="en-us_topic_0000001149807881_p3800118112615"></a><a name="en-us_topic_0000001149807881_p3800118112615"></a>Description</p> <th class="cellrowborder" valign="top" width="59.67%" id="mcps1.1.4.1.3"><p id="p3800118112615"><a name="p3800118112615"></a><a name="p3800118112615"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row98008816264"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="en-us_topic_0000001149807881_p1542334211265"><a name="en-us_topic_0000001149807881_p1542334211265"></a><a name="en-us_topic_0000001149807881_p1542334211265"></a>INPUT_DEVICE</p> <tbody><tr id="row98008816264"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="p1542334211265"><a name="p1542334211265"></a><a name="p1542334211265"></a>INPUT_DEVICE</p>
</td> </td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="en-us_topic_0000001149807881_p98008852610"><a name="en-us_topic_0000001149807881_p98008852610"></a><a name="en-us_topic_0000001149807881_p98008852610"></a>1</p> <td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="p98008852610"><a name="p98008852610"></a><a name="p98008852610"></a>1</p>
</td> </td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="en-us_topic_0000001149807881_p118009817260"><a name="en-us_topic_0000001149807881_p118009817260"></a><a name="en-us_topic_0000001149807881_p118009817260"></a>Input role</p> <td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p118009817260"><a name="p118009817260"></a><a name="p118009817260"></a>Input role</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001149807881_row680018802618"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="en-us_topic_0000001149807881_p2011710479267"><a name="en-us_topic_0000001149807881_p2011710479267"></a><a name="en-us_topic_0000001149807881_p2011710479267"></a>OUTPUT_DEVICE</p> <tr id="row680018802618"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="p2011710479267"><a name="p2011710479267"></a><a name="p2011710479267"></a>OUTPUT_DEVICE</p>
</td> </td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="en-us_topic_0000001149807881_p08009812613"><a name="en-us_topic_0000001149807881_p08009812613"></a><a name="en-us_topic_0000001149807881_p08009812613"></a>2</p> <td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="p08009812613"><a name="p08009812613"></a><a name="p08009812613"></a>2</p>
</td> </td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="en-us_topic_0000001149807881_p380020842611"><a name="en-us_topic_0000001149807881_p380020842611"></a><a name="en-us_topic_0000001149807881_p380020842611"></a>Output role</p> <td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p380020842611"><a name="p380020842611"></a><a name="p380020842611"></a>Output role</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
## DeviceType<a name="en-us_topic_0000001149807881_section11727420122710"></a> ## DeviceType<a name="section11727420122710"></a>
Enumerates device types. Enumerates audio device types.
<a name="en-us_topic_0000001149807881_table67271020132718"></a> <a name="table67271020132718"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row4727122012711"><th class="cellrowborder" valign="top" width="30.380000000000003%" id="mcps1.1.4.1.1"><p id="en-us_topic_0000001149807881_p157271520152715"><a name="en-us_topic_0000001149807881_p157271520152715"></a><a name="en-us_topic_0000001149807881_p157271520152715"></a>Name</p> <table><thead align="left"><tr id="row4727122012711"><th class="cellrowborder" valign="top" width="30.380000000000003%" id="mcps1.1.4.1.1"><p id="p157271520152715"><a name="p157271520152715"></a><a name="p157271520152715"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="9.950000000000001%" id="mcps1.1.4.1.2"><p id="en-us_topic_0000001149807881_p187271620152719"><a name="en-us_topic_0000001149807881_p187271620152719"></a><a name="en-us_topic_0000001149807881_p187271620152719"></a>Default Value</p> <th class="cellrowborder" valign="top" width="9.950000000000001%" id="mcps1.1.4.1.2"><p id="p187271620152719"><a name="p187271620152719"></a><a name="p187271620152719"></a>Default Value</p>
</th> </th>
<th class="cellrowborder" valign="top" width="59.67%" id="mcps1.1.4.1.3"><p id="en-us_topic_0000001149807881_p772720201277"><a name="en-us_topic_0000001149807881_p772720201277"></a><a name="en-us_topic_0000001149807881_p772720201277"></a>Description</p> <th class="cellrowborder" valign="top" width="59.67%" id="mcps1.1.4.1.3"><p id="p772720201277"><a name="p772720201277"></a><a name="p772720201277"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row572714205272"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="en-us_topic_0000001149807881_p1895057192713"><a name="en-us_topic_0000001149807881_p1895057192713"></a><a name="en-us_topic_0000001149807881_p1895057192713"></a>INVALID</p> <tbody><tr id="row572714205272"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="p1895057192713"><a name="p1895057192713"></a><a name="p1895057192713"></a>INVALID</p>
</td> </td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="en-us_topic_0000001149807881_p772892012273"><a name="en-us_topic_0000001149807881_p772892012273"></a><a name="en-us_topic_0000001149807881_p772892012273"></a>0</p> <td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="p772892012273"><a name="p772892012273"></a><a name="p772892012273"></a>0</p>
</td> </td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="en-us_topic_0000001149807881_p137281920172712"><a name="en-us_topic_0000001149807881_p137281920172712"></a><a name="en-us_topic_0000001149807881_p137281920172712"></a>Invalid device</p> <td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p137281920172712"><a name="p137281920172712"></a><a name="p137281920172712"></a>Invalid device</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001149807881_row16728520192714"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="en-us_topic_0000001149807881_p4753161132815"><a name="en-us_topic_0000001149807881_p4753161132815"></a><a name="en-us_topic_0000001149807881_p4753161132815"></a>SPEAKER</p> <tr id="row16728520192714"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="p4753161132815"><a name="p4753161132815"></a><a name="p4753161132815"></a>SPEAKER</p>
</td> </td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="en-us_topic_0000001149807881_p3728920162713"><a name="en-us_topic_0000001149807881_p3728920162713"></a><a name="en-us_topic_0000001149807881_p3728920162713"></a>1</p> <td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="p3728920162713"><a name="p3728920162713"></a><a name="p3728920162713"></a>1</p>
</td> </td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="en-us_topic_0000001149807881_p17728112062715"><a name="en-us_topic_0000001149807881_p17728112062715"></a><a name="en-us_topic_0000001149807881_p17728112062715"></a>Speaker</p> <td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p17728112062715"><a name="p17728112062715"></a><a name="p17728112062715"></a>Speaker</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001149807881_row1758117472814"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="en-us_topic_0000001149807881_p74802011112815"><a name="en-us_topic_0000001149807881_p74802011112815"></a><a name="en-us_topic_0000001149807881_p74802011112815"></a>WIRED_HEADSET</p> <tr id="row1758117472814"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="p74802011112815"><a name="p74802011112815"></a><a name="p74802011112815"></a>WIRED_HEADSET</p>
</td> </td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="en-us_topic_0000001149807881_p35820462819"><a name="en-us_topic_0000001149807881_p35820462819"></a><a name="en-us_topic_0000001149807881_p35820462819"></a>2</p> <td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="p35820462819"><a name="p35820462819"></a><a name="p35820462819"></a>2</p>
</td> </td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="en-us_topic_0000001149807881_p155821548285"><a name="en-us_topic_0000001149807881_p155821548285"></a><a name="en-us_topic_0000001149807881_p155821548285"></a>Wired headset</p> <td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p155821548285"><a name="p155821548285"></a><a name="p155821548285"></a>Wired headset</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001149807881_row1335108192818"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="en-us_topic_0000001149807881_p107521514142811"><a name="en-us_topic_0000001149807881_p107521514142811"></a><a name="en-us_topic_0000001149807881_p107521514142811"></a>BLUETOOTH_SCO</p> <tr id="row1335108192818"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="p107521514142811"><a name="p107521514142811"></a><a name="p107521514142811"></a>BLUETOOTH_SCO</p>
</td> </td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="en-us_topic_0000001149807881_p18335108112819"><a name="en-us_topic_0000001149807881_p18335108112819"></a><a name="en-us_topic_0000001149807881_p18335108112819"></a>3</p> <td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="p18335108112819"><a name="p18335108112819"></a><a name="p18335108112819"></a>3</p>
</td> </td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="en-us_topic_0000001149807881_p193351683289"><a name="en-us_topic_0000001149807881_p193351683289"></a><a name="en-us_topic_0000001149807881_p193351683289"></a>Bluetooth device using the synchronous connection oriented link (SCO)</p> <td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p193351683289"><a name="p193351683289"></a><a name="p193351683289"></a>Bluetooth device using the synchronous connection oriented (SCO) link</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001149807881_row1649111617286"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="en-us_topic_0000001149807881_p10784017102818"><a name="en-us_topic_0000001149807881_p10784017102818"></a><a name="en-us_topic_0000001149807881_p10784017102818"></a>BLUETOOTH_A2DP</p> <tr id="row1649111617286"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="p10784017102818"><a name="p10784017102818"></a><a name="p10784017102818"></a>BLUETOOTH_A2DP</p>
</td> </td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="en-us_topic_0000001149807881_p849110610286"><a name="en-us_topic_0000001149807881_p849110610286"></a><a name="en-us_topic_0000001149807881_p849110610286"></a>4</p> <td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="p849110610286"><a name="p849110610286"></a><a name="p849110610286"></a>4</p>
</td> </td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="en-us_topic_0000001149807881_p549117620284"><a name="en-us_topic_0000001149807881_p549117620284"></a><a name="en-us_topic_0000001149807881_p549117620284"></a>Bluetooth device using advanced audio distribution profile (A2DP)</p> <td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p549117620284"><a name="p549117620284"></a><a name="p549117620284"></a>Bluetooth device using the advanced audio distribution profile (A2DP)</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001149807881_row81701220112812"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="en-us_topic_0000001149807881_p168642028152812"><a name="en-us_topic_0000001149807881_p168642028152812"></a><a name="en-us_topic_0000001149807881_p168642028152812"></a>MIC</p> <tr id="row81701220112812"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="p168642028152812"><a name="p168642028152812"></a><a name="p168642028152812"></a>MIC</p>
</td> </td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="en-us_topic_0000001149807881_p517062012812"><a name="en-us_topic_0000001149807881_p517062012812"></a><a name="en-us_topic_0000001149807881_p517062012812"></a>5</p> <td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="p517062012812"><a name="p517062012812"></a><a name="p517062012812"></a>5</p>
</td> </td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="en-us_topic_0000001149807881_p5170520112813"><a name="en-us_topic_0000001149807881_p5170520112813"></a><a name="en-us_topic_0000001149807881_p5170520112813"></a>Microphone</p> <td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p5170520112813"><a name="p5170520112813"></a><a name="p5170520112813"></a>Microphone</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
## Appendixes<a name="en-us_topic_0000001149807881_section1933416317165"></a> ## AudioRingMode<sup>7+</sup><a name="section14948916131018"></a>
Enumerates ringer modes.
<a name="table794961616108"></a>
<table><thead align="left"><tr id="row189491616171016"><th class="cellrowborder" valign="top" width="30.380000000000003%" id="mcps1.1.4.1.1"><p id="p15949151616106"><a name="p15949151616106"></a><a name="p15949151616106"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="9.950000000000001%" id="mcps1.1.4.1.2"><p id="p15949416141012"><a name="p15949416141012"></a><a name="p15949416141012"></a>Default Value</p>
</th>
<th class="cellrowborder" valign="top" width="59.67%" id="mcps1.1.4.1.3"><p id="p15949216151020"><a name="p15949216151020"></a><a name="p15949216151020"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1094911651010"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="p12788943145414"><a name="p12788943145414"></a><a name="p12788943145414"></a>RINGER_MODE_SILENT</p>
</td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="p18788114345414"><a name="p18788114345414"></a><a name="p18788114345414"></a>0</p>
</td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p1378874385416"><a name="p1378874385416"></a><a name="p1378874385416"></a>Silence mode</p>
</td>
</tr>
<tr id="row69495166107"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="p1447557125520"><a name="p1447557125520"></a><a name="p1447557125520"></a>RINGER_MODE_VIBRATE</p>
</td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="p04766720552"><a name="p04766720552"></a><a name="p04766720552"></a>1</p>
</td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p3610191945517"><a name="p3610191945517"></a><a name="p3610191945517"></a>Vibration mode</p>
</td>
</tr>
<tr id="row49498168105"><td class="cellrowborder" valign="top" width="30.380000000000003%" headers="mcps1.1.4.1.1 "><p id="p1034891712171"><a name="p1034891712171"></a><a name="p1034891712171"></a>RINGER_MODE_NORMAL</p>
</td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.4.1.2 "><p id="p421692310811"><a name="p421692310811"></a><a name="p421692310811"></a>2</p>
</td>
<td class="cellrowborder" valign="top" width="59.67%" headers="mcps1.1.4.1.3 "><p id="p187929346177"><a name="p187929346177"></a><a name="p187929346177"></a>Normal mode</p>
</td>
</tr>
</tbody>
</table>
## AudioManager<a name="en-us_topic_0000001149807881_section8265143814015"></a> ## AudioManager<a name="section8265143814015"></a>
Manages audio volume and audio device information. Implements audio volume and audio device management.
### setVolume\(AudioVolumeType, number, AsyncCallback<void\>\)<a name="en-us_topic_0000001149807881_section189141826104616"></a> ### setVolume\(volumeType: AudioVolumeType, volume: number, callback: AsyncCallback<void\>\): void<a name="section189141826104616"></a>
Sets volume for a stream. This method uses an asynchronous callback to return the execution result. Sets the volume for a stream. This method uses an asynchronous callback to return the execution result.
**Parameters** **Parameters**
<a name="en-us_topic_0000001149807881_table11004831415"></a> <a name="table11004831415"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row1510164861414"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="en-us_topic_0000001149807881_p171154819142"><a name="en-us_topic_0000001149807881_p171154819142"></a><a name="en-us_topic_0000001149807881_p171154819142"></a>Name</p> <table><thead align="left"><tr id="row1510164861414"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p171154819142"><a name="p171154819142"></a><a name="p171154819142"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="en-us_topic_0000001149807881_p121164815148"><a name="en-us_topic_0000001149807881_p121164815148"></a><a name="en-us_topic_0000001149807881_p121164815148"></a>Type</p> <th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p121164815148"><a name="p121164815148"></a><a name="p121164815148"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="en-us_topic_0000001149807881_p1351547105313"><a name="en-us_topic_0000001149807881_p1351547105313"></a><a name="en-us_topic_0000001149807881_p1351547105313"></a>Mandatory</p> <th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="p1351547105313"><a name="p1351547105313"></a><a name="p1351547105313"></a>Mandatory</p>
</th> </th>
<th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="en-us_topic_0000001149807881_p131114812144"><a name="en-us_topic_0000001149807881_p131114812144"></a><a name="en-us_topic_0000001149807881_p131114812144"></a>Description</p> <th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="p131114812144"><a name="p131114812144"></a><a name="p131114812144"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row911124881410"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p11184811420"><a name="en-us_topic_0000001149807881_p11184811420"></a><a name="en-us_topic_0000001149807881_p11184811420"></a>audioType</p> <tbody><tr id="row911124881410"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p11184811420"><a name="p11184811420"></a><a name="p11184811420"></a>volumeType</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p91134810142"><a name="en-us_topic_0000001149807881_p91134810142"></a><a name="en-us_topic_0000001149807881_p91134810142"></a><a href="#en-us_topic_0000001149807881_section92261857172218">AudioVolumeType</a></p> <td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p91134810142"><a name="p91134810142"></a><a name="p91134810142"></a><a href="#section92261857172218">AudioVolumeType</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p1751247115312"><a name="en-us_topic_0000001149807881_p1751247115312"></a><a name="en-us_topic_0000001149807881_p1751247115312"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p1751247115312"><a name="p1751247115312"></a><a name="p1751247115312"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p151134811149"><a name="en-us_topic_0000001149807881_p151134811149"></a><a name="en-us_topic_0000001149807881_p151134811149"></a>Audio stream type</p> <td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="p151134811149"><a name="p151134811149"></a><a name="p151134811149"></a>Audio stream type</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001149807881_row1811164871417"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p141114817144"><a name="en-us_topic_0000001149807881_p141114817144"></a><a name="en-us_topic_0000001149807881_p141114817144"></a>volume</p> <tr id="row1811164871417"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p141114817144"><a name="p141114817144"></a><a name="p141114817144"></a>volume</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p1511648151417"><a name="en-us_topic_0000001149807881_p1511648151417"></a><a name="en-us_topic_0000001149807881_p1511648151417"></a>number</p> <td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p1511648151417"><a name="p1511648151417"></a><a name="p1511648151417"></a>number</p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p151947175314"><a name="en-us_topic_0000001149807881_p151947175314"></a><a name="en-us_topic_0000001149807881_p151947175314"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p151947175314"><a name="p151947175314"></a><a name="p151947175314"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p16111548121411"><a name="en-us_topic_0000001149807881_p16111548121411"></a><a name="en-us_topic_0000001149807881_p16111548121411"></a>Volume to set</p> <td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="p16111548121411"><a name="p16111548121411"></a><a name="p16111548121411"></a>Volume to set. The value range can be obtained by calling <strong id="b13473592612"><a name="b13473592612"></a><a name="b13473592612"></a>getMinVolume</strong> and <strong id="b9786013715"><a name="b9786013715"></a><a name="b9786013715"></a>getMaxVolume</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001149807881_row85121563158"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p175121965154"><a name="en-us_topic_0000001149807881_p175121965154"></a><a name="en-us_topic_0000001149807881_p175121965154"></a>callback</p> <tr id="row85121563158"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p175121965154"><a name="p175121965154"></a><a name="p175121965154"></a>callback</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p1851220691518"><a name="en-us_topic_0000001149807881_p1851220691518"></a><a name="en-us_topic_0000001149807881_p1851220691518"></a>AsyncCallback&lt;void&gt;</p> <td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p1851220691518"><a name="p1851220691518"></a><a name="p1851220691518"></a>AsyncCallback&lt;void&gt;</p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p15134711532"><a name="en-us_topic_0000001149807881_p15134711532"></a><a name="en-us_topic_0000001149807881_p15134711532"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p15134711532"><a name="p15134711532"></a><a name="p15134711532"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p751211651512"><a name="en-us_topic_0000001149807881_p751211651512"></a><a name="en-us_topic_0000001149807881_p751211651512"></a>Callback used to return whether the setting is successful</p> <td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="p751211651512"><a name="p751211651512"></a><a name="p751211651512"></a>Callback used to return the execution result</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
**Return values**
None
**Example** **Example**
``` ```
audioManager.setVolume(audio.AudioVolumeType.MEDIA, 30, (err)=>{ audioManager.setVolume(audio.AudioVolumeType.MEDIA, 10, (err)=>{
if (err) { if (err) {
console.error(`failed to set volume ${err.message}`); console.error('Failed to set the volume. ${err.message}');
return; return;
} }
console.log(`Media setVolume successful callback`); console.log('Callback invoked to indicate a successful volume setting.');
}) })
``` ```
### setVolume\(AudioVolumeType, number\)<a name="en-us_topic_0000001149807881_section102021249114612"></a> ### setVolume\(volumeType: AudioVolumeType, volume: number\): Promise<void\><a name="section102021249114612"></a>
Sets volume for a stream. This method uses a promise to return the execution result. Sets the volume for a stream. This method uses a promise to return the execution result.
**Parameters** **Parameters**
<a name="en-us_topic_0000001149807881_table20688181818176"></a> <a name="table20688181818176"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row1368810188176"><th class="cellrowborder" valign="top" width="17.599999999999998%" id="mcps1.1.5.1.1"><p id="en-us_topic_0000001149807881_p5688818171712"><a name="en-us_topic_0000001149807881_p5688818171712"></a><a name="en-us_topic_0000001149807881_p5688818171712"></a>Name</p> <table><thead align="left"><tr id="row1368810188176"><th class="cellrowborder" valign="top" width="17.599999999999998%" id="mcps1.1.5.1.1"><p id="p5688818171712"><a name="p5688818171712"></a><a name="p5688818171712"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="19.49%" id="mcps1.1.5.1.2"><p id="en-us_topic_0000001149807881_p8688118111719"><a name="en-us_topic_0000001149807881_p8688118111719"></a><a name="en-us_topic_0000001149807881_p8688118111719"></a>Type</p> <th class="cellrowborder" valign="top" width="19.49%" id="mcps1.1.5.1.2"><p id="p8688118111719"><a name="p8688118111719"></a><a name="p8688118111719"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="en-us_topic_0000001149807881_p1994792215711"><a name="en-us_topic_0000001149807881_p1994792215711"></a><a name="en-us_topic_0000001149807881_p1994792215711"></a>Mandatory</p> <th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="p1994792215711"><a name="p1994792215711"></a><a name="p1994792215711"></a>Mandatory</p>
</th> </th>
<th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="en-us_topic_0000001149807881_p12688151816173"><a name="en-us_topic_0000001149807881_p12688151816173"></a><a name="en-us_topic_0000001149807881_p12688151816173"></a>Description</p> <th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="p12688151816173"><a name="p12688151816173"></a><a name="p12688151816173"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row0688518171714"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p1368820182174"><a name="en-us_topic_0000001149807881_p1368820182174"></a><a name="en-us_topic_0000001149807881_p1368820182174"></a>audioType</p> <tbody><tr id="row0688518171714"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.1.5.1.1 "><p id="p1368820182174"><a name="p1368820182174"></a><a name="p1368820182174"></a>volumeType</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p116881518111712"><a name="en-us_topic_0000001149807881_p116881518111712"></a><a name="en-us_topic_0000001149807881_p116881518111712"></a><a href="#en-us_topic_0000001149807881_section92261857172218">AudioVolumeType</a></p> <td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.1.5.1.2 "><p id="p116881518111712"><a name="p116881518111712"></a><a name="p116881518111712"></a><a href="#section92261857172218">AudioVolumeType</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p2094702218579"><a name="en-us_topic_0000001149807881_p2094702218579"></a><a name="en-us_topic_0000001149807881_p2094702218579"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p2094702218579"><a name="p2094702218579"></a><a name="p2094702218579"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p1688131812176"><a name="en-us_topic_0000001149807881_p1688131812176"></a><a name="en-us_topic_0000001149807881_p1688131812176"></a>Audio stream type</p> <td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="p1688131812176"><a name="p1688131812176"></a><a name="p1688131812176"></a>Audio stream type</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001149807881_row5688218131711"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p176881618181715"><a name="en-us_topic_0000001149807881_p176881618181715"></a><a name="en-us_topic_0000001149807881_p176881618181715"></a>volume</p> <tr id="row5688218131711"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.1.5.1.1 "><p id="p176881618181715"><a name="p176881618181715"></a><a name="p176881618181715"></a>volume</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p5688201811720"><a name="en-us_topic_0000001149807881_p5688201811720"></a><a name="en-us_topic_0000001149807881_p5688201811720"></a>number</p> <td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.1.5.1.2 "><p id="p5688201811720"><a name="p5688201811720"></a><a name="p5688201811720"></a>number</p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p79472226579"><a name="en-us_topic_0000001149807881_p79472226579"></a><a name="en-us_topic_0000001149807881_p79472226579"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p79472226579"><a name="p79472226579"></a><a name="p79472226579"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p2688718171716"><a name="en-us_topic_0000001149807881_p2688718171716"></a><a name="en-us_topic_0000001149807881_p2688718171716"></a>Volume to set</p> <td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="p2688718171716"><a name="p2688718171716"></a><a name="p2688718171716"></a>Volume to set. The value range can be obtained by calling <strong id="b665410551184"><a name="b665410551184"></a><a name="b665410551184"></a>getMinVolume</strong> and <strong id="b16547550813"><a name="b16547550813"></a><a name="b16547550813"></a>getMaxVolume</strong>.</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
**Return Values** **Return values**
<a name="en-us_topic_0000001149807881_table106721328171713"></a> <a name="table106721328171713"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row9672122817176"><th class="cellrowborder" valign="top" width="26.06%" id="mcps1.1.3.1.1"><p id="en-us_topic_0000001149807881_p106728288171"><a name="en-us_topic_0000001149807881_p106728288171"></a><a name="en-us_topic_0000001149807881_p106728288171"></a>Type</p> <table><thead align="left"><tr id="row9672122817176"><th class="cellrowborder" valign="top" width="26.06%" id="mcps1.1.3.1.1"><p id="p106728288171"><a name="p106728288171"></a><a name="p106728288171"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="73.94%" id="mcps1.1.3.1.2"><p id="en-us_topic_0000001149807881_p5672112817178"><a name="en-us_topic_0000001149807881_p5672112817178"></a><a name="en-us_topic_0000001149807881_p5672112817178"></a>Description</p> <th class="cellrowborder" valign="top" width="73.94%" id="mcps1.1.3.1.2"><p id="p5672112817178"><a name="p5672112817178"></a><a name="p5672112817178"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row06721528191711"><td class="cellrowborder" valign="top" width="26.06%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0000001149807881_p107821612171919"><a name="en-us_topic_0000001149807881_p107821612171919"></a><a name="en-us_topic_0000001149807881_p107821612171919"></a>Promise&lt;void&gt;</p> <tbody><tr id="row06721528191711"><td class="cellrowborder" valign="top" width="26.06%" headers="mcps1.1.3.1.1 "><p id="p107821612171919"><a name="p107821612171919"></a><a name="p107821612171919"></a>Promise&lt;void&gt;</p>
</td> </td>
<td class="cellrowborder" valign="top" width="73.94%" headers="mcps1.1.3.1.2 "><p id="en-us_topic_0000001149807881_p4672828141718"><a name="en-us_topic_0000001149807881_p4672828141718"></a><a name="en-us_topic_0000001149807881_p4672828141718"></a>Promise used to return whether the setting is successful</p> <td class="cellrowborder" valign="top" width="73.94%" headers="mcps1.1.3.1.2 "><p id="p4672828141718"><a name="p4672828141718"></a><a name="p4672828141718"></a>Promise used to return the execution result</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
...@@ -347,102 +401,106 @@ Sets volume for a stream. This method uses a promise to return the execution res ...@@ -347,102 +401,106 @@ Sets volume for a stream. This method uses a promise to return the execution res
**Example** **Example**
``` ```
audioManager.setVolume(audio.AudioVolumeType.MEDIA, 30).then(()=> audioManager.setVolume(audio.AudioVolumeType.MEDIA, 10).then(()=>
console.log(`Media setVolume successful callback`); console.log('Promise returned to indicate a successful volume setting.');
) )
``` ```
### getVolume\(AudioVolumeType, AsyncCallback<number\>\)<a name="en-us_topic_0000001149807881_section4387320194714"></a> ### getVolume\(volumeType: AudioVolumeType, callback: AsyncCallback<number\>\): void<a name="section4387320194714"></a>
Obtains volume of a stream. This method uses an asynchronous callback to return the execution result. Obtains the volume of a stream. This method uses an asynchronous callback to return the query result.
**Parameters** **Parameters**
<a name="en-us_topic_0000001149807881_table44323134204"></a> <a name="table44323134204"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row16433171322017"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="en-us_topic_0000001149807881_p1943319132201"><a name="en-us_topic_0000001149807881_p1943319132201"></a><a name="en-us_topic_0000001149807881_p1943319132201"></a>Name</p> <table><thead align="left"><tr id="row16433171322017"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p1943319132201"><a name="p1943319132201"></a><a name="p1943319132201"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="en-us_topic_0000001149807881_p143314139203"><a name="en-us_topic_0000001149807881_p143314139203"></a><a name="en-us_topic_0000001149807881_p143314139203"></a>Type</p> <th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p143314139203"><a name="p143314139203"></a><a name="p143314139203"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="en-us_topic_0000001149807881_p1540765014581"><a name="en-us_topic_0000001149807881_p1540765014581"></a><a name="en-us_topic_0000001149807881_p1540765014581"></a>Mandatory</p> <th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="p1540765014581"><a name="p1540765014581"></a><a name="p1540765014581"></a>Mandatory</p>
</th> </th>
<th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="en-us_topic_0000001149807881_p10433181362011"><a name="en-us_topic_0000001149807881_p10433181362011"></a><a name="en-us_topic_0000001149807881_p10433181362011"></a>Description</p> <th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="p10433181362011"><a name="p10433181362011"></a><a name="p10433181362011"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row4433913122010"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p54331513192018"><a name="en-us_topic_0000001149807881_p54331513192018"></a><a name="en-us_topic_0000001149807881_p54331513192018"></a>audioType</p> <tbody><tr id="row4433913122010"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p54331513192018"><a name="p54331513192018"></a><a name="p54331513192018"></a>volumeType</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p182075544714"><a name="en-us_topic_0000001149807881_p182075544714"></a><a name="en-us_topic_0000001149807881_p182075544714"></a><a href="#en-us_topic_0000001149807881_section92261857172218">AudioVolumeType</a></p> <td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p182075544714"><a name="p182075544714"></a><a name="p182075544714"></a><a href="#section92261857172218">AudioVolumeType</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p3407185013588"><a name="en-us_topic_0000001149807881_p3407185013588"></a><a name="en-us_topic_0000001149807881_p3407185013588"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p3407185013588"><a name="p3407185013588"></a><a name="p3407185013588"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p44331613142018"><a name="en-us_topic_0000001149807881_p44331613142018"></a><a name="en-us_topic_0000001149807881_p44331613142018"></a>Audio stream type</p> <td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="p44331613142018"><a name="p44331613142018"></a><a name="p44331613142018"></a>Audio stream type</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001149807881_row743331372014"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p143341319205"><a name="en-us_topic_0000001149807881_p143341319205"></a><a name="en-us_topic_0000001149807881_p143341319205"></a>callback</p> <tr id="row743331372014"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p143341319205"><a name="p143341319205"></a><a name="p143341319205"></a>callback</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p1043316137200"><a name="en-us_topic_0000001149807881_p1043316137200"></a><a name="en-us_topic_0000001149807881_p1043316137200"></a>AsyncCallback&lt;number&gt;</p> <td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p1043316137200"><a name="p1043316137200"></a><a name="p1043316137200"></a>AsyncCallback&lt;number&gt;</p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p12659352195818"><a name="en-us_topic_0000001149807881_p12659352195818"></a><a name="en-us_topic_0000001149807881_p12659352195818"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p12659352195818"><a name="p12659352195818"></a><a name="p12659352195818"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p3433161313204"><a name="en-us_topic_0000001149807881_p3433161313204"></a><a name="en-us_topic_0000001149807881_p3433161313204"></a>Callback used to return the volume</p> <td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="p3433161313204"><a name="p3433161313204"></a><a name="p3433161313204"></a>Callback used to return the volume</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
**Return values**
None
**Example** **Example**
``` ```
audioManager.getVolume(audio.AudioVolumeType.MEDIA, (err, value)=>{ audioManager.getVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
if (err) { if (err) {
console.error(`failed to get volume ${err.message}`); console.error('Failed to obtain the volume. ${err.message}');
return; return;
} }
console.log(`Media getVolume successful callback`); console.log('Callback invoked to indicate that the volume is obtained.');
}) })
``` ```
### getVolume\(AudioVolumeType\)<a name="en-us_topic_0000001149807881_section04121965119"></a> ### getVolume\(volumeType: AudioVolumeType\): Promise<number\><a name="section04121965119"></a>
Obtains the volume of a stream. This method uses a promise to return the execution result. Obtains the volume of a stream. This method uses a promise to return the query result.
**Parameters** **Parameters**
<a name="en-us_topic_0000001149807881_table174341113202016"></a> <a name="table174341113202016"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row843416136203"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="en-us_topic_0000001149807881_p143410134207"><a name="en-us_topic_0000001149807881_p143410134207"></a><a name="en-us_topic_0000001149807881_p143410134207"></a>Name</p> <table><thead align="left"><tr id="row843416136203"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p143410134207"><a name="p143410134207"></a><a name="p143410134207"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="en-us_topic_0000001149807881_p6434813182016"><a name="en-us_topic_0000001149807881_p6434813182016"></a><a name="en-us_topic_0000001149807881_p6434813182016"></a>Type</p> <th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p6434813182016"><a name="p6434813182016"></a><a name="p6434813182016"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="en-us_topic_0000001149807881_p418721165918"><a name="en-us_topic_0000001149807881_p418721165918"></a><a name="en-us_topic_0000001149807881_p418721165918"></a>Mandatory</p> <th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="p418721165918"><a name="p418721165918"></a><a name="p418721165918"></a>Mandatory</p>
</th> </th>
<th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="en-us_topic_0000001149807881_p943491320207"><a name="en-us_topic_0000001149807881_p943491320207"></a><a name="en-us_topic_0000001149807881_p943491320207"></a>Description</p> <th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="p943491320207"><a name="p943491320207"></a><a name="p943491320207"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row5434181312207"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p144343134206"><a name="en-us_topic_0000001149807881_p144343134206"></a><a name="en-us_topic_0000001149807881_p144343134206"></a>audioType</p> <tbody><tr id="row5434181312207"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p144343134206"><a name="p144343134206"></a><a name="p144343134206"></a>volumeType</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p121741711487"><a name="en-us_topic_0000001149807881_p121741711487"></a><a name="en-us_topic_0000001149807881_p121741711487"></a><a href="#en-us_topic_0000001149807881_section92261857172218">AudioVolumeType</a></p> <td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p121741711487"><a name="p121741711487"></a><a name="p121741711487"></a><a href="#section92261857172218">AudioVolumeType</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p118791205914"><a name="en-us_topic_0000001149807881_p118791205914"></a><a name="en-us_topic_0000001149807881_p118791205914"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p118791205914"><a name="p118791205914"></a><a name="p118791205914"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p6434613122010"><a name="en-us_topic_0000001149807881_p6434613122010"></a><a name="en-us_topic_0000001149807881_p6434613122010"></a>Audio stream type</p> <td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="p6434613122010"><a name="p6434613122010"></a><a name="p6434613122010"></a>Audio stream type</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
**Return Values** **Return values**
<a name="en-us_topic_0000001149807881_table11435101313201"></a> <a name="table11435101313201"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row9435191332013"><th class="cellrowborder" valign="top" width="25.97%" id="mcps1.1.3.1.1"><p id="en-us_topic_0000001149807881_p7435131352019"><a name="en-us_topic_0000001149807881_p7435131352019"></a><a name="en-us_topic_0000001149807881_p7435131352019"></a>Type</p> <table><thead align="left"><tr id="row9435191332013"><th class="cellrowborder" valign="top" width="25.97%" id="mcps1.1.3.1.1"><p id="p7435131352019"><a name="p7435131352019"></a><a name="p7435131352019"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="74.03%" id="mcps1.1.3.1.2"><p id="en-us_topic_0000001149807881_p343521362017"><a name="en-us_topic_0000001149807881_p343521362017"></a><a name="en-us_topic_0000001149807881_p343521362017"></a>Description</p> <th class="cellrowborder" valign="top" width="74.03%" id="mcps1.1.3.1.2"><p id="p343521362017"><a name="p343521362017"></a><a name="p343521362017"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row1143515137209"><td class="cellrowborder" valign="top" width="25.97%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0000001149807881_p3435171318201"><a name="en-us_topic_0000001149807881_p3435171318201"></a><a name="en-us_topic_0000001149807881_p3435171318201"></a>Promise&lt;number&gt;</p> <tbody><tr id="row1143515137209"><td class="cellrowborder" valign="top" width="25.97%" headers="mcps1.1.3.1.1 "><p id="p3435171318201"><a name="p3435171318201"></a><a name="p3435171318201"></a>Promise&lt;number&gt;</p>
</td> </td>
<td class="cellrowborder" valign="top" width="74.03%" headers="mcps1.1.3.1.2 "><p id="en-us_topic_0000001149807881_p17435513102016"><a name="en-us_topic_0000001149807881_p17435513102016"></a><a name="en-us_topic_0000001149807881_p17435513102016"></a>Promise used to return stream volume</p> <td class="cellrowborder" valign="top" width="74.03%" headers="mcps1.1.3.1.2 "><p id="p17435513102016"><a name="p17435513102016"></a><a name="p17435513102016"></a>Promise used to return the volume</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
...@@ -451,102 +509,106 @@ Obtains the volume of a stream. This method uses a promise to return the executi ...@@ -451,102 +509,106 @@ Obtains the volume of a stream. This method uses a promise to return the executi
**Example** **Example**
``` ```
audioManager.getVolume(audio.AudioVolumeType.MEDIA).then((data)=> audioManager.getVolume(audio.AudioVolumeType.MEDIA).then((value) =>
console.log(`Media getVolume successful callback`); console.log('Promise returned to indicate that the volume is obtained.' + value);
) )
``` ```
### getMinVolume\(AudioVolumeType, AsyncCallback<number\>\)<a name="en-us_topic_0000001149807881_section188714283511"></a> ### getMinVolume\(volumeType: AudioVolumeType, callback: AsyncCallback<number\>\): void<a name="section188714283511"></a>
Obtains the minimum volume allowed for a stream. This method uses an asynchronous callback to return the execution result. Obtains the minimum volume allowed for a stream. This method uses an asynchronous callback to return the query result.
**Parameters** **Parameters**
<a name="en-us_topic_0000001149807881_table9585157122219"></a> <a name="table9585157122219"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row95857713228"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="en-us_topic_0000001149807881_p1358510710223"><a name="en-us_topic_0000001149807881_p1358510710223"></a><a name="en-us_topic_0000001149807881_p1358510710223"></a>Name</p> <table><thead align="left"><tr id="row95857713228"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p1358510710223"><a name="p1358510710223"></a><a name="p1358510710223"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="en-us_topic_0000001149807881_p958577152214"><a name="en-us_topic_0000001149807881_p958577152214"></a><a name="en-us_topic_0000001149807881_p958577152214"></a>Type</p> <th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p958577152214"><a name="p958577152214"></a><a name="p958577152214"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="en-us_topic_0000001149807881_p12979171810590"><a name="en-us_topic_0000001149807881_p12979171810590"></a><a name="en-us_topic_0000001149807881_p12979171810590"></a>Mandatory</p> <th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="p12979171810590"><a name="p12979171810590"></a><a name="p12979171810590"></a>Mandatory</p>
</th> </th>
<th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="en-us_topic_0000001149807881_p85851579221"><a name="en-us_topic_0000001149807881_p85851579221"></a><a name="en-us_topic_0000001149807881_p85851579221"></a>Description</p> <th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="p85851579221"><a name="p85851579221"></a><a name="p85851579221"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row7585373227"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p105852712216"><a name="en-us_topic_0000001149807881_p105852712216"></a><a name="en-us_topic_0000001149807881_p105852712216"></a>audioType</p> <tbody><tr id="row7585373227"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p105852712216"><a name="p105852712216"></a><a name="p105852712216"></a>volumeType</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p1862714319487"><a name="en-us_topic_0000001149807881_p1862714319487"></a><a name="en-us_topic_0000001149807881_p1862714319487"></a><a href="#en-us_topic_0000001149807881_section92261857172218">AudioVolumeType</a></p> <td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p1862714319487"><a name="p1862714319487"></a><a name="p1862714319487"></a><a href="#section92261857172218">AudioVolumeType</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p59791018125916"><a name="en-us_topic_0000001149807881_p59791018125916"></a><a name="en-us_topic_0000001149807881_p59791018125916"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p59791018125916"><a name="p59791018125916"></a><a name="p59791018125916"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p758517710222"><a name="en-us_topic_0000001149807881_p758517710222"></a><a name="en-us_topic_0000001149807881_p758517710222"></a>Audio stream type</p> <td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="p758517710222"><a name="p758517710222"></a><a name="p758517710222"></a>Audio stream type</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001149807881_row165851718222"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p115866772214"><a name="en-us_topic_0000001149807881_p115866772214"></a><a name="en-us_topic_0000001149807881_p115866772214"></a>callback</p> <tr id="row165851718222"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p115866772214"><a name="p115866772214"></a><a name="p115866772214"></a>callback</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p558614719222"><a name="en-us_topic_0000001149807881_p558614719222"></a><a name="en-us_topic_0000001149807881_p558614719222"></a>AsyncCallback&lt;number&gt;</p> <td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p558614719222"><a name="p558614719222"></a><a name="p558614719222"></a>AsyncCallback&lt;number&gt;</p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p89791518185916"><a name="en-us_topic_0000001149807881_p89791518185916"></a><a name="en-us_topic_0000001149807881_p89791518185916"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p89791518185916"><a name="p89791518185916"></a><a name="p89791518185916"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p1958614711221"><a name="en-us_topic_0000001149807881_p1958614711221"></a><a name="en-us_topic_0000001149807881_p1958614711221"></a>Callback used to return the minimum volume</p> <td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="p1958614711221"><a name="p1958614711221"></a><a name="p1958614711221"></a>Callback used to return the minimum volume</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
**Return values**
None
**Example** **Example**
``` ```
audioManager.getMinVolume(audio.AudioVolumeType.MEDIA, (err, value)=>{ audioManager.getMinVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
if (err) { if (err) {
console.error(`failed to get minvolume ${err.message}`); console.error('Failed to obtain the minimum volume. ${err.message}');
return; return;
} }
console.log(`Media getMinVolume successful callback`); console.log('Callback invoked to indicate that the minimum volume is obtained.' + value);
}) })
``` ```
### getMinVolume\(AudioVolumeType\)<a name="en-us_topic_0000001149807881_section41556389511"></a> ### getMinVolume\(volumeType: AudioVolumeType\): Promise<number\><a name="section41556389511"></a>
Obtains the minimum volume allowed for a stream. This method uses a promise to return the execution result. Obtains the minimum volume allowed for a stream. This method uses a promise to return the query result.
**Parameters** **Parameters**
<a name="en-us_topic_0000001149807881_table558627102215"></a> <a name="table558627102215"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row175868714227"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="en-us_topic_0000001149807881_p1758619712217"><a name="en-us_topic_0000001149807881_p1758619712217"></a><a name="en-us_topic_0000001149807881_p1758619712217"></a>Name</p> <table><thead align="left"><tr id="row175868714227"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p1758619712217"><a name="p1758619712217"></a><a name="p1758619712217"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="en-us_topic_0000001149807881_p12586776227"><a name="en-us_topic_0000001149807881_p12586776227"></a><a name="en-us_topic_0000001149807881_p12586776227"></a>Type</p> <th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p12586776227"><a name="p12586776227"></a><a name="p12586776227"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="en-us_topic_0000001149807881_p94861627165914"><a name="en-us_topic_0000001149807881_p94861627165914"></a><a name="en-us_topic_0000001149807881_p94861627165914"></a>Mandatory</p> <th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="p94861627165914"><a name="p94861627165914"></a><a name="p94861627165914"></a>Mandatory</p>
</th> </th>
<th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="en-us_topic_0000001149807881_p85862711223"><a name="en-us_topic_0000001149807881_p85862711223"></a><a name="en-us_topic_0000001149807881_p85862711223"></a>Description</p> <th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="p85862711223"><a name="p85862711223"></a><a name="p85862711223"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row65861477221"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p5586167172217"><a name="en-us_topic_0000001149807881_p5586167172217"></a><a name="en-us_topic_0000001149807881_p5586167172217"></a>audioType</p> <tbody><tr id="row65861477221"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p5586167172217"><a name="p5586167172217"></a><a name="p5586167172217"></a>volumeType</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p592519511485"><a name="en-us_topic_0000001149807881_p592519511485"></a><a name="en-us_topic_0000001149807881_p592519511485"></a><a href="#en-us_topic_0000001149807881_section92261857172218">AudioVolumeType</a></p> <td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p592519511485"><a name="p592519511485"></a><a name="p592519511485"></a><a href="#section92261857172218">AudioVolumeType</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p2048622713593"><a name="en-us_topic_0000001149807881_p2048622713593"></a><a name="en-us_topic_0000001149807881_p2048622713593"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p2048622713593"><a name="p2048622713593"></a><a name="p2048622713593"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p135871079226"><a name="en-us_topic_0000001149807881_p135871079226"></a><a name="en-us_topic_0000001149807881_p135871079226"></a>Audio stream type</p> <td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="p135871079226"><a name="p135871079226"></a><a name="p135871079226"></a>Audio stream type</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
**Return Values** **Return values**
<a name="en-us_topic_0000001149807881_table35874718223"></a> <a name="table35874718223"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row1558718715227"><th class="cellrowborder" valign="top" width="26.02%" id="mcps1.1.3.1.1"><p id="en-us_topic_0000001149807881_p75871715226"><a name="en-us_topic_0000001149807881_p75871715226"></a><a name="en-us_topic_0000001149807881_p75871715226"></a>Type</p> <table><thead align="left"><tr id="row1558718715227"><th class="cellrowborder" valign="top" width="26.02%" id="mcps1.1.3.1.1"><p id="p75871715226"><a name="p75871715226"></a><a name="p75871715226"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="73.98%" id="mcps1.1.3.1.2"><p id="en-us_topic_0000001149807881_p85871720225"><a name="en-us_topic_0000001149807881_p85871720225"></a><a name="en-us_topic_0000001149807881_p85871720225"></a>Description</p> <th class="cellrowborder" valign="top" width="73.98%" id="mcps1.1.3.1.2"><p id="p85871720225"><a name="p85871720225"></a><a name="p85871720225"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row1458710714221"><td class="cellrowborder" valign="top" width="26.02%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0000001149807881_p558737142218"><a name="en-us_topic_0000001149807881_p558737142218"></a><a name="en-us_topic_0000001149807881_p558737142218"></a>Promise&lt;number&gt;</p> <tbody><tr id="row1458710714221"><td class="cellrowborder" valign="top" width="26.02%" headers="mcps1.1.3.1.1 "><p id="p558737142218"><a name="p558737142218"></a><a name="p558737142218"></a>Promise&lt;number&gt;</p>
</td> </td>
<td class="cellrowborder" valign="top" width="73.98%" headers="mcps1.1.3.1.2 "><p id="en-us_topic_0000001149807881_p05878717229"><a name="en-us_topic_0000001149807881_p05878717229"></a><a name="en-us_topic_0000001149807881_p05878717229"></a>Promise used to return the minimum volume</p> <td class="cellrowborder" valign="top" width="73.98%" headers="mcps1.1.3.1.2 "><p id="p05878717229"><a name="p05878717229"></a><a name="p05878717229"></a>Promise used to return the minimum volume</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
...@@ -555,102 +617,106 @@ Obtains the minimum volume allowed for a stream. This method uses a promise to r ...@@ -555,102 +617,106 @@ Obtains the minimum volume allowed for a stream. This method uses a promise to r
**Example** **Example**
``` ```
audioManager.getMinVolume(audio.AudioVolumeType.MEDIA).then((data)=> audioManager.getMinVolume(audio.AudioVolumeType.MEDIA).then((value) =>
console.log(`Media getMinVolume successful callback`); console.log('Promised returned to indicate that the minimum volume is obtained.' + value);
) )
``` ```
### getMaxVolume\(AudioVolumeType, AsyncCallback<number\>\)<a name="en-us_topic_0000001149807881_section690395418516"></a> ### getMaxVolume\(volumeType: AudioVolumeType, callback: AsyncCallback<number\>\): void<a name="section690395418516"></a>
Obtains the maximum volume allowed for a stream. This method uses an asynchronous callback to return the execution result. Obtains the maximum volume allowed for a stream. This method uses an asynchronous callback to return the query result.
**Parameters** **Parameters**
<a name="en-us_topic_0000001149807881_table7210144262214"></a> <a name="table7210144262214"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row7210104242215"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="en-us_topic_0000001149807881_p521018428221"><a name="en-us_topic_0000001149807881_p521018428221"></a><a name="en-us_topic_0000001149807881_p521018428221"></a>Name</p> <table><thead align="left"><tr id="row7210104242215"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p521018428221"><a name="p521018428221"></a><a name="p521018428221"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="en-us_topic_0000001149807881_p102107424223"><a name="en-us_topic_0000001149807881_p102107424223"></a><a name="en-us_topic_0000001149807881_p102107424223"></a>Type</p> <th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p102107424223"><a name="p102107424223"></a><a name="p102107424223"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="en-us_topic_0000001149807881_p167531439593"><a name="en-us_topic_0000001149807881_p167531439593"></a><a name="en-us_topic_0000001149807881_p167531439593"></a>Mandatory</p> <th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="p167531439593"><a name="p167531439593"></a><a name="p167531439593"></a>Mandatory</p>
</th> </th>
<th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="en-us_topic_0000001149807881_p1521054292218"><a name="en-us_topic_0000001149807881_p1521054292218"></a><a name="en-us_topic_0000001149807881_p1521054292218"></a>Description</p> <th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="p1521054292218"><a name="p1521054292218"></a><a name="p1521054292218"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row321010428228"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p5210642132212"><a name="en-us_topic_0000001149807881_p5210642132212"></a><a name="en-us_topic_0000001149807881_p5210642132212"></a>audioType</p> <tbody><tr id="row321010428228"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p5210642132212"><a name="p5210642132212"></a><a name="p5210642132212"></a>volumeType</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p35691288487"><a name="en-us_topic_0000001149807881_p35691288487"></a><a name="en-us_topic_0000001149807881_p35691288487"></a><a href="#en-us_topic_0000001149807881_section92261857172218">AudioVolumeType</a></p> <td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p35691288487"><a name="p35691288487"></a><a name="p35691288487"></a><a href="#section92261857172218">AudioVolumeType</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p14753114317590"><a name="en-us_topic_0000001149807881_p14753114317590"></a><a name="en-us_topic_0000001149807881_p14753114317590"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p14753114317590"><a name="p14753114317590"></a><a name="p14753114317590"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p8210242112217"><a name="en-us_topic_0000001149807881_p8210242112217"></a><a name="en-us_topic_0000001149807881_p8210242112217"></a>Audio stream type</p> <td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="p8210242112217"><a name="p8210242112217"></a><a name="p8210242112217"></a>Audio stream type</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001149807881_row82115429227"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p4211842132218"><a name="en-us_topic_0000001149807881_p4211842132218"></a><a name="en-us_topic_0000001149807881_p4211842132218"></a>callback</p> <tr id="row82115429227"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p4211842132218"><a name="p4211842132218"></a><a name="p4211842132218"></a>callback</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p8211114232217"><a name="en-us_topic_0000001149807881_p8211114232217"></a><a name="en-us_topic_0000001149807881_p8211114232217"></a>AsyncCallback&lt;number&gt;</p> <td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p8211114232217"><a name="p8211114232217"></a><a name="p8211114232217"></a>AsyncCallback&lt;number&gt;</p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p1275384315910"><a name="en-us_topic_0000001149807881_p1275384315910"></a><a name="en-us_topic_0000001149807881_p1275384315910"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p1275384315910"><a name="p1275384315910"></a><a name="p1275384315910"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p1621114282212"><a name="en-us_topic_0000001149807881_p1621114282212"></a><a name="en-us_topic_0000001149807881_p1621114282212"></a>Callback used to return the maximum volume</p> <td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="p1621114282212"><a name="p1621114282212"></a><a name="p1621114282212"></a>Callback used to return the maximum volume</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
**Return values**
None
**Example** **Example**
``` ```
audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA, (err, value)=>{ audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
if (err) { if (err) {
console.error(`failed to get maxvolume ${err.message}`); console.error('Failed to obtain the maximum volume. ${err.message}');
return; return;
} }
console.log(`Media getMaxVolume successful callback`); console.log('Callback invoked to indicate that the maximum volume is obtained.' + value);
}) })
``` ```
### getMaxVolume\(AudioVolumeType\)<a name="en-us_topic_0000001149807881_section155151345217"></a> ### getMaxVolume\(volumeType: AudioVolumeType\): Promise<number\><a name="section155151345217"></a>
Obtains the maximum volume allowed for a stream. This method uses a promise to return the execution result. Obtains the maximum volume allowed for a stream. This method uses a promise to return the query result.
**Parameters** **Parameters**
<a name="en-us_topic_0000001149807881_table11211104210226"></a> <a name="table11211104210226"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row42111424228"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="en-us_topic_0000001149807881_p14211842162217"><a name="en-us_topic_0000001149807881_p14211842162217"></a><a name="en-us_topic_0000001149807881_p14211842162217"></a>Name</p> <table><thead align="left"><tr id="row42111424228"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p14211842162217"><a name="p14211842162217"></a><a name="p14211842162217"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="en-us_topic_0000001149807881_p7211184211223"><a name="en-us_topic_0000001149807881_p7211184211223"></a><a name="en-us_topic_0000001149807881_p7211184211223"></a>Type</p> <th class="cellrowborder" valign="top" width="20.54%" id="mcps1.1.5.1.2"><p id="p7211184211223"><a name="p7211184211223"></a><a name="p7211184211223"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="en-us_topic_0000001149807881_p165812523592"><a name="en-us_topic_0000001149807881_p165812523592"></a><a name="en-us_topic_0000001149807881_p165812523592"></a>Mandatory</p> <th class="cellrowborder" valign="top" width="8.72%" id="mcps1.1.5.1.3"><p id="p165812523592"><a name="p165812523592"></a><a name="p165812523592"></a>Mandatory</p>
</th> </th>
<th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="en-us_topic_0000001149807881_p821164232217"><a name="en-us_topic_0000001149807881_p821164232217"></a><a name="en-us_topic_0000001149807881_p821164232217"></a>Description</p> <th class="cellrowborder" valign="top" width="53.169999999999995%" id="mcps1.1.5.1.4"><p id="p821164232217"><a name="p821164232217"></a><a name="p821164232217"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row22111742112216"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p152121542152218"><a name="en-us_topic_0000001149807881_p152121542152218"></a><a name="en-us_topic_0000001149807881_p152121542152218"></a>audioType</p> <tbody><tr id="row22111742112216"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p152121542152218"><a name="p152121542152218"></a><a name="p152121542152218"></a>volumeType</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p9479411164814"><a name="en-us_topic_0000001149807881_p9479411164814"></a><a name="en-us_topic_0000001149807881_p9479411164814"></a><a href="#en-us_topic_0000001149807881_section92261857172218">AudioVolumeType</a></p> <td class="cellrowborder" valign="top" width="20.54%" headers="mcps1.1.5.1.2 "><p id="p9479411164814"><a name="p9479411164814"></a><a name="p9479411164814"></a><a href="#section92261857172218">AudioVolumeType</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p45811752165910"><a name="en-us_topic_0000001149807881_p45811752165910"></a><a name="en-us_topic_0000001149807881_p45811752165910"></a>Yes</p> <td class="cellrowborder" valign="top" width="8.72%" headers="mcps1.1.5.1.3 "><p id="p45811752165910"><a name="p45811752165910"></a><a name="p45811752165910"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p1021294292216"><a name="en-us_topic_0000001149807881_p1021294292216"></a><a name="en-us_topic_0000001149807881_p1021294292216"></a>Audio stream type</p> <td class="cellrowborder" valign="top" width="53.169999999999995%" headers="mcps1.1.5.1.4 "><p id="p1021294292216"><a name="p1021294292216"></a><a name="p1021294292216"></a>Audio stream type</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
**Return Values** **Return values**
<a name="en-us_topic_0000001149807881_table621215425220"></a> <a name="table621215425220"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row3212842112215"><th class="cellrowborder" valign="top" width="26.02%" id="mcps1.1.3.1.1"><p id="en-us_topic_0000001149807881_p521274272216"><a name="en-us_topic_0000001149807881_p521274272216"></a><a name="en-us_topic_0000001149807881_p521274272216"></a>Type</p> <table><thead align="left"><tr id="row3212842112215"><th class="cellrowborder" valign="top" width="26.02%" id="mcps1.1.3.1.1"><p id="p521274272216"><a name="p521274272216"></a><a name="p521274272216"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="73.98%" id="mcps1.1.3.1.2"><p id="en-us_topic_0000001149807881_p1121214215221"><a name="en-us_topic_0000001149807881_p1121214215221"></a><a name="en-us_topic_0000001149807881_p1121214215221"></a>Description</p> <th class="cellrowborder" valign="top" width="73.98%" id="mcps1.1.3.1.2"><p id="p1121214215221"><a name="p1121214215221"></a><a name="p1121214215221"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row12121442192216"><td class="cellrowborder" valign="top" width="26.02%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0000001149807881_p72128426221"><a name="en-us_topic_0000001149807881_p72128426221"></a><a name="en-us_topic_0000001149807881_p72128426221"></a>Promise&lt;number&gt;</p> <tbody><tr id="row12121442192216"><td class="cellrowborder" valign="top" width="26.02%" headers="mcps1.1.3.1.1 "><p id="p72128426221"><a name="p72128426221"></a><a name="p72128426221"></a>Promise&lt;number&gt;</p>
</td> </td>
<td class="cellrowborder" valign="top" width="73.98%" headers="mcps1.1.3.1.2 "><p id="en-us_topic_0000001149807881_p4212114210226"><a name="en-us_topic_0000001149807881_p4212114210226"></a><a name="en-us_topic_0000001149807881_p4212114210226"></a>Promise used to return the maximum volume</p> <td class="cellrowborder" valign="top" width="73.98%" headers="mcps1.1.3.1.2 "><p id="p4212114210226"><a name="p4212114210226"></a><a name="p4212114210226"></a>Promise used to return the maximum volume</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
...@@ -660,101 +726,231 @@ Obtains the maximum volume allowed for a stream. This method uses a promise to r ...@@ -660,101 +726,231 @@ Obtains the maximum volume allowed for a stream. This method uses a promise to r
``` ```
audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA).then((data)=> audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA).then((data)=>
console.log(`Media getMaxVolume successful callback`); console.log('Promised returned to indicate that the maximum volume is obtained.');
) )
``` ```
### getDevices\(DeviceFlag, AsyncCallback<AudioDeviceDescriptors\>\)<a name="en-us_topic_0000001149807881_section11536182020523"></a> ### mute\(volumeType: AudioVolumeType, mute: boolean, callback: AsyncCallback<void\>\): void<sup>7+</sup><a name="section13516136134613"></a>
Obtains the audio devices of a specified flag. This method uses an asynchronous callback to return the execution result. Mutes a stream. This method uses an asynchronous callback to return the execution result.
**Parameters** **Parameters**
<a name="en-us_topic_0000001149807881_table8653191616249"></a> <a name="table16516183634618"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row165412169245"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="en-us_topic_0000001149807881_p1665412161243"><a name="en-us_topic_0000001149807881_p1665412161243"></a><a name="en-us_topic_0000001149807881_p1665412161243"></a>Name</p> <table><thead align="left"><tr id="row35162369464"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p1751663624620"><a name="p1751663624620"></a><a name="p1751663624620"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="26.26%" id="mcps1.1.5.1.2"><p id="en-us_topic_0000001149807881_p1765491672417"><a name="en-us_topic_0000001149807881_p1765491672417"></a><a name="en-us_topic_0000001149807881_p1765491672417"></a>Type</p> <th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p10517193604610"><a name="p10517193604610"></a><a name="p10517193604610"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="en-us_topic_0000001149807881_p113067111209"><a name="en-us_topic_0000001149807881_p113067111209"></a><a name="en-us_topic_0000001149807881_p113067111209"></a>Mandatory</p> <th class="cellrowborder" valign="top" width="8.97%" id="mcps1.1.5.1.3"><p id="p75178369466"><a name="p75178369466"></a><a name="p75178369466"></a>Mandatory</p>
</th> </th>
<th class="cellrowborder" valign="top" width="48.65%" id="mcps1.1.5.1.4"><p id="en-us_topic_0000001149807881_p765431682419"><a name="en-us_topic_0000001149807881_p765431682419"></a><a name="en-us_topic_0000001149807881_p765431682419"></a>Description</p> <th class="cellrowborder" valign="top" width="53.94%" id="mcps1.1.5.1.4"><p id="p135173369461"><a name="p135173369461"></a><a name="p135173369461"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row1654191652419"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p126549165241"><a name="en-us_topic_0000001149807881_p126549165241"></a><a name="en-us_topic_0000001149807881_p126549165241"></a>deviceFlag</p> <tbody><tr id="row14517123611463"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p1051753654616"><a name="p1051753654616"></a><a name="p1051753654616"></a>volumeType</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p19517183664611"><a name="p19517183664611"></a><a name="p19517183664611"></a><a href="#section92261857172218">AudioVolumeType</a></p>
</td>
<td class="cellrowborder" valign="top" width="8.97%" headers="mcps1.1.5.1.3 "><p id="p14517113634613"><a name="p14517113634613"></a><a name="p14517113634613"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.94%" headers="mcps1.1.5.1.4 "><p id="p412912394120"><a name="p412912394120"></a><a name="p412912394120"></a>Audio stream type</p>
</td> </td>
<td class="cellrowborder" valign="top" width="26.26%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p8654141622416"><a name="en-us_topic_0000001149807881_p8654141622416"></a><a name="en-us_topic_0000001149807881_p8654141622416"></a><a href="#en-us_topic_0000001149807881_section11285183164210">DeviceFlag</a></p> </tr>
<tr id="row051703612469"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p8518436144612"><a name="p8518436144612"></a><a name="p8518436144612"></a>mute</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p592111217487"><a name="p592111217487"></a><a name="p592111217487"></a>boolean</p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p830651111019"><a name="en-us_topic_0000001149807881_p830651111019"></a><a name="en-us_topic_0000001149807881_p830651111019"></a>Yes</p> <td class="cellrowborder" valign="top" width="8.97%" headers="mcps1.1.5.1.3 "><p id="p145187366468"><a name="p145187366468"></a><a name="p145187366468"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="48.65%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p10654131616248"><a name="en-us_topic_0000001149807881_p10654131616248"></a><a name="en-us_topic_0000001149807881_p10654131616248"></a>Audio device flag</p> <td class="cellrowborder" valign="top" width="53.94%" headers="mcps1.1.5.1.4 "><p id="p11518133684618"><a name="p11518133684618"></a><a name="p11518133684618"></a>Mute status to set. The value <strong id="b19795182381214"><a name="b19795182381214"></a><a name="b19795182381214"></a>true</strong> means to mute the stream, and <strong id="b5748123812121"><a name="b5748123812121"></a><a name="b5748123812121"></a>false</strong> means the opposite.</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001149807881_row16544162243"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p176541316122412"><a name="en-us_topic_0000001149807881_p176541316122412"></a><a name="en-us_topic_0000001149807881_p176541316122412"></a>callback</p> <tr id="row351833624617"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p1651817365464"><a name="p1651817365464"></a><a name="p1651817365464"></a>callback</p>
</td> </td>
<td class="cellrowborder" valign="top" width="26.26%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p1565461620244"><a name="en-us_topic_0000001149807881_p1565461620244"></a><a name="en-us_topic_0000001149807881_p1565461620244"></a>AsyncCallback&lt;<a href="#en-us_topic_0000001149807881_section5181155710523">AudioDeviceDescriptors</a>&gt;</p> <td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p451813613462"><a name="p451813613462"></a><a name="p451813613462"></a>AsyncCallback&lt;void&gt;</p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p2307711908"><a name="en-us_topic_0000001149807881_p2307711908"></a><a name="en-us_topic_0000001149807881_p2307711908"></a>Yes</p> <td class="cellrowborder" valign="top" width="8.97%" headers="mcps1.1.5.1.3 "><p id="p65181636194618"><a name="p65181636194618"></a><a name="p65181636194618"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="48.65%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p19654141672416"><a name="en-us_topic_0000001149807881_p19654141672416"></a><a name="en-us_topic_0000001149807881_p19654141672416"></a>Callback used to return the device list</p> <td class="cellrowborder" valign="top" width="53.94%" headers="mcps1.1.5.1.4 "><p id="p18115237124119"><a name="p18115237124119"></a><a name="p18115237124119"></a>Callback used to return the execution result</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
**Return values**
None
**Example** **Example**
``` ```
audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG, (err, value)=>{ audioManager.mute(audio.AudioVolumeType.MEDIA, true, (err) => {
if (err) {
console.error('Failed to mute the stream. ${err.message}');
return;
}
console.log('Callback invoked to indicate that the stream is muted.');
})
```
### mute\(volumeType: AudioVolumeType, mute: boolean\): Promise<void\><sup>7+</sup><a name="section7519036144616"></a>
Mutes a stream. This method uses a promise to return the execution result.
**Parameters**
<a name="table9519103616467"></a>
<table><thead align="left"><tr id="row12519123684618"><th class="cellrowborder" valign="top" width="17.599999999999998%" id="mcps1.1.5.1.1"><p id="p7885132645511"><a name="p7885132645511"></a><a name="p7885132645511"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="19.49%" id="mcps1.1.5.1.2"><p id="p98856261553"><a name="p98856261553"></a><a name="p98856261553"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.950000000000001%" id="mcps1.1.5.1.3"><p id="p1388582618559"><a name="p1388582618559"></a><a name="p1388582618559"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="52.959999999999994%" id="mcps1.1.5.1.4"><p id="p688512261558"><a name="p688512261558"></a><a name="p688512261558"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row552093624612"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.1.5.1.1 "><p id="p1052023616462"><a name="p1052023616462"></a><a name="p1052023616462"></a>volumeType</p>
</td>
<td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.1.5.1.2 "><p id="p552013620468"><a name="p552013620468"></a><a name="p552013620468"></a><a href="#section92261857172218">AudioVolumeType</a></p>
</td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.5.1.3 "><p id="p85203364468"><a name="p85203364468"></a><a name="p85203364468"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.959999999999994%" headers="mcps1.1.5.1.4 "><p id="p05201036124617"><a name="p05201036124617"></a><a name="p05201036124617"></a>Audio stream type</p>
</td>
</tr>
<tr id="row7520143614463"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.1.5.1.1 "><p id="p9522436134617"><a name="p9522436134617"></a><a name="p9522436134617"></a>mute</p>
</td>
<td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.1.5.1.2 "><p id="p12440205013243"><a name="p12440205013243"></a><a name="p12440205013243"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.1.5.1.3 "><p id="p15221236134617"><a name="p15221236134617"></a><a name="p15221236134617"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.959999999999994%" headers="mcps1.1.5.1.4 "><p id="p1079311161421"><a name="p1079311161421"></a><a name="p1079311161421"></a>Mute status to set. The value <strong id="b171348125135"><a name="b171348125135"></a><a name="b171348125135"></a>true</strong> means to mute the stream, and <strong id="b10134212151311"><a name="b10134212151311"></a><a name="b10134212151311"></a>false</strong> means the opposite.</p>
</td>
</tr>
</tbody>
</table>
**Return values**
<a name="table1152273694614"></a>
<table><thead align="left"><tr id="row352213367467"><th class="cellrowborder" valign="top" width="26.06%" id="mcps1.1.3.1.1"><p id="p16791154010553"><a name="p16791154010553"></a><a name="p16791154010553"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="73.94%" id="mcps1.1.3.1.2"><p id="p117911040155511"><a name="p117911040155511"></a><a name="p117911040155511"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row185231369468"><td class="cellrowborder" valign="top" width="26.06%" headers="mcps1.1.3.1.1 "><p id="p25231836174612"><a name="p25231836174612"></a><a name="p25231836174612"></a>Promise&lt;void&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="73.94%" headers="mcps1.1.3.1.2 "><p id="p18347134724215"><a name="p18347134724215"></a><a name="p18347134724215"></a>Promise used to return the execution result</p>
</td>
</tr>
</tbody>
</table>
**Example**
```
audioManager.mute(audio.AudioVolumeType.MEDIA, true).then(() =>
console.log('Promise returned to indicate that the stream is muted.');
)
```
### isMute\(volumeType: AudioVolumeType, callback: AsyncCallback<boolean\>\): void<sup>7+</sup><a name="section10684183819585"></a>
Checks whether a stream is muted. This method uses an asynchronous callback to return the query result.
**Parameters**
<a name="table26841038115812"></a>
<table><thead align="left"><tr id="row166859386584"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p1077814316558"><a name="p1077814316558"></a><a name="p1077814316558"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p67781331135518"><a name="p67781331135518"></a><a name="p67781331135518"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="10.56%" id="mcps1.1.5.1.3"><p id="p1177819312556"><a name="p1177819312556"></a><a name="p1177819312556"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="52.349999999999994%" id="mcps1.1.5.1.4"><p id="p177816317552"><a name="p177816317552"></a><a name="p177816317552"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row14685163820583"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p668543875817"><a name="p668543875817"></a><a name="p668543875817"></a>volumeType</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p1268653815581"><a name="p1268653815581"></a><a name="p1268653815581"></a><a href="#section92261857172218">AudioVolumeType</a></p>
</td>
<td class="cellrowborder" valign="top" width="10.56%" headers="mcps1.1.5.1.3 "><p id="p12686123814583"><a name="p12686123814583"></a><a name="p12686123814583"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.349999999999994%" headers="mcps1.1.5.1.4 "><p id="p6947181918459"><a name="p6947181918459"></a><a name="p6947181918459"></a>Audio stream type</p>
</td>
</tr>
<tr id="row15686153825819"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p5686153895817"><a name="p5686153895817"></a><a name="p5686153895817"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p16869387581"><a name="p16869387581"></a><a name="p16869387581"></a>AsyncCallback&lt;boolean&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="10.56%" headers="mcps1.1.5.1.3 "><p id="p4686163865811"><a name="p4686163865811"></a><a name="p4686163865811"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.349999999999994%" headers="mcps1.1.5.1.4 "><p id="p183723274511"><a name="p183723274511"></a><a name="p183723274511"></a>Callback used to return the mute status of the stream. The value <strong id="b892511611142"><a name="b892511611142"></a><a name="b892511611142"></a>true</strong> means that the stream is muted, and <strong id="b17347151781419"><a name="b17347151781419"></a><a name="b17347151781419"></a>false</strong> means the opposite.</p>
</td>
</tr>
</tbody>
</table>
**Return values**
None
**Example**
```
audioManager.isMute(audio.AudioVolumeType.MEDIA, (err, value) => {
if (err) { if (err) {
console.error(`failed to get getdevices ${err.message}`); console.error('Failed to obtain the mute status. ${err.message}');
return; return;
} }
console.log(`Media getDevices successful callback`); console.log('Callback invoked to indicate that the mute status of the stream is obtained.' + value);
}) })
``` ```
### getDevices\(DeviceFlag\)<a name="en-us_topic_0000001149807881_section181733125210"></a> ### isMute\(volumeType: AudioVolumeType\): Promise<boolean\><sup>7+</sup><a name="section6920211145610"></a>
Obtains the audio devices with a specified flag. This method uses a promise to return the execution result. Checks whether a stream is muted. This method uses a promise to return the execution result.
**Parameters** **Parameters**
<a name="en-us_topic_0000001149807881_table17655516132411"></a> <a name="table179201611155614"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row4655616192414"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="en-us_topic_0000001149807881_p1465518164247"><a name="en-us_topic_0000001149807881_p1465518164247"></a><a name="en-us_topic_0000001149807881_p1465518164247"></a>Name</p> <table><thead align="left"><tr id="row9920911195617"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p873322815570"><a name="p873322815570"></a><a name="p873322815570"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="en-us_topic_0000001149807881_p196551316172415"><a name="en-us_topic_0000001149807881_p196551316172415"></a><a name="en-us_topic_0000001149807881_p196551316172415"></a>Type</p> <th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p87331028115717"><a name="p87331028115717"></a><a name="p87331028115717"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="en-us_topic_0000001149807881_p13161629902"><a name="en-us_topic_0000001149807881_p13161629902"></a><a name="en-us_topic_0000001149807881_p13161629902"></a>Mandatory</p> <th class="cellrowborder" valign="top" width="9.94%" id="mcps1.1.5.1.3"><p id="p47331128105710"><a name="p47331128105710"></a><a name="p47331128105710"></a>Mandatory</p>
</th> </th>
<th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="en-us_topic_0000001149807881_p17655616102417"><a name="en-us_topic_0000001149807881_p17655616102417"></a><a name="en-us_topic_0000001149807881_p17655616102417"></a>Description</p> <th class="cellrowborder" valign="top" width="52.96999999999999%" id="mcps1.1.5.1.4"><p id="p373318281575"><a name="p373318281575"></a><a name="p373318281575"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row13656111662415"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p2092935211270"><a name="en-us_topic_0000001149807881_p2092935211270"></a><a name="en-us_topic_0000001149807881_p2092935211270"></a>deviceFlag</p> <tbody><tr id="row1292111110560"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p149211311135618"><a name="p149211311135618"></a><a name="p149211311135618"></a>volumeType</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p88719299489"><a name="en-us_topic_0000001149807881_p88719299489"></a><a name="en-us_topic_0000001149807881_p88719299489"></a><a href="#en-us_topic_0000001149807881_section11285183164210">DeviceFlag</a></p> <td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p1692191110568"><a name="p1692191110568"></a><a name="p1692191110568"></a><a href="#section92261857172218">AudioVolumeType</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p12161129209"><a name="en-us_topic_0000001149807881_p12161129209"></a><a name="en-us_topic_0000001149807881_p12161129209"></a>Yes</p> <td class="cellrowborder" valign="top" width="9.94%" headers="mcps1.1.5.1.3 "><p id="p1921131145612"><a name="p1921131145612"></a><a name="p1921131145612"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p1692985222710"><a name="en-us_topic_0000001149807881_p1692985222710"></a><a name="en-us_topic_0000001149807881_p1692985222710"></a>Audio device flag</p> <td class="cellrowborder" valign="top" width="52.96999999999999%" headers="mcps1.1.5.1.4 "><p id="p12726822462"><a name="p12726822462"></a><a name="p12726822462"></a>Audio stream type</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
**Return Values** **Return values**
<a name="en-us_topic_0000001149807881_table565618166249"></a> <a name="table1392211113567"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row19656151662410"><th class="cellrowborder" valign="top" width="26.02%" id="mcps1.1.3.1.1"><p id="en-us_topic_0000001149807881_p15656916152415"><a name="en-us_topic_0000001149807881_p15656916152415"></a><a name="en-us_topic_0000001149807881_p15656916152415"></a>Type</p> <table><thead align="left"><tr id="row39224110565"><th class="cellrowborder" valign="top" width="25.97%" id="mcps1.1.3.1.1"><p id="p1532894520558"><a name="p1532894520558"></a><a name="p1532894520558"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="73.98%" id="mcps1.1.3.1.2"><p id="en-us_topic_0000001149807881_p365641616247"><a name="en-us_topic_0000001149807881_p365641616247"></a><a name="en-us_topic_0000001149807881_p365641616247"></a>Description</p> <th class="cellrowborder" valign="top" width="74.03%" id="mcps1.1.3.1.2"><p id="p16328114517555"><a name="p16328114517555"></a><a name="p16328114517555"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row665681617243"><td class="cellrowborder" valign="top" width="26.02%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0000001149807881_p5673192162816"><a name="en-us_topic_0000001149807881_p5673192162816"></a><a name="en-us_topic_0000001149807881_p5673192162816"></a>Promise&lt;<a href="#en-us_topic_0000001149807881_section5181155710523">AudioDeviceDescriptors</a>&gt;</p> <tbody><tr id="row8922161155612"><td class="cellrowborder" valign="top" width="25.97%" headers="mcps1.1.3.1.1 "><p id="p992211117566"><a name="p992211117566"></a><a name="p992211117566"></a>Promise&lt;boolean&gt;</p>
</td> </td>
<td class="cellrowborder" valign="top" width="73.98%" headers="mcps1.1.3.1.2 "><p id="en-us_topic_0000001149807881_p765751610249"><a name="en-us_topic_0000001149807881_p765751610249"></a><a name="en-us_topic_0000001149807881_p765751610249"></a>Promise used to return the obtained device list</p> <td class="cellrowborder" valign="top" width="74.03%" headers="mcps1.1.3.1.2 "><p id="p17922131112568"><a name="p17922131112568"></a><a name="p17922131112568"></a>Promise used to return the mute status of the stream. The value <strong id="b6258181931519"><a name="b6258181931519"></a><a name="b6258181931519"></a>true</strong> means that the stream is muted, and <strong id="b545312300158"><a name="b545312300158"></a><a name="b545312300158"></a>false</strong> means the opposite.</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
...@@ -763,59 +959,1123 @@ Obtains the audio devices with a specified flag. This method uses a promise to r ...@@ -763,59 +959,1123 @@ Obtains the audio devices with a specified flag. This method uses a promise to r
**Example** **Example**
``` ```
audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG).then((data)=> audioManager.isMute(audio.AudioVolumeType.MEDIA).then((value) =>
console.log(`Media getDevices successful callback`); console.log('Promise returned to indicate that the mute status of the stream is obtained.' + value);
)
```
### isActive\(volumeType: AudioVolumeType, callback: AsyncCallback<boolean\>\): void<sup>7+</sup><a name="section380012544121"></a>
Checks whether a stream is active. This method uses an asynchronous callback to return the query result.
**Parameters**
<a name="table11801954151215"></a>
<table><thead align="left"><tr id="row480175481211"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p16771626115716"><a name="p16771626115716"></a><a name="p16771626115716"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p146771226195712"><a name="p146771226195712"></a><a name="p146771226195712"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.78%" id="mcps1.1.5.1.3"><p id="p16678202665719"><a name="p16678202665719"></a><a name="p16678202665719"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="53.13%" id="mcps1.1.5.1.4"><p id="p867882665719"><a name="p867882665719"></a><a name="p867882665719"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row6802165481211"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p138023547121"><a name="p138023547121"></a><a name="p138023547121"></a>volumeType</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p168021543125"><a name="p168021543125"></a><a name="p168021543125"></a><a href="#section92261857172218">AudioVolumeType</a></p>
</td>
<td class="cellrowborder" valign="top" width="9.78%" headers="mcps1.1.5.1.3 "><p id="p1180275418128"><a name="p1180275418128"></a><a name="p1180275418128"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.13%" headers="mcps1.1.5.1.4 "><p id="p106221941204617"><a name="p106221941204617"></a><a name="p106221941204617"></a>Audio stream type</p>
</td>
</tr>
<tr id="row148021654111218"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p1280275410128"><a name="p1280275410128"></a><a name="p1280275410128"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p1680245411214"><a name="p1680245411214"></a><a name="p1680245411214"></a>AsyncCallback&lt;boolean&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="9.78%" headers="mcps1.1.5.1.3 "><p id="p198031054151212"><a name="p198031054151212"></a><a name="p198031054151212"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.13%" headers="mcps1.1.5.1.4 "><p id="p2803354131214"><a name="p2803354131214"></a><a name="p2803354131214"></a>Callback used to return the active status of the stream. The value <strong id="b15293142015162"><a name="b15293142015162"></a><a name="b15293142015162"></a>true</strong> means that the stream is active, and <strong id="b82641034121613"><a name="b82641034121613"></a><a name="b82641034121613"></a>false</strong> means the opposite.</p>
</td>
</tr>
</tbody>
</table>
**Return values**
None
**Example**
```
audioManager.isActive(audio.AudioVolumeType.MEDIA, (err, value) => {
if (err) {
console.error('Failed to obtain the active status of the stream. ${err.message}');
return;
}
console.log('Callback invoked to indicate that the active status of the stream is obtained.' + value);
})
```
### isActive\(volumeType: AudioVolumeType\): Promise<boolean\><sup>7+</sup><a name="section1880315481216"></a>
Checks whether a stream is active. This method uses a promise to return the query result.
**Parameters**
<a name="table18041954171217"></a>
<table><thead align="left"><tr id="row18804154151212"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p1162310248571"><a name="p1162310248571"></a><a name="p1162310248571"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p262322411572"><a name="p262322411572"></a><a name="p262322411572"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.43%" id="mcps1.1.5.1.3"><p id="p13623152455711"><a name="p13623152455711"></a><a name="p13623152455711"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="53.480000000000004%" id="mcps1.1.5.1.4"><p id="p186231724165714"><a name="p186231724165714"></a><a name="p186231724165714"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row8805115411211"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p118051544122"><a name="p118051544122"></a><a name="p118051544122"></a>volumeType</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p19805145415124"><a name="p19805145415124"></a><a name="p19805145415124"></a><a href="#section92261857172218">AudioVolumeType</a></p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.1.5.1.3 "><p id="p380585411216"><a name="p380585411216"></a><a name="p380585411216"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.480000000000004%" headers="mcps1.1.5.1.4 "><p id="p1238516185410"><a name="p1238516185410"></a><a name="p1238516185410"></a>Audio stream type</p>
</td>
</tr>
</tbody>
</table>
**Return values**
<a name="table1380613543122"></a>
<table><thead align="left"><tr id="row2806125411129"><th class="cellrowborder" valign="top" width="25.97%" id="mcps1.1.3.1.1"><p id="p07811652175517"><a name="p07811652175517"></a><a name="p07811652175517"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="74.03%" id="mcps1.1.3.1.2"><p id="p478112526558"><a name="p478112526558"></a><a name="p478112526558"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row680605491218"><td class="cellrowborder" valign="top" width="25.97%" headers="mcps1.1.3.1.1 "><p id="p138061054101212"><a name="p138061054101212"></a><a name="p138061054101212"></a>Promise&lt;boolean&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="74.03%" headers="mcps1.1.3.1.2 "><p id="p280615541125"><a name="p280615541125"></a><a name="p280615541125"></a>Promise used to return the active status of the stream. The value <strong id="b6322155711164"><a name="b6322155711164"></a><a name="b6322155711164"></a>true</strong> means that the stream is active, and <strong id="b1832825714163"><a name="b1832825714163"></a><a name="b1832825714163"></a>false</strong> means the opposite.</p>
</td>
</tr>
</tbody>
</table>
**Example**
```
audioManager.isActive(audio.AudioVolumeType.MEDIA).then((value) =>
console.log('Promise returned to indicate that the active status of the stream is obtained.' + value);
) )
``` ```
## AudioDeviceDescriptor<a name="en-us_topic_0000001149807881_section17427121913310"></a> ### setRingerMode\(mode: AudioRingMode, callback: AsyncCallback<void\>\): void<sup>7+</sup><a name="section18572131483613"></a>
Sets the ringer mode. This method uses an asynchronous callback to return the execution result.
**Parameters**
<a name="table157219143361"></a>
<table><thead align="left"><tr id="row1357221412365"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p1175132113575"><a name="p1175132113575"></a><a name="p1175132113575"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p1375122116572"><a name="p1375122116572"></a><a name="p1375122116572"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="10.56%" id="mcps1.1.5.1.3"><p id="p1375122115710"><a name="p1375122115710"></a><a name="p1375122115710"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="52.349999999999994%" id="mcps1.1.5.1.4"><p id="p18751521135717"><a name="p18751521135717"></a><a name="p18751521135717"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row14573171411369"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p55731714143611"><a name="p55731714143611"></a><a name="p55731714143611"></a>mode</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p185881627122214"><a name="p185881627122214"></a><a name="p185881627122214"></a><a href="#section14948916131018">AudioRingMode</a></p>
</td>
<td class="cellrowborder" valign="top" width="10.56%" headers="mcps1.1.5.1.3 "><p id="p35731514193617"><a name="p35731514193617"></a><a name="p35731514193617"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.349999999999994%" headers="mcps1.1.5.1.4 "><p id="p8573191453617"><a name="p8573191453617"></a><a name="p8573191453617"></a>Ringer mode</p>
</td>
</tr>
<tr id="row165731014143611"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p357416149361"><a name="p357416149361"></a><a name="p357416149361"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p1457491463618"><a name="p1457491463618"></a><a name="p1457491463618"></a>AsyncCallback&lt;void&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="10.56%" headers="mcps1.1.5.1.3 "><p id="p95741514103617"><a name="p95741514103617"></a><a name="p95741514103617"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.349999999999994%" headers="mcps1.1.5.1.4 "><p id="p19574514123617"><a name="p19574514123617"></a><a name="p19574514123617"></a>Callback used to return the execution result</p>
</td>
</tr>
</tbody>
</table>
**Return values**
None
**Example**
```
audioManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL, (err) => {
if (err) {
console.error('Failed to set the ringer mode.​ ${err.message}');
return;
}
console.log('Callback invoked to indicate a successful setting of the ringer mode.');
})
```
### setRingerMode\(mode: AudioRingMode\): Promise<void\><sup>7+</sup><a name="section55741914143615"></a>
Sets the ringer mode. This method uses a promise to return the execution result.
Describes audio devices. **Parameters**
<a name="en-us_topic_0000001149807881_table5702164473415"></a> <a name="table55743147369"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row97021944203413"><th class="cellrowborder" valign="top" width="17.378262173782623%" id="mcps1.1.5.1.1"><p id="en-us_topic_0000001149807881_p1610322561817"><a name="en-us_topic_0000001149807881_p1610322561817"></a><a name="en-us_topic_0000001149807881_p1610322561817"></a>Name</p> <table><thead align="left"><tr id="row557512147369"><th class="cellrowborder" valign="top" width="17.599999999999998%" id="mcps1.1.5.1.1"><p id="p86951317155710"><a name="p86951317155710"></a><a name="p86951317155710"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="21.547845215478453%" id="mcps1.1.5.1.2"><p id="en-us_topic_0000001149807881_p177024446340"><a name="en-us_topic_0000001149807881_p177024446340"></a><a name="en-us_topic_0000001149807881_p177024446340"></a>Type</p> <th class="cellrowborder" valign="top" width="19.49%" id="mcps1.1.5.1.2"><p id="p13695101705716"><a name="p13695101705716"></a><a name="p13695101705716"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="7.519248075192481%" id="mcps1.1.5.1.3"><p id="en-us_topic_0000001149807881_p1103172518188"><a name="en-us_topic_0000001149807881_p1103172518188"></a><a name="en-us_topic_0000001149807881_p1103172518188"></a>Mandatory</p> <th class="cellrowborder" valign="top" width="9.08%" id="mcps1.1.5.1.3"><p id="p7695717175715"><a name="p7695717175715"></a><a name="p7695717175715"></a>Mandatory</p>
</th> </th>
<th class="cellrowborder" valign="top" width="53.554644535546444%" id="mcps1.1.5.1.4"><p id="en-us_topic_0000001149807881_p570274410345"><a name="en-us_topic_0000001149807881_p570274410345"></a><a name="en-us_topic_0000001149807881_p570274410345"></a>Description</p> <th class="cellrowborder" valign="top" width="53.83%" id="mcps1.1.5.1.4"><p id="p2695181775710"><a name="p2695181775710"></a><a name="p2695181775710"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row1770204412344"><td class="cellrowborder" valign="top" width="17.378262173782623%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p116764916367"><a name="en-us_topic_0000001149807881_p116764916367"></a><a name="en-us_topic_0000001149807881_p116764916367"></a>deviceRole</p> <tbody><tr id="row10575131412368"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.1.5.1.1 "><p id="p1957571420365"><a name="p1957571420365"></a><a name="p1957571420365"></a>mode</p>
</td>
<td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.1.5.1.2 "><p id="p14224197645"><a name="p14224197645"></a><a name="p14224197645"></a><a href="#section14948916131018">AudioRingMode</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="21.547845215478453%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p1710432543618"><a name="en-us_topic_0000001149807881_p1710432543618"></a><a name="en-us_topic_0000001149807881_p1710432543618"></a><a href="#en-us_topic_0000001149807881_section380038142619">DeviceRole</a></p> <td class="cellrowborder" valign="top" width="9.08%" headers="mcps1.1.5.1.3 "><p id="p9575191416367"><a name="p9575191416367"></a><a name="p9575191416367"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.519248075192481%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p14435512251"><a name="en-us_topic_0000001149807881_p14435512251"></a><a name="en-us_topic_0000001149807881_p14435512251"></a>No</p> <td class="cellrowborder" valign="top" width="53.83%" headers="mcps1.1.5.1.4 "><p id="p10576214143620"><a name="p10576214143620"></a><a name="p10576214143620"></a>Ringer mode</p>
</td>
</tr>
</tbody>
</table>
**Return values**
<a name="table145763146361"></a>
<table><thead align="left"><tr id="row1576101403610"><th class="cellrowborder" valign="top" width="26.06%" id="mcps1.1.3.1.1"><p id="p465818212561"><a name="p465818212561"></a><a name="p465818212561"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="73.94%" id="mcps1.1.3.1.2"><p id="p2065832195616"><a name="p2065832195616"></a><a name="p2065832195616"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1257711144362"><td class="cellrowborder" valign="top" width="26.06%" headers="mcps1.1.3.1.1 "><p id="p1577714143613"><a name="p1577714143613"></a><a name="p1577714143613"></a>Promise&lt;void&gt;</p>
</td> </td>
<td class="cellrowborder" valign="top" width="53.554644535546444%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p8703114411348"><a name="en-us_topic_0000001149807881_p8703114411348"></a><a name="en-us_topic_0000001149807881_p8703114411348"></a>Audio device role</p> <td class="cellrowborder" valign="top" width="73.94%" headers="mcps1.1.3.1.2 "><p id="p20577181420364"><a name="p20577181420364"></a><a name="p20577181420364"></a>Promise used to return the execution result</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001149807881_row370314447340"><td class="cellrowborder" valign="top" width="17.378262173782623%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001149807881_p32441814173618"><a name="en-us_topic_0000001149807881_p32441814173618"></a><a name="en-us_topic_0000001149807881_p32441814173618"></a>deviceType</p> </tbody>
</table>
**Example**
```
audioManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL).then(() =>
console.log('Promise returned to indicate a successful setting of the ringer mode.');
)
```
### getRingerMode\(callback: AsyncCallback<AudioRingMode\>\): void<sup>7+</sup><a name="section149044108162"></a>
Obtains the ringer mode. This method uses an asynchronous callback to return the query result.
**Parameters**
<a name="table139051710191611"></a>
<table><thead align="left"><tr id="row6905910101619"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p67261514145710"><a name="p67261514145710"></a><a name="p67261514145710"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="22.71%" id="mcps1.1.5.1.2"><p id="p177261314145713"><a name="p177261314145713"></a><a name="p177261314145713"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.8%" id="mcps1.1.5.1.3"><p id="p1672610143573"><a name="p1672610143573"></a><a name="p1672610143573"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="49.919999999999995%" id="mcps1.1.5.1.4"><p id="p27268142573"><a name="p27268142573"></a><a name="p27268142573"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row690717102164"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p2907191071616"><a name="p2907191071616"></a><a name="p2907191071616"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="22.71%" headers="mcps1.1.5.1.2 "><p id="p1490712109166"><a name="p1490712109166"></a><a name="p1490712109166"></a>AsyncCallback&lt;<a href="#section14948916131018">AudioRingMode</a>&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="9.8%" headers="mcps1.1.5.1.3 "><p id="p12907181051618"><a name="p12907181051618"></a><a name="p12907181051618"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.919999999999995%" headers="mcps1.1.5.1.4 "><p id="p1890771019169"><a name="p1890771019169"></a><a name="p1890771019169"></a>Callback used to return the ringer mode</p>
</td>
</tr>
</tbody>
</table>
**Return values**
None
**Example**
```
audioManager.getRingerMode((err, value) => {
if (err) {
console.error('Failed to obtain the ringer mode.​ ${err.message}');
return;
}
console.log('Callback invoked to indicate that the ringer mode is obtained.' + value);
})
```
### getRingerMode\(\): Promise<AudioRingMode\><sup>7+</sup><a name="section13908210101620"></a>
Obtains the ringer mode. This method uses a promise to return the query result.
**Parameters**
None
**Return values**
<a name="table59092010111611"></a>
<table><thead align="left"><tr id="row1290901017161"><th class="cellrowborder" valign="top" width="25.97%" id="mcps1.1.3.1.1"><p id="p138856135611"><a name="p138856135611"></a><a name="p138856135611"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="74.03%" id="mcps1.1.3.1.2"><p id="p03899675614"><a name="p03899675614"></a><a name="p03899675614"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row14910121071610"><td class="cellrowborder" valign="top" width="25.97%" headers="mcps1.1.3.1.1 "><p id="p191031031611"><a name="p191031031611"></a><a name="p191031031611"></a>Promise&lt;<a href="#section14948916131018">AudioRingMode</a>&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="74.03%" headers="mcps1.1.3.1.2 "><p id="p17910141021611"><a name="p17910141021611"></a><a name="p17910141021611"></a>Promise used to return the ringer mode</p>
</td>
</tr>
</tbody>
</table>
**Example**
```
audioManager.getRingerMode().then((value) =>
console.log('Promise returned to indicate that the ringer mode is obtained.' + value);
)
```
### setAudioParameter\(key: string, value: string, callback: AsyncCallback<void\>\): void<sup>7+</sup><a name="section1691957174818"></a>
Sets an audio parameter. This method uses an asynchronous callback to return the execution result.
**Parameters**
<a name="table59175774814"></a>
<table><thead align="left"><tr id="row31075754816"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p134771411145711"><a name="p134771411145711"></a><a name="p134771411145711"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p64779113577"><a name="p64779113577"></a><a name="p64779113577"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.08%" id="mcps1.1.5.1.3"><p id="p14477311155717"><a name="p14477311155717"></a><a name="p14477311155717"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="53.83%" id="mcps1.1.5.1.4"><p id="p1347701112574"><a name="p1347701112574"></a><a name="p1347701112574"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1210257154813"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p310105784818"><a name="p310105784818"></a><a name="p310105784818"></a>key</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p1438102417524"><a name="p1438102417524"></a><a name="p1438102417524"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.08%" headers="mcps1.1.5.1.3 "><p id="p811195717481"><a name="p811195717481"></a><a name="p811195717481"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.83%" headers="mcps1.1.5.1.4 "><p id="p10117574484"><a name="p10117574484"></a><a name="p10117574484"></a>Key of the audio parameter to set</p>
</td>
</tr>
<tr id="row16111057124817"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p1159793235211"><a name="p1159793235211"></a><a name="p1159793235211"></a>value</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p19461139165212"><a name="p19461139165212"></a><a name="p19461139165212"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.08%" headers="mcps1.1.5.1.3 "><p id="p91155718487"><a name="p91155718487"></a><a name="p91155718487"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.83%" headers="mcps1.1.5.1.4 "><p id="p13111157164816"><a name="p13111157164816"></a><a name="p13111157164816"></a>Value of the audio parameter to set</p>
</td>
</tr>
<tr id="row611205754810"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p31235754812"><a name="p31235754812"></a><a name="p31235754812"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p11255718483"><a name="p11255718483"></a><a name="p11255718483"></a>AsyncCallback&lt;void&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="9.08%" headers="mcps1.1.5.1.3 "><p id="p101255744812"><a name="p101255744812"></a><a name="p101255744812"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.83%" headers="mcps1.1.5.1.4 "><p id="p91220576488"><a name="p91220576488"></a><a name="p91220576488"></a>Callback used to return the execution result</p>
</td>
</tr>
</tbody>
</table>
**Return values**
None
**Example**
```
audioManager.setAudioParameter('PBits per sample', '8 bit', (err) => {
if (err) {
console.error('Failed to set the audio parameter. ${err.message}');
return;
}
console.log('Callback invoked to indicate a successful setting of the audio parameter.');
})
```
### setAudioParameter\(key: string, value: string\): Promise<void\><sup>7+</sup><a name="section18121057174820"></a>
Sets an audio parameter. This method uses a promise to return the execution result.
**Parameters**
<a name="table18121957164810"></a>
<table><thead align="left"><tr id="row1139578486"><th class="cellrowborder" valign="top" width="17.599999999999998%" id="mcps1.1.5.1.1"><p id="p658416785710"><a name="p658416785710"></a><a name="p658416785710"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="19.49%" id="mcps1.1.5.1.2"><p id="p175849775719"><a name="p175849775719"></a><a name="p175849775719"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.78%" id="mcps1.1.5.1.3"><p id="p4584578579"><a name="p4584578579"></a><a name="p4584578579"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="53.13%" id="mcps1.1.5.1.4"><p id="p10585577570"><a name="p10585577570"></a><a name="p10585577570"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1113125710483"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.1.5.1.1 "><p id="p1421211251605"><a name="p1421211251605"></a><a name="p1421211251605"></a>key</p>
</td>
<td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.1.5.1.2 "><p id="p15212725503"><a name="p15212725503"></a><a name="p15212725503"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.78%" headers="mcps1.1.5.1.3 "><p id="p52122259012"><a name="p52122259012"></a><a name="p52122259012"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.13%" headers="mcps1.1.5.1.4 "><p id="p1747016545595"><a name="p1747016545595"></a><a name="p1747016545595"></a>Key of the audio parameter to set</p>
</td>
</tr>
<tr id="row914185716488"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.1.5.1.1 "><p id="p1931324215016"><a name="p1931324215016"></a><a name="p1931324215016"></a>value</p>
</td>
<td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.1.5.1.2 "><p id="p9313164219015"><a name="p9313164219015"></a><a name="p9313164219015"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.78%" headers="mcps1.1.5.1.3 "><p id="p931316429017"><a name="p931316429017"></a><a name="p931316429017"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.13%" headers="mcps1.1.5.1.4 "><p id="p1231310421203"><a name="p1231310421203"></a><a name="p1231310421203"></a>Value of the audio parameter to set</p>
</td>
</tr>
</tbody>
</table>
**Return values**
<a name="table1514135774811"></a>
<table><thead align="left"><tr id="row16141857164818"><th class="cellrowborder" valign="top" width="26.06%" id="mcps1.1.3.1.1"><p id="p1847161019561"><a name="p1847161019561"></a><a name="p1847161019561"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="73.94%" id="mcps1.1.3.1.2"><p id="p7847161018562"><a name="p7847161018562"></a><a name="p7847161018562"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1815185711489"><td class="cellrowborder" valign="top" width="26.06%" headers="mcps1.1.3.1.1 "><p id="p8151957184816"><a name="p8151957184816"></a><a name="p8151957184816"></a>Promise&lt;void&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="73.94%" headers="mcps1.1.3.1.2 "><p id="p41511577486"><a name="p41511577486"></a><a name="p41511577486"></a>Promise used to return the execution result</p>
</td>
</tr>
</tbody>
</table>
**Example**
```
audioManager.setAudioParameter('PBits per sample', '8 bit').then(() =>
console.log('Promise returned to indicate a successful setting of the audio parameter.');
)
```
### getAudioParameter\(key: string, callback: AsyncCallback<string\>\): void<sup>7+</sup><a name="section1415145714812"></a>
Obtains the value of an audio parameter. This method uses an asynchronous callback to return the query result.
**Parameters**
<a name="table1315657114817"></a>
<table><thead align="left"><tr id="row181517574489"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p1023712411572"><a name="p1023712411572"></a><a name="p1023712411572"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p16238124125713"><a name="p16238124125713"></a><a name="p16238124125713"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.17%" id="mcps1.1.5.1.3"><p id="p1623811419574"><a name="p1623811419574"></a><a name="p1623811419574"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="53.74%" id="mcps1.1.5.1.4"><p id="p82387411579"><a name="p82387411579"></a><a name="p82387411579"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row616115754814"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p5220105915810"><a name="p5220105915810"></a><a name="p5220105915810"></a>key</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p1722019593812"><a name="p1722019593812"></a><a name="p1722019593812"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.17%" headers="mcps1.1.5.1.3 "><p id="p82209596816"><a name="p82209596816"></a><a name="p82209596816"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.74%" headers="mcps1.1.5.1.4 "><p id="p11261642604"><a name="p11261642604"></a><a name="p11261642604"></a>Key of the audio parameter whose value is to be obtained</p>
</td>
</tr>
<tr id="row61715714487"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p1517145710486"><a name="p1517145710486"></a><a name="p1517145710486"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p141715713486"><a name="p141715713486"></a><a name="p141715713486"></a>AsyncCallback&lt;string&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="9.17%" headers="mcps1.1.5.1.3 "><p id="p21785718487"><a name="p21785718487"></a><a name="p21785718487"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.74%" headers="mcps1.1.5.1.4 "><p id="p91715719485"><a name="p91715719485"></a><a name="p91715719485"></a>Callback used to return the value of the audio parameter</p>
</td>
</tr>
</tbody>
</table>
**Return values**
None
**Example**
```
audioManager.getAudioParameter('PBits per sample', (err, value) => {
if (err) {
console.error('Failed to obtain the value of the audio parameter. ${err.message}');
return;
}
console.log('Callback invoked to indicate that the value of the audio parameter is obtained.' + value);
})
```
### getAudioParameter\(key: string\): Promise<string\><sup>7+</sup><a name="section3185577485"></a>
Obtains the value of an audio parameter. This method uses a promise to return the query result.
**Parameters**
<a name="table5180572488"></a>
<table><thead align="left"><tr id="row111885714815"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p51148120574"><a name="p51148120574"></a><a name="p51148120574"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p111142175720"><a name="p111142175720"></a><a name="p111142175720"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.42%" id="mcps1.1.5.1.3"><p id="p151141145717"><a name="p151141145717"></a><a name="p151141145717"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="53.49%" id="mcps1.1.5.1.4"><p id="p1111410195711"><a name="p1111410195711"></a><a name="p1111410195711"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1519105784811"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p7988114714123"><a name="p7988114714123"></a><a name="p7988114714123"></a>key</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p149881947161218"><a name="p149881947161218"></a><a name="p149881947161218"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="9.42%" headers="mcps1.1.5.1.3 "><p id="p1798812477124"><a name="p1798812477124"></a><a name="p1798812477124"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.1.5.1.4 "><p id="p1860910215116"><a name="p1860910215116"></a><a name="p1860910215116"></a>Key of the audio parameter whose value is to be obtained</p>
</td>
</tr>
</tbody>
</table>
**Return values**
<a name="table152065754818"></a>
<table><thead align="left"><tr id="row10201357184813"><th class="cellrowborder" valign="top" width="25.97%" id="mcps1.1.3.1.1"><p id="p11727422165616"><a name="p11727422165616"></a><a name="p11727422165616"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="74.03%" id="mcps1.1.3.1.2"><p id="p5727922155611"><a name="p5727922155611"></a><a name="p5727922155611"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row8207572485"><td class="cellrowborder" valign="top" width="25.97%" headers="mcps1.1.3.1.1 "><p id="p22155774819"><a name="p22155774819"></a><a name="p22155774819"></a>Promise&lt;string&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="74.03%" headers="mcps1.1.3.1.2 "><p id="p1121155704810"><a name="p1121155704810"></a><a name="p1121155704810"></a>Promise used to return the value of the audio parameter</p>
</td>
</tr>
</tbody>
</table>
**Example**
```
audioManager.getAudioParameter('PBits per sample').then((value) =>
console.log('Promise returned to indicate that the value of the audio parameter is obtained.' + value);
)
```
### getDevices\(deviceFlag: DeviceFlag, callback: AsyncCallback<AudioDeviceDescriptors\>\): void<a name="section11536182020523"></a>
Obtains the audio devices with a specific flag. This method uses an asynchronous callback to return the query result.
**Parameters**
<a name="table8653191616249"></a>
<table><thead align="left"><tr id="row165412169245"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p1665412161243"><a name="p1665412161243"></a><a name="p1665412161243"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="21%" id="mcps1.1.5.1.2"><p id="p1765491672417"><a name="p1765491672417"></a><a name="p1765491672417"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="12.78%" id="mcps1.1.5.1.3"><p id="p113067111209"><a name="p113067111209"></a><a name="p113067111209"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="48.65%" id="mcps1.1.5.1.4"><p id="p765431682419"><a name="p765431682419"></a><a name="p765431682419"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1654191652419"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p126549165241"><a name="p126549165241"></a><a name="p126549165241"></a>deviceFlag</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.1.5.1.2 "><p id="p8654141622416"><a name="p8654141622416"></a><a name="p8654141622416"></a><a href="#section11285183164210">DeviceFlag</a></p>
</td>
<td class="cellrowborder" valign="top" width="12.78%" headers="mcps1.1.5.1.3 "><p id="p830651111019"><a name="p830651111019"></a><a name="p830651111019"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.65%" headers="mcps1.1.5.1.4 "><p id="p10654131616248"><a name="p10654131616248"></a><a name="p10654131616248"></a>Audio device flag</p>
</td>
</tr>
<tr id="row16544162243"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p176541316122412"><a name="p176541316122412"></a><a name="p176541316122412"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.1.5.1.2 "><p id="p1565461620244"><a name="p1565461620244"></a><a name="p1565461620244"></a>AsyncCallback&lt;<a href="#section5181155710523">AudioDeviceDescriptors</a>&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="12.78%" headers="mcps1.1.5.1.3 "><p id="p2307711908"><a name="p2307711908"></a><a name="p2307711908"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.65%" headers="mcps1.1.5.1.4 "><p id="p19654141672416"><a name="p19654141672416"></a><a name="p19654141672416"></a>Callback used to return the device list</p>
</td>
</tr>
</tbody>
</table>
**Return values**
None
**Example**
```
audioManager.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\(deviceFlag: DeviceFlag\): Promise<AudioDeviceDescriptors\><a name="section181733125210"></a>
Obtains the audio devices with a specific flag. This method uses a promise to return the query result.
**Parameters**
<a name="table17655516132411"></a>
<table><thead align="left"><tr id="row4655616192414"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p1465518164247"><a name="p1465518164247"></a><a name="p1465518164247"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p196551316172415"><a name="p196551316172415"></a><a name="p196551316172415"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="p13161629902"><a name="p13161629902"></a><a name="p13161629902"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="p17655616102417"><a name="p17655616102417"></a><a name="p17655616102417"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row13656111662415"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p2092935211270"><a name="p2092935211270"></a><a name="p2092935211270"></a>deviceFlag</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p88719299489"><a name="p88719299489"></a><a name="p88719299489"></a><a href="#section11285183164210">DeviceFlag</a></p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p12161129209"><a name="p12161129209"></a><a name="p12161129209"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="p1692985222710"><a name="p1692985222710"></a><a name="p1692985222710"></a>Audio device flag</p>
</td>
</tr>
</tbody>
</table>
**Return values**
<a name="table565618166249"></a>
<table><thead align="left"><tr id="row19656151662410"><th class="cellrowborder" valign="top" width="26.02%" id="mcps1.1.3.1.1"><p id="p15656916152415"><a name="p15656916152415"></a><a name="p15656916152415"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="73.98%" id="mcps1.1.3.1.2"><p id="p365641616247"><a name="p365641616247"></a><a name="p365641616247"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row665681617243"><td class="cellrowborder" valign="top" width="26.02%" headers="mcps1.1.3.1.1 "><p id="p5673192162816"><a name="p5673192162816"></a><a name="p5673192162816"></a>Promise&lt;<a href="#section5181155710523">AudioDeviceDescriptors</a>&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="73.98%" headers="mcps1.1.3.1.2 "><p id="p765751610249"><a name="p765751610249"></a><a name="p765751610249"></a>Promise used to return the device list</p>
</td>
</tr>
</tbody>
</table>
**Example**
```
audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG).then((data)=>
console.log('Promise returned to indicate that the device list is obtained.');
)
```
### setDeviceActive\(deviceType: DeviceType, active: boolean, callback: AsyncCallback<void\>\): void<sup>7+</sup><a name="section103558400222"></a>
Sets a device to the active state. This method uses an asynchronous callback to return the execution result.
**Parameters**
<a name="table5355740142213"></a>
<table><thead align="left"><tr id="row133561640192217"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p41511817185812"><a name="p41511817185812"></a><a name="p41511817185812"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p1415119175583"><a name="p1415119175583"></a><a name="p1415119175583"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.78%" id="mcps1.1.5.1.3"><p id="p16151171720587"><a name="p16151171720587"></a><a name="p16151171720587"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="53.13%" id="mcps1.1.5.1.4"><p id="p141511117195811"><a name="p141511117195811"></a><a name="p141511117195811"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row15356174052213"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p6356240182212"><a name="p6356240182212"></a><a name="p6356240182212"></a>deviceType</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p1982716244344"><a name="p1982716244344"></a><a name="p1982716244344"></a><a href="#section11727420122710">DeviceType</a></p>
</td>
<td class="cellrowborder" valign="top" width="9.78%" headers="mcps1.1.5.1.3 "><p id="p035794062216"><a name="p035794062216"></a><a name="p035794062216"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.13%" headers="mcps1.1.5.1.4 "><p id="p166271345204414"><a name="p166271345204414"></a><a name="p166271345204414"></a>Audio device type</p>
</td>
</tr>
<tr id="row1635713409226"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p268924403311"><a name="p268924403311"></a><a name="p268924403311"></a>active</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p5357104032210"><a name="p5357104032210"></a><a name="p5357104032210"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="9.78%" headers="mcps1.1.5.1.3 "><p id="p635764012218"><a name="p635764012218"></a><a name="p635764012218"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.13%" headers="mcps1.1.5.1.4 "><p id="p1357124052217"><a name="p1357124052217"></a><a name="p1357124052217"></a>Active status to set. The value <strong id="b3724942112511"><a name="b3724942112511"></a><a name="b3724942112511"></a>true</strong> means to set the device to the active status, and <strong id="b166801546102520"><a name="b166801546102520"></a><a name="b166801546102520"></a>false</strong> means the opposite.</p>
</td>
</tr>
<tr id="row133581840102212"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p03581340182212"><a name="p03581340182212"></a><a name="p03581340182212"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p3358204011223"><a name="p3358204011223"></a><a name="p3358204011223"></a>AsyncCallback&lt;void&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="9.78%" headers="mcps1.1.5.1.3 "><p id="p10358124014222"><a name="p10358124014222"></a><a name="p10358124014222"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.13%" headers="mcps1.1.5.1.4 "><p id="p13358540132217"><a name="p13358540132217"></a><a name="p13358540132217"></a>Callback used to return the execution result</p>
</td>
</tr>
</tbody>
</table>
**Return values**
None
**Example**
```
audioManager.setDeviceActive(audio.DeviceType.SPEAKER, true, (err)=> {
if (err) {
console.error('Failed to set the active status of the device. ${err.message}');
return;
}
console.log('Callback invoked to indicate that the device is set to the active status.');
})
```
### setDeviceActive\(deviceType: DeviceType, active: boolean\): Promise<void\><sup>7+</sup><a name="section1235914401228"></a>
Sets a device to the active state. This method uses a promise to return the execution result.
**Parameters**
<a name="table1335914018225"></a>
<table><thead align="left"><tr id="row103598403228"><th class="cellrowborder" valign="top" width="17.599999999999998%" id="mcps1.1.5.1.1"><p id="p5120161465816"><a name="p5120161465816"></a><a name="p5120161465816"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="19.49%" id="mcps1.1.5.1.2"><p id="p6120121420586"><a name="p6120121420586"></a><a name="p6120121420586"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="p412015148583"><a name="p412015148583"></a><a name="p412015148583"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.1.5.1.4"><p id="p14120111417585"><a name="p14120111417585"></a><a name="p14120111417585"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row6360124010225"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.1.5.1.1 "><p id="p21049584484"><a name="p21049584484"></a><a name="p21049584484"></a>deviceType</p>
</td>
<td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.1.5.1.2 "><p id="p98241474910"><a name="p98241474910"></a><a name="p98241474910"></a><a href="#section11727420122710">DeviceType</a></p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p103601240202216"><a name="p103601240202216"></a><a name="p103601240202216"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="p173618402226"><a name="p173618402226"></a><a name="p173618402226"></a>Audio device type</p>
</td>
</tr>
<tr id="row10361104018222"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.1.5.1.1 "><p id="p280718578504"><a name="p280718578504"></a><a name="p280718578504"></a>active</p>
</td>
<td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.1.5.1.2 "><p id="p103615400229"><a name="p103615400229"></a><a name="p103615400229"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p936154082210"><a name="p936154082210"></a><a name="p936154082210"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.1.5.1.4 "><p id="p280510397459"><a name="p280510397459"></a><a name="p280510397459"></a>Active status to set. The value <strong id="b191031648162515"><a name="b191031648162515"></a><a name="b191031648162515"></a>true</strong> means to set the device to the active status, and <strong id="b910354832514"><a name="b910354832514"></a><a name="b910354832514"></a>false</strong> means the opposite.</p>
</td>
</tr>
</tbody>
</table>
**Return values**
<a name="table636154016223"></a>
<table><thead align="left"><tr id="row17362540112218"><th class="cellrowborder" valign="top" width="26.06%" id="mcps1.1.3.1.1"><p id="p78801632195618"><a name="p78801632195618"></a><a name="p78801632195618"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="73.94%" id="mcps1.1.3.1.2"><p id="p1688043265614"><a name="p1688043265614"></a><a name="p1688043265614"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row143621940142213"><td class="cellrowborder" valign="top" width="26.06%" headers="mcps1.1.3.1.1 "><p id="p236215405225"><a name="p236215405225"></a><a name="p236215405225"></a>Promise&lt;void&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="73.94%" headers="mcps1.1.3.1.2 "><p id="p536214032220"><a name="p536214032220"></a><a name="p536214032220"></a>Promise used to return the execution result</p>
</td>
</tr>
</tbody>
</table>
**Example**
```
audioManager.setDeviceActive(audio.DeviceType.SPEAKER, true).then(()=>
console.log('Promise returned to indicate that the device is set to the active status.');
)
```
### isDeviceActive\(deviceType: DeviceType, callback: AsyncCallback<boolean\>\): void<sup>7+</sup><a name="section12363240122219"></a>
Checks whether a device is active. This method uses an asynchronous callback to return the query result.
**Parameters**
<a name="table13638406221"></a>
<table><thead align="left"><tr id="row15363840122216"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p18980131114586"><a name="p18980131114586"></a><a name="p18980131114586"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p16980161145817"><a name="p16980161145817"></a><a name="p16980161145817"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.25%" id="mcps1.1.5.1.3"><p id="p5980121165813"><a name="p5980121165813"></a><a name="p5980121165813"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="53.66%" id="mcps1.1.5.1.4"><p id="p149802111588"><a name="p149802111588"></a><a name="p149802111588"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1536417409223"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p12364174016224"><a name="p12364174016224"></a><a name="p12364174016224"></a>deviceType</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p1779218497578"><a name="p1779218497578"></a><a name="p1779218497578"></a><a href="#section11727420122710">DeviceType</a></p>
</td>
<td class="cellrowborder" valign="top" width="9.25%" headers="mcps1.1.5.1.3 "><p id="p122111521127"><a name="p122111521127"></a><a name="p122111521127"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.66%" headers="mcps1.1.5.1.4 "><p id="p4364640122219"><a name="p4364640122219"></a><a name="p4364640122219"></a>Audio device type</p>
</td>
</tr>
<tr id="row11365174011226"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p14365144016225"><a name="p14365144016225"></a><a name="p14365144016225"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p15365104062213"><a name="p15365104062213"></a><a name="p15365104062213"></a>AsyncCallback&lt;boolean&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="9.25%" headers="mcps1.1.5.1.3 "><p id="p20365154014220"><a name="p20365154014220"></a><a name="p20365154014220"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.66%" headers="mcps1.1.5.1.4 "><p id="p19365154072213"><a name="p19365154072213"></a><a name="p19365154072213"></a>Callback used to return the active status of the device</p>
</td>
</tr>
</tbody>
</table>
**Return values**
None
**Example**
```
audioManager.isDeviceActive(audio.DeviceType.SPEAKER, (err, value) => {
if (err) {
console.error('Failed to obtain the active status of the device. ${err.message}');
return;
}
console.log('Callback invoked to indicate that the active status of the device is obtained.');
})
```
### isDeviceActive\(deviceType: DeviceType\): Promise<boolean\><sup>7+</sup><a name="section18366184012213"></a>
Checks whether a device is active. This method uses a promise to return the query result.
**Parameters**
<a name="table10366184019222"></a>
<table><thead align="left"><tr id="row3366174012217"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p158645818582"><a name="p158645818582"></a><a name="p158645818582"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p15864158125814"><a name="p15864158125814"></a><a name="p15864158125814"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="8.99%" id="mcps1.1.5.1.3"><p id="p168649845815"><a name="p168649845815"></a><a name="p168649845815"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="53.92%" id="mcps1.1.5.1.4"><p id="p2086413855815"><a name="p2086413855815"></a><a name="p2086413855815"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row12367340122213"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p11637137420"><a name="p11637137420"></a><a name="p11637137420"></a>deviceType</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p1616311136412"><a name="p1616311136412"></a><a name="p1616311136412"></a><a href="#section11727420122710">DeviceType</a></p>
</td>
<td class="cellrowborder" valign="top" width="8.99%" headers="mcps1.1.5.1.3 "><p id="p201646138419"><a name="p201646138419"></a><a name="p201646138419"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.92%" headers="mcps1.1.5.1.4 "><p id="p7164113246"><a name="p7164113246"></a><a name="p7164113246"></a>Audio device type</p>
</td>
</tr>
</tbody>
</table>
**Return values**
<a name="table1368174012225"></a>
<table><thead align="left"><tr id="row17368164018220"><th class="cellrowborder" valign="top" width="25.97%" id="mcps1.1.3.1.1"><p id="p16368154062213"><a name="p16368154062213"></a><a name="p16368154062213"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="74.03%" id="mcps1.1.3.1.2"><p id="p1368740102218"><a name="p1368740102218"></a><a name="p1368740102218"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row8368840162213"><td class="cellrowborder" valign="top" width="25.97%" headers="mcps1.1.3.1.1 "><p id="p1436944092212"><a name="p1436944092212"></a><a name="p1436944092212"></a>Promise&lt;boolean&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="74.03%" headers="mcps1.1.3.1.2 "><p id="p113691340122217"><a name="p113691340122217"></a><a name="p113691340122217"></a>Promise used to return the active status of the device</p>
</td>
</tr>
</tbody>
</table>
**Example**
```
audioManager.isDeviceActive(audio.DeviceType.SPEAKER).then((value) =>
console.log('Promise returned to indicate that the active status of the device is obtained.' + value);
)
```
### setMicrophoneMute\(mute: boolean, callback: AsyncCallback<void\>\): void<sup>7+</sup><a name="section14703163618122"></a>
Mutes or unmutes the microphone. This method uses an asynchronous callback to return the execution result.
**Parameters**
<a name="table6703123691210"></a>
<table><thead align="left"><tr id="row67041836111213"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p25751666588"><a name="p25751666588"></a><a name="p25751666588"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p12575065588"><a name="p12575065588"></a><a name="p12575065588"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9.6%" id="mcps1.1.5.1.3"><p id="p3575136125814"><a name="p3575136125814"></a><a name="p3575136125814"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="53.31%" id="mcps1.1.5.1.4"><p id="p55751061582"><a name="p55751061582"></a><a name="p55751061582"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row670420363129"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p17493113218156"><a name="p17493113218156"></a><a name="p17493113218156"></a>mute</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p519017106151"><a name="p519017106151"></a><a name="p519017106151"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="9.6%" headers="mcps1.1.5.1.3 "><p id="p6705103681214"><a name="p6705103681214"></a><a name="p6705103681214"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.31%" headers="mcps1.1.5.1.4 "><p id="p1953244311156"><a name="p1953244311156"></a><a name="p1953244311156"></a>Mute status to set. The value <strong id="b1767620103286"><a name="b1767620103286"></a><a name="b1767620103286"></a>true</strong> means to mute the microphone, and <strong id="b168341072815"><a name="b168341072815"></a><a name="b168341072815"></a>false</strong> means the opposite.</p>
</td>
</tr>
<tr id="row9705103671212"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p14705436191218"><a name="p14705436191218"></a><a name="p14705436191218"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p270593617126"><a name="p270593617126"></a><a name="p270593617126"></a>AsyncCallback&lt;void&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="9.6%" headers="mcps1.1.5.1.3 "><p id="p1570573621213"><a name="p1570573621213"></a><a name="p1570573621213"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.31%" headers="mcps1.1.5.1.4 "><p id="p19706103612122"><a name="p19706103612122"></a><a name="p19706103612122"></a>Callback used to return the execution result</p>
</td>
</tr>
</tbody>
</table>
**Return values**
None
**Example**
```
audioManager.setMicrophoneMute(true, (err) => {
if (err) {
console.error('Failed to mute the microphone. ${err.message}');
return;
}
console.log('Callback invoked to indicate that the microphone is muted.');
})
```
### setMicrophoneMute\(mute: boolean\): Promise<void\><sup>7+</sup><a name="section56287111791"></a>
Mutes or unmutes the microphone. This method uses a promise to return the execution result.
**Parameters**
<a name="table36281411997"></a>
<table><thead align="left"><tr id="row16629011891"><th class="cellrowborder" valign="top" width="17.599999999999998%" id="mcps1.1.5.1.1"><p id="p1853715297587"><a name="p1853715297587"></a><a name="p1853715297587"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="19.49%" id="mcps1.1.5.1.2"><p id="p253711297583"><a name="p253711297583"></a><a name="p253711297583"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="10.39%" id="mcps1.1.5.1.3"><p id="p95374292585"><a name="p95374292585"></a><a name="p95374292585"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="52.52%" id="mcps1.1.5.1.4"><p id="p953722918583"><a name="p953722918583"></a><a name="p953722918583"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row186306112918"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.1.5.1.1 "><p id="p16482185512813"><a name="p16482185512813"></a><a name="p16482185512813"></a>mute</p>
</td>
<td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.1.5.1.2 "><p id="p17482195572814"><a name="p17482195572814"></a><a name="p17482195572814"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="10.39%" headers="mcps1.1.5.1.3 "><p id="p54828557284"><a name="p54828557284"></a><a name="p54828557284"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.52%" headers="mcps1.1.5.1.4 "><p id="p5819746191515"><a name="p5819746191515"></a><a name="p5819746191515"></a>Mute status to set. The value <strong id="b1892852419284"><a name="b1892852419284"></a><a name="b1892852419284"></a>true</strong> means to mute the microphone, and <strong id="b1792862482817"><a name="b1792862482817"></a><a name="b1792862482817"></a>false</strong> means the opposite.</p>
</td>
</tr>
</tbody>
</table>
**Return values**
<a name="table1263113111593"></a>
<table><thead align="left"><tr id="row1863116111998"><th class="cellrowborder" valign="top" width="26.06%" id="mcps1.1.3.1.1"><p id="p17429547125617"><a name="p17429547125617"></a><a name="p17429547125617"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="73.94%" id="mcps1.1.3.1.2"><p id="p15429347165616"><a name="p15429347165616"></a><a name="p15429347165616"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row19631511495"><td class="cellrowborder" valign="top" width="26.06%" headers="mcps1.1.3.1.1 "><p id="p963131110911"><a name="p963131110911"></a><a name="p963131110911"></a>Promise&lt;void&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="73.94%" headers="mcps1.1.3.1.2 "><p id="p2632911495"><a name="p2632911495"></a><a name="p2632911495"></a>Promise used to return the execution result</p>
</td>
</tr>
</tbody>
</table>
**Example**
```
audioManager.setMicrophoneMute(true).then(() =>
console.log('Promise returned to indicate that the microphone is muted.');
)
```
### isMicrophoneMute\(callback: AsyncCallback<boolean\>\): void<sup>7+</sup><a name="section6632141119912"></a>
Checks whether the microphone is muted. This method uses an asynchronous callback to return the query result.
**Parameters**
<a name="table263341115910"></a>
<table><thead align="left"><tr id="row963351114915"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p17609143285813"><a name="p17609143285813"></a><a name="p17609143285813"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="19.52%" id="mcps1.1.5.1.2"><p id="p1460953214582"><a name="p1460953214582"></a><a name="p1460953214582"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="8.38%" id="mcps1.1.5.1.3"><p id="p4609103219585"><a name="p4609103219585"></a><a name="p4609103219585"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="54.53%" id="mcps1.1.5.1.4"><p id="p13609332195816"><a name="p13609332195816"></a><a name="p13609332195816"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row863416111912"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p136341311990"><a name="p136341311990"></a><a name="p136341311990"></a>callback</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.1.5.1.2 "><p id="p263413111799"><a name="p263413111799"></a><a name="p263413111799"></a>AsyncCallback&lt;boolean&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="8.38%" headers="mcps1.1.5.1.3 "><p id="p1563571116915"><a name="p1563571116915"></a><a name="p1563571116915"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="54.53%" headers="mcps1.1.5.1.4 "><p id="p7929533121617"><a name="p7929533121617"></a><a name="p7929533121617"></a>Callback used to return the mute status of the microphone. The value <strong id="b5430124112912"><a name="b5430124112912"></a><a name="b5430124112912"></a>true</strong> means that the microphone is muted, and <strong id="b49243242915"><a name="b49243242915"></a><a name="b49243242915"></a>false</strong> means the opposite.</p>
</td>
</tr>
</tbody>
</table>
**Return values**
None
**Example**
```
audioManager.isMicrophoneMute((err, value) => {
if (err) {
console.error('Failed to obtain the mute status of the microphone. ${err.message}');
return;
}
console.log('Callback invoked to indicate that the mute status of the microphone is obtained.' + value);
})
```
### isMicrophoneMute\(\): Promise<boolean\><sup>7+</sup><a name="section196363111918"></a>
Checks whether the microphone is muted. This method uses a promise to return the query result.
**Parameters**
None
**Return values**
<a name="table1563618111590"></a>
<table><thead align="left"><tr id="row1563614111198"><th class="cellrowborder" valign="top" width="25.97%" id="mcps1.1.3.1.1"><p id="p4631195085616"><a name="p4631195085616"></a><a name="p4631195085616"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="74.03%" id="mcps1.1.3.1.2"><p id="p2063115065618"><a name="p2063115065618"></a><a name="p2063115065618"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row2063711111794"><td class="cellrowborder" valign="top" width="25.97%" headers="mcps1.1.3.1.1 "><p id="p7637511798"><a name="p7637511798"></a><a name="p7637511798"></a>Promise&lt;boolean&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="74.03%" headers="mcps1.1.3.1.2 "><p id="p9637191112911"><a name="p9637191112911"></a><a name="p9637191112911"></a>Promise used to return the mute status of the microphone. The value <strong id="b151051552172911"><a name="b151051552172911"></a><a name="b151051552172911"></a>true</strong> means that the microphone is muted, and <strong id="b2111205212918"><a name="b2111205212918"></a><a name="b2111205212918"></a>false</strong> means the opposite.</p>
</td>
</tr>
</tbody>
</table>
**Example**
```
audioManager.isMicrophoneMute().then((value) =>
console.log('Promise returned to indicate that the mute status of the microphone is obtained.', + value);
)
```
## AudioDeviceDescriptor<a name="section164657411927"></a>
Describes an audio device.
### Attributes<a name="section4947115405"></a>
<a name="table92548495595"></a>
<table><thead align="left"><tr id="row132541749175917"><th class="cellrowborder" valign="top" width="22.65226522652265%" id="mcps1.1.6.1.1"><p id="p925404965919"><a name="p925404965919"></a><a name="p925404965919"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="17.021702170217022%" id="mcps1.1.6.1.2"><p id="p325464914599"><a name="p325464914599"></a><a name="p325464914599"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="8.720872087208722%" id="mcps1.1.6.1.3"><p id="p025484918596"><a name="p025484918596"></a><a name="p025484918596"></a>Readable</p>
</th>
<th class="cellrowborder" valign="top" width="13.881388138813882%" id="mcps1.1.6.1.4"><p id="p025414499590"><a name="p025414499590"></a><a name="p025414499590"></a>Writable</p>
</th>
<th class="cellrowborder" valign="top" width="37.72377237723772%" id="mcps1.1.6.1.5"><p id="p20254134925912"><a name="p20254134925912"></a><a name="p20254134925912"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row18254849155915"><td class="cellrowborder" valign="top" width="22.65226522652265%" headers="mcps1.1.6.1.1 "><p id="p4909151512710"><a name="p4909151512710"></a><a name="p4909151512710"></a>deviceRole</p>
</td>
<td class="cellrowborder" valign="top" width="17.021702170217022%" headers="mcps1.1.6.1.2 "><p id="p262713618564"><a name="p262713618564"></a><a name="p262713618564"></a><a href="#section380038142619">DeviceRole</a></p>
</td>
<td class="cellrowborder" valign="top" width="8.720872087208722%" headers="mcps1.1.6.1.3 "><p id="p8254749195914"><a name="p8254749195914"></a><a name="p8254749195914"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.881388138813882%" headers="mcps1.1.6.1.4 "><p id="p5255549115910"><a name="p5255549115910"></a><a name="p5255549115910"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="37.72377237723772%" headers="mcps1.1.6.1.5 "><p id="p11973171511560"><a name="p11973171511560"></a><a name="p11973171511560"></a>Audio device role</p>
</td>
</tr>
<tr id="row3558145812553"><td class="cellrowborder" valign="top" width="22.65226522652265%" headers="mcps1.1.6.1.1 "><p id="p1155815580552"><a name="p1155815580552"></a><a name="p1155815580552"></a>deviceType</p>
</td>
<td class="cellrowborder" valign="top" width="17.021702170217022%" headers="mcps1.1.6.1.2 "><p id="p5558165811550"><a name="p5558165811550"></a><a name="p5558165811550"></a><a href="#section11727420122710">DeviceType</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="21.547845215478453%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001149807881_p654132923620"><a name="en-us_topic_0000001149807881_p654132923620"></a><a name="en-us_topic_0000001149807881_p654132923620"></a><a href="#en-us_topic_0000001149807881_section11727420122710">DeviceType</a></p> <td class="cellrowborder" valign="top" width="8.720872087208722%" headers="mcps1.1.6.1.3 "><p id="p17539151215617"><a name="p17539151215617"></a><a name="p17539151215617"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.519248075192481%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001149807881_p44475515256"><a name="en-us_topic_0000001149807881_p44475515256"></a><a name="en-us_topic_0000001149807881_p44475515256"></a>No</p> <td class="cellrowborder" valign="top" width="13.881388138813882%" headers="mcps1.1.6.1.4 "><p id="p85391712105612"><a name="p85391712105612"></a><a name="p85391712105612"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="53.554644535546444%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001149807881_p207031344133411"><a name="en-us_topic_0000001149807881_p207031344133411"></a><a name="en-us_topic_0000001149807881_p207031344133411"></a>Audio device type</p> <td class="cellrowborder" valign="top" width="37.72377237723772%" headers="mcps1.1.6.1.5 "><p id="p525718188565"><a name="p525718188565"></a><a name="p525718188565"></a>Audio device type</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
## AudioDeviceDescriptors<a name="en-us_topic_0000001149807881_section5181155710523"></a> ## AudioDeviceDescriptors<a name="section5181155710523"></a>
<a name="en-us_topic_0000001149807881_table169751229266"></a> <a name="table169751229266"></a>
<table><thead align="left"><tr id="en-us_topic_0000001149807881_row169757224268"><th class="cellrowborder" valign="top" width="19.7%" id="mcps1.1.3.1.1"><p id="en-us_topic_0000001149807881_p19975182202612"><a name="en-us_topic_0000001149807881_p19975182202612"></a><a name="en-us_topic_0000001149807881_p19975182202612"></a>Name</p> <table><thead align="left"><tr id="row169757224268"><th class="cellrowborder" valign="top" width="19.7%" id="mcps1.1.3.1.1"><p id="p19975182202612"><a name="p19975182202612"></a><a name="p19975182202612"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="80.30000000000001%" id="mcps1.1.3.1.2"><p id="en-us_topic_0000001149807881_p109751622132611"><a name="en-us_topic_0000001149807881_p109751622132611"></a><a name="en-us_topic_0000001149807881_p109751622132611"></a>Description</p> <th class="cellrowborder" valign="top" width="80.30000000000001%" id="mcps1.1.3.1.2"><p id="p109751622132611"><a name="p109751622132611"></a><a name="p109751622132611"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001149807881_row169751322182613"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0000001149807881_p139751522182616"><a name="en-us_topic_0000001149807881_p139751522182616"></a><a name="en-us_topic_0000001149807881_p139751522182616"></a>Device property queue</p> <tbody><tr id="row169751322182613"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.1.3.1.1 "><p id="p139751522182616"><a name="p139751522182616"></a><a name="p139751522182616"></a>Device attribute array</p>
</td> </td>
<td class="cellrowborder" valign="top" width="80.30000000000001%" headers="mcps1.1.3.1.2 "><p id="en-us_topic_0000001149807881_p597532272616"><a name="en-us_topic_0000001149807881_p597532272616"></a><a name="en-us_topic_0000001149807881_p597532272616"></a>A queue of <strong id="en-us_topic_0000001149807881_b12615715612"><a name="en-us_topic_0000001149807881_b12615715612"></a><a name="en-us_topic_0000001149807881_b12615715612"></a>AudioDeviceDescriptor</strong>, which is read-only.</p> <td class="cellrowborder" valign="top" width="80.30000000000001%" headers="mcps1.1.3.1.2 "><p id="p597532272616"><a name="p597532272616"></a><a name="p597532272616"></a>Array of <strong id="b1463165615308"><a name="b1463165615308"></a><a name="b1463165615308"></a>AudioDeviceDescriptor</strong>s, which is read-only</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
......
en/application-dev/js-reference/audio-playback.md
浏览文件 @ 83fcc63e
# Audio Playback<a name="EN-US_TOPIC_0000001115974764"></a> # Audio Playback<a name="EN-US_TOPIC_0000001103383404"></a>
- [Modules to Import](#en-us_topic_0000001103383404_s56d19203690d4782bfc74069abb6bd71) - [Modules to Import](#s56d19203690d4782bfc74069abb6bd71)
- [Required Permissions](#en-us_topic_0000001103383404_section11257113618419) - [Required Permissions](#section11257113618419)
- [Methods](#en-us_topic_0000001103383404_section125675489541) - [Methods](#section125675489541)
- [createAudioPlayer\(\)](#en-us_topic_0000001103383404_section582314017253) - [createAudioPlayer\(\)](#section582314017253)
- [Appendixes](#en-us_topic_0000001103383404_section1933416317165) - [Appendixes](#section1933416317165)
- [AudioPlayer](#en-us_topic_0000001103383404_section5174142818365) - [AudioPlayer](#section5174142818365)
- [Attributes](#en-us_topic_0000001103383404_section4947115405) - [Attributes](#section4947115405)
- [play\(\)](#en-us_topic_0000001103383404_section964512672913) - [play\(\)](#section964512672913)
- [pause\(\)](#en-us_topic_0000001103383404_section78173258296) - [pause\(\)](#section78173258296)
- [stop\(\)](#en-us_topic_0000001103383404_section122114334296) - [stop\(\)](#section122114334296)
- [seek\(number\)](#en-us_topic_0000001103383404_section1387113816298) - [seek\(number\)](#section1387113816298)
- [setVolume\(number\)](#en-us_topic_0000001103383404_section164235176552) - [setVolume\(number\)](#section164235176552)
- [release\(\)](#en-us_topic_0000001103383404_section9224621145512) - [reset\(\)7+](#section1473283011356)
- [Events](#en-us_topic_0000001103383404_section5453721192911) - [release\(\)](#section9224621145512)
- [play](#en-us_topic_0000001103383404_section87307411494) - [Events](#section5453721192911)
- [pause](#en-us_topic_0000001103383404_section198217471590) - [play](#section87307411494)
- [stop](#en-us_topic_0000001103383404_section437616531910) - [pause](#section198217471590)
- [dataLoad](#en-us_topic_0000001103383404_section982114219106) - [stop](#section437616531910)
- [timeUpdate](#en-us_topic_0000001103383404_section13687114181014) - [dataLoad](#section982114219106)
- [volumeChange](#en-us_topic_0000001103383404_section139227715717) - [timeUpdate](#section13687114181014)
- [finish](#en-us_topic_0000001103383404_section15181321181018) - [volumeChange](#section139227715717)
- [error](#en-us_topic_0000001103383404_section5593132921016) - [finish](#section15181321181018)
- [error](#section5593132921016)
- [AudioState](#en-us_topic_0000001103383404_section5181155710523)
- [AudioState](#section5181155710523)
>![](public_sys-resources/icon-note.gif) **NOTE:**
>Due to permission issues, these feature are temporarily unavailable for the standard system. ## Modules to Import<a name="s56d19203690d4782bfc74069abb6bd71"></a>
## Modules to Import<a name="en-us_topic_0000001103383404_s56d19203690d4782bfc74069abb6bd71"></a>
``` ```
import audio from '@ohos.multimedia.media'; import audio from '@ohos.multimedia.media';
``` ```
## Required Permissions<a name="en-us_topic_0000001103383404_section11257113618419"></a> ## Required Permissions<a name="section11257113618419"></a>
None None
## Methods<a name="en-us_topic_0000001103383404_section125675489541"></a> ## Methods<a name="section125675489541"></a>
## createAudioPlayer\(\)<a name="en-us_topic_0000001103383404_section582314017253"></a> ## createAudioPlayer\(\)<a name="section582314017253"></a>
Creates an **AudioPlayer** instance to control audio playback. Creates an **AudioPlayer** instance to control audio playback.
**Return Values** **Return Values**
<a name="en-us_topic_0000001103383404_table482411406254"></a> <a name="table482411406254"></a>
<table><thead align="left"><tr id="en-us_topic_0000001103383404_row138241940172518"><th class="cellrowborder" valign="top" width="16.05%" id="mcps1.1.3.1.1"><p id="en-us_topic_0000001103383404_p28256407257"><a name="en-us_topic_0000001103383404_p28256407257"></a><a name="en-us_topic_0000001103383404_p28256407257"></a>Type</p> <table><thead align="left"><tr id="row138241940172518"><th class="cellrowborder" valign="top" width="16.05%" id="mcps1.1.3.1.1"><p id="p28256407257"><a name="p28256407257"></a><a name="p28256407257"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="83.95%" id="mcps1.1.3.1.2"><p id="en-us_topic_0000001103383404_p1582544017256"><a name="en-us_topic_0000001103383404_p1582544017256"></a><a name="en-us_topic_0000001103383404_p1582544017256"></a>Description</p> <th class="cellrowborder" valign="top" width="83.95%" id="mcps1.1.3.1.2"><p id="p1582544017256"><a name="p1582544017256"></a><a name="p1582544017256"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001103383404_row0825540192520"><td class="cellrowborder" valign="top" width="16.05%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0000001103383404_p482574042511"><a name="en-us_topic_0000001103383404_p482574042511"></a><a name="en-us_topic_0000001103383404_p482574042511"></a><a href="#en-us_topic_0000001103383404_section5174142818365">AudioPlayer</a></p> <tbody><tr id="row0825540192520"><td class="cellrowborder" valign="top" width="16.05%" headers="mcps1.1.3.1.1 "><p id="p482574042511"><a name="p482574042511"></a><a name="p482574042511"></a><a href="#section5174142818365">AudioPlayer</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="83.95%" headers="mcps1.1.3.1.2 "><p id="en-us_topic_0000001103383404_p14825194014258"><a name="en-us_topic_0000001103383404_p14825194014258"></a><a name="en-us_topic_0000001103383404_p14825194014258"></a>Returns the <strong id="en-us_topic_0000001103383404_b1322434113810"><a name="en-us_topic_0000001103383404_b1322434113810"></a><a name="en-us_topic_0000001103383404_b1322434113810"></a>AudioPlayer</strong> instance if the operation is successful; returns <strong id="en-us_topic_0000001103383404_b114701838153811"><a name="en-us_topic_0000001103383404_b114701838153811"></a><a name="en-us_topic_0000001103383404_b114701838153811"></a>null</strong> otherwise.</p> <td class="cellrowborder" valign="top" width="83.95%" headers="mcps1.1.3.1.2 "><p id="p14825194014258"><a name="p14825194014258"></a><a name="p14825194014258"></a>Returns the <strong id="b1322434113810"><a name="b1322434113810"></a><a name="b1322434113810"></a>AudioPlayer</strong> instance if the operation is successful; returns <strong id="b114701838153811"><a name="b114701838153811"></a><a name="b114701838153811"></a>null</strong> otherwise.</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
...@@ -67,164 +65,201 @@ Creates an **AudioPlayer** instance to control audio playback. ...@@ -67,164 +65,201 @@ Creates an **AudioPlayer** instance to control audio playback.
var audioplayer = audio.createAudioPlayer(); var audioplayer = audio.createAudioPlayer();
``` ```
## Appendixes<a name="en-us_topic_0000001103383404_section1933416317165"></a> ## Appendixes<a name="section1933416317165"></a>
## AudioPlayer<a name="en-us_topic_0000001103383404_section5174142818365"></a> ## AudioPlayer<a name="section5174142818365"></a>
Represents an audio player. Represents an audio player.
### Attributes<a name="en-us_topic_0000001103383404_section4947115405"></a> ### Attributes<a name="section4947115405"></a>
<a name="en-us_topic_0000001103383404_table92548495595"></a> <a name="table92548495595"></a>
<table><thead align="left"><tr id="en-us_topic_0000001103383404_row132541749175917"><th class="cellrowborder" valign="top" width="15.8015801580158%" id="mcps1.1.6.1.1"><p id="en-us_topic_0000001103383404_p925404965919"><a name="en-us_topic_0000001103383404_p925404965919"></a><a name="en-us_topic_0000001103383404_p925404965919"></a>Name</p> <table><thead align="left"><tr id="row132541749175917"><th class="cellrowborder" valign="top" width="15.8015801580158%" id="mcps1.1.6.1.1"><p id="p925404965919"><a name="p925404965919"></a><a name="p925404965919"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="19.591959195919593%" id="mcps1.1.6.1.2"><p id="en-us_topic_0000001103383404_p325464914599"><a name="en-us_topic_0000001103383404_p325464914599"></a><a name="en-us_topic_0000001103383404_p325464914599"></a>Type</p> <th class="cellrowborder" valign="top" width="19.591959195919593%" id="mcps1.1.6.1.2"><p id="p325464914599"><a name="p325464914599"></a><a name="p325464914599"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="7.660766076607661%" id="mcps1.1.6.1.3"><p id="en-us_topic_0000001103383404_p025484918596"><a name="en-us_topic_0000001103383404_p025484918596"></a><a name="en-us_topic_0000001103383404_p025484918596"></a>Readable</p> <th class="cellrowborder" valign="top" width="7.660766076607661%" id="mcps1.1.6.1.3"><p id="p025484918596"><a name="p025484918596"></a><a name="p025484918596"></a>Readable</p>
</th> </th>
<th class="cellrowborder" valign="top" width="8.29082908290829%" id="mcps1.1.6.1.4"><p id="en-us_topic_0000001103383404_p025414499590"><a name="en-us_topic_0000001103383404_p025414499590"></a><a name="en-us_topic_0000001103383404_p025414499590"></a>Writable</p> <th class="cellrowborder" valign="top" width="8.29082908290829%" id="mcps1.1.6.1.4"><p id="p025414499590"><a name="p025414499590"></a><a name="p025414499590"></a>Writable</p>
</th> </th>
<th class="cellrowborder" valign="top" width="48.65486548654865%" id="mcps1.1.6.1.5"><p id="en-us_topic_0000001103383404_p20254134925912"><a name="en-us_topic_0000001103383404_p20254134925912"></a><a name="en-us_topic_0000001103383404_p20254134925912"></a>Description</p> <th class="cellrowborder" valign="top" width="48.65486548654865%" id="mcps1.1.6.1.5"><p id="p20254134925912"><a name="p20254134925912"></a><a name="p20254134925912"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001103383404_row18254849155915"><td class="cellrowborder" valign="top" width="15.8015801580158%" headers="mcps1.1.6.1.1 "><p id="en-us_topic_0000001103383404_p20254204935915"><a name="en-us_topic_0000001103383404_p20254204935915"></a><a name="en-us_topic_0000001103383404_p20254204935915"></a>src</p> <tbody><tr id="row18254849155915"><td class="cellrowborder" valign="top" width="15.8015801580158%" headers="mcps1.1.6.1.1 "><p id="p20254204935915"><a name="p20254204935915"></a><a name="p20254204935915"></a>src</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.591959195919593%" headers="mcps1.1.6.1.2 "><p id="en-us_topic_0000001103383404_p1525413497591"><a name="en-us_topic_0000001103383404_p1525413497591"></a><a name="en-us_topic_0000001103383404_p1525413497591"></a>string</p> <td class="cellrowborder" valign="top" width="19.591959195919593%" headers="mcps1.1.6.1.2 "><p id="p1525413497591"><a name="p1525413497591"></a><a name="p1525413497591"></a>string</p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.660766076607661%" headers="mcps1.1.6.1.3 "><p id="en-us_topic_0000001103383404_p8254749195914"><a name="en-us_topic_0000001103383404_p8254749195914"></a><a name="en-us_topic_0000001103383404_p8254749195914"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.660766076607661%" headers="mcps1.1.6.1.3 "><p id="p8254749195914"><a name="p8254749195914"></a><a name="p8254749195914"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="8.29082908290829%" headers="mcps1.1.6.1.4 "><p id="en-us_topic_0000001103383404_p5255549115910"><a name="en-us_topic_0000001103383404_p5255549115910"></a><a name="en-us_topic_0000001103383404_p5255549115910"></a>Yes</p> <td class="cellrowborder" valign="top" width="8.29082908290829%" headers="mcps1.1.6.1.4 "><p id="p5255549115910"><a name="p5255549115910"></a><a name="p5255549115910"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="48.65486548654865%" headers="mcps1.1.6.1.5 "><p id="en-us_topic_0000001103383404_p72551449145914"><a name="en-us_topic_0000001103383404_p72551449145914"></a><a name="en-us_topic_0000001103383404_p72551449145914"></a>URI of the audio resources</p> <td class="cellrowborder" valign="top" width="48.65486548654865%" headers="mcps1.1.6.1.5 "><p id="p72551449145914"><a name="p72551449145914"></a><a name="p72551449145914"></a>URI of the audio resources</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001103383404_row10255134945917"><td class="cellrowborder" valign="top" width="15.8015801580158%" headers="mcps1.1.6.1.1 "><p id="en-us_topic_0000001103383404_p82551349125910"><a name="en-us_topic_0000001103383404_p82551349125910"></a><a name="en-us_topic_0000001103383404_p82551349125910"></a>loop</p> <tr id="row10255134945917"><td class="cellrowborder" valign="top" width="15.8015801580158%" headers="mcps1.1.6.1.1 "><p id="p82551349125910"><a name="p82551349125910"></a><a name="p82551349125910"></a>loop</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.591959195919593%" headers="mcps1.1.6.1.2 "><p id="en-us_topic_0000001103383404_p18255154913598"><a name="en-us_topic_0000001103383404_p18255154913598"></a><a name="en-us_topic_0000001103383404_p18255154913598"></a>boolean</p> <td class="cellrowborder" valign="top" width="19.591959195919593%" headers="mcps1.1.6.1.2 "><p id="p18255154913598"><a name="p18255154913598"></a><a name="p18255154913598"></a>boolean</p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.660766076607661%" headers="mcps1.1.6.1.3 "><p id="en-us_topic_0000001103383404_p525516497595"><a name="en-us_topic_0000001103383404_p525516497595"></a><a name="en-us_topic_0000001103383404_p525516497595"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.660766076607661%" headers="mcps1.1.6.1.3 "><p id="p525516497595"><a name="p525516497595"></a><a name="p525516497595"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="8.29082908290829%" headers="mcps1.1.6.1.4 "><p id="en-us_topic_0000001103383404_p2025504917593"><a name="en-us_topic_0000001103383404_p2025504917593"></a><a name="en-us_topic_0000001103383404_p2025504917593"></a>Yes</p> <td class="cellrowborder" valign="top" width="8.29082908290829%" headers="mcps1.1.6.1.4 "><p id="p2025504917593"><a name="p2025504917593"></a><a name="p2025504917593"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="48.65486548654865%" headers="mcps1.1.6.1.5 "><p id="en-us_topic_0000001103383404_p7255194925919"><a name="en-us_topic_0000001103383404_p7255194925919"></a><a name="en-us_topic_0000001103383404_p7255194925919"></a>Whether to loop audio playback</p> <td class="cellrowborder" valign="top" width="48.65486548654865%" headers="mcps1.1.6.1.5 "><p id="p7255194925919"><a name="p7255194925919"></a><a name="p7255194925919"></a>Whether to loop audio playback</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001103383404_row18256049165911"><td class="cellrowborder" valign="top" width="15.8015801580158%" headers="mcps1.1.6.1.1 "><p id="en-us_topic_0000001103383404_p2256154919590"><a name="en-us_topic_0000001103383404_p2256154919590"></a><a name="en-us_topic_0000001103383404_p2256154919590"></a>currentTime</p> <tr id="row18256049165911"><td class="cellrowborder" valign="top" width="15.8015801580158%" headers="mcps1.1.6.1.1 "><p id="p2256154919590"><a name="p2256154919590"></a><a name="p2256154919590"></a>currentTime</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.591959195919593%" headers="mcps1.1.6.1.2 "><p id="en-us_topic_0000001103383404_p10256849165915"><a name="en-us_topic_0000001103383404_p10256849165915"></a><a name="en-us_topic_0000001103383404_p10256849165915"></a>number</p> <td class="cellrowborder" valign="top" width="19.591959195919593%" headers="mcps1.1.6.1.2 "><p id="p10256849165915"><a name="p10256849165915"></a><a name="p10256849165915"></a>number</p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.660766076607661%" headers="mcps1.1.6.1.3 "><p id="en-us_topic_0000001103383404_p19256149155915"><a name="en-us_topic_0000001103383404_p19256149155915"></a><a name="en-us_topic_0000001103383404_p19256149155915"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.660766076607661%" headers="mcps1.1.6.1.3 "><p id="p19256149155915"><a name="p19256149155915"></a><a name="p19256149155915"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="8.29082908290829%" headers="mcps1.1.6.1.4 "><p id="en-us_topic_0000001103383404_p3256174935919"><a name="en-us_topic_0000001103383404_p3256174935919"></a><a name="en-us_topic_0000001103383404_p3256174935919"></a>No</p> <td class="cellrowborder" valign="top" width="8.29082908290829%" headers="mcps1.1.6.1.4 "><p id="p3256174935919"><a name="p3256174935919"></a><a name="p3256174935919"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="48.65486548654865%" headers="mcps1.1.6.1.5 "><p id="en-us_topic_0000001103383404_p12256144995913"><a name="en-us_topic_0000001103383404_p12256144995913"></a><a name="en-us_topic_0000001103383404_p12256144995913"></a>Current playback position</p> <td class="cellrowborder" valign="top" width="48.65486548654865%" headers="mcps1.1.6.1.5 "><p id="p12256144995913"><a name="p12256144995913"></a><a name="p12256144995913"></a>Current playback position</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001103383404_row11256144911598"><td class="cellrowborder" valign="top" width="15.8015801580158%" headers="mcps1.1.6.1.1 "><p id="en-us_topic_0000001103383404_p92561949125910"><a name="en-us_topic_0000001103383404_p92561949125910"></a><a name="en-us_topic_0000001103383404_p92561949125910"></a>duration</p> <tr id="row11256144911598"><td class="cellrowborder" valign="top" width="15.8015801580158%" headers="mcps1.1.6.1.1 "><p id="p92561949125910"><a name="p92561949125910"></a><a name="p92561949125910"></a>duration</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.591959195919593%" headers="mcps1.1.6.1.2 "><p id="en-us_topic_0000001103383404_p9256124914597"><a name="en-us_topic_0000001103383404_p9256124914597"></a><a name="en-us_topic_0000001103383404_p9256124914597"></a>number</p> <td class="cellrowborder" valign="top" width="19.591959195919593%" headers="mcps1.1.6.1.2 "><p id="p9256124914597"><a name="p9256124914597"></a><a name="p9256124914597"></a>number</p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.660766076607661%" headers="mcps1.1.6.1.3 "><p id="en-us_topic_0000001103383404_p1725654915911"><a name="en-us_topic_0000001103383404_p1725654915911"></a><a name="en-us_topic_0000001103383404_p1725654915911"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.660766076607661%" headers="mcps1.1.6.1.3 "><p id="p1725654915911"><a name="p1725654915911"></a><a name="p1725654915911"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="8.29082908290829%" headers="mcps1.1.6.1.4 "><p id="en-us_topic_0000001103383404_p192562049125910"><a name="en-us_topic_0000001103383404_p192562049125910"></a><a name="en-us_topic_0000001103383404_p192562049125910"></a>No</p> <td class="cellrowborder" valign="top" width="8.29082908290829%" headers="mcps1.1.6.1.4 "><p id="p192562049125910"><a name="p192562049125910"></a><a name="p192562049125910"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="48.65486548654865%" headers="mcps1.1.6.1.5 "><p id="en-us_topic_0000001103383404_p125684995913"><a name="en-us_topic_0000001103383404_p125684995913"></a><a name="en-us_topic_0000001103383404_p125684995913"></a>Playback duration</p> <td class="cellrowborder" valign="top" width="48.65486548654865%" headers="mcps1.1.6.1.5 "><p id="p125684995913"><a name="p125684995913"></a><a name="p125684995913"></a>Playback duration</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001103383404_row6256149115920"><td class="cellrowborder" valign="top" width="15.8015801580158%" headers="mcps1.1.6.1.1 "><p id="en-us_topic_0000001103383404_p2256144918596"><a name="en-us_topic_0000001103383404_p2256144918596"></a><a name="en-us_topic_0000001103383404_p2256144918596"></a>state</p> <tr id="row6256149115920"><td class="cellrowborder" valign="top" width="15.8015801580158%" headers="mcps1.1.6.1.1 "><p id="p2256144918596"><a name="p2256144918596"></a><a name="p2256144918596"></a>state</p>
</td> </td>
<td class="cellrowborder" valign="top" width="19.591959195919593%" headers="mcps1.1.6.1.2 "><p id="en-us_topic_0000001103383404_p9256144918593"><a name="en-us_topic_0000001103383404_p9256144918593"></a><a name="en-us_topic_0000001103383404_p9256144918593"></a><a href="#en-us_topic_0000001103383404_section5181155710523">AudioState</a></p> <td class="cellrowborder" valign="top" width="19.591959195919593%" headers="mcps1.1.6.1.2 "><p id="p9256144918593"><a name="p9256144918593"></a><a name="p9256144918593"></a><a href="#section5181155710523">AudioState</a></p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.660766076607661%" headers="mcps1.1.6.1.3 "><p id="en-us_topic_0000001103383404_p102563495592"><a name="en-us_topic_0000001103383404_p102563495592"></a><a name="en-us_topic_0000001103383404_p102563495592"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.660766076607661%" headers="mcps1.1.6.1.3 "><p id="p102563495592"><a name="p102563495592"></a><a name="p102563495592"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="8.29082908290829%" headers="mcps1.1.6.1.4 "><p id="en-us_topic_0000001103383404_p625620497594"><a name="en-us_topic_0000001103383404_p625620497594"></a><a name="en-us_topic_0000001103383404_p625620497594"></a>No</p> <td class="cellrowborder" valign="top" width="8.29082908290829%" headers="mcps1.1.6.1.4 "><p id="p625620497594"><a name="p625620497594"></a><a name="p625620497594"></a>No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="48.65486548654865%" headers="mcps1.1.6.1.5 "><p id="en-us_topic_0000001103383404_p162571549195920"><a name="en-us_topic_0000001103383404_p162571549195920"></a><a name="en-us_topic_0000001103383404_p162571549195920"></a>Playback status</p> <td class="cellrowborder" valign="top" width="48.65486548654865%" headers="mcps1.1.6.1.5 "><p id="p162571549195920"><a name="p162571549195920"></a><a name="p162571549195920"></a>Playback status</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
### play\(\)<a name="en-us_topic_0000001103383404_section964512672913"></a> ### play\(\)<a name="section964512672913"></a>
Starts audio playback. Starts audio playback.
**Example** **Example**
``` ```
audioplayer.src = 'common/mydream.mp3'; audioplayer.on('dataload', (err, action) => {
if (err) {
console.info('Error returned in the prepare() callback.');
return;
}
console.info('Start to play the audio.');
audioplayer.play();
};
audioplayer.on('play', (err, action) => { audioplayer.on('play', (err, action) => {
if (err) { if (err) {
console.log(`err returned in play() callback`); console.info('Error returned in the play() callback.');
return; return;
} }
console.log('start to play'); console.info('Succeeded in playing the audio.');
audioplayer.pause();
}; };
audioplayer.play(); audioplayer.src = 'common/mydream.mp3';
``` ```
### pause\(\)<a name="en-us_topic_0000001103383404_section78173258296"></a> ### pause\(\)<a name="section78173258296"></a>
Pauses audio playback. Pauses audio playback.
**Example** **Example**
``` ```
audioplayer.src = 'common/mydream.mp3'; audioplayer.on('dataload', (err, action) => {
if (err) {
console.info('Error returned in the prepare() callback.');
return;
}
console.info('Start to play the audio.');
audioplayer.play();
}
audioplayer.on('play', (err, action) => {
if (err) {
console.info('Error returned in the play() callback.');
return;
}
console.info('Start to pause audio playback.');
audioplayer.pause();
};
audioplayer.on('pause', (err, action) => { audioplayer.on('pause', (err, action) => {
if (err) { if (err) {
console.log(`err returned in pause() callback`); console.info('Error returned in the pause() callback.');
return; return;
} }
console.log('playback pause'); console.info('Succeeded in pausing audio playback.');
}; };
audioplayer.pause(); audioplayer.src = 'common/mydream.mp3';
``` ```
### stop\(\)<a name="en-us_topic_0000001103383404_section122114334296"></a> ### stop\(\)<a name="section122114334296"></a>
Stops audio playback. Stops audio playback.
**Example** **Example**
``` ```
audioplayer.src = 'common/mydream.mp3'; audioplayer.on('dataload', (err, action) => {
audioplayer.on('stop',(err, action) => {
if (err) { if (err) {
console.log(`err returned in stop() callback`); console.info('Error returned in the prepare() callback.');
return; return;
} }
console.log('playback stop'); console.info('Start to play the audio.');
audioplayer.play();
}; };
audioplayer.stop(); audioplayer.on('play', (err, action) => {
if (err) {
console.info('Error returned in the play() callback.');
return;
}
console.info('Start to pause audio playback.');
audioplayer.pause();
};
audioplayer.on('stop', (err, action) => {
if (err) {
console.info('Error returned in the stop() callback.');
return;
}
console.info('Succeeded in stopping audio playback.');
};
audioplayer.src = 'common/mydream.mp3';
``` ```
### seek\(number\)<a name="en-us_topic_0000001103383404_section1387113816298"></a> ### seek\(number\)<a name="section1387113816298"></a>
Goes to a specified playback position. Goes to a specified playback position.
**Parameters** **Parameters**
<a name="en-us_topic_0000001103383404_table1442723852917"></a> <a name="table1442723852917"></a>
<table><thead align="left"><tr id="en-us_topic_0000001103383404_row84261138172911"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="en-us_topic_0000001103383404_p204261938182919"><a name="en-us_topic_0000001103383404_p204261938182919"></a><a name="en-us_topic_0000001103383404_p204261938182919"></a>Name</p> <table><thead align="left"><tr id="row84261138172911"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p204261938182919"><a name="p204261938182919"></a><a name="p204261938182919"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="12.02%" id="mcps1.1.5.1.2"><p id="en-us_topic_0000001103383404_p1342683842920"><a name="en-us_topic_0000001103383404_p1342683842920"></a><a name="en-us_topic_0000001103383404_p1342683842920"></a>Type</p> <th class="cellrowborder" valign="top" width="12.02%" id="mcps1.1.5.1.2"><p id="p1342683842920"><a name="p1342683842920"></a><a name="p1342683842920"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="en-us_topic_0000001103383404_p134260383297"><a name="en-us_topic_0000001103383404_p134260383297"></a><a name="en-us_topic_0000001103383404_p134260383297"></a>Mandatory</p> <th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="p134260383297"><a name="p134260383297"></a><a name="p134260383297"></a>Mandatory</p>
</th> </th>
<th class="cellrowborder" valign="top" width="62.89%" id="mcps1.1.5.1.4"><p id="en-us_topic_0000001103383404_p442663832912"><a name="en-us_topic_0000001103383404_p442663832912"></a><a name="en-us_topic_0000001103383404_p442663832912"></a>Description</p> <th class="cellrowborder" valign="top" width="62.89%" id="mcps1.1.5.1.4"><p id="p442663832912"><a name="p442663832912"></a><a name="p442663832912"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001103383404_row18427738202910"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001103383404_p184261338192913"><a name="en-us_topic_0000001103383404_p184261338192913"></a><a name="en-us_topic_0000001103383404_p184261338192913"></a>timeMs</p> <tbody><tr id="row18427738202910"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p184261338192913"><a name="p184261338192913"></a><a name="p184261338192913"></a>timeMs</p>
</td> </td>
<td class="cellrowborder" valign="top" width="12.02%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001103383404_p1242643819295"><a name="en-us_topic_0000001103383404_p1242643819295"></a><a name="en-us_topic_0000001103383404_p1242643819295"></a>number</p> <td class="cellrowborder" valign="top" width="12.02%" headers="mcps1.1.5.1.2 "><p id="p1242643819295"><a name="p1242643819295"></a><a name="p1242643819295"></a>number</p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001103383404_p44261838112918"><a name="en-us_topic_0000001103383404_p44261838112918"></a><a name="en-us_topic_0000001103383404_p44261838112918"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p44261838112918"><a name="p44261838112918"></a><a name="p44261838112918"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="62.89%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001103383404_p16427163812913"><a name="en-us_topic_0000001103383404_p16427163812913"></a><a name="en-us_topic_0000001103383404_p16427163812913"></a>Target playback position</p> <td class="cellrowborder" valign="top" width="62.89%" headers="mcps1.1.5.1.4 "><p id="p16427163812913"><a name="p16427163812913"></a><a name="p16427163812913"></a>Target playback position</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
...@@ -233,46 +268,58 @@ Goes to a specified playback position. ...@@ -233,46 +268,58 @@ Goes to a specified playback position.
**Example** **Example**
``` ```
audioplayer.src = 'common/mydream.mp3'; audioplayer.on('dataload', (err, action) => {
audioplayer.on('timeupdate', (err, action) => {
if (err) { if (err) {
console.log(`err returned in seek() callback`); console.info('Error returned in the prepare() callback.');
return; return;
} }
console.info('Start to play the audio.');
audioplayer.play();
};
audioplayer.on('play', (err, action) => {
if (err) {
console.info('Error returned in the play() callback.');
return;
}
console.info('Succeeded in playing the audio.')
};
audioplayer.on('timeUpdate', (seekTime, action) => {
console.info('Seek time returned in the seek() callback: ' + seekTime);
var newTime = audioplayer.currenTime; var newTime = audioplayer.currenTime;
if(newTime = 30000) { if(newTime == 30000) {
console.info('Seek success, new time : ' + newTime); console.info('Seek succeeded. New time: ' + newTime);
} else { } else {
console.info('Seek Failed'); console.info('Seek failed.');
} }
}; };
audioplayer.src = 'common/mydream.mp3';
audioplayer.seek(30000); audioplayer.seek(30000);
``` ```
### setVolume\(number\)<a name="en-us_topic_0000001103383404_section164235176552"></a> ### setVolume\(number\)<a name="section164235176552"></a>
Sets the volume. Sets the volume.
**Parameters** **Parameters**
<a name="en-us_topic_0000001103383404_table1242391713555"></a> <a name="table1242391713555"></a>
<table><thead align="left"><tr id="en-us_topic_0000001103383404_row14424217195517"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="en-us_topic_0000001103383404_p1424917135519"><a name="en-us_topic_0000001103383404_p1424917135519"></a><a name="en-us_topic_0000001103383404_p1424917135519"></a>Name</p> <table><thead align="left"><tr id="row14424217195517"><th class="cellrowborder" valign="top" width="17.57%" id="mcps1.1.5.1.1"><p id="p1424917135519"><a name="p1424917135519"></a><a name="p1424917135519"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="12.02%" id="mcps1.1.5.1.2"><p id="en-us_topic_0000001103383404_p10424121795520"><a name="en-us_topic_0000001103383404_p10424121795520"></a><a name="en-us_topic_0000001103383404_p10424121795520"></a>Type</p> <th class="cellrowborder" valign="top" width="12.02%" id="mcps1.1.5.1.2"><p id="p10424121795520"><a name="p10424121795520"></a><a name="p10424121795520"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="en-us_topic_0000001103383404_p1042415178559"><a name="en-us_topic_0000001103383404_p1042415178559"></a><a name="en-us_topic_0000001103383404_p1042415178559"></a>Mandatory</p> <th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.5.1.3"><p id="p1042415178559"><a name="p1042415178559"></a><a name="p1042415178559"></a>Mandatory</p>
</th> </th>
<th class="cellrowborder" valign="top" width="62.89%" id="mcps1.1.5.1.4"><p id="en-us_topic_0000001103383404_p13424717125513"><a name="en-us_topic_0000001103383404_p13424717125513"></a><a name="en-us_topic_0000001103383404_p13424717125513"></a>Description</p> <th class="cellrowborder" valign="top" width="62.89%" id="mcps1.1.5.1.4"><p id="p13424717125513"><a name="p13424717125513"></a><a name="p13424717125513"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001103383404_row13424171745513"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="en-us_topic_0000001103383404_p204241517125517"><a name="en-us_topic_0000001103383404_p204241517125517"></a><a name="en-us_topic_0000001103383404_p204241517125517"></a>vol</p> <tbody><tr id="row13424171745513"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.1.5.1.1 "><p id="p204241517125517"><a name="p204241517125517"></a><a name="p204241517125517"></a>vol</p>
</td> </td>
<td class="cellrowborder" valign="top" width="12.02%" headers="mcps1.1.5.1.2 "><p id="en-us_topic_0000001103383404_p18424121755517"><a name="en-us_topic_0000001103383404_p18424121755517"></a><a name="en-us_topic_0000001103383404_p18424121755517"></a>number</p> <td class="cellrowborder" valign="top" width="12.02%" headers="mcps1.1.5.1.2 "><p id="p18424121755517"><a name="p18424121755517"></a><a name="p18424121755517"></a>number</p>
</td> </td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="en-us_topic_0000001103383404_p2042417176554"><a name="en-us_topic_0000001103383404_p2042417176554"></a><a name="en-us_topic_0000001103383404_p2042417176554"></a>Yes</p> <td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.5.1.3 "><p id="p2042417176554"><a name="p2042417176554"></a><a name="p2042417176554"></a>Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="62.89%" headers="mcps1.1.5.1.4 "><p id="en-us_topic_0000001103383404_p9424171717557"><a name="en-us_topic_0000001103383404_p9424171717557"></a><a name="en-us_topic_0000001103383404_p9424171717557"></a>Volume to set</p> <td class="cellrowborder" valign="top" width="62.89%" headers="mcps1.1.5.1.4 "><p id="p9424171717557"><a name="p9424171717557"></a><a name="p9424171717557"></a>Volume to set. The value ranges from 0 to 1.</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
...@@ -281,18 +328,58 @@ Sets the volume. ...@@ -281,18 +328,58 @@ Sets the volume.
**Example** **Example**
``` ```
audioplayer.src = 'common/mydream.mp3'; audioplayer.on('dataload', (err, action) => {
if (err) {
console.error('Error returned in the prepare() callback.');
return;
}
console.info('Start to play the audio.');
audioplayer.play();
};
audioplayer.on('play', (err, action) => {
if (err) {
console.error('Error returned in the play() callback.');
return;
}
console.info('Succeeded in playing the audio.')
};
audioplayer.on('volumeChange', (err, action) => { audioplayer.on('volumeChange', (err, action) => {
if (err) { if (err) {
console.log(`err returned in setVolume() callback`); console.error('Error returned in the setVolume() callback.');
return;
}
console.info('Playback volume changed.');
};
audioplayer.src = 'common/mydream.mp3';
audioplayer.setVolume(0.5);
```
### reset\(\)<sup>7+</sup><a name="section1473283011356"></a>
Switches the audio resource to be played.
**Example**
```
audioplayer.on('dataload', (err, action) => {
if (err) {
console.error('Error returned in the prepare() callback.');
return; return;
} }
console.log('playback volume change'); console.info('Start to reset audio playback.');
audioplayer.reset();
}; };
audioplayer.setVolume(30); audioplayer.on('reset', (err, action) => {
if (err) {
console.error('Error returned in the reset() callback.');
return;
}
console.info('Reset succeeded.');
};
audioplayer.src = 'common/mydream.mp3';
``` ```
### release\(\)<a name="en-us_topic_0000001103383404_section9224621145512"></a> ### release\(\)<a name="section9224621145512"></a>
Releases audio resources. Releases audio resources.
...@@ -302,83 +389,88 @@ Releases audio resources. ...@@ -302,83 +389,88 @@ Releases audio resources.
audioplay.release(); audioplay.release();
``` ```
### Events<a name="en-us_topic_0000001103383404_section5453721192911"></a> ### Events<a name="section5453721192911"></a>
### play<a name="en-us_topic_0000001103383404_section87307411494"></a> ### play<a name="section87307411494"></a>
Triggered when **play\(\)** is called Triggered when **play\(\)** is called
### pause<a name="en-us_topic_0000001103383404_section198217471590"></a> ### pause<a name="section198217471590"></a>
Triggered when **pause\(\)** is called Triggered when **pause\(\)** is called
### stop<a name="en-us_topic_0000001103383404_section437616531910"></a> ### stop<a name="section437616531910"></a>
Triggered when **stop\(\)** is called Triggered when **stop\(\)** is called
### dataLoad<a name="en-us_topic_0000001103383404_section982114219106"></a> ### dataLoad<a name="section982114219106"></a>
Triggered when audio data is loaded Triggered when audio data is loaded
### timeUpdate<a name="en-us_topic_0000001103383404_section13687114181014"></a> ### timeUpdate<a name="section13687114181014"></a>
Triggered when the playback position changes Triggered when the playback position changes
### volumeChange<a name="en-us_topic_0000001103383404_section139227715717"></a> ### volumeChange<a name="section139227715717"></a>
Triggered when playback volume changes Triggered when playback volume changes
### finish<a name="en-us_topic_0000001103383404_section15181321181018"></a> ### finish<a name="section15181321181018"></a>
Triggered when playback is finished Triggered when playback is finished
### error<a name="en-us_topic_0000001103383404_section5593132921016"></a> ### error<a name="section5593132921016"></a>
Triggered when a playback error occurs Triggered when a playback error occurs
<a name="en-us_topic_0000001103383404_table24591722143619"></a> <a name="table24591722143619"></a>
<table><thead align="left"><tr id="en-us_topic_0000001103383404_row1945962219364"><th class="cellrowborder" valign="top" width="24.060000000000002%" id="mcps1.1.4.1.1"><p id="en-us_topic_0000001103383404_p84591522103610"><a name="en-us_topic_0000001103383404_p84591522103610"></a><a name="en-us_topic_0000001103383404_p84591522103610"></a>Parameter</p> <table><thead align="left"><tr id="row1945962219364"><th class="cellrowborder" valign="top" width="24.060000000000002%" id="mcps1.1.4.1.1"><p id="p84591522103610"><a name="p84591522103610"></a><a name="p84591522103610"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="25.25%" id="mcps1.1.4.1.2"><p id="en-us_topic_0000001103383404_p11459102243616"><a name="en-us_topic_0000001103383404_p11459102243616"></a><a name="en-us_topic_0000001103383404_p11459102243616"></a>Type</p> <th class="cellrowborder" valign="top" width="25.25%" id="mcps1.1.4.1.2"><p id="p11459102243616"><a name="p11459102243616"></a><a name="p11459102243616"></a>Type</p>
</th> </th>
<th class="cellrowborder" valign="top" width="50.690000000000005%" id="mcps1.1.4.1.3"><p id="en-us_topic_0000001103383404_p14591922113616"><a name="en-us_topic_0000001103383404_p14591922113616"></a><a name="en-us_topic_0000001103383404_p14591922113616"></a>Description</p> <th class="cellrowborder" valign="top" width="50.690000000000005%" id="mcps1.1.4.1.3"><p id="p14591922113616"><a name="p14591922113616"></a><a name="p14591922113616"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001103383404_row2459622183611"><td class="cellrowborder" valign="top" width="24.060000000000002%" headers="mcps1.1.4.1.1 "><p id="en-us_topic_0000001103383404_p17338122234119"><a name="en-us_topic_0000001103383404_p17338122234119"></a><a name="en-us_topic_0000001103383404_p17338122234119"></a>callback</p> <tbody><tr id="row2459622183611"><td class="cellrowborder" valign="top" width="24.060000000000002%" headers="mcps1.1.4.1.1 "><p id="p17338122234119"><a name="p17338122234119"></a><a name="p17338122234119"></a>callback</p>
</td> </td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.1.4.1.2 "><p id="en-us_topic_0000001103383404_p174601822193612"><a name="en-us_topic_0000001103383404_p174601822193612"></a><a name="en-us_topic_0000001103383404_p174601822193612"></a>ErrorCallback</p> <td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.1.4.1.2 "><p id="p174601822193612"><a name="p174601822193612"></a><a name="p174601822193612"></a>ErrorCallback</p>
</td> </td>
<td class="cellrowborder" valign="top" width="50.690000000000005%" headers="mcps1.1.4.1.3 "><p id="en-us_topic_0000001103383404_p7460222123612"><a name="en-us_topic_0000001103383404_p7460222123612"></a><a name="en-us_topic_0000001103383404_p7460222123612"></a>Callback function for handling this event</p> <td class="cellrowborder" valign="top" width="50.690000000000005%" headers="mcps1.1.4.1.3 "><p id="p7460222123612"><a name="p7460222123612"></a><a name="p7460222123612"></a>Callback function for handling this event</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
## AudioState<a name="en-us_topic_0000001103383404_section5181155710523"></a> ## AudioState<a name="section5181155710523"></a>
Describes playback status. Describes playback status.
<a name="en-us_topic_0000001103383404_table919114616314"></a> <a name="table919114616314"></a>
<table><thead align="left"><tr id="en-us_topic_0000001103383404_row31917610318"><th class="cellrowborder" valign="top" width="33.739999999999995%" id="mcps1.1.3.1.1"><p id="en-us_topic_0000001103383404_p219196531"><a name="en-us_topic_0000001103383404_p219196531"></a><a name="en-us_topic_0000001103383404_p219196531"></a>Parameter</p> <table><thead align="left"><tr id="row31917610318"><th class="cellrowborder" valign="top" width="33.739999999999995%" id="mcps1.1.3.1.1"><p id="p219196531"><a name="p219196531"></a><a name="p219196531"></a>Name</p>
</th> </th>
<th class="cellrowborder" valign="top" width="66.25999999999999%" id="mcps1.1.3.1.2"><p id="en-us_topic_0000001103383404_p14191563313"><a name="en-us_topic_0000001103383404_p14191563313"></a><a name="en-us_topic_0000001103383404_p14191563313"></a>Description</p> <th class="cellrowborder" valign="top" width="66.25999999999999%" id="mcps1.1.3.1.2"><p id="p14191563313"><a name="p14191563313"></a><a name="p14191563313"></a>Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="en-us_topic_0000001103383404_row2019146539"><td class="cellrowborder" valign="top" width="33.739999999999995%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0000001103383404_p201913617311"><a name="en-us_topic_0000001103383404_p201913617311"></a><a name="en-us_topic_0000001103383404_p201913617311"></a>playing</p> <tbody><tr id="row3427194315719"><td class="cellrowborder" valign="top" width="33.739999999999995%" headers="mcps1.1.3.1.1 "><p id="p642711431172"><a name="p642711431172"></a><a name="p642711431172"></a>idle</p>
</td>
<td class="cellrowborder" valign="top" width="66.25999999999999%" headers="mcps1.1.3.1.2 "><p id="p24281543777"><a name="p24281543777"></a><a name="p24281543777"></a>Audio playback is idle.</p>
</td>
</tr>
<tr id="row2019146539"><td class="cellrowborder" valign="top" width="33.739999999999995%" headers="mcps1.1.3.1.1 "><p id="p201913617311"><a name="p201913617311"></a><a name="p201913617311"></a>playing</p>
</td> </td>
<td class="cellrowborder" valign="top" width="66.25999999999999%" headers="mcps1.1.3.1.2 "><p id="en-us_topic_0000001103383404_p81911362316"><a name="en-us_topic_0000001103383404_p81911362316"></a><a name="en-us_topic_0000001103383404_p81911362316"></a>The audio is being played.</p> <td class="cellrowborder" valign="top" width="66.25999999999999%" headers="mcps1.1.3.1.2 "><p id="p81911362316"><a name="p81911362316"></a><a name="p81911362316"></a>The audio is being played.</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001103383404_row11912612316"><td class="cellrowborder" valign="top" width="33.739999999999995%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0000001103383404_p9191136731"><a name="en-us_topic_0000001103383404_p9191136731"></a><a name="en-us_topic_0000001103383404_p9191136731"></a>paused</p> <tr id="row11912612316"><td class="cellrowborder" valign="top" width="33.739999999999995%" headers="mcps1.1.3.1.1 "><p id="p9191136731"><a name="p9191136731"></a><a name="p9191136731"></a>paused</p>
</td> </td>
<td class="cellrowborder" valign="top" width="66.25999999999999%" headers="mcps1.1.3.1.2 "><p id="en-us_topic_0000001103383404_p419166738"><a name="en-us_topic_0000001103383404_p419166738"></a><a name="en-us_topic_0000001103383404_p419166738"></a>Audio playback is paused.</p> <td class="cellrowborder" valign="top" width="66.25999999999999%" headers="mcps1.1.3.1.2 "><p id="p419166738"><a name="p419166738"></a><a name="p419166738"></a>Audio playback is paused.</p>
</td> </td>
</tr> </tr>
<tr id="en-us_topic_0000001103383404_row111912617314"><td class="cellrowborder" valign="top" width="33.739999999999995%" headers="mcps1.1.3.1.1 "><p id="en-us_topic_0000001103383404_p9191156333"><a name="en-us_topic_0000001103383404_p9191156333"></a><a name="en-us_topic_0000001103383404_p9191156333"></a>stopped</p> <tr id="row111912617314"><td class="cellrowborder" valign="top" width="33.739999999999995%" headers="mcps1.1.3.1.1 "><p id="p9191156333"><a name="p9191156333"></a><a name="p9191156333"></a>stopped</p>
</td> </td>
<td class="cellrowborder" valign="top" width="66.25999999999999%" headers="mcps1.1.3.1.2 "><p id="en-us_topic_0000001103383404_p2019215618316"><a name="en-us_topic_0000001103383404_p2019215618316"></a><a name="en-us_topic_0000001103383404_p2019215618316"></a>Audio playback is stopped.</p> <td class="cellrowborder" valign="top" width="66.25999999999999%" headers="mcps1.1.3.1.2 "><p id="p2019215618316"><a name="p2019215618316"></a><a name="p2019215618316"></a>Audio playback is stopped.</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
......
en/application-dev/media/development-guidelines-on-audio-playback.md
浏览文件 @ 83fcc63e
...@@ -63,6 +63,11 @@ You use audio playback APIs to convert audio data into audible analog signals, p ...@@ -63,6 +63,11 @@ You use audio playback APIs to convert audio data into audible analog signals, p
<td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p1140814471274"><a name="p1140814471274"></a><a name="p1140814471274"></a>Stops playback.</p> <td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p1140814471274"><a name="p1140814471274"></a><a name="p1140814471274"></a>Stops playback.</p>
</td> </td>
</tr> </tr>
<tr id="row93063645415"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p230715618541"><a name="p230715618541"></a><a name="p230715618541"></a>reset()<sup id="sup15868135520538"><a name="sup15868135520538"></a><a name="sup15868135520538"></a>7+</sup></p>
</td>
<td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p530714615545"><a name="p530714615545"></a><a name="p530714615545"></a>Resets the audio source to be played.</p>
</td>
</tr>
<tr id="row36221450105715"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p162210506572"><a name="p162210506572"></a><a name="p162210506572"></a>setVolume(vol: number)</p> <tr id="row36221450105715"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p162210506572"><a name="p162210506572"></a><a name="p162210506572"></a>setVolume(vol: number)</p>
</td> </td>
<td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p166221550165720"><a name="p166221550165720"></a><a name="p166221550165720"></a>Sets playback volume.</p> <td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p166221550165720"><a name="p166221550165720"></a><a name="p166221550165720"></a>Sets playback volume.</p>
...@@ -78,17 +83,12 @@ You use audio playback APIs to convert audio data into audible analog signals, p ...@@ -78,17 +83,12 @@ You use audio playback APIs to convert audio data into audible analog signals, p
<td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p1040814782716"><a name="p1040814782716"></a><a name="p1040814782716"></a>Defines the URI of an audio file to play.</p> <td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p1040814782716"><a name="p1040814782716"></a><a name="p1040814782716"></a>Defines the URI of an audio file to play.</p>
</td> </td>
</tr> </tr>
<tr id="row155026127182"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p5503812121819"><a name="p5503812121819"></a><a name="p5503812121819"></a>state:string</p> <tr id="row155026127182"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p633012347"><a name="p633012347"></a><a name="p633012347"></a>state:AudioState</p>
</td> </td>
<td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p105031612141811"><a name="p105031612141811"></a><a name="p105031612141811"></a>Defines a playback state.</p> <td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p105031612141811"><a name="p105031612141811"></a><a name="p105031612141811"></a>Defines a playback state.</p>
</td> </td>
</tr> </tr>
<tr id="row19408114732719"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p12209729141817"><a name="p12209729141817"></a><a name="p12209729141817"></a>autoplay:boolean</p> <tr id="row340854714273"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p16234263330"><a name="p16234263330"></a><a name="p16234263330"></a>currentTime:number</p>
</td>
<td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p19189929171811"><a name="p19189929171811"></a><a name="p19189929171811"></a>Defines whether playback starts automatically.</p>
</td>
</tr>
<tr id="row340854714273"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p1840914712277"><a name="p1840914712277"></a><a name="p1840914712277"></a>currenttime:number</p>
</td> </td>
<td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p3409174762710"><a name="p3409174762710"></a><a name="p3409174762710"></a>Defines the current playback position.</p> <td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p3409174762710"><a name="p3409174762710"></a><a name="p3409174762710"></a>Defines the current playback position.</p>
</td> </td>
...@@ -103,11 +103,6 @@ You use audio playback APIs to convert audio data into audible analog signals, p ...@@ -103,11 +103,6 @@ You use audio playback APIs to convert audio data into audible analog signals, p
<td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p94091847102711"><a name="p94091847102711"></a><a name="p94091847102711"></a>Defines whether to loop audio playback.</p> <td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p94091847102711"><a name="p94091847102711"></a><a name="p94091847102711"></a>Defines whether to loop audio playback.</p>
</td> </td>
</tr> </tr>
<tr id="row19915911171916"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p20915111121918"><a name="p20915111121918"></a><a name="p20915111121918"></a>muted:boolean</p>
</td>
<td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p12915211131910"><a name="p12915211131910"></a><a name="p12915211131910"></a>Defines whether to mute the audio.</p>
</td>
</tr>
<tr id="row44091647192718"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p18937155862412"><a name="p18937155862412"></a><a name="p18937155862412"></a>on('play', function callback)</p> <tr id="row44091647192718"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p18937155862412"><a name="p18937155862412"></a><a name="p18937155862412"></a>on('play', function callback)</p>
</td> </td>
<td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p13409164722717"><a name="p13409164722717"></a><a name="p13409164722717"></a>Listens for the playback start event.</p> <td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p13409164722717"><a name="p13409164722717"></a><a name="p13409164722717"></a>Listens for the playback start event.</p>
...@@ -123,7 +118,12 @@ You use audio playback APIs to convert audio data into audible analog signals, p ...@@ -123,7 +118,12 @@ You use audio playback APIs to convert audio data into audible analog signals, p
<td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p1409164772714"><a name="p1409164772714"></a><a name="p1409164772714"></a>Listens for the playback stop event.</p> <td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p1409164772714"><a name="p1409164772714"></a><a name="p1409164772714"></a>Listens for the playback stop event.</p>
</td> </td>
</tr> </tr>
<tr id="row11409747202711"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p189901420102514"><a name="p189901420102514"></a><a name="p189901420102514"></a>on('ended',function callback)</p> <tr id="row712184163016"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p1167517115311"><a name="p1167517115311"></a><a name="p1167517115311"></a>on('reset', function callback)</p>
</td>
<td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p1113134115301"><a name="p1113134115301"></a><a name="p1113134115301"></a>Listens for the playback reset event.</p>
</td>
</tr>
<tr id="row11409747202711"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p189901420102514"><a name="p189901420102514"></a><a name="p189901420102514"></a>on('finish',function callback)</p>
</td> </td>
<td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p8410124742713"><a name="p8410124742713"></a><a name="p8410124742713"></a>Listens for the playback end event.</p> <td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p8410124742713"><a name="p8410124742713"></a><a name="p8410124742713"></a>Listens for the playback end event.</p>
</td> </td>
...@@ -133,7 +133,7 @@ You use audio playback APIs to convert audio data into audible analog signals, p ...@@ -133,7 +133,7 @@ You use audio playback APIs to convert audio data into audible analog signals, p
<td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p54101047102712"><a name="p54101047102712"></a><a name="p54101047102712"></a>Listens for the playback error event.</p> <td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p54101047102712"><a name="p54101047102712"></a><a name="p54101047102712"></a>Listens for the playback error event.</p>
</td> </td>
</tr> </tr>
<tr id="row1410154715273"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p135217361257"><a name="p135217361257"></a><a name="p135217361257"></a>on('loaderdata', function callback)</p> <tr id="row1410154715273"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p135217361257"><a name="p135217361257"></a><a name="p135217361257"></a>on('dataload', function callback)</p>
</td> </td>
<td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p1541054719271"><a name="p1541054719271"></a><a name="p1541054719271"></a>Listens for the data loading event.</p> <td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p1541054719271"><a name="p1541054719271"></a><a name="p1541054719271"></a>Listens for the data loading event.</p>
</td> </td>
...@@ -143,7 +143,7 @@ You use audio playback APIs to convert audio data into audible analog signals, p ...@@ -143,7 +143,7 @@ You use audio playback APIs to convert audio data into audible analog signals, p
<td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p116527483584"><a name="p116527483584"></a><a name="p116527483584"></a>Listens for the volume change event.</p> <td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p116527483584"><a name="p116527483584"></a><a name="p116527483584"></a>Listens for the volume change event.</p>
</td> </td>
</tr> </tr>
<tr id="row1410124732711"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p942310426254"><a name="p942310426254"></a><a name="p942310426254"></a>on('timeupdate', function callback)</p> <tr id="row1410124732711"><td class="cellrowborder" valign="top" width="42.980000000000004%" headers="mcps1.2.3.1.1 "><p id="p942310426254"><a name="p942310426254"></a><a name="p942310426254"></a>on('timeUpdate', function callback)</p>
</td> </td>
<td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p18410144715271"><a name="p18410144715271"></a><a name="p18410144715271"></a>Listens for the progress change event.</p> <td class="cellrowborder" valign="top" width="57.02%" headers="mcps1.2.3.1.2 "><p id="p18410144715271"><a name="p18410144715271"></a><a name="p18410144715271"></a>Listens for the progress change event.</p>
</td> </td>
...@@ -162,73 +162,70 @@ You use audio playback APIs to convert audio data into audible analog signals, p ...@@ -162,73 +162,70 @@ You use audio playback APIs to convert audio data into audible analog signals, p
``` ```
player.on('play', (err, action) => { player.on('play', (err, action) => {
if (err) { if (err) {
console.log(`err returned in play() callback`); console.error('Error returned in the play() callback.');
return; return;
} }
console.info('Current Song duration: '+duration); console.info('Current player duration: '+ player.duration);
console.log(`In play callback current time: ${player.currentTime}`); console.info('Current player time: ' + player.currentTime);
console.info('Current Player Status: '+player.state); console.info('Current player status: '+player.state);
console.info('Pause Mp3'); console.info('Pause MP3');
player.pause(); player.pause();
}); });
player.on('pause', (err, action) => { player.on('pause', (err, action) => {
if (err) { if (err) {
console.log(`err returned in pause() callback`); console.error('Error returned in the pause() callback.');
return; return;
} }
console.log(`pause callback, state: ${player.state}`); console.info('Current player status: ' + player.state);
console.info('Current Player Status: '+player.state); console.info('Current player time: ' + player.currentTime);
var currentTime = player.currenTime; player.seek(30000); // Seek for 30 seconds.
console.info('Current Player Time: '+currentTime);
player.seek(30000); //seek for 30 seconds
}); });
player.on('stop', (err, action) => { player.on('stop', (err, action) => {
if (err) { if (err) {
console.log(`err returned in stop() callback`); console.error('Error returned in the stop() callback.');
return; return;
} }
console.log(`stop callback, state: ${player.state}`); console.info('stop callback invoked. State:' + player.state);
player.reset();
}); });
player.on('dataLoad', (err, action) => { player.on('dataLoad', (err, action) => {
if (err) { if (err) {
console.log(`err returned in dataLoad() callback`); console.error('Error returned in the dataLoad() callback.');
return; return;
} }
console.log(`dataLoad callback is called, current time: ${player.currentTime}`); console.info('dataLoad callback invoked. Current time: ' + player.currentTime);
console.log(`Duration of the source: ${player.duration}`); console.info('Duration of the source:' + player.duration);
player.play();
});
player.on('reset', (err, action) => {
if (err) {
console.error('Error returned in the reset() callback.');
return;
}
console.info('reset callback invoked.');
player.release();
}); });
player.on('finish', (err, action) => { player.on('finish', (err, action) => {
if (err) { if (err) {
console.log(`err returned in finish() callback`); console.error('Error returned in the finish() callback.');
return; return;
} }
console.log(`Player finish callback is called`); console.info('finish callback invoked.');
}); });
player.on('timeUpdate', (err, action) => { player.on('timeUpdate', (seekTime, action) => {
if (err) { console.info('Seek time: ' + seekTime);
console.log(`err returned in timeUpdate() callback`); console.info('Current player time: ' + player.currentTime);
return;
}
console.log(`In timeupdate callback current time: ${player.currentTime}`);
var newTime = player.currentTime; var newTime = player.currentTime;
if(newTime = 30000) { if(newTime == 30000) {
console.info('Seek success, new time : '+newTime); console.info('Seek succeeded. New time: ' + newTime);
} else { } else {
console.info('Seek Failed'); console.error('Seek failed: ', + newTime);
} }
player.stop(); player.stop();
}); });
player.on('durationchange', (err, action) => {
if (err) {
console.log(`err returned in durationchange callback`);
return;
}
console.log(`Durationchange callback is called`);
});
player.on('error', (err) => { player.on('error', (err) => {
console.error(`player error: ${err.message}`); console.error('Player error: ${err.message}');
}); });
``` ```
3. Start playback. 3. Start playback.
...@@ -237,7 +234,6 @@ You use audio playback APIs to convert audio data into audible analog signals, p ...@@ -237,7 +234,6 @@ You use audio playback APIs to convert audio data into audible analog signals, p
var audioSourceMp3 = 'file://test.mp3'; var audioSourceMp3 = 'file://test.mp3';
player.src = audioSourceMp3; player.src = audioSourceMp3;
player.loop = true; player.loop = true;
player.play();
``` ```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或