Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
bc6c32ec
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
bc6c32ec
编写于
3月 24, 2022
作者:
L
lwx1059628
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
updata audio js api
Signed-off-by:
N
lwx1059628
<
liyifan37@huawei.com
>
上级
38d1809c
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
290 addition
and
217 deletion
+290
-217
zh-cn/application-dev/reference/apis/js-apis-audio.md
zh-cn/application-dev/reference/apis/js-apis-audio.md
+290
-217
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-audio.md
浏览文件 @
bc6c32ec
...
@@ -52,6 +52,7 @@ createAudioRenderer(options: AudioRendererOptions, callback: AsyncCallback\<Audi
...
@@ -52,6 +52,7 @@ createAudioRenderer(options: AudioRendererOptions, callback: AsyncCallback\<Audi
**示例:**
**示例:**
```
```
import audio from '@ohos.multimedia.audio';
var audioStreamInfo = {
var audioStreamInfo = {
samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
channels: audio.AudioChannel.CHANNEL_1,
channels: audio.AudioChannel.CHANNEL_1,
...
@@ -72,11 +73,11 @@ var audioRendererOptions = {
...
@@ -72,11 +73,11 @@ var audioRendererOptions = {
audio.createAudioRenderer(audioRendererOptions,(err, data) => {
audio.createAudioRenderer(audioRendererOptions,(err, data) => {
if (err) {
if (err) {
console.error(`AudioRender Created : Error: ${err.message}`);
console.error(`AudioRender
er
Created : Error: ${err.message}`);
}
}
else {
else {
console.info('AudioRender Created : Success : SUCCESS');
console.info('AudioRender
er
Created : Success : SUCCESS');
audioRenderer = data;
let
audioRenderer = data;
}
}
});
});
```
```
...
@@ -104,6 +105,8 @@ createAudioRenderer(options: AudioRendererOptions): Promise<AudioRenderer\>
...
@@ -104,6 +105,8 @@ createAudioRenderer(options: AudioRendererOptions): Promise<AudioRenderer\>
**示例:**
**示例:**
```
```
import audio from '@ohos.multimedia.audio';
var audioStreamInfo = {
var audioStreamInfo = {
samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
channels: audio.AudioChannel.CHANNEL_1,
channels: audio.AudioChannel.CHANNEL_1,
...
@@ -122,7 +125,13 @@ var audioRendererOptions = {
...
@@ -122,7 +125,13 @@ var audioRendererOptions = {
rendererInfo: audioRendererInfo
rendererInfo: audioRendererInfo
}
}
let audioRenderer = await audio.createAudioRenderer(audioRendererOptions);
var audioRenderer;
audio.createAudioRenderer(audioRendererOptions).then((data) => {
audioRenderer = data;
console.info('AudioFrameworkRenderLog: AudioRenderer Created : Success : Stream Type: SUCCESS');
}).catch((err) => {
console.info('AudioFrameworkRenderLog: AudioRenderer Created : ERROR : '+err.message);
});
```
```
## audio.createAudioCapturer<sup>8+</sup>
## audio.createAudioCapturer<sup>8+</sup>
...
@@ -143,6 +152,7 @@ createAudioCapturer(options: AudioCapturerOptions, callback: AsyncCallback<Audio
...
@@ -143,6 +152,7 @@ createAudioCapturer(options: AudioCapturerOptions, callback: AsyncCallback<Audio
**示例:**
**示例:**
```
```
import audio from '@ohos.multimedia.audio';
var audioStreamInfo = {
var audioStreamInfo = {
samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
channels: audio.AudioChannel.CHANNEL_2,
channels: audio.AudioChannel.CHANNEL_2,
...
@@ -166,7 +176,7 @@ audio.createAudioCapturer(audioCapturerOptions,(err, data) => {
...
@@ -166,7 +176,7 @@ audio.createAudioCapturer(audioCapturerOptions,(err, data) => {
}
}
else {
else {
console.info('AudioCapturer Created : Success : SUCCESS');
console.info('AudioCapturer Created : Success : SUCCESS');
audioCapturer = data;
let
audioCapturer = data;
}
}
});
});
```
```
...
@@ -194,6 +204,8 @@ createAudioCapturer(options: AudioCapturerOptions): Promise<AudioCapturer\>
...
@@ -194,6 +204,8 @@ createAudioCapturer(options: AudioCapturerOptions): Promise<AudioCapturer\>
**示例:**
**示例:**
```
```
import audio from '@ohos.multimedia.audio';
var audioStreamInfo = {
var audioStreamInfo = {
samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
channels: audio.AudioChannel.CHANNEL_2,
channels: audio.AudioChannel.CHANNEL_2,
...
@@ -207,11 +219,17 @@ var audioCapturerInfo = {
...
@@ -207,11 +219,17 @@ var audioCapturerInfo = {
}
}
var audioCapturerOptions = {
var audioCapturerOptions = {
streamInfo:
A
udioStreamInfo,
streamInfo:
a
udioStreamInfo,
capturerInfo:
A
udioCapturerInfo
capturerInfo:
a
udioCapturerInfo
}
}
let audioCapturer = await audio.createAudioCapturer(audioCapturerOptions);
var audioCapturer;
audio.createAudioRenderer(audioCapturerOptions).then((data) => {
audioCapturer = data;
console.info('AudioCapturer Created : Success : Stream Type: SUCCESS');
}).catch((err) => {
console.info('AudioCapturer Created : ERROR : '+err.message);
});
```
```
## AudioVolumeType
## AudioVolumeType
...
@@ -641,14 +659,13 @@ setVolume(volumeType: AudioVolumeType, volume: number, callback: AsyncCallback&l
...
@@ -641,14 +659,13 @@ setVolume(volumeType: AudioVolumeType, volume: number, callback: AsyncCallback&l
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.setVolume(audio.AudioVolumeType.MEDIA, 10, (err) => {
audioManager.setVolume(audio.AudioVolumeType.MEDIA, 10, (err)=>{
if (err) {
if (err) {
console.error('Failed to set the volume. ${err.message}');
console.error('Failed to set the volume. ${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate a successful volume setting.');
console.log('Callback invoked to indicate a successful volume setting.');
});
})
```
```
### setVolume
### setVolume
...
@@ -675,10 +692,9 @@ setVolume(volumeType: AudioVolumeType, volume: number): Promise<void>
...
@@ -675,10 +692,9 @@ setVolume(volumeType: AudioVolumeType, volume: number): Promise<void>
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.setVolume(audio.AudioVolumeType.MEDIA, 10).then(() => {
audioManager.setVolume(audio.AudioVolumeType.MEDIA, 10).then(() => {
console.log('Promise returned to indicate a successful volume setting.');
console.log('Promise returned to indicate a successful volume setting.');
})
})
;
```
```
### getVolume
### getVolume
...
@@ -699,14 +715,13 @@ getVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>): v
...
@@ -699,14 +715,13 @@ getVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>): v
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.getVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
audioManager.getVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
if (err) {
if (err) {
console.error('Failed to obtain the volume. ${err.message}');
console.error('Failed to obtain the volume. ${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate that the volume is obtained.');
console.log('Callback invoked to indicate that the volume is obtained.');
})
})
;
```
```
### getVolume
### getVolume
...
@@ -732,10 +747,9 @@ getVolume(volumeType: AudioVolumeType): Promise<number>
...
@@ -732,10 +747,9 @@ getVolume(volumeType: AudioVolumeType): Promise<number>
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.getVolume(audio.AudioVolumeType.MEDIA).then((value) => {
audioManager.getVolume(audio.AudioVolumeType.MEDIA).then((value) => {
console.log('Promise returned to indicate that the volume is obtained.' + value);
console.log('Promise returned to indicate that the volume is obtained.' + value);
})
})
;
```
```
### getMinVolume
### getMinVolume
...
@@ -756,14 +770,13 @@ getMinVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>)
...
@@ -756,14 +770,13 @@ getMinVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>)
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.getMinVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
audioManager.getMinVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
if (err) {
if (err) {
console.error('Failed to obtain the minimum volume. ${err.message}');
console.error('Failed to obtain the minimum volume. ${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate that the minimum volume is obtained.' + value);
console.log('Callback invoked to indicate that the minimum volume is obtained.' + value);
})
})
;
```
```
### getMinVolume
### getMinVolume
...
@@ -789,10 +802,9 @@ getMinVolume(volumeType: AudioVolumeType): Promise<number>
...
@@ -789,10 +802,9 @@ getMinVolume(volumeType: AudioVolumeType): Promise<number>
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.getMinVolume(audio.AudioVolumeType.MEDIA).then((value) => {
audioManager.getMinVolume(audio.AudioVolumeType.MEDIA).then((value) => {
console.log('Promised returned to indicate that the minimum
volume is obtained.' + value);
console.log('Promised returned to indicate that the minimum volume is obtained.' + value);
})
})
;
```
```
### getMaxVolume
### getMaxVolume
...
@@ -813,14 +825,13 @@ getMaxVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>)
...
@@ -813,14 +825,13 @@ getMaxVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>)
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
if (err) {
if (err) {
console.error('Failed to obtain the maximum volume. ${err.message}');
console.error('Failed to obtain the maximum volume. ${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate that the maximum volume is obtained.' + value);
console.log('Callback invoked to indicate that the maximum volume is obtained.' + value);
})
})
;
```
```
### getMaxVolume
### getMaxVolume
...
@@ -846,10 +857,9 @@ getMaxVolume(volumeType: AudioVolumeType): Promise<number>
...
@@ -846,10 +857,9 @@ getMaxVolume(volumeType: AudioVolumeType): Promise<number>
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA).then((data) => {
audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA).then((data) => {
console.log('Promised returned to indicate that the maximum volume is obtained.');
console.log('Promised returned to indicate that the maximum volume is obtained.');
})
})
;
```
```
### mute
### mute
...
@@ -871,14 +881,13 @@ mute(volumeType: AudioVolumeType, mute: boolean, callback: AsyncCallback<void
...
@@ -871,14 +881,13 @@ mute(volumeType: AudioVolumeType, mute: boolean, callback: AsyncCallback<void
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.mute(audio.AudioVolumeType.MEDIA, true, (err) => {
audioManager.mute(audio.AudioVolumeType.MEDIA, true, (err) => {
if (err) {
if (err) {
console.error('Failed to mute the stream. ${err.message}');
console.error('Failed to mute the stream. ${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate that the stream is muted.');
console.log('Callback invoked to indicate that the stream is muted.');
})
})
;
```
```
### mute
### mute
...
@@ -906,10 +915,9 @@ mute(volumeType: AudioVolumeType, mute: boolean): Promise<void>
...
@@ -906,10 +915,9 @@ mute(volumeType: AudioVolumeType, mute: boolean): Promise<void>
```
```
var audioManager = audio.getAudioManager();
audioManager.mute(audio.AudioVolumeType.MEDIA, true).then(() => {
audioManager.mute(audio.AudioVolumeType.MEDIA, true).then(() => {
console.log('Promise returned to indicate that the stream is muted.');
console.log('Promise returned to indicate that the stream is muted.');
})
})
;
```
```
...
@@ -931,14 +939,13 @@ isMute(volumeType: AudioVolumeType, callback: AsyncCallback<boolean>): voi
...
@@ -931,14 +939,13 @@ isMute(volumeType: AudioVolumeType, callback: AsyncCallback<boolean>): voi
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.isMute(audio.AudioVolumeType.MEDIA, (err, value) => {
audioManager.isMute(audio.AudioVolumeType.MEDIA, (err, value) => {
if (err) {
if (err) {
console.error('Failed to obtain the mute status. ${err.message}');
console.error('Failed to obtain the mute status. ${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate that the mute status of the stream is obtained.' + value);
console.log('Callback invoked to indicate that the mute status of the stream is obtained.' + value);
})
})
;
```
```
...
@@ -965,10 +972,9 @@ isMute(volumeType: AudioVolumeType): Promise<boolean>
...
@@ -965,10 +972,9 @@ isMute(volumeType: AudioVolumeType): Promise<boolean>
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.isMute(audio.AudioVolumeType.MEDIA).then((value) => {
audioManager.isMute(audio.AudioVolumeType.MEDIA).then((value) => {
console.log('Promise returned to indicate that the mute status of the stream is obtained.' + value);
console.log('Promise returned to indicate that the mute status of the stream is obtained.' + value);
})
})
;
```
```
### isActive
### isActive
...
@@ -989,14 +995,13 @@ isActive(volumeType: AudioVolumeType, callback: AsyncCallback<boolean>): v
...
@@ -989,14 +995,13 @@ isActive(volumeType: AudioVolumeType, callback: AsyncCallback<boolean>): v
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.isActive(audio.AudioVolumeType.MEDIA, (err, value) => {
audioManager.isActive(audio.AudioVolumeType.MEDIA, (err, value) => {
if (err) {
if (err) {
console.error('Failed to obtain the active status of the stream. ${err.message}');
console.error('Failed to obtain the active status of the stream. ${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate that the active status of the stream is obtained.' + value);
console.log('Callback invoked to indicate that the active status of the stream is obtained.' + value);
})
})
;
```
```
### isActive
### isActive
...
@@ -1022,10 +1027,9 @@ isActive(volumeType: AudioVolumeType): Promise<boolean>
...
@@ -1022,10 +1027,9 @@ isActive(volumeType: AudioVolumeType): Promise<boolean>
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.isActive(audio.AudioVolumeType.MEDIA).then((value) => {
audioManager.isActive(audio.AudioVolumeType.MEDIA).then((value) => {
console.log('Promise returned to indicate that the active status of the stream is obtained.' + value);
console.log('Promise returned to indicate that the active status of the stream is obtained.' + value);
})
})
;
```
```
### setRingerMode
### setRingerMode
...
@@ -1046,14 +1050,13 @@ setRingerMode(mode: AudioRingMode, callback: AsyncCallback<void>): void
...
@@ -1046,14 +1050,13 @@ setRingerMode(mode: AudioRingMode, callback: AsyncCallback<void>): void
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL, (err) => {
audioManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL, (err) => {
if (err) {
if (err) {
console.error('Failed to set the ringer mode. ${err.message}');
console.error('Failed to set the ringer mode.
${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate a successful setting of the ringer mode.');
console.log('Callback invoked to indicate a successful setting of the ringer mode.');
})
})
;
```
```
### setRingerMode
### setRingerMode
...
@@ -1079,10 +1082,9 @@ setRingerMode(mode: AudioRingMode): Promise<void>
...
@@ -1079,10 +1082,9 @@ setRingerMode(mode: AudioRingMode): Promise<void>
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL).then(() => {
audioManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL).then(() => {
console.log('Promise returned to indicate a successful setting of the ringer mode.');
console.log('Promise returned to indicate a successful setting of the ringer mode.');
})
})
;
```
```
...
@@ -1103,14 +1105,13 @@ getRingerMode(callback: AsyncCallback<AudioRingMode>): void
...
@@ -1103,14 +1105,13 @@ getRingerMode(callback: AsyncCallback<AudioRingMode>): void
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.getRingerMode((err, value) => {
audioManager.getRingerMode((err, value) => {
if (err) {
if (err) {
console.error('Failed to obtain the ringer mode.
${err.message}');
console.error('Failed to obtain the ringer mode.
${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate that the ringer mode is obtained.' + value);
console.log('Callback invoked to indicate that the ringer mode is obtained.' + value);
})
})
;
```
```
...
@@ -1131,10 +1132,9 @@ getRingerMode(): Promise<AudioRingMode>
...
@@ -1131,10 +1132,9 @@ getRingerMode(): Promise<AudioRingMode>
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.getRingerMode().then((value) => {
audioManager.getRingerMode().then((value) => {
console.log('Promise returned to indicate that the ringer mode is obtained.' + value);
console.log('Promise returned to indicate that the ringer mode is obtained.' + value);
})
})
;
```
```
### setAudioParameter
### setAudioParameter
...
@@ -1156,14 +1156,13 @@ setAudioParameter(key: string, value: string, callback: AsyncCallback<void>
...
@@ -1156,14 +1156,13 @@ setAudioParameter(key: string, value: string, callback: AsyncCallback<void>
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.setAudioParameter('PBits per sample', '8 bit', (err) => {
audioManager.setAudioParameter('PBits per sample', '8 bit', (err) => {
if (err) {
if (err) {
console.error('Failed to set the audio parameter. ${err.message}');
console.error('Failed to set the audio parameter. ${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate a successful setting of the audio parameter.');
console.log('Callback invoked to indicate a successful setting of the audio parameter.');
})
})
;
```
```
### setAudioParameter
### setAudioParameter
...
@@ -1190,10 +1189,9 @@ setAudioParameter(key: string, value: string): Promise<void>
...
@@ -1190,10 +1189,9 @@ setAudioParameter(key: string, value: string): Promise<void>
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.setAudioParameter('PBits per sample', '8 bit').then(() => {
audioManager.setAudioParameter('PBits per sample', '8 bit').then(() => {
console.log('Promise returned to indicate a successful setting of the audio parameter.');
console.log('Promise returned to indicate a successful setting of the audio parameter.');
})
})
;
```
```
### getAudioParameter
### getAudioParameter
...
@@ -1214,14 +1212,13 @@ getAudioParameter(key: string, callback: AsyncCallback<string>): void
...
@@ -1214,14 +1212,13 @@ getAudioParameter(key: string, callback: AsyncCallback<string>): void
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.getAudioParameter('PBits per sample', (err, value) => {
audioManager.getAudioParameter('PBits per sample', (err, value) => {
if (err) {
if (err) {
console.error('Failed to obtain the value of the audio parameter. ${err.message}');
console.error('Failed to obtain the value of the audio parameter. ${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate that the value of the audio parameter is obtained.' + value);
console.log('Callback invoked to indicate that the value of the audio parameter is obtained.' + value);
})
})
;
```
```
### getAudioParameter
### getAudioParameter
...
@@ -1247,10 +1244,9 @@ getAudioParameter(key: string): Promise<string>
...
@@ -1247,10 +1244,9 @@ getAudioParameter(key: string): Promise<string>
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.getAudioParameter('PBits per sample').then((value) => {
audioManager.getAudioParameter('PBits per sample').then((value) => {
console.log('Promise returned to indicate that the value of the audio parameter is obtained.' + value);
console.log('Promise returned to indicate that the value of the audio parameter is obtained.' + value);
})
})
;
```
```
### getDevices
### getDevices
...
@@ -1270,14 +1266,13 @@ getDevices(deviceFlag: DeviceFlag, callback: AsyncCallback<AudioDeviceDescrip
...
@@ -1270,14 +1266,13 @@ getDevices(deviceFlag: DeviceFlag, callback: AsyncCallback<AudioDeviceDescrip
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG, (err, value) => {
audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG, (err, value) => {
if (err) {
if (err) {
console.error('Failed to obtain the device list. ${err.message}');
console.error('Failed to obtain the device list. ${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate that the device list is obtained.');
console.log('Callback invoked to indicate that the device list is obtained.');
})
})
;
```
```
### getDevices
### getDevices
...
@@ -1303,10 +1298,9 @@ getDevices(deviceFlag: DeviceFlag): Promise<AudioDeviceDescriptors>
...
@@ -1303,10 +1298,9 @@ getDevices(deviceFlag: DeviceFlag): Promise<AudioDeviceDescriptors>
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG).then((data) => {
audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG).then((data) => {
console.log('Promise returned to indicate that the device list is obtained.');
console.log('Promise returned to indicate that the device list is obtained.');
})
})
;
```
```
### setDeviceActive
### setDeviceActive
...
@@ -1328,14 +1322,13 @@ setDeviceActive(deviceType: ActiveDeviceType, active: boolean, callback: AsyncCa
...
@@ -1328,14 +1322,13 @@ setDeviceActive(deviceType: ActiveDeviceType, active: boolean, callback: AsyncCa
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.setDeviceActive(audio.DeviceType.SPEAKER, true, (err) => {
audioManager.setDeviceActive(audio.DeviceType.SPEAKER, true, (err) => {
if (err) {
if (err) {
console.error('Failed to set the active status of the device. ${err.message}');
console.error('Failed to set the active status of the device. ${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate that the device is set to the active status.');
console.log('Callback invoked to indicate that the device is set to the active status.');
})
})
;
```
```
### setDeviceActive
### setDeviceActive
...
@@ -1363,10 +1356,9 @@ setDeviceActive(deviceType: ActiveDeviceType, active: boolean): Promise<void&
...
@@ -1363,10 +1356,9 @@ setDeviceActive(deviceType: ActiveDeviceType, active: boolean): Promise<void&
```
```
var audioManager = audio.getAudioManager();
audioManager.setDeviceActive(audio.DeviceType.SPEAKER, true).then(() => {
audioManager.setDeviceActive(audio.DeviceType.SPEAKER, true).then(() => {
console.log('Promise returned to indicate that the device is set to the active status.');
console.log('Promise returned to indicate that the device is set to the active status.');
})
})
;
```
```
### isDeviceActive
### isDeviceActive
...
@@ -1387,14 +1379,13 @@ isDeviceActive(deviceType: ActiveDeviceType, callback: AsyncCallback<boolean&
...
@@ -1387,14 +1379,13 @@ isDeviceActive(deviceType: ActiveDeviceType, callback: AsyncCallback<boolean&
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.isDeviceActive(audio.DeviceType.SPEAKER, (err, value) => {
audioManager.isDeviceActive(audio.DeviceType.SPEAKER, (err, value) => {
if (err) {
if (err) {
console.error('Failed to obtain the active status of the device. ${err.message}');
console.error('Failed to obtain the active status of the device. ${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate that the active status of the device is obtained.');
console.log('Callback invoked to indicate that the active status of the device is obtained.');
})
})
;
```
```
...
@@ -1421,10 +1412,9 @@ isDeviceActive(deviceType: ActiveDeviceType): Promise<boolean>
...
@@ -1421,10 +1412,9 @@ isDeviceActive(deviceType: ActiveDeviceType): Promise<boolean>
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.isDeviceActive(audio.DeviceType.SPEAKER).then((value) => {
audioManager.isDeviceActive(audio.DeviceType.SPEAKER).then((value) => {
console.log('Promise returned to indicate that the active status of the device is obtained.' + value);
console.log('Promise returned to indicate that the active status of the device is obtained.' + value);
})
})
;
```
```
### setMicrophoneMute
### setMicrophoneMute
...
@@ -1445,14 +1435,13 @@ setMicrophoneMute(mute: boolean, callback: AsyncCallback<void>): void
...
@@ -1445,14 +1435,13 @@ setMicrophoneMute(mute: boolean, callback: AsyncCallback<void>): void
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.setMicrophoneMute(true, (err) => {
audioManager.setMicrophoneMute(true, (err) => {
if (err) {
if (err) {
console.error('Failed to mute the microphone. ${err.message}');
console.error('Failed to mute the microphone. ${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate that the microphone is muted.');
console.log('Callback invoked to indicate that the microphone is muted.');
})
})
;
```
```
### setMicrophoneMute
### setMicrophoneMute
...
@@ -1478,10 +1467,9 @@ setMicrophoneMute(mute: boolean): Promise<void>
...
@@ -1478,10 +1467,9 @@ setMicrophoneMute(mute: boolean): Promise<void>
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.setMicrophoneMute(true).then(() => {
audioManager.setMicrophoneMute(true).then(() => {
console.log('Promise returned to indicate that the microphone is muted.');
console.log('Promise returned to indicate that the microphone is muted.');
})
})
;
```
```
### isMicrophoneMute
### isMicrophoneMute
...
@@ -1501,14 +1489,13 @@ isMicrophoneMute(callback: AsyncCallback<boolean>): void
...
@@ -1501,14 +1489,13 @@ isMicrophoneMute(callback: AsyncCallback<boolean>): void
**示例:**
**示例:**
```
```
var audioManager = audio.getAudioManager();
audioManager.isMicrophoneMute((err, value) => {
audioManager.isMicrophoneMute((err, value) => {
if (err) {
if (err) {
console.error('Failed to obtain the mute status of the microphone. ${err.message}');
console.error('Failed to obtain the mute status of the microphone. ${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate that the mute status of the microphone is obtained.' + value);
console.log('Callback invoked to indicate that the mute status of the microphone is obtained.' + value);
})
})
;
```
```
### isMicrophoneMute
### isMicrophoneMute
...
@@ -1529,10 +1516,9 @@ isMicrophoneMute(): Promise<boolean>
...
@@ -1529,10 +1516,9 @@ isMicrophoneMute(): Promise<boolean>
```
```
var audioManager = audio.getAudioManager();
audioManager.isMicrophoneMute().then((value) => {
audioManager.isMicrophoneMute().then((value) => {
console.log('Promise returned to indicate that the mute status of the microphone is obtained.', + value);
console.log('Promise returned to indicate that the mute status of the microphone is obtained.', + value);
})
})
;
```
```
### on('volumeChange')<sup>8+</sup>
### on('volumeChange')<sup>8+</sup>
...
@@ -1559,7 +1545,7 @@ audioManager.on('volumeChange', (volumeEvent) => {
...
@@ -1559,7 +1545,7 @@ audioManager.on('volumeChange', (volumeEvent) => {
console.log('VolumeType of stream: ' + volumeEvent.volumeType);
console.log('VolumeType of stream: ' + volumeEvent.volumeType);
console.log('Volume level: ' + volumeEvent.volume);
console.log('Volume level: ' + volumeEvent.volume);
console.log('Whether to updateUI: ' + volumeEvent.updateUi);
console.log('Whether to updateUI: ' + volumeEvent.updateUi);
})
})
;
```
```
### on('ringerModeChange')<sup>8+</sup>
### on('ringerModeChange')<sup>8+</sup>
...
@@ -1579,6 +1565,14 @@ on(type: 'ringerModeChange', callback: Callback\<AudioRingMode>): void
...
@@ -1579,6 +1565,14 @@ on(type: 'ringerModeChange', callback: Callback\<AudioRingMode>): void
| type | string | 是 | 事件回调类型,支持的事件为:'ringerModeChange'(铃声模式变化事件,检测到铃声模式改变时,触发该事件)。 |
| type | string | 是 | 事件回调类型,支持的事件为:'ringerModeChange'(铃声模式变化事件,检测到铃声模式改变时,触发该事件)。 |
| callback | Callback
<
[
AudioRingMode
](
#audioringmode
)
>
| 是 | 回调方法。 |
| callback | Callback
<
[
AudioRingMode
](
#audioringmode
)
>
| 是 | 回调方法。 |
**示例:**
```
audioManager.on('ringerModeChange', (ringerMode) => {
console.log('Updated ringermode: ' + ringerMode);
});
```
### on('deviceChange')
### on('deviceChange')
on(type: 'deviceChange', callback: Callback<DeviceChangeAction
\>
): void
on(type: 'deviceChange', callback: Callback<DeviceChangeAction
\>
): void
...
@@ -1724,7 +1718,7 @@ setAudioScene\(scene: AudioScene, callback: AsyncCallback<void\>\): void
...
@@ -1724,7 +1718,7 @@ setAudioScene\(scene: AudioScene, callback: AsyncCallback<void\>\): void
```
```
audioManager.setAudioScene(audio.AudioScene.AUDIO_SCENE_PHONE_CALL, (err) => {
audioManager.setAudioScene(audio.AudioScene.AUDIO_SCENE_PHONE_CALL, (err) => {
if (err) {
if (err) {
console.error('Failed to set the audio scene mode. ${err.message}');
console.error('Failed to set the audio scene mode.
${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate a successful setting of the audio scene mode.');
console.log('Callback invoked to indicate a successful setting of the audio scene mode.');
...
@@ -1782,7 +1776,7 @@ getAudioScene\(callback: AsyncCallback<AudioScene\>\): void
...
@@ -1782,7 +1776,7 @@ getAudioScene\(callback: AsyncCallback<AudioScene\>\): void
```
```
audioManager.getAudioScene((err, value) => {
audioManager.getAudioScene((err, value) => {
if (err) {
if (err) {
console.error('Failed to obtain the audio scene mode. ${err.message}');
console.error('Failed to obtain the audio scene mode.
${err.message}');
return;
return;
}
}
console.log('Callback invoked to indicate that the audio scene mode is obtained.' + value);
console.log('Callback invoked to indicate that the audio scene mode is obtained.' + value);
...
@@ -1832,29 +1826,27 @@ audioManager.getAudioScene().then((value) => {
...
@@ -1832,29 +1826,27 @@ audioManager.getAudioScene().then((value) => {
**示例:**
**示例:**
```
```
function deviceProp(audioDeviceDescriptor, index, array) {
import audio from '@ohos.multimedia.audio';
deviceRoleValue = audioDeviceDescriptor.deviceRole;
deviceTypeValue = audioDeviceDescriptor.deviceType;
function displayDeviceProp(value) {
deviceRoleValue = value.deviceRole;
deviceTypeValue = value.deviceType;
}
}
deviceRoleValue = null;
var
deviceRoleValue = null;
deviceTypeValue = null;
var
deviceTypeValue = null;
const promise = audio
Manager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG
);
const promise = audio
.getAudioManager().getDevices(1
);
promise.then(
async function (audioDeviceDescriptors
) {
promise.then(
function (value
) {
console.info('getDevices OUTPUT_DEVICES_FLAG');
console.info('
AudioFrameworkTest: Promise:
getDevices OUTPUT_DEVICES_FLAG');
audioDeviceDescriptors.forEach(d
eviceProp);
value.forEach(displayD
eviceProp);
if (deviceTypeValue != null && deviceRoleValue != null){
if (deviceTypeValue != null && deviceRoleValue != null){
console.info('OUTPUT_DEVICES_FLAG : Pass');
console.info('AudioFrameworkTest: Promise: getDevices : OUTPUT_DEVICES_FLAG : PASS');
expect(true).assertTrue();
}
}
else{
else{
console.error('OUTPUT_DEVICES_FLAG : fail');
console.info('AudioFrameworkTest: Promise: getDevices : OUTPUT_DEVICES_FLAG : FAIL');
expect(false).assertTrue();
}
}
});
});
await promise;
done();
})
```
```
## AudioRenderer<sup>8+</sup>
## AudioRenderer<sup>8+</sup>
...
@@ -1898,12 +1890,12 @@ getRendererInfo(callback: AsyncCallback<AudioRendererInfo\>): void
...
@@ -1898,12 +1890,12 @@ getRendererInfo(callback: AsyncCallback<AudioRendererInfo\>): void
**示例:**
**示例:**
```
```
audioRenderer.getRendererInfo((err, rendererInfo)
=>
{
audioRenderer.getRendererInfo((err, rendererInfo)
=>
{
console.log('Renderer GetRendererInfo:');
console.log('Renderer GetRendererInfo:');
console.log('Renderer content:' + rendererInfo.content);
console.log('Renderer content:' + rendererInfo.content);
console.log('Renderer usage:' + rendererInfo.usage);
console.log('Renderer usage:' + rendererInfo.usage);
console.log('Renderer flags:' + rendererInfo.rendererFlags);
console.log('Renderer flags:' + rendererInfo.rendererFlags);
})
})
;
```
```
### getRendererInfo<sup>8+</sup>
### getRendererInfo<sup>8+</sup>
...
@@ -1923,12 +1915,15 @@ getRendererInfo(): Promise<AudioRendererInfo\>
...
@@ -1923,12 +1915,15 @@ getRendererInfo(): Promise<AudioRendererInfo\>
**示例:**
**示例:**
```
```
let streamInfo = await audioRenderer.getStreamInfo();
audioRenderer.getRendererInfo().then((rendererInfo) => {
console.log('Renderer GetStreamInfo:');
console.log('Renderer GetRendererInfo:');
console.log('Renderer sampling rate:' + streamInfo.samplingRate);
console.log('Renderer content:' + rendererInfo.content);
console.log('Renderer channel:' + streamInfo.channels);
console.log('Renderer usage:' + rendererInfo.usage);
console.log('Renderer format:' + streamInfo.sampleFormat);
console.log('Renderer flags:' + rendererInfo.rendererFlags);
console.log('Renderer encoding type:' + streamInfo.encodingType);
}).catch((err) => {
console.log('AudioFrameworkRenderLog: RendererInfo :ERROR: '+err.message);
resultFlag = false;
});
```
```
### getStreamInfo<sup>8+</sup>
### getStreamInfo<sup>8+</sup>
...
@@ -1948,13 +1943,13 @@ getStreamInfo(callback: AsyncCallback<AudioStreamInfo\>): void
...
@@ -1948,13 +1943,13 @@ getStreamInfo(callback: AsyncCallback<AudioStreamInfo\>): void
**示例:**
**示例:**
```
```
audioRenderer.getStreamInfo((err, streamInfo)
=>
{
audioRenderer.getStreamInfo((err, streamInfo)
=>
{
console.log('Renderer GetStreamInfo:');
console.log('Renderer GetStreamInfo:');
console.log('Renderer sampling rate:' + streamInfo.samplingRate);
console.log('Renderer sampling rate:' + streamInfo.samplingRate);
console.log('Renderer channel:' + streamInfo.channels);
console.log('Renderer channel:' + streamInfo.channels);
console.log('Renderer format:' + streamInfo.sampleFormat);
console.log('Renderer format:' + streamInfo.sampleFormat);
console.log('Renderer encoding type:' + streamInfo.encodingType);
console.log('Renderer encoding type:' + streamInfo.encodingType);
})
})
;
```
```
### getStreamInfo<sup>8+</sup>
### getStreamInfo<sup>8+</sup>
...
@@ -1974,12 +1969,15 @@ getStreamInfo(): Promise<AudioStreamInfo\>
...
@@ -1974,12 +1969,15 @@ getStreamInfo(): Promise<AudioStreamInfo\>
**示例:**
**示例:**
```
```
let streamInfo = await audioRenderer.getStreamInfo();
audioRenderer.getStreamInfo().then((streamInfo) => {
console.log('Renderer GetStreamInfo:');
console.log('Renderer GetStreamInfo:');
console.log('Renderer sampling rate:' + streamInfo.samplingRate);
console.log('Renderer sampling rate:' + streamInfo.samplingRate);
console.log('Renderer channel:' + streamInfo.AudioChannel);
console.log('Renderer channel:' + streamInfo.channels);
console.log('Renderer format:' + streamInfo.AudioSampleFormat);
console.log('Renderer format:' + streamInfo.sampleFormat);
console.log('Renderer encoding type:' + streamInfo.AudioEncodingType);
console.log('Renderer encoding type:' + streamInfo.encodingType);
}).catch((err) => {
console.log('ERROR: '+err.message);
});
```
```
### start<sup>8+</sup>
### start<sup>8+</sup>
...
@@ -1999,13 +1997,13 @@ start(callback: AsyncCallback<void\>): void
...
@@ -1999,13 +1997,13 @@ start(callback: AsyncCallback<void\>): void
**示例:**
**示例:**
```
```
audioRenderer.start((err)
=>
{
audioRenderer.start((err)
=>
{
if (err) {
if (err) {
console.error('Renderer start failed.');
console.error('Renderer start failed.');
} else {
} else {
console.info('Renderer start success.');
console.info('Renderer start success.');
}
}
})
})
;
```
```
### start<sup>8+</sup>
### start<sup>8+</sup>
...
@@ -2025,7 +2023,11 @@ start(): Promise<void\>
...
@@ -2025,7 +2023,11 @@ start(): Promise<void\>
**示例:**
**示例:**
```
```
await audioRenderer.start();
audioRenderer.start().then(() => {
console.log('Renderer started');
}).catch((err) => {
console.log('ERROR: '+err.message);
});
```
```
### pause<sup>8+</sup>
### pause<sup>8+</sup>
...
@@ -2045,13 +2047,13 @@ pause(callback: AsyncCallback\<void>): void
...
@@ -2045,13 +2047,13 @@ pause(callback: AsyncCallback\<void>): void
**示例:**
**示例:**
```
```
audioRenderer.pause((err)
=>
{
audioRenderer.pause((err)
=>
{
if (err) {
if (err) {
console.error('Renderer pause failed');
console.error('Renderer pause failed');
} else {
} else {
console.log('Renderer paused.');
console.log('Renderer paused.');
}
}
})
})
;
```
```
### pause<sup>8+</sup>
### pause<sup>8+</sup>
...
@@ -2071,7 +2073,11 @@ pause(): Promise\<void>
...
@@ -2071,7 +2073,11 @@ pause(): Promise\<void>
**示例:**
**示例:**
```
```
await audioRenderer.pause();
audioRenderer.pause().then(() => {
console.log('Renderer paused');
}).catch((err) => {
console.log('ERROR: '+err.message);
});
```
```
### drain<sup>8+</sup>
### drain<sup>8+</sup>
...
@@ -2091,13 +2097,13 @@ drain(callback: AsyncCallback\<void>): void
...
@@ -2091,13 +2097,13 @@ drain(callback: AsyncCallback\<void>): void
**示例:**
**示例:**
```
```
audioRenderer.drain((err)
=>
{
audioRenderer.drain((err)
=>
{
if (err) {
if (err) {
console.error('Renderer drain failed');
console.error('Renderer drain failed');
} else {
} else {
console.log('Renderer drained.');
console.log('Renderer drained.');
}
}
})
})
;
```
```
### drain<sup>8+</sup>
### drain<sup>8+</sup>
...
@@ -2117,7 +2123,11 @@ drain(): Promise\<void>
...
@@ -2117,7 +2123,11 @@ drain(): Promise\<void>
**示例:**
**示例:**
```
```
await audioRenderer.drain();
audioRenderer.drain().then(() => {
console.log('Renderer drained successfully');
}).catch((err) => {
console.log('ERROR: '+err.message);
});
```
```
### stop<sup>8+</sup>
### stop<sup>8+</sup>
...
@@ -2137,13 +2147,13 @@ stop(callback: AsyncCallback\<void>): void
...
@@ -2137,13 +2147,13 @@ stop(callback: AsyncCallback\<void>): void
**示例:**
**示例:**
```
```
audioRenderer.stop((err)
=>
{
audioRenderer.stop((err)
=>
{
if (err) {
if (err) {
console.error('Renderer stop failed');
console.error('Renderer stop failed');
} else {
} else {
console.log('Renderer stopped.');
console.log('Renderer stopped.');
}
}
})
})
;
```
```
### stop<sup>8+</sup>
### stop<sup>8+</sup>
...
@@ -2163,7 +2173,11 @@ stop(): Promise\<void>
...
@@ -2163,7 +2173,11 @@ stop(): Promise\<void>
**示例:**
**示例:**
```
```
await audioRenderer.stop();
audioRenderer.stop().then(() => {
console.log('Renderer stopped successfully');
}).catch((err) => {
console.log('ERROR: '+err.message);
});
```
```
### release<sup>8+</sup>
### release<sup>8+</sup>
...
@@ -2183,13 +2197,13 @@ release(callback: AsyncCallback\<void>): void
...
@@ -2183,13 +2197,13 @@ release(callback: AsyncCallback\<void>): void
**示例:**
**示例:**
```
```
audioRenderer.release((err)
=>
{
audioRenderer.release((err)
=>
{
if (err) {
if (err) {
console.error('Renderer release failed');
console.error('Renderer release failed');
} else {
} else {
console.log('Renderer released.');
console.log('Renderer released.');
}
}
})
})
;
```
```
### release<sup>8+</sup>
### release<sup>8+</sup>
...
@@ -2209,7 +2223,11 @@ release(): Promise\<void>
...
@@ -2209,7 +2223,11 @@ release(): Promise\<void>
**示例:**
**示例:**
```
```
await audioRenderer.release();
audioRenderer.release().then(() => {
console.log('Renderer released successfully');
}).catch((err) => {
console.log('ERROR: '+err.message);
});
```
```
### write<sup>8+</sup>
### write<sup>8+</sup>
...
@@ -2230,16 +2248,19 @@ write(buffer: ArrayBuffer, callback: AsyncCallback\<number>): void
...
@@ -2230,16 +2248,19 @@ write(buffer: ArrayBuffer, callback: AsyncCallback\<number>): void
**示例:**
**示例:**
```
```
import audio from '@ohos.multimedia.audio';
import fileio from '@ohos.fileio';
let ss = fileio.createStreamSync(filePath, 'r');
let ss = fileio.createStreamSync(filePath, 'r');
let buf = new ArrayBuffer(bufferSize);
let buf = new ArrayBuffer(bufferSize);
ss.readSync(buf);
ss.readSync(buf);
audioRenderer.write(buf, (err, writtenbytes)
=>
{
audioRenderer.write(buf, (err, writtenbytes)
=>
{
if (writtenbytes < 0) {
if (writtenbytes < 0) {
console.error('write failed.');
console.error('write failed.');
} else {
} else {
console.log('Actual written bytes: ' + writtenbytes);
console.log('Actual written bytes: ' + writtenbytes);
}
}
})
})
;
```
```
### write<sup>8+</sup>
### write<sup>8+</sup>
...
@@ -2259,15 +2280,22 @@ write(buffer: ArrayBuffer): Promise\<number>
...
@@ -2259,15 +2280,22 @@ write(buffer: ArrayBuffer): Promise\<number>
**示例:**
**示例:**
```
```
import audio from '@ohos.multimedia.audio';
import fileio from '@ohos.fileio';
var filePath = 'data/StarWars10s-2C-48000-4SW.wav';
let ss = fileio.createStreamSync(filePath, 'r');
let ss = fileio.createStreamSync(filePath, 'r');
let buf = new ArrayBuffer(bufferSize);
let buf = new ArrayBuffer(bufferSize);
ss.readSync(buf);
ss.readSync(buf);
let writtenbytes = await audioRenderer.write(buf);
audioRenderer.write(buf).then((writtenbytes) => {
if (writtenbytes < 0) {
if (writtenbytes < 0) {
console.error('write failed.');
console.error('write failed.');
} else {
} else {
console.log('Actual written bytes: ' + writtenbytes);
console.log('Actual written bytes: ' + writtenbytes);
}
}
}).catch((err) => {
console.log('ERROR: '+err.message);
});
```
```
### getAudioTime<sup>8+</sup>
### getAudioTime<sup>8+</sup>
...
@@ -2287,9 +2315,9 @@ getAudioTime(callback: AsyncCallback\<number>): void
...
@@ -2287,9 +2315,9 @@ getAudioTime(callback: AsyncCallback\<number>): void
**示例:**
**示例:**
```
```
audioRenderer.getAudioTime((err, timestamp)
=>
{
audioRenderer.getAudioTime((err, timestamp)
=>
{
console.log('Current timestamp: ' + timestamp);
console.log('Current timestamp: ' + timestamp);
})
})
;
```
```
### getAudioTime<sup>8+</sup>
### getAudioTime<sup>8+</sup>
...
@@ -2309,8 +2337,11 @@ getAudioTime(): Promise\<number>
...
@@ -2309,8 +2337,11 @@ getAudioTime(): Promise\<number>
**示例:**
**示例:**
```
```
let timestamp = await audioRenderer.getAudioTime();
audioRenderer.getAudioTime().then((timestamp) => {
console.log('Current timestamp: ' + timestamp);
console.log('Current timestamp: ' + timestamp);
}).catch((err) => {
console.log('ERROR: '+err.message);
});
```
```
### getBufferSize<sup>8+</sup>
### getBufferSize<sup>8+</sup>
...
@@ -2330,11 +2361,11 @@ getBufferSize(callback: AsyncCallback\<number>): void
...
@@ -2330,11 +2361,11 @@ getBufferSize(callback: AsyncCallback\<number>): void
**示例:**
**示例:**
```
```
audioRenderer.getBufferSize((err, bufferSize)
=>
{
audioRenderer.getBufferSize((err, bufferSize)
=>
{
if (err) {
if (err) {
console.error('getBufferSize error');
console.error('getBufferSize error');
}
}
})
})
;
let buf = new ArrayBuffer(bufferSize);
let buf = new ArrayBuffer(bufferSize);
ss.readSync(buf);
ss.readSync(buf);
```
```
...
@@ -2356,9 +2387,12 @@ getBufferSize(): Promise\<number>
...
@@ -2356,9 +2387,12 @@ getBufferSize(): Promise\<number>
**示例:**
**示例:**
```
```
var bufferSize = await audioRenderer.getBufferSize();
audioRenderer.getBufferSize().then((bufferSize) => {
let buf = new ArrayBuffer(bufferSize);
let buf = new ArrayBuffer(bufferSize);
ss.readSync(buf);
ss.readSync(buf);
}).catch((err) => {
console.log('ERROR: '+err.message);
});
```
```
### setRenderRate<sup>8+</sup>
### setRenderRate<sup>8+</sup>
...
@@ -2379,13 +2413,13 @@ setRenderRate(rate: AudioRendererRate, callback: AsyncCallback\<void>): void
...
@@ -2379,13 +2413,13 @@ setRenderRate(rate: AudioRendererRate, callback: AsyncCallback\<void>): void
**示例:**
**示例:**
```
```
audioRenderer.setRenderRate(audio.AudioRendererRate.RENDER_RATE_NORMAL, (err)=> {
audioRenderer.setRenderRate(audio.AudioRendererRate.RENDER_RATE_NORMAL, (err)
=> {
if (err) {
if (err) {
console.error('Failed to set params');
console.error('Failed to set params');
} else {
} else {
console.log('Callback invoked to indicate a successful render rate setting.');
console.log('Callback invoked to indicate a successful render rate setting.');
}
}
})
})
;
```
```
### setRenderRate<sup>8+</sup>
### setRenderRate<sup>8+</sup>
...
@@ -2411,7 +2445,11 @@ setRenderRate(rate: AudioRendererRate): Promise\<void>
...
@@ -2411,7 +2445,11 @@ setRenderRate(rate: AudioRendererRate): Promise\<void>
**示例:**
**示例:**
```
```
await audioRenderer.setRenderRate(audio.AudioRendererRate.RENDER_RATE_NORMAL);
audioRenderer.setRenderRate(audio.AudioRendererRate.RENDER_RATE_NORMAL).then(() => {
console.log('setRenderRate SUCCESS');
}).catch((err) => {
console.log('ERROR: '+err.message);
});
```
```
### getRenderRate<sup>8+</sup>
### getRenderRate<sup>8+</sup>
...
@@ -2431,9 +2469,9 @@ getRenderRate(callback: AsyncCallback\<AudioRendererRate>): void
...
@@ -2431,9 +2469,9 @@ getRenderRate(callback: AsyncCallback\<AudioRendererRate>): void
**示例:**
**示例:**
```
```
audioRenderer.getRenderRate((err, renderrate)
=>
{
audioRenderer.getRenderRate((err, renderrate)
=>
{
console.log('getRenderRate: ' + renderrate);
console.log('getRenderRate: ' + renderrate);
})
})
;
```
```
### getRenderRate<sup>8+</sup>
### getRenderRate<sup>8+</sup>
...
@@ -2453,8 +2491,11 @@ getRenderRate(): Promise\<AudioRendererRate>
...
@@ -2453,8 +2491,11 @@ getRenderRate(): Promise\<AudioRendererRate>
**示例:**
**示例:**
```
```
let renderRate = await audioRenderer.getRenderRate();
audioRenderer.getRenderRate().then((renderRate) => {
console.log('getRenderRate: ' + renderrate);
console.log('getRenderRate: ' + renderRate);
}).catch((err) => {
console.log('ERROR: '+err.message);
});
```
```
### on('interrupt')<sup>9+</sup>
### on('interrupt')<sup>9+</sup>
...
@@ -2499,7 +2540,7 @@ audioRenderer.on('interrupt', (interruptEvent) => {
...
@@ -2499,7 +2540,7 @@ audioRenderer.on('interrupt', (interruptEvent) => {
break;
break;
}
}
}
}
})
})
;
```
```
### on('markReach')<sup>8+</sup>
### on('markReach')<sup>8+</sup>
...
@@ -2662,7 +2703,7 @@ getCapturerInfo(callback: AsyncCallback<AudioCapturerInfo\>): void
...
@@ -2662,7 +2703,7 @@ getCapturerInfo(callback: AsyncCallback<AudioCapturerInfo\>): void
**示例:**
**示例:**
```
```
audioCapturer.getCapturerInfo((err, capturerInfo)
=>
{
audioCapturer.getCapturerInfo((err, capturerInfo)
=>
{
if (err) {
if (err) {
console.error('Failed to get capture info');
console.error('Failed to get capture info');
} else {
} else {
...
@@ -2691,12 +2732,17 @@ getCapturerInfo(): Promise<AudioCapturerInfo\>
...
@@ -2691,12 +2732,17 @@ getCapturerInfo(): Promise<AudioCapturerInfo\>
**示例:**
**示例:**
```
```
audioCapturer.getCapturerInfo().then((capturerInfo) => {
audioCapturer.getCapturerInfo().then((audioParamsGet) => {
console.log('Capturer getCapturerInfo:');
if (audioParamsGet != undefined) {
console.log('Capturer source:' + capturerInfo.source);
console.info('AudioFrameworkRecLog: Capturer CapturerInfo:');
console.log('Capturer flags:' + capturerInfo.capturerFlags);
console.info('AudioFrameworkRecLog: Capturer SourceType:' + audioParamsGet.source);
}).catch ((err) => {
console.info('AudioFrameworkRecLog: Capturer capturerFlags:' + audioParamsGet.capturerFlags);
console.log("Failed to get capturer info");
}else {
console.info('AudioFrameworkRecLog: audioParamsGet is : '+audioParamsGet);
console.info('AudioFrameworkRecLog: audioParams getCapturerInfo are incorrect: ');
}
}).catch((err) => {
console.log('AudioFrameworkRecLog: CapturerInfo :ERROR: '+err.message);
});
});
```
```
...
@@ -2717,7 +2763,7 @@ getStreamInfo(callback: AsyncCallback<AudioStreamInfo\>): void
...
@@ -2717,7 +2763,7 @@ getStreamInfo(callback: AsyncCallback<AudioStreamInfo\>): void
**示例:**
**示例:**
```
```
audioCapturer.
start((err)=>
{
audioCapturer.
getStreamInfo((err, streamInfo) =>
{
if (err) {
if (err) {
console.error('Failed to get stream info');
console.error('Failed to get stream info');
} else {
} else {
...
@@ -2747,14 +2793,14 @@ getStreamInfo(): Promise<AudioStreamInfo\>
...
@@ -2747,14 +2793,14 @@ getStreamInfo(): Promise<AudioStreamInfo\>
**示例:**
**示例:**
```
```
audioCapturer.getStreamInfo().then((
streamInfo
) => {
audioCapturer.getStreamInfo().then((
audioParamsGet
) => {
console.
log('Capturer G
etStreamInfo:');
console.
info('g
etStreamInfo:');
console.
log('Capturer sampling rate:' + streamInfo.samplingRate
);
console.
info('sampleFormat:' + audioParamsGet.sampleFormat
);
console.
log('Capturer channel:' + streamInfo.channels
);
console.
info('samplingRate:' + audioParamsGet.samplingRate
);
console.
log('Capturer format:' + streamInfo.sampleFormat
);
console.
info('channels:' + audioParamsGet.channels
);
console.
log('Capturer encoding type:' + streamInfo
.encodingType);
console.
info('encodingType:' + audioParamsGet
.encodingType);
}).catch
((err) => {
}).catch((err) => {
console.log(
"Failed to get stream info"
);
console.log(
'getStreamInfo :ERROR: ' + err.message
);
});
});
```
```
...
@@ -2775,7 +2821,7 @@ start(callback: AsyncCallback<void\>): void
...
@@ -2775,7 +2821,7 @@ start(callback: AsyncCallback<void\>): void
**示例:**
**示例:**
```
```
audioCapturer.start((err)
=>
{
audioCapturer.start((err)
=>
{
if (err) {
if (err) {
console.error('Capturer start failed.');
console.error('Capturer start failed.');
} else {
} else {
...
@@ -2803,9 +2849,16 @@ start(): Promise<void\>
...
@@ -2803,9 +2849,16 @@ start(): Promise<void\>
```
```
audioCapturer.start().then(() => {
audioCapturer.start().then(() => {
console.log("capturer start success");
console.info('AudioFrameworkRecLog: ---------START---------');
}).catch ((err) => {
console.info('AudioFrameworkRecLog: Capturer started :SUCCESS ');
console.log("Failed to start capturer");
console.info('AudioFrameworkRecLog: AudioCapturer : STATE : '+audioCapturer.state);
console.info('AudioFrameworkRecLog: Capturer started :SUCCESS ');
if ((audioCapturer.state == audio.AudioState.STATE_RUNNING)) {
stateFlag = true;
}
}).catch((err) => {
console.info('AudioFrameworkRecLog: Capturer start :ERROR : '+err.message);
stateFlag=false;
});
});
```
```
...
@@ -2826,7 +2879,7 @@ stop(callback: AsyncCallback<void\>): void
...
@@ -2826,7 +2879,7 @@ stop(callback: AsyncCallback<void\>): void
**示例:**
**示例:**
```
```
audioCapturer.stop((err)
=>
{
audioCapturer.stop((err)
=>
{
if (err) {
if (err) {
console.error('Capturer stop failed');
console.error('Capturer stop failed');
} else {
} else {
...
@@ -2854,9 +2907,15 @@ stop(): Promise<void\>
...
@@ -2854,9 +2907,15 @@ stop(): Promise<void\>
```
```
audioCapturer.stop().then(() => {
audioCapturer.stop().then(() => {
console.log("capturer stop success");
console.info('AudioFrameworkRecLog: ---------RELEASE RECORD---------');
}).catch ((err) => {
console.info('AudioFrameworkRecLog: Capturer stopped : SUCCESS');
console.log("Failed to stop capturer");
if ((audioCapturer.state == audioCapturer.AudioState.STATE_STOPPED)){
stateFlag=true;
console.info('AudioFrameworkRecLog: resultFlag : '+stateFlag);
}
}).catch((err) => {
console.info('AudioFrameworkRecLog: Capturer stop:ERROR : '+err.message);
stateFlag=false;
});
});
```
```
...
@@ -2877,7 +2936,7 @@ release(callback: AsyncCallback<void\>): void
...
@@ -2877,7 +2936,7 @@ release(callback: AsyncCallback<void\>): void
**示例:**
**示例:**
```
```
audioCapturer.release((err)
=>
{
audioCapturer.release((err)
=>
{
if (err) {
if (err) {
console.error('capturer release failed');
console.error('capturer release failed');
} else {
} else {
...
@@ -2905,9 +2964,16 @@ release(): Promise<void\>
...
@@ -2905,9 +2964,16 @@ release(): Promise<void\>
```
```
audioCapturer.release().then(() => {
audioCapturer.release().then(() => {
console.log("capturer release success");
console.info('AudioFrameworkRecLog: ---------RELEASE RECORD---------');
}).catch ((err) => {
console.info('AudioFrameworkRecLog: Capturer release : SUCCESS');
console.log("Failed to release capturer");
console.info('AudioFrameworkRecLog: AudioCapturer : STATE : '+audioCapturer.state);
stateFlag=true;
console.info('AudioFrameworkRecLog: stateFlag : '+stateFlag);
expect(stateFlag).assertTrue();
done();
}).catch((err) => {
console.info('AudioFrameworkRecLog: Capturer stop:ERROR : '+err.message);
stateFlag=false
});
});
```
```
...
@@ -2964,11 +3030,10 @@ read(size: number, isBlockingRead: boolean): Promise<ArrayBuffer\>
...
@@ -2964,11 +3030,10 @@ read(size: number, isBlockingRead: boolean): Promise<ArrayBuffer\>
**示例:**
**示例:**
```
```
audioCapturer.read(size, true).then((buffer) => {
audioCapturer.read(bufferSize, true).then((buffer) => {
console.log("Success in reading the buffer data");
console.info('buffer read successfully');
var number = fileio.writeSync(fd, buffer);
}).catch((err) => {
}).catch ((err) => {
console.info('ERROR : '+err.message);
console.log("Failed to read data!");
});
});
```
```
...
@@ -2990,7 +3055,7 @@ getAudioTime(callback: AsyncCallback<number\>): void
...
@@ -2990,7 +3055,7 @@ getAudioTime(callback: AsyncCallback<number\>): void
**示例:**
**示例:**
```
```
audioCapturer.getAudioTime((err, timestamp)
=>
{
audioCapturer.getAudioTime((err, timestamp)
=>
{
console.log('Current timestamp: ' + timestamp);
console.log('Current timestamp: ' + timestamp);
});
});
```
```
...
@@ -3014,9 +3079,9 @@ getAudioTime(): Promise<number\>
...
@@ -3014,9 +3079,9 @@ getAudioTime(): Promise<number\>
```
```
audioCapturer.getAudioTime().then((audioTime) => {
audioCapturer.getAudioTime().then((audioTime) => {
console.
log("Success in getting the audio time"
);
console.
info('AudioFrameworkRecLog: AudioCapturer getAudioTime : Success' + audioTime
);
}).catch
((err) => {
}).catch((err) => {
console.
log("Failed to get the audio time"
);
console.
info('AudioFrameworkRecLog: AudioCapturer Created : ERROR : '+err.message
);
});
});
```
```
...
@@ -3038,10 +3103,14 @@ getBufferSize(callback: AsyncCallback<number\>): void
...
@@ -3038,10 +3103,14 @@ getBufferSize(callback: AsyncCallback<number\>): void
**示例:**
**示例:**
```
```
audioCapturer.getBufferSize((err, bufferSize)
=>
{
audioCapturer.getBufferSize((err, bufferSize)
=>
{
if (!err) {
if (!err) {
console.log('BufferSize : ' + bufferSize);
console.log('BufferSize : ' + bufferSize);
var buffer = await audioCapturer.read(bufferSize, true);
audioCapturer.read(bufferSize, true).then((buffer) => {
console.info('Buffer read is ' + buffer );
}).catch((err) => {
console.info('AudioFrameworkRecLog: AudioCapturer Created : ERROR : '+err.message);
});
}
}
});
});
```
```
...
@@ -3065,10 +3134,14 @@ getBufferSize(): Promise<number\>
...
@@ -3065,10 +3134,14 @@ getBufferSize(): Promise<number\>
```
```
audioCapturer.getBufferSize().then((bufferSize) => {
audioCapturer.getBufferSize().then((bufferSize) => {
console.log("Success in getting the buffer size");
if (!err) {
var buffer = await audioCapturer.read(bufferSize, true);
console.log('BufferSize : ' + bufferSize);
}).catch ((err) => {
audioCapturer.read(bufferSize, true).then((buffer) => {
console.log("Failed to get the buffer size");
console.info('Buffer read is ' + buffer );
}).catch((err) => {
console.info('ERROR : '+err.message);
});
}
});
});
```
```
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录