diff --git a/en/application-dev/reference/apis/js-apis-audio.md b/en/application-dev/reference/apis/js-apis-audio.md index 80ac13c01931162680670633ac374864c8a24101..85d2dc6b01ebe7dc2dc97e3965985ae1a61efb52 100644 --- a/en/application-dev/reference/apis/js-apis-audio.md +++ b/en/application-dev/reference/apis/js-apis-audio.md @@ -1,6 +1,7 @@ # Audio -This module provides the following functions: audio management, audio rendering and system sound management. +> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** +> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. ## Modules to Import @@ -284,8 +285,18 @@ Enumerates audio device types. +## ActiveDeviceType -## AudioRingMode7+ +Enumerates the active device types. + +| Name | Default Value | Default Value | +| ------------- | ------ | ------------------------------------------------------------ | +| SPEAKER | 2 | Speaker.
**System capabilities:** SystemCapability.Multimedia.Audio.Device | +| BLUETOOTH_SCO | 7 | Bluetooth device using the SCO link.
**System capabilities:** SystemCapability.Multimedia.Audio.Device | + + + +## AudioRingMode Enumerates ringer modes. @@ -1028,7 +1039,7 @@ audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA).then((data)=> ## audioManager.mute -mute\(volumeType: AudioVolumeType, mute: boolean, callback: AsyncCallback\): void7+ +mute\(volumeType: AudioVolumeType, mute: boolean, callback: AsyncCallback\): void Mutes a stream. This method uses an asynchronous callback to return the result. @@ -1096,7 +1107,7 @@ audioManager.mute(audio.AudioVolumeType.MEDIA, true, (err) => { ## audioManager.mute -mute\(volumeType: AudioVolumeType, mute: boolean\): Promise7+ +mute\(volumeType: AudioVolumeType, mute: boolean\): Promise Mutes a stream. This method uses a promise to return the result. @@ -1164,7 +1175,7 @@ audioManager.mute(audio.AudioVolumeType.MEDIA, true).then(() => ## audioManager.isMute -isMute\(volumeType: AudioVolumeType, callback: AsyncCallback\): void7+ +isMute\(volumeType: AudioVolumeType, callback: AsyncCallback\): void Checks whether a stream is muted. This method uses an asynchronous callback to return the query result. @@ -1223,7 +1234,7 @@ audioManager.isMute(audio.AudioVolumeType.MEDIA, (err, value) => { ## audioManager.isMute -isMute\(volumeType: AudioVolumeType\): Promise7+ +isMute\(volumeType: AudioVolumeType\): Promise Checks whether a stream is muted. This method uses a promise to return the result. @@ -1282,7 +1293,7 @@ audioManager.isMute(audio.AudioVolumeType.MEDIA).then((value) => ## audioManager.isActive -isActive\(volumeType: AudioVolumeType, callback: AsyncCallback\): void7+ +isActive\(volumeType: AudioVolumeType, callback: AsyncCallback\) Checks whether a stream is active. This method uses an asynchronous callback to return the query result. @@ -1341,7 +1352,7 @@ audioManager.isActive(audio.AudioVolumeType.MEDIA, (err, value) => { ## audioManager.isActive -isActive\(volumeType: AudioVolumeType\): Promise7+ +isActive\(volumeType: AudioVolumeType\): Promise Checks whether a stream is active. This method uses a promise to return the query result. @@ -1400,7 +1411,7 @@ audioManager.isActive(audio.AudioVolumeType.MEDIA).then((value) => ## audioManager.setRingerMode -setRingerMode\(mode: AudioRingMode, callback: AsyncCallback\): void7+ +setRingerMode\(mode: AudioRingMode, callback: AsyncCallback\): void Sets the ringer mode. This method uses an asynchronous callback to return the result. @@ -1459,7 +1470,7 @@ audioManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL, (err) => { ## audioManager.setRingerMode -setRingerMode\(mode: AudioRingMode\): Promise7+ +setRingerMode\(mode: AudioRingMode\): Promise Sets the ringer mode. This method uses a promise to return the result. @@ -1518,7 +1529,7 @@ audioManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL).then(() => ## audioManager.getRingerMode -getRingerMode\(callback: AsyncCallback\): void7+ +getRingerMode\(callback: AsyncCallback\): void Obtains the ringer mode. This method uses an asynchronous callback to return the query result. @@ -1568,7 +1579,7 @@ audioManager.getRingerMode((err, value) => { ## audioManager.getRingerMode -getRingerMode\(\): Promise7+ +getRingerMode\(\): Promise Obtains the ringer mode. This method uses a promise to return the query result. @@ -1606,7 +1617,7 @@ audioManager.getRingerMode().then((value) => ## audioManager.setAudioParameter -setAudioParameter\(key: string, value: string, callback: AsyncCallback\): void7+ +setAudioParameter\(key: string, value: string, callback: AsyncCallback\): void Sets an audio parameter. This method uses an asynchronous callback to return the result. @@ -1674,7 +1685,7 @@ audioManager.setAudioParameter('PBits per sample', '8 bit', (err) => { ## audioManager.setAudioParameter -setAudioParameter\(key: string, value: string\): Promise7+ +setAudioParameter\(key: string, value: string\): Promise Sets an audio parameter. This method uses a promise to return the result. @@ -1742,7 +1753,7 @@ audioManager.setAudioParameter('PBits per sample', '8 bit').then(() => ## audioManager.getAudioParameter -getAudioParameter\(key: string, callback: AsyncCallback\): void7+ +getAudioParameter\(key: string, callback: AsyncCallback\) Obtains the value of an audio parameter. This method uses an asynchronous callback to return the query result. @@ -1801,7 +1812,7 @@ audioManager.getAudioParameter('PBits per sample', (err, value) => { ## audioManager.getAudioParameter -getAudioParameter\(key: string\): Promise7+ +getAudioParameter\(key: string\): Promise Obtains the value of an audio parameter. This method uses a promise to return the query result. @@ -1979,7 +1990,7 @@ audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG).then((data)=> ## audioManager.setDeviceActive -setDeviceActive\(deviceType: DeviceType, active: boolean, callback: AsyncCallback\): void7+ +setDeviceActive\(deviceType: DeviceType, active: boolean, callback: AsyncCallback\): void Sets a device to the active state. This method uses an asynchronous callback to return the result. @@ -2048,7 +2059,7 @@ audioManager.setDeviceActive(audio.DeviceType.SPEAKER, true, (err)=> { ## audioManager.setDeviceActive -setDeviceActive\(deviceType: DeviceType, active: boolean\): Promise7+ +setDeviceActive\(deviceType: DeviceType, active: boolean\): Promise Sets a device to the active state. This method uses a promise to return the result. @@ -2116,7 +2127,7 @@ audioManager.setDeviceActive(audio.DeviceType.SPEAKER, true).then(()=> ## audioManager.isDeviceActive -isDeviceActive\(deviceType: DeviceType, callback: AsyncCallback\): void7+ +isDeviceActive\(deviceType: DeviceType, callback: AsyncCallback\): void Checks whether a device is active. This method uses an asynchronous callback to return the query result. @@ -2175,7 +2186,7 @@ audioManager.isDeviceActive(audio.DeviceType.SPEAKER, (err, value) => { ## audioManager.isDeviceActive -isDeviceActive\(deviceType: DeviceType\): Promise7+ +isDeviceActive\(deviceType: DeviceType\): Promise Checks whether a device is active. This method uses a promise to return the query result. @@ -2234,7 +2245,7 @@ audioManager.isDeviceActive(audio.DeviceType.SPEAKER).then((value) => ## audioManager.setMicrophoneMute -setMicrophoneMute\(mute: boolean, callback: AsyncCallback\): void7+ +setMicrophoneMute\(mute: boolean, callback: AsyncCallback\): void Mutes or unmutes the microphone. This method uses an asynchronous callback to return the result. @@ -2293,7 +2304,7 @@ audioManager.setMicrophoneMute(true, (err) => { ## audioManager.setMicrophoneMute -setMicrophoneMute\(mute: boolean\): Promise7+ +setMicrophoneMute\(mute: boolean\): Promise Mutes or unmutes the microphone. This method uses a promise to return the result. @@ -2352,7 +2363,7 @@ audioManager.setMicrophoneMute(true).then(() => ## audioManager.isMicrophoneMute -isMicrophoneMute\(callback: AsyncCallback\): void7+ +isMicrophoneMute\(callback: AsyncCallback\): void Checks whether the microphone is muted. This method uses an asynchronous callback to return the query result. @@ -2402,7 +2413,7 @@ audioManager.isMicrophoneMute((err, value) => { ## audioManager.isMicrophoneMute -isMicrophoneMute\(\): Promise7+ +isMicrophoneMute\(\): Promise Checks whether the microphone is muted. This method uses a promise to return the query result. @@ -4121,3 +4132,20 @@ None ``` await ringtonePlayer.release(); ``` + + +## AudioDeviceDescriptor + +Describes an audio device. + +| Name | Type | Readable | Writable | Description | +| -------- | -------- | -------- | -------- | -------- | +| deviceRole | [DeviceRole](#devicerole) | Yes | No | Device role.
**System capabilities:** SystemCapability.Multimedia.Audio.Device | +| deviceType | [DeviceType](#devicetype) | Yes | No | Device type.
**System capabilities:** SystemCapability.Multimedia.Audio.Device | + + +## AudioDeviceDescriptors + +| Name | Description | +| -------- | -------- | +| AudioDeviceDescriptors | Array of **AudioDeviceDescriptor** objects. It is read-only.
**System capabilities:** SystemCapability.Multimedia.Audio.Device | \ No newline at end of file diff --git a/en/application-dev/reference/apis/js-apis-camera.md b/en/application-dev/reference/apis/js-apis-camera.md index 92aef3bc743bc5a1e0466fecbbefa94a274f5af3..c076a882942d2145b641555efd8ac2bd5a504fd4 100644 --- a/en/application-dev/reference/apis/js-apis-camera.md +++ b/en/application-dev/reference/apis/js-apis-camera.md @@ -1,5 +1,8 @@ # Camera +> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** +> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. + ## Modules to Import ```