未验证 提交 3c5bf894 编写于 作者: O openharmony_ci 提交者: Gitee

!5703 add special description for audio set/getAudioParameter api

Merge pull request !5703 from AOL/master
......@@ -1146,6 +1146,8 @@ setAudioParameter(key: string, value: string, callback: AsyncCallback<void&gt
Sets an audio parameter. This API uses an asynchronous callback to return the result.
This API is used to extend the audio configuration based on the hardware capability. The supported audio parameters vary according to the device and can be obtained from the device manual. The example below is for reference only.
**System capability**: SystemCapability.Multimedia.Audio.Core
**Parameters**
......@@ -1159,7 +1161,7 @@ Sets an audio parameter. This API uses an asynchronous callback to return the re
**Example**
```
audioManager.setAudioParameter('PBits per sample', '8 bit', (err) => {
audioManager.setAudioParameter('key_example', 'value_example', (err) => {
if (err) {
console.error('Failed to set the audio parameter. ${err.message}');
return;
......@@ -1174,6 +1176,8 @@ setAudioParameter(key: string, value: string): Promise<void>
Sets an audio parameter. This API uses a promise to return the result.
This API is used to extend the audio configuration based on the hardware capability. The supported audio parameters vary according to the device and can be obtained from the device manual. The example below is for reference only.
**System capability**: SystemCapability.Multimedia.Audio.Core
**Parameters**
......@@ -1192,7 +1196,7 @@ Sets an audio parameter. This API uses a promise to return the result.
**Example**
```
audioManager.setAudioParameter('PBits per sample', '8 bit').then(() => {
audioManager.setAudioParameter('key_example', 'value_example').then(() => {
console.log('Promise returned to indicate a successful setting of the audio parameter.');
});
```
......@@ -1203,6 +1207,8 @@ getAudioParameter(key: string, callback: AsyncCallback<string>): void
Obtains the value of an audio parameter. This API uses an asynchronous callback to return the result.
This API is used to extend the audio configuration based on the hardware capability. The supported audio parameters vary according to the device and can be obtained from the device manual. The example below is for reference only.
**System capability**: SystemCapability.Multimedia.Audio.Core
**Parameters**
......@@ -1215,7 +1221,7 @@ Obtains the value of an audio parameter. This API uses an asynchronous callback
**Example**
```
audioManager.getAudioParameter('PBits per sample', (err, value) => {
audioManager.getAudioParameter('key_example', (err, value) => {
if (err) {
console.error('Failed to obtain the value of the audio parameter. ${err.message}');
return;
......@@ -1230,6 +1236,8 @@ getAudioParameter(key: string): Promise<string>
Obtains the value of an audio parameter. This API uses a promise to return the result.
This API is used to extend the audio configuration based on the hardware capability. The supported audio parameters vary according to the device and can be obtained from the device manual. The example below is for reference only.
**System capability**: SystemCapability.Multimedia.Audio.Core
**Parameters**
......@@ -1247,7 +1255,7 @@ Obtains the value of an audio parameter. This API uses a promise to return the r
**Example**
```
audioManager.getAudioParameter('PBits per sample').then((value) => {
audioManager.getAudioParameter('key_example').then((value) => {
console.log('Promise returned to indicate that the value of the audio parameter is obtained.' + value);
});
```
......
......@@ -1146,6 +1146,8 @@ setAudioParameter(key: string, value: string, callback: AsyncCallback<void&gt
音频参数设置,使用callback方式异步返回结果。
本接口的使用场景为根据硬件设备支持能力扩展音频配置。在不同的设备平台上,所支持的音频参数会存在差异。示例代码内使用样例参数,实际支持的音频配置参数见具体设备平台的资料描述。
**系统能力:** SystemCapability.Multimedia.Audio.Core
**参数:**
......@@ -1159,7 +1161,7 @@ setAudioParameter(key: string, value: string, callback: AsyncCallback<void&gt
**示例:**
```
audioManager.setAudioParameter('PBits per sample', '8 bit', (err) => {
audioManager.setAudioParameter('key_example', 'value_example', (err) => {
if (err) {
console.error('Failed to set the audio parameter. ${err.message}');
return;
......@@ -1174,6 +1176,8 @@ setAudioParameter(key: string, value: string): Promise<void>
音频参数设置,使用Promise方式异步返回结果。
本接口的使用场景为根据硬件设备支持能力扩展音频配置。在不同的设备平台上,所支持的音频参数会存在差异。示例代码内使用样例参数,实际支持的音频配置参数见具体设备平台的资料描述。
**系统能力:** SystemCapability.Multimedia.Audio.Core
**参数:**
......@@ -1192,7 +1196,7 @@ setAudioParameter(key: string, value: string): Promise<void>
**示例:**
```
audioManager.setAudioParameter('PBits per sample', '8 bit').then(() => {
audioManager.setAudioParameter('key_example', 'value_example').then(() => {
console.log('Promise returned to indicate a successful setting of the audio parameter.');
});
```
......@@ -1203,6 +1207,8 @@ getAudioParameter(key: string, callback: AsyncCallback<string>): void
获取指定音频参数值,使用callback方式异步返回结果。
本接口的使用场景为根据硬件设备支持能力扩展音频配置。在不同的设备平台上,所支持的音频参数会存在差异。示例代码内使用样例参数,实际支持的音频配置参数见具体设备平台的资料描述。
**系统能力:** SystemCapability.Multimedia.Audio.Core
**参数:**
......@@ -1215,7 +1221,7 @@ getAudioParameter(key: string, callback: AsyncCallback<string>): void
**示例:**
```
audioManager.getAudioParameter('PBits per sample', (err, value) => {
audioManager.getAudioParameter('key_example', (err, value) => {
if (err) {
console.error('Failed to obtain the value of the audio parameter. ${err.message}');
return;
......@@ -1230,6 +1236,8 @@ getAudioParameter(key: string): Promise<string>
获取指定音频参数值,使用Promise方式异步返回结果。
本接口的使用场景为根据硬件设备支持能力扩展音频配置。在不同的设备平台上,所支持的音频参数会存在差异。示例代码内使用样例参数,实际支持的音频配置参数见具体设备平台的资料描述。
**系统能力:** SystemCapability.Multimedia.Audio.Core
**参数:**
......@@ -1247,7 +1255,7 @@ getAudioParameter(key: string): Promise<string>
**示例:**
```
audioManager.getAudioParameter('PBits per sample').then((value) => {
audioManager.getAudioParameter('key_example').then((value) => {
console.log('Promise returned to indicate that the value of the audio parameter is obtained.' + value);
});
```
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册