# Audio Management > **NOTE** > The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. This module provides the following common audio-related functions: - [AudioManager](#audiomanager): Audio management. - [AudioRenderer](#audiorenderer8): Audio rendering, used to play Pulse Code Modulation (PCM) audio data. - [AudioCapturer](#audiocapturer8): Audio capture, used to record PCM audio data. ## Modules to Import ``` import audio from '@ohos.multimedia.audio'; ``` ## audio.getAudioManager getAudioManager(): AudioManager Obtains an **AudioManager** instance. **System capability:** SystemCapability.Multimedia.Audio.Core **Return value:** | Type | Description | | ----------------------------- | -------------------- | | [AudioManager](#audiomanager) | AudioManager object. | **Example:** ``` var audioManager = audio.getAudioManager(); ``` ## audio.createAudioRenderer8+ createAudioRenderer(options: AudioRendererOptions, callback: AsyncCallback\): void Obtains an **AudioRenderer** instance. This API uses an asynchronous callback to return the renderer instance. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :--------- | :---------------------------------------------- | :-------- | :--------------------------------------------------- | | options | [AudioRendererOptions](#audiorendereroptions8) | Yes | Renderer configurations. | | callback | AsyncCallback<[AudioRenderer](#audiorenderer8)> | Yes | Callback used to return the audio renderer instance. | **Example:** ``` import audio from '@ohos.multimedia.audio'; var audioStreamInfo = { samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100, channels: audio.AudioChannel.CHANNEL_1, sampleFormat: audio.AudioSampleFormat.SAMPLE_FORMAT_S16LE, encodingType: audio.AudioEncodingType.ENCODING_TYPE_RAW } var audioRendererInfo = { content: audio.ContentType.CONTENT_TYPE_SPEECH, usage: audio.StreamUsage.STREAM_USAGE_VOICE_COMMUNICATION, rendererFlags: 1 } var audioRendererOptions = { streamInfo: audioStreamInfo, rendererInfo: audioRendererInfo } audio.createAudioRenderer(audioRendererOptions,(err, data) => { if (err) { console.error(`AudioRenderer Created : Error: ${err.message}`); } else { console.info('AudioRenderer Created : Success : SUCCESS'); let audioRenderer = data; } }); ``` ## audio.createAudioRenderer8+ createAudioRenderer(options: AudioRendererOptions): Promise Obtains an **AudioRenderer** instance. This API uses a promise to return the renderer instance. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :--------- | :--------------------------------------------- | :-------- | :---------------------------| | options | [AudioRendererOptions](#audiorendereroptions8) | Yes | Renderer configurations. | **Return value:** | Type | Description | | ----------------------------------------- | --------------------------------------------------- | | Promise<[AudioRenderer](#audiorenderer8)> | Promise used to return the audio renderer instance. | **Example:** ``` import audio from '@ohos.multimedia.audio'; var audioStreamInfo = { samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100, channels: audio.AudioChannel.CHANNEL_1, sampleFormat: audio.AudioSampleFormat.SAMPLE_FORMAT_S16LE, encodingType: audio.AudioEncodingType.ENCODING_TYPE_RAW } var audioRendererInfo = { content: audio.ContentType.CONTENT_TYPE_SPEECH, usage: audio.StreamUsage.STREAM_USAGE_VOICE_COMMUNICATION, rendererFlags: 1 } var audioRendererOptions = { streamInfo: audioStreamInfo, rendererInfo: audioRendererInfo } 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.createAudioCapturer8+ createAudioCapturer(options: AudioCapturerOptions, callback: AsyncCallback): void Obtains an **AudioCapturer** instance. This API uses an asynchronous callback to return the capturer instance. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Parameters:** | Name | Type | Mandatory | Description | | :--------- | :---------------------------------------------- | :-------- | :--------------------------------------------------- | | options | [AudioCapturerOptions](#AudioCapturerOptions) | Yes | Capturer configurations. | | callback | AsyncCallback<[AudioCapturer](#audiocapturer8)> | Yes | Callback used to return the audio capturer instance. | **Example:** ``` import audio from '@ohos.multimedia.audio'; var audioStreamInfo = { samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100, channels: audio.AudioChannel.CHANNEL_2, sampleFormat: audio.AudioSampleFormat.SAMPLE_FORMAT_S16LE, encodingType: audio.AudioEncodingType.ENCODING_TYPE_RAW } var audioCapturerInfo = { source: audio.SourceType.SOURCE_TYPE_MIC, capturerFlags: 1 } var audioCapturerOptions = { streamInfo: audioStreamInfo, capturerInfo: audioCapturerInfo } audio.createAudioCapturer(audioCapturerOptions,(err, data) => { if (err) { console.error(`AudioCapturer Created : Error: ${err.message}`); } else { console.info('AudioCapturer Created : Success : SUCCESS'); let audioCapturer = data; } }); ``` ## audio.createAudioCapturer8+ createAudioCapturer(options: AudioCapturerOptions): Promise Obtains an **AudioCapturer** instance. This API uses a promise to return the capturer instance. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Parameters:** | Name | Type | Mandatory | Description | | :--------- | :-------------------------------------------- | :-------- | :-------------------------- | | options | [AudioCapturerOptions](#AudioCapturerOptions) | Yes | Capturer configurations. | **Return value:** | Type | Description | | ----------------------------------------- | --------------------------------------------------- | | Promise<[AudioCapturer](#audiocapturer8)> | Promise used to return the audio capturer instance. | **Example:** ``` import audio from '@ohos.multimedia.audio'; var audioStreamInfo = { samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100, channels: audio.AudioChannel.CHANNEL_2, sampleFormat: audio.AudioSampleFormat.SAMPLE_FORMAT_S16LE, encodingType: audio.AudioEncodingType.ENCODING_TYPE_RAW } var audioCapturerInfo = { source: audio.SourceType.SOURCE_TYPE_MIC, capturerFlags: 1 } var audioCapturerOptions = { streamInfo: audioStreamInfo, capturerInfo: audioCapturerInfo } 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 Enumerates audio stream types. **System capability:** SystemCapability.Multimedia.Audio.Volume | Name | Default Value | Description | | ---------------------------- | -------------- | --------------------------------- | | VOICE_CALL8+ | 0 | Audio stream for voice calls. | | RINGTONE | 2 | Audio stream for ringtones. | | MEDIA | 3 | Audio stream for media purpose. | | VOICE_ASSISTANT8+ | 9 | Audio stream for voice assistant. | ## DeviceFlag Enumerates audio device flags. **System capability:** SystemCapability.Multimedia.Audio.Device | Name | Default Value | Description | | ------------------- | ------------- | -------------- | | OUTPUT_DEVICES_FLAG | 1 | Output device. | | INPUT_DEVICES_FLAG | 2 | Input device. | | ALL_DEVICES_FLAG | 3 | All devices. | ## DeviceRole Enumerates audio device roles. **System capability:** SystemCapability.Multimedia.Audio.Device | Name | Default Value | Description | | ------------- | ------------- | ------------ | | INPUT_DEVICE | 1 | Input role. | | OUTPUT_DEVICE | 2 | Output role. | ## DeviceType Enumerates audio device types. **System capability:** SystemCapability.Multimedia.Audio.Device | Name | Default Value | Description | | ---------------- | ------------- | ------------------------------------------------------------------------ | | INVALID | 0 | Invalid device. | | EARPIECE | 1 | Earpiece. | | SPEAKER | 2 | Speaker. | | WIRED_HEADSET | 3 | Wired headset. | | WIRED_HEADPHONES | 4 | Wired headset without microphone. | | BLUETOOTH_SCO | 7 | Bluetooth device using Synchronous Connection Oriented (SCO) links. | | BLUETOOTH_A2DP | 8 | Bluetooth device using Advanced Audio Distribution Profile (A2DP) links. | | MIC | 15 | Microphone. | | USB_HEADSET | 22 | USB Type-C headset. | ## ActiveDeviceType Enumerates the active device types. **System capability:** SystemCapability.Multimedia.Audio.Device | Name | Default Value | Description | | ------------- | ------------- | ---------------------------------------------------------------------- | | SPEAKER | 2 | Speaker. | | BLUETOOTH_SCO | 7 | Bluetooth device using the SCO links. | ## AudioRingMode Enumerates ringer modes. **System capability:** SystemCapability.Multimedia.Audio.Communication | Name | Default Value | Description | | ------------------- | ------------- | ---------------- | | RINGER_MODE_SILENT | 0 | Silent mode. | | RINGER_MODE_VIBRATE | 1 | Vibration mode. | | RINGER_MODE_NORMAL | 2 | Normal mode. | ## AudioSampleFormat8+ Enumerates the audio sample formats. **System capability:** SystemCapability.Multimedia.Audio.Core | Name | Default Value | Description | | :-------------------- | :------------ | :------------------------------------ | | SAMPLE_FORMAT_INVALID | -1 | Invalid format. | | SAMPLE_FORMAT_U8 | 0 | Unsigned 8 bit integer. | | SAMPLE_FORMAT_S16LE | 1 | Signed 16 bit integer, little endian. | | SAMPLE_FORMAT_S24LE | 2 | Signed 24 bit integer, little endian. | | SAMPLE_FORMAT_S32LE | 3 | Signed 32 bit integer, little endian. | ## AudioChannel8+ Enumerates the audio channels. **System capability:** SystemCapability.Multimedia.Audio.Core | Name | Default Value | Description | | :-------- | :------------ | :--------------- | | CHANNEL_1 | 0x1 << 0 | Channel count 1. | | CHANNEL_2 | 0x1 << 1 | Channel count 2. | ## AudioSamplingRate8+ Enumerates the audio sampling rates. **System capability:** SystemCapability.Multimedia.Audio.Core | Name | Default Value | Description | | :---------------- | :------------ | :------------------- | | SAMPLE_RATE_8000 | 8000 | Sampling rate 8000. | | SAMPLE_RATE_11025 | 11025 | Sampling rate 11025. | | SAMPLE_RATE_12000 | 12000 | Sampling rate 12000. | | SAMPLE_RATE_16000 | 16000 | Sampling rate 16000. | | SAMPLE_RATE_22050 | 22050 | Sampling rate 22050. | | SAMPLE_RATE_24000 | 24000 | Sampling rate 24000. | | SAMPLE_RATE_32000 | 32000 | Sampling rate 32000. | | SAMPLE_RATE_44100 | 44100 | Sampling rate 44100. | | SAMPLE_RATE_48000 | 48000 | Sampling rate 48000. | | SAMPLE_RATE_64000 | 64000 | Sampling rate 64000. | | SAMPLE_RATE_96000 | 96000 | Sampling rate 96000. | ## AudioEncodingType8+ Enumerates the audio encoding types. **System capability:** SystemCapability.Multimedia.Audio.Core | Name | Default Value | Description | | :-------------------- | :------------- | :---------------- | | ENCODING_TYPE_INVALID | -1 | Invalid. | | ENCODING_TYPE_RAW | 0 | PCM encoding. | ## ContentType Enumerates the content types. **System capability:** SystemCapability.Multimedia.Audio.Core | Name | Default Value | Description | | :----------------------------------| :------------ | :---------------------- | | CONTENT_TYPE_UNKNOWN | 0 | Unknown content. | | CONTENT_TYPE_SPEECH | 1 | Speech content. | | CONTENT_TYPE_MUSIC | 2 | Music content. | | CONTENT_TYPE_MOVIE | 3 | Movie content. | | CONTENT_TYPE_SONIFICATION | 4 | Sonification content. | | CONTENT_TYPE_RINGTONE8+ | 5 | Ringtone content. | ## StreamUsage Enumerates the stream usage. **System capability:** SystemCapability.Multimedia.Audio.Core | Name | Default Value | Description | | :--------------------------------- | :------------ | :-------------------------------- | | STREAM_USAGE_UNKNOWN | 0 | Unknown usage. | | STREAM_USAGE_MEDIA | 1 | Media usage. | | STREAM_USAGE_VOICE_COMMUNICATION | 2 | Voice communication usage. | | STREAM_USAGE_NOTIFICATION_RINGTONE | 6 | Notification or ringtone usage. | ## AudioState8+ Enumerates the audio states. **System capability:** SystemCapability.Multimedia.Audio.Core | Name | Default Value | Description | | :------------- | :------------ | :--------------------------- | | STATE_INVALID | -1 | Invalid state. | | STATE_NEW | 0 | Creating new instance state. | | STATE_PREPARED | 1 | Prepared state. | | STATE_RUNNING | 2 | Running state. | | STATE_STOPPED | 3 | Stopped state. | | STATE_RELEASED | 4 | Released state. | | STATE_PAUSED | 5 | Paused state. | ## AudioRendererRate8+ Enumerates the audio renderer rates. **System capability:** SystemCapability.Multimedia.Audio.Renderer | Name | Default Value | Description | | :----------------- | :------------ | :------------ | | RENDER_RATE_NORMAL | 0 | Normal rate. | | RENDER_RATE_DOUBLE | 1 | Double rate. | | RENDER_RATE_HALF | 2 | Half rate. | ## InterruptType Enumerates the interrupt types. **System capability:** SystemCapability.Multimedia.Audio.Renderer | Name | Default Value | Description | | :------------------- | :------------ | :----------------------------------- | | INTERRUPT_TYPE_BEGIN | 1 | Audio playback interruption started. | | INTERRUPT_TYPE_END | 2 | Audio playback interruption ended. | ## InterruptForceType9+ Enumerates the interrupt force types. **System capability:** SystemCapability.Multimedia.Audio.Renderer | Name | Default Value | Description | | :-------------- | :------------ | :----------------------------------------- | | INTERRUPT_FORCE | 0 | Forced action taken by system. | | INTERRUPT_SHARE | 1 | App can choose to take action or ignore. | ## InterruptHint Enumerates the interrupt hints. **System capability:** SystemCapability.Multimedia.Audio.Renderer | Name | Default Value | Description | | :--------------------------------- | :------------ | :--------------------------- | | INTERRUPT_HINT_NONE8+ | 0 | None. | | INTERRUPT_HINT_RESUME | 1 | Resume the playback. | | INTERRUPT_HINT_PAUSE | 2 | Paused/Pause the playback. | | INTERRUPT_HINT_STOP | 3 | Stopped/Stop the playback. | | INTERRUPT_HINT_DUCK | 4 | Ducked the playback. | | INTERRUPT_HINT_UNDUCK8+ | 5 | Unducked the playback. | ## InterruptActionType Enumerates the interrupt event return types. This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR. **System capability:** SystemCapability.Multimedia.Audio.Renderer | Name | Default Value | Description | | :------------- | :------------ | :---------------------------------------- | | TYPE_ACTIVATED | 0 | Audio interrupt activated. | | TYPE_INTERRUPT | 1 | Audio interrupted. | ## AudioStreamInfo8+ Describes audio stream information. **System capability:** SystemCapability.Multimedia.Audio.Core **Parameters:** | Name | Type | Mandatory | Description | | :------------ | :---------------------------------------- | :-------- | :-------------------- | | samplingRate | [AudioSamplingRate](#audiosamplingrate8) | Yes | Sampling rate. | | channels | [AudioChannel](#audiochannel8) | Yes | Audio channels. | | sampleFormat | [AudioSampleFormat](#audiosampleformat8) | Yes | Audio sample format. | | encodingType | [AudioEncodingType](#audioencodingtype8) | Yes | Audio encoding type. | ## AudioRendererInfo8+ Describes audio renderer information. **System capability:** SystemCapability.Multimedia.Audio.Core **Parameters:** | Name | Type | Mandatory | Description | | :------------ | :-------------------------- | :-------- | :-------------------- | | contentType | [ContentType](#contenttype) | Yes | Content type. | | usage | [StreamUsage](#streamusage) | Yes | Stream usage. | | rendererFlags | number | Yes | Audio renderer flags. | ## AudioRendererOptions8+ Describes audio renderer configuration options. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------------ | :-----------------------------------------| :-------- | :-------------------- | | streamInfo | [AudioStreamInfo](#audiostreaminfo8) | Yes | Stream information. | | rendererInfo | [AudioRendererInfo](#audiorendererinfo8) | Yes | Renderer information. | ## InterruptEvent9+ Describes the interrupt event received by the app when playback is interrupted. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :-------- | :-------------------------------------------- | :-------- | :---------------------------------------------------------------- | | eventType | [InterruptType](#interrupttype) | Yes | Whether the interruption has started or finished. | | forceType | [InterruptForceType](#interruptforcetype9) | Yes | Whether the action is taken by system or to be taken by the app. | | hintType | [InterruptHint](#interrupthint) | Yes | Type of action. | ## AudioInterrupt The parameters passed in by the audio listener event. This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR. **System capability:** SystemCapability.Multimedia.Audio.Renderer | Name | Type | Mandatory | Description | | --------------- | --------------------------- | ---- | ------------------------------------------------------------ | | streamUsage | [StreamUsage](#streamusage) | Yes | Audio stream usage type. | | contentType | [ContentType](#contenttype) | Yes | Audio interrupt media type. | | pauseWhenDucked | boolean | Yes | Whether audio playback can be paused when audio is interrupted (true means audio playback can be paused during audio interruptions and false means the opposite). | ## InterruptAction Callback method for the audio interrupt or audio interrupt activated event. This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR. **System capability:** SystemCapability.Multimedia.Audio.Renderer | Name | Type | Mandatory | Description | | ---------- | ------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | actionType | [InterruptActionType](#interruptactiontype) | Yes | Event return type. TYPE_ACTIVATED is the audio interrupt activated event, and TYPE_INTERRUPT is the audio interrupt event. | | type | [InterruptType](#interrupttype) | No | Interrupt event type. | | hint | [InterruptHint](interrupthint) | No | Interrupt event prompts. | | activated | boolean | No | Acquire/release focus. true indicates that the focus acquisition/release is successful, and false indicates that the focus acquisition/release fails. | ## VolumeEvent8+ Describes the volume event received by the app when the volume is changed. This is a system API and cannot be called by third-party applications. **System capability:** SystemCapability.Multimedia.Audio.Volume **Parameters:** | Name | Type | Mandatory | Description | | :--------- | :---------------------------------- | :-------- | :--------------------------------------- | | volumeType | [AudioVolumeType](#audiovolumetype) | Yes | Volume type of the current stream. | | volume | number | Yes | Volume level. | | updateUi | boolean | Yes | Whether to show the volume change in UI. | ## DeviceChangeAction Describes the device change type and device information. **System capability:** SystemCapability.Multimedia.Audio.Device **Parameters:** | Name | Type | Mandatory | Description | | :------------------ | :------------------------------------------------ | :-------- | :------------------ | | type | [DeviceChangeType](#DeviceChangeType) | Yes | Device change type. | | deviceDescriptors | [AudioDeviceDescriptors](#AudioDeviceDescriptors) | Yes | Device information. | ## DeviceChangeType Enumerates device change types. **System capability:** SystemCapability.Multimedia.Audio.Device | Name | Default Value | Description | | :--------------------- | :------------ | :-------------------- | | CONNECT | 0 | Device connection. | | DISCONNECT | 1 | Device disconnection. | ## AudioCapturerInfo8+ Describes audio capturer information. **System capability:** SystemCapability.Multimedia.Audio.Core **Parameters:** | Name | Type | Mandatory | Description | | :---------------| :------------------------- | :-------- | :-------------------- | | source | [SourceType](#sourcetype) | Yes | Audio source type. | | capturerFlags | number | Yes | Audio capturer flags. | ## SourceType8+ Enumerates source types. **System capability:** SystemCapability.Multimedia.Audio.Core | Name | Default Value | Description | | :----------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------ | :------------------------------- | | SOURCE_TYPE_INVALID | -1 | Invalid source type. | | SOURCE_TYPE_MIC | 0 | Mic source type. | | SOURCE_TYPE_VOICE_COMMUNICATION(This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR) | 7 | Voice communication source type. | ## AudioScene8+ Enumerates audio scenes. **System capability:** SystemCapability.Multimedia.Audio.Communication | Name | Default Value | Description | | :------------------------------------------------------------------------------------ | :------------ | :---------------------- | | AUDIO_SCENE_DEFAULT | 0 | Default audio scene. | | AUDIO_SCENE_RINGING(system API, not supported by third-party applications) | 1 | Ringing audio scene. | | AUDIO_SCENE_PHONE_CALL(system API, not supported by third-party applications) | 2 | Phone call audio scene. | | AUDIO_SCENE_VOICE_CHAT | 3 | Voice chat audio scene. | ## AudioManager Implements audio volume and audio device management. Before calling the interface of AudioManager, you need to create an instance through [getAudioManager](#audiogetaudiomanager). ### setVolume setVolume\(volumeType: AudioVolumeType, volume: number, callback: AsyncCallback\): void Sets the volume for a stream. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Volume **Parameters:** | Name | Type | Mandatory | Description | | ---------- | ----------------------------------- | --------- | ---------------------------------------------------------------------------------------- | | volumeType | [AudioVolumeType](#audiovolumetype) | Yes | Volume stream type. | | volume | number | Yes | Volume to set. The value range can be obtained by calling getMinVolume and getMaxVolume. | | callback | AsyncCallback | Yes | Callback used to return the result. | **Example:** ``` audioManager.setVolume(audio.AudioVolumeType.MEDIA, 10, (err) => { if (err) { console.error('Failed to set the volume. ${err.message}'); return; } console.log('Callback invoked to indicate a successful volume setting.'); }); ``` ### setVolume setVolume\(volumeType: AudioVolumeType, volume: number\): Promise Sets the volume for a stream. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Volume **Parameters:** | Name | Type | Mandatory | Description | | ---------- | ----------------------------------- | --------- | ---------------------------------------------------------------------------------------- | | volumeType | [AudioVolumeType](#audiovolumetype) | Yes | Volume stream type. | | volume | number | Yes | Volume to set. The value range can be obtained by calling getMinVolume and getMaxVolume. | **Return value:** | Type | Description | | ------------------- | ----------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioManager.setVolume(audio.AudioVolumeType.MEDIA, 10).then(() => { console.log('Promise returned to indicate a successful volume setting.'); }); ``` ### getVolume getVolume\(volumeType: AudioVolumeType, callback: AsyncCallback\): void Obtains the volume of a stream. This API uses an asynchronous callback to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Volume **Parameters:** | Name | Type | Mandatory | Description | | ---------- | ----------------------------------- | --------- | ------------------------------------ | | volumeType | [AudioVolumeType](#audiovolumetype) | Yes | Audio stream type. | | callback | AsyncCallback | Yes | Callback used to return the volume. | **Example:** ``` audioManager.getVolume(audio.AudioVolumeType.MEDIA, (err, value) => { if (err) { console.error('Failed to obtain the volume. ${err.message}'); return; } console.log('Callback invoked to indicate that the volume is obtained.'); }); ``` ### getVolume getVolume\(volumeType: AudioVolumeType\): Promise Obtains the volume of a stream. This API uses a promise to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Volume **Parameters:** | Name | Type | Mandatory | Description | | ---------- | ----------------------------------- | --------- | ------------------------------------ | | volumeType | [AudioVolumeType](#audiovolumetype) | Yes | Audio stream type. | **Return value:** | Type | Description | | ------------------- | ----------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioManager.getVolume(audio.AudioVolumeType.MEDIA).then((value) => { console.log('Promise returned to indicate that the volume is obtained.' + value); }); ``` ### getMinVolume getMinVolume\(volumeType: AudioVolumeType, callback: AsyncCallback\): void Obtains the minimum volume allowed for a stream. This API uses an asynchronous callback to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Volume **Parameters:** | Name | Type | Mandatory | Description | | ---------- | ----------------------------------- | --------- | ------------------------------------ | | volumeType | [AudioVolumeType](#audiovolumetype) | Yes | Audio stream type. | | callback | AsyncCallback | Yes | Callback used to return the volume. | **Example:** ``` audioManager.getMinVolume(audio.AudioVolumeType.MEDIA, (err, value) => { if (err) { console.error('Failed to obtain the minimum volume. ${err.message}'); return; } console.log('Callback invoked to indicate that the minimum volume is obtained.' + value); }); ``` ### getMinVolume getMinVolume\(volumeType: AudioVolumeType\): Promise Obtains the minimum volume allowed for a stream. This API uses a promise to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Volume **Parameters:** | Name | Type | Mandatory | Description | | ---------- | ----------------------------------- | --------- | ------------------------------------ | | volumeType | [AudioVolumeType](#audiovolumetype) | Yes | Audio stream type. | **Return value:** | Type | Description | | ------------------- | ----------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioManager.getMinVolume(audio.AudioVolumeType.MEDIA).then((value) => { console.log('Promised returned to indicate that the minimum volume is obtained.' + value); }); ``` ### getMaxVolume getMaxVolume\(volumeType: AudioVolumeType, callback: AsyncCallback\): void Obtains the maximum volume allowed for a stream. This API uses an asynchronous callback to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Volume **Parameters:** | Name | Type | Mandatory | Description | | ---------- | ----------------------------------- | --------- | ------------------------------------ | | volumeType | [AudioVolumeType](#audiovolumetype) | Yes | Audio stream type. | | callback | AsyncCallback | Yes | Callback used to return the volume. | **Example:** ``` audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA, (err, value) => { if (err) { console.error('Failed to obtain the maximum volume. ${err.message}'); return; } console.log('Callback invoked to indicate that the maximum volume is obtained.' + value); }); ``` ### getMaxVolume getMaxVolume\(volumeType: AudioVolumeType\): Promise Obtains the maximum volume allowed for a stream. This API uses a promise to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Volume **Parameters:** | Name | Type | Mandatory | Description | | ---------- | ----------------------------------- | --------- | ------------------------------------ | | volumeType | [AudioVolumeType](#audiovolumetype) | Yes | Audio stream type. | **Return value:** | Type | Description | | ------------------- | ----------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA).then((data) => { console.log('Promised returned to indicate that the maximum volume is obtained.'); }); ``` ### mute mute\(volumeType: AudioVolumeType, mute: boolean, callback: AsyncCallback\): void Mutes a stream. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Volume **Parameters:** | Name | Type | Mandatory | Description | | ---------- | ----------------------------------- | --------- | ------------------------------------------------------------------------------------------ | | volumeType | [AudioVolumeType](#audiovolumetype) | Yes | Audio stream type. | | mute | boolean | Yes | Mute status to set. The value true means to mute the stream, and false means the opposite. | | callback | AsyncCallback | Yes | Callback used to return the volume. | **Example:** ``` 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 mute\(volumeType: AudioVolumeType, mute: boolean\): Promise Mutes a stream. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Volume **Parameters:** | Name | Type | Mandatory | Description | | ---------- | ----------------------------------- | --------- | ------------------------------------------------------------------------------------------ | | volumeType | [AudioVolumeType](#audiovolumetype) | Yes | Audio stream type. | | mute | boolean | Yes | Mute status to set. The value true means to mute the stream, and false means the opposite. | **Return value:** | Type | Description | | ------------------- | ----------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioManager.mute(audio.AudioVolumeType.MEDIA, true).then(() => { console.log('Promise returned to indicate that the stream is muted.'); }); ``` ### isMute isMute\(volumeType: AudioVolumeType, callback: AsyncCallback\): void Checks whether a stream is muted. This API uses an asynchronous callback to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Volume **Parameters:** | Name | Type | Mandatory | Description | | ---------- | ----------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------- | | volumeType | [AudioVolumeType](#audiovolumetype) | Yes | Audio stream type. | | callback | AsyncCallback | Yes | Callback used to return the mute status of the stream. The value true means that the stream is muted, and false means the opposite.| **Example:** ``` audioManager.isMute(audio.AudioVolumeType.MEDIA, (err, value) => { if (err) { console.error('Failed to obtain the mute status. ${err.message}'); return; } console.log('Callback invoked to indicate that the mute status of the stream is obtained.' + value); }); ``` ### isMute isMute\(volumeType: AudioVolumeType\): Promise Checks whether a stream is muted. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Volume **Parameters:** | Name | Type | Mandatory | Description | | ---------- | ----------------------------------- | --------- | ------------------- | | volumeType | [AudioVolumeType](#audiovolumetype) | Yes | Audio stream type. | **Return value:** | Type | Description | | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | Promise | Promise used to return the mute status of the stream. The value true means that the stream is muted, and false means the opposite. | **Example:** ``` audioManager.isMute(audio.AudioVolumeType.MEDIA).then((value) => { console.log('Promise returned to indicate that the mute status of the stream is obtained.' + value); }); ``` ### isActive isActive\(volumeType: AudioVolumeType, callback: AsyncCallback\) Checks whether a stream is active. This API uses an asynchronous callback to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Volume **Parameters:** | Name | Type | Mandatory | Description | | ---------- | ----------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------- | | volumeType | [AudioVolumeType](#audiovolumetype) | Yes | Audio stream type. | | callback | AsyncCallback | Yes | Callback used to return the active status of the stream. The value true means that the stream is active, and false means the opposite.| **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 isActive\(volumeType: AudioVolumeType\): Promise Checks whether a stream is active. This API uses a promise to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Volume **Parameters:** | Name | Type | Mandatory | Description | | ---------- | ----------------------------------- | --------- | ------------------ | | volumeType | [AudioVolumeType](#audiovolumetype) | Yes | Audio stream type. | **Return value:** | Type | Description | | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | Promise | Promise used to return the active status of the stream. The value true means that the stream is active, and false means the opposite. | **Example:** ``` audioManager.isActive(audio.AudioVolumeType.MEDIA).then((value) => { console.log('Promise returned to indicate that the active status of the stream is obtained.' + value); }); ``` ### setRingerMode setRingerMode\(mode: AudioRingMode, callback: AsyncCallback\): void Sets the ringer mode. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Communication **Parameters:** | Name | Type | Mandatory | Description | | ---------- | ----------------------------------- | --------- | ----------------------------------- | | mode | [AudioRingMode](#audioringmode) | Yes | Ringer mode. | | callback | AsyncCallback | Yes | Callback used to return the result. | **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 setRingerMode\(mode: AudioRingMode\): Promise Sets the ringer mode. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Communication **Parameters:** | Name | Type | Mandatory | Description | | ---------- | ----------------------------------- | --------- | ----------------------------------- | | mode | [AudioRingMode](#audioringmode) | Yes | Ringer mode. | **Return value:** | Type | Description | | ------------------- | ----------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL).then(() => { console.log('Promise returned to indicate a successful setting of the ringer mode.'); }); ``` ### getRingerMode getRingerMode\(callback: AsyncCallback\): void Obtains the ringer mode. This API uses an asynchronous callback to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Communication **Parameters:** | Name | Type | Mandatory | Description | | ---------- | ----------------------------------------------- | --------- | ---------------------------------------- | | callback | AsyncCallback<[AudioRingMode](#audioringmode)> | Yes | Callback used to return the ringer mode. | **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 getRingerMode\(\): Promise Obtains the ringer mode. This API uses a promise to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Communication **Return value:** | Type | Description | | ---------------------------------------------- | --------------------------------------- | | Promise<[AudioRingMode](#audioringmode)> | Promise used to return the ringer mode. | **Example:** ``` audioManager.getRingerMode().then((value) => { console.log('Promise returned to indicate that the ringer mode is obtained.' + value); }); ``` ### setAudioParameter setAudioParameter\(key: string, value: string, callback: AsyncCallback\): void Sets an audio parameter. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Core **Parameters:** | Name | Type | Mandatory | Description | | --------- | ----------------------| --------- | ------------------------------------- | | key | string | Yes | Key of the audio parameter to set. | | value | string | Yes | Value of the audio parameter to set. | | callback | AsyncCallback | Yes | Callback used to return the result. | **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 setAudioParameter\(key: string, value: string\): Promise Sets an audio parameter. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Core **Parameters:** | Name | Type | Mandatory | Description | | --------- | ----------------------| --------- | ------------------------------------- | | key | string | Yes | Key of the audio parameter to set. | | value | string | Yes | Value of the audio parameter to set. | **Return value:** | Type | Description | | ------------------- | ----------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioManager.setAudioParameter('PBits per sample', '8 bit').then(() => { console.log('Promise returned to indicate a successful setting of the audio parameter.'); }); ``` ### getAudioParameter getAudioParameter\(key: string, callback: AsyncCallback\) Obtains the value of an audio parameter. This API uses an asynchronous callback to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Core **Parameters:** | Name | Type | Mandatory | Description | | --------- | ----------------------| --------- | ---------------------------------------------------------- | | key | string | Yes | Key of the audio parameter whose value is to be obtained. | | callback | AsyncCallback | Yes | Callback used to return the value of the audio parameter. | **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 getAudioParameter\(key: string\): Promise Obtains the value of an audio parameter. This API uses a promise to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Core **Parameters:** | Name | Type | Mandatory | Description | | --------- | ----------------------| --------- | ----------------------------------------------------------- | | key | string | Yes | Key of the audio parameter whose value is to be obtained. | **Return value:** | Type | Description | | ------------------- | ----------------------------------- | | Promise | Promise used to return the value of the audio parameter. | **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 getDevices\(deviceFlag: DeviceFlag, callback: AsyncCallback\): void Obtains the audio devices with a specific flag. This API uses an asynchronous callback to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Device **Parameters:** | Name | Type | Mandatory | Description | | --------- | ---------------------------------------------------------------- | --------- | ----------------------------------------- | | deviceFlag | [DeviceFlag](#deviceflag) | Yes | Audio device flag. | | callback | AsyncCallback<[AudioDeviceDescriptors](#audiodevicedescriptors)> | Yes | Callback used to return the device list. | **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 getDevices\(deviceFlag: DeviceFlag\): Promise Obtains the audio devices with a specific flag. This API uses a promise to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Device **Parameters:** | Name | Type | Mandatory | Description | | --------- | --------------------------- | --------- | ------------------- | | deviceFlag | [DeviceFlag](#deviceflag) | Yes | Audio device flag. | **Return value:** | Type | Description | | ----------------------------------------------------------- | ---------------------------------------- | | Promise<[AudioDeviceDescriptors](#audiodevicedescriptors)> | Promise used to return the device list. | **Example:** ``` audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG).then((data) => { console.log('Promise returned to indicate that the device list is obtained.'); }); ``` ### setDeviceActive setDeviceActive\(deviceType: DeviceType, active: boolean, callback: AsyncCallback\): void Sets a device to the active state. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Device **Parameters:** | Name | Type | Mandatory | Description | | --------- | ---------------------------------------| --------- | ---------------------------------------------------------------------------------------------------------------- | | deviceType | [ActiveDeviceType](#activedevicetype) | Yes | Audio device type. | | active | boolean | Yes | Active status to set. The value true means to set the device to the active status, and false means the opposite. | | callback | AsyncCallback | Yes | Callback used to return the result. | **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 setDeviceActive\(deviceType: DeviceType, active: boolean\): Promise Sets a device to the active state. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Device **Parameters:** | Name | Type | Mandatory | Description | | --------- | ---------------------------------------| --------- | ---------------------------------------------------------------------------------------------------------------- | | deviceType | [ActiveDeviceType](#activedevicetype) | Yes | Audio device type. | | active | boolean | Yes | Active status to set. The value true means to set the device to the active status, and false means the opposite. | **Return value:** | Type | Description | | ------------------- | ----------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioManager.setDeviceActive(audio.DeviceType.SPEAKER, true).then(() => { console.log('Promise returned to indicate that the device is set to the active status.'); }); ``` ### isDeviceActive isDeviceActive\(deviceType: DeviceType, callback: AsyncCallback\): void Checks whether a device is active. This API uses an asynchronous callback to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Device **Parameters:** | Name | Type | Mandatory | Description | | --------- | ---------------------------------------| --------- | -------------------------------------------------------- | | deviceType | [ActiveDeviceType](#activedevicetype) | Yes | Audio device type. | | callback | AsyncCallback | Yes | Callback used to return the active status of the device. | **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 isDeviceActive\(deviceType: DeviceType\): Promise Checks whether a device is active. This API uses a promise to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Device **Parameters:** | Name | Type | Mandatory | Description | | --------- | ---------------------------------------| --------- | ----------------------------------------- | | deviceType | [ActiveDeviceType](#activedevicetype) | Yes | Audio device type. | **Return value:** | Type | Description | | ------------------- | ----------------------------------- | | Promise | Promise used to return the active status of the device. | **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 setMicrophoneMute\(mute: boolean, callback: AsyncCallback\): void Mutes or unmutes the microphone. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Device **Parameters:** | Name | Type | Mandatory | Description | | --------- | -------------------- | --------- | ---------------------------------------------------------------------------------------------- | | mute | boolean | Yes | Mute status to set. The value true means to mute the microphone, and false means the opposite. | | callback | AsyncCallback | Yes | Callback used to return the result. | **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 setMicrophoneMute\(mute: boolean\): Promise Mutes or unmutes the microphone. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Device **Parameters:** | Name | Type | Mandatory | Description | | --------- | -------------------- | --------- | ---------------------------------------------------------------------------------------------- | | mute | boolean | Yes | Mute status to set. The value true means to mute the microphone, and false means the opposite. | **Return value:** | Type | Description | | ------------------- | ----------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioManager.setMicrophoneMute(true).then(() => { console.log('Promise returned to indicate that the microphone is muted.'); }); ``` ### isMicrophoneMute isMicrophoneMute\(callback: AsyncCallback\): void Checks whether the microphone is muted. This API uses an asynchronous callback to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Device **Parameters:** | Name | Type | Mandatory | Description | | --------- | -------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | callback | AsyncCallback | Yes | Callback used to return the mute status of the microphone. The value true means that the microphone is muted, and false means the opposite. | **Example:** ``` var audioManager = audio.getAudioManager(); 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 isMicrophoneMute\(\): Promise Checks whether the microphone is muted. This API uses a promise to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Device **Return value:** | Type | Description | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | Promise | Promise used to return the mute status of the microphone. The value true means that the microphone is muted, and false means the opposite. | **Example:** ``` var audioManager = audio.getAudioManager(); audioManager.isMicrophoneMute().then((value) => { console.log('Promise returned to indicate that the mute status of the microphone is obtained.', + value); }); ``` ### on('volumeChange')8+ on(type: 'volumeChange', callback: Callback\): void Subscribes to system volume change events. This API uses a callback to get volume change events. This is a system API and cannot be called by third-party applications. **System capability:** SystemCapability.Multimedia.Audio.Volume **Parameters:** | Name | Type | Mandatory | Description | | :------- | :--------------------------------------| :-------------| :------------------------------------------------------------------------------------------------------------------------------------------------------------ | | type | string | Yes | Type of the event to subscribe to. The value 'volumeChange' means the system volume change event, which is triggered when a system volume change is detected. | | callback | Callback<[VolumeEvent](#volumeevent8)> | Yes | Callback used to get the system volume change event. | **Example:** ``` audioManager.on('volumeChange', (volumeEvent) => { console.log('VolumeType of stream: ' + volumeEvent.volumeType); console.log('Volume level: ' + volumeEvent.volume); console.log('Whether to updateUI: ' + volumeEvent.updateUi); }); ``` ### on('ringerModeChange')8+ on(type: 'ringerModeChange', callback: Callback\): void Subscribes to ringer mode change events. This API uses a callback to get ringer mode changes. This is a system API and cannot be called by third-party applications. **System capability:** SystemCapability.Multimedia.Audio.Communication **Parameters:** | Name | Type | Mandatory | Description | | :------- | :----------------------------------------- | :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- | | type | string | Yes | Type of the event to subscribe to. The value 'ringerModeChange' means the ringer mode change event, which is triggered when a ringer mode change is detected. | | callback | Callback<[AudioRingMode](#audioringmode)> | Yes | Callback used to get the updated ringer mode. | **Example:** ``` audioManager.on('ringerModeChange', (ringerMode) => { console.log('Updated ringermode: ' + ringerMode); }); ``` ### on('deviceChange') on(type: 'deviceChange', callback: Callback): void Subscribes to device change events. When a device is connected/disconnected, registered clients will receive the callback. **System capability:** SystemCapability.Multimedia.Audio.Device **Parameters:** | Name | Type | Mandatory | Description | | :------- | :-------------------------------------------------- | :---------| :---------------------------------------------------------------------------------------------------------------------------------------------- | | type | string | Yes | Type of the event to subscribe to. The value 'deviceChange' means the device change event, which is triggered when a device change is detected. | | callback | Callback<[DeviceChangeAction](#DeviceChangeAction)> | Yes | Callback used to obtain the device update details. | **Example:** ``` audioManager.on('deviceChange', (deviceChanged) => { console.info("device change type : " + deviceChanged.type); console.info("device descriptor size : " + deviceChanged.deviceDescriptors.length); console.info("device change descriptor : " + deviceChanged.deviceDescriptors[0].deviceRole); console.info("device change descriptor : " + deviceChanged.deviceDescriptors[0].deviceType); }); ``` ### off('deviceChange') off(type: 'deviceChange', callback?: Callback): void Unsubscribes from audio device connection change events. This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR. **System capability:** SystemCapability.Multimedia.Audio.Device **Parameters:** | Name | Type | Mandatory | Description | | :------- | :-------------------------------------------------- | :---------| :-------------------------------------------------- | | type | string | Yes | Type of the event to unsubscribe from. | | callback | Callback<[DeviceChangeAction](#DeviceChangeAction)> | Yes | Callback used to obtain the device update details. | **Example:** ``` audioManager.off('deviceChange', (deviceChanged) => { console.log("Should be no callback."); }); ``` ### on('interrupt') on(type: 'interrupt', interrupt: AudioInterrupt, callback: Callback\): void Subscribes to audio interrupt events. When the application's audio is interrupted by another playback event, the application will receive the callback. This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | --------- | --------------------------------------------- | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | type | string | Yes | Type of event to subscribe to. The value 'interrupt' means the audio interrupt event, which is triggered when the audio playback of the current application is interrupted by another application.| | interrupt | AudioInterrupt | Yes | Audio interrupt event type. | | callback | Callback<[InterruptAction](#interruptaction)> | Yes | Audio interrupt event callback method. | **Example:** ``` var interAudioInterrupt = { streamUsage:2, contentType:0, pauseWhenDucked:true }; this.audioManager.on('interrupt', interAudioInterrupt, (InterruptAction) => { if (InterruptAction.actionType === 0) { console.log("An event to gain the audio focus starts."); console.log("Focus gain event:" + JSON.stringify(InterruptAction)); } if (InterruptAction.actionType === 1) { console.log("An audio interruption event starts."); console.log("Audio interruption event:" + JSON.stringify(InterruptAction)); } }); ``` ### off('interrupt') off(type: 'interrupt', interrupt: AudioInterrupt, callback?: Callback\): void Unsubscribes from audio interrupt events. This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | --------- | --------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | type | string | Yes | Type of event to unsubscribe from. The value 'interrupt' means the audio interrupt event, which is triggered when the audio playback of the current application is interrupted by another application. | | interrupt | AudioInterrupt | Yes | Audio interrupt event type. | | callback | Callback<[InterruptAction](#interruptaction)> | No | Audio interrupt event callback method. | **Example:** ``` var interAudioInterrupt = { streamUsage:2, contentType:0, pauseWhenDucked:true }; this.audioManager.off('interrupt', interAudioInterrupt, (InterruptAction) => { if (InterruptAction.actionType === 0) { console.log("An event to release the audio focus starts."); console.log("Focus release event:" + JSON.stringify(InterruptAction)); } }); ``` ### setAudioScene8+ setAudioScene\(scene: AudioScene, callback: AsyncCallback\): void Sets the audio scene mode to change audio strategies. This API uses an asynchronous callback to return the result. This is a system API and cannot be called by third-party applications. **System capability:** SystemCapability.Multimedia.Audio.Communication **Parameters:** | Name | Type | Mandatory | Description | | :------- | :------------------------------------ | :-------- | :---------------------------------- | | scene | AudioScene | Yes | Audio scene mode. | | callback | AsyncCallback | Yes | Callback used to return the result. | **Example:** ``` audioManager.setAudioScene(audio.AudioScene.AUDIO_SCENE_PHONE_CALL, (err) => { if (err) { console.error('Failed to set the audio scene mode.​ ${err.message}'); return; } console.log('Callback invoked to indicate a successful setting of the audio scene mode.'); }); ``` ### setAudioScene8+ setAudioScene\(scene: AudioScene\): Promise Sets the audio scene mode to change audio strategies. This API uses a promise to return the result. This is a system API and cannot be called by third-party applications. **System capability:** SystemCapability.Multimedia.Audio.Communication **Parameters:** | Name | Type | Mandatory | Description | | :------- | :-------------------------------------- | :-------- | :---------------- | | scene | AudioScene | Yes | Audio scene mode. | **Return value:** | Type | Description | | :------------- | :---------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioManager.setAudioScene(audio.AudioSceneMode.AUDIO_SCENE_PHONE_CALL).then(() => { console.log('Promise returned to indicate a successful setting of the audio scene mode.'); }).catch ((err) => { console.log('Failed to set the audio scene mode'); }); ``` ### getAudioScene8+ getAudioScene\(callback: AsyncCallback\): void Obtains the audio scene mode. This API uses an asynchronous callback to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Communication **Parameters:** | Name | Type | Mandatory | Description | | :------- | :-------------------------------------------------- | :-------- | :-------------------------------------------- | | callback | AsyncCallback<AudioScene> | Yes | Callback used to return the audio scene mode. | **Example:** ``` audioManager.getAudioScene((err, value) => { if (err) { console.error('Failed to obtain the audio scene mode.​ ${err.message}'); return; } console.log('Callback invoked to indicate that the audio scene mode is obtained.' + value); }); ``` ### getAudioScene8+ getAudioScene\(\): Promise Obtains the audio scene mode. This API uses a promise to return the query result. **System capability:** SystemCapability.Multimedia.Audio.Communication **Return value:** | Type | Description | | :-------------------------------------------- | :------------------------------------------- | | Promise<AudioScene> | Promise used to return the audio scene mode. | **Example:** ``` audioManager.getAudioScene().then((value) => { console.log('Promise returned to indicate that the audio scene mode is obtained.' + value); }).catch ((err) => { console.log('Failed to obtain the audio scene mode'); }); ``` ## AudioDeviceDescriptor Describes an audio device. **System capability:** SystemCapability.Multimedia.Audio.Device | Name | Type | Readable | Writable | Description | | ---------- | ------------------------- | -------- | -------- | ------------------ | | deviceRole | [DeviceRole](#devicerole) | Yes | No | Audio device role. | | deviceType | [DeviceType](#devicetype) | Yes | No | Audio device type. | ## AudioDeviceDescriptors Array of [AudioDeviceDescriptor](#audiodevicedescriptor), which is read-only. **System capability:** SystemCapability.Multimedia.Audio.Device **Example:** ``` import audio from '@ohos.multimedia.audio'; function displayDeviceProp(value) { deviceRoleValue = value.deviceRole; deviceTypeValue = value.deviceType; } var deviceRoleValue = null; var deviceTypeValue = null; const promise = audio.getAudioManager().getDevices(1); promise.then(function (value) { console.info('AudioFrameworkTest: Promise: getDevices OUTPUT_DEVICES_FLAG'); value.forEach(displayDeviceProp); if (deviceTypeValue != null && deviceRoleValue != null){ console.info('AudioFrameworkTest: Promise: getDevices : OUTPUT_DEVICES_FLAG : PASS'); } else{ console.info('AudioFrameworkTest: Promise: getDevices : OUTPUT_DEVICES_FLAG : FAIL'); } }); ``` ## AudioRenderer8+ Provides related APIs for audio rendering. Before calling the AudioRenderer API, you need to create an instance through [createAudioRenderer](#audiocreateaudiorenderer8). **System capability:** SystemCapability.Multimedia.Audio.Renderer ### state8+ readonly state: AudioState Defines the current render state. **System capability:** SystemCapability.Multimedia.Audio.Renderer | Name | Type | Readable | Writable | Description | | :---- | :-------------------------- | :------- | :------- | :------------------ | | state | [AudioState](#audiostate8) | Yes | No | Audio render state. | **Example:** ``` var state = audioRenderer.state; ``` ### getRendererInfo8+ getRendererInfo(callback: AsyncCallback): void Obtains the renderer information provided while creating a renderer instance. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :------------------------------------------------------- | :-------- | :------------------------------------------------ | | callback | AsyncCallback<[AudioRendererInfo](#audiorendererinfo8)> | Yes | Callback used to return the renderer information. | **Example:** ``` audioRenderer.getRendererInfo((err, rendererInfo) => { console.log('Renderer GetRendererInfo:'); console.log('Renderer content:' + rendererInfo.content); console.log('Renderer usage:' + rendererInfo.usage); console.log('Renderer flags:' + rendererInfo.rendererFlags); }); ``` ### getRendererInfo8+ getRendererInfo(): Promise Obtains the renderer information provided while creating a renderer instance. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Return value:** | Type | Description | | :-------------------------------------------------- | :----------------------------------------------- | | Promise<[AudioRendererInfo](#audiorendererinfo8)> | Promise used to return the renderer information. | **Example:** ``` audioRenderer.getRendererInfo().then((rendererInfo) => { console.log('Renderer GetRendererInfo:'); console.log('Renderer content:' + rendererInfo.content); console.log('Renderer usage:' + rendererInfo.usage); console.log('Renderer flags:' + rendererInfo.rendererFlags); }).catch((err) => { console.log('AudioFrameworkRenderLog: RendererInfo :ERROR: '+err.message); resultFlag = false; }); ``` ### getStreamInfo8+ getStreamInfo(callback: AsyncCallback): void Obtains the renderer stream information. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :------------------------------------------------------ | :-------- | :---------------------------------------------- | | callback | AsyncCallback<[AudioStreamInfo](#audiostreaminfo8)\> | Yes | Callback used to return the stream information. | **Example:** ``` audioRenderer.getStreamInfo((err, streamInfo) => { console.log('Renderer GetStreamInfo:'); console.log('Renderer sampling rate:' + streamInfo.samplingRate); console.log('Renderer channel:' + streamInfo.channels); console.log('Renderer format:' + streamInfo.sampleFormat); console.log('Renderer encoding type:' + streamInfo.encodingType); }); ``` ### getStreamInfo8+ getStreamInfo(): Promise Obtains the renderer stream information. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Return value:** | Type | Description | | :------------------------------------------------- | :--------------------------------------------- | | Promise<[AudioStreamInfo](#audiostreaminfo8)\> | Promise used to return the stream information. | **Example:** ``` audioRenderer.getStreamInfo().then((streamInfo) => { console.log('Renderer GetStreamInfo:'); console.log('Renderer sampling rate:' + streamInfo.samplingRate); console.log('Renderer channel:' + streamInfo.channels); console.log('Renderer format:' + streamInfo.sampleFormat); console.log('Renderer encoding type:' + streamInfo.encodingType); }).catch((err) => { console.log('ERROR: '+err.message); }); ``` ### start8+ start(callback: AsyncCallback): void Starts the renderer. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :---------------------- | :-------- | :-------------------------------------- | | callback | AsyncCallback | Yes | Callback used to return the result. | | | | | | **Example:** ``` audioRenderer.start((err) => { if (err) { console.error('Renderer start failed.'); } else { console.info('Renderer start success.'); } }); ``` ### start8+ start(): Promise Starts the renderer. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Return value:** | Type | Description | | :------------- | :--------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioRenderer.start().then(() => { console.log('Renderer started'); }).catch((err) => { console.log('ERROR: '+err.message); }); ``` ### pause8+ pause(callback: AsyncCallback\): void Pauses rendering. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :---------------------- | :-------- | :------------------------------------ | | callback | AsyncCallback | Yes | Callback used to return the result. | | | | | | **Example:** ``` audioRenderer.pause((err) => { if (err) { console.error('Renderer pause failed'); } else { console.log('Renderer paused.'); } }); ``` ### pause8+ pause(): Promise\ Pauses rendering. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Return value:** | Type | Description | | :------------- | :--------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioRenderer.pause().then(() => { console.log('Renderer paused'); }).catch((err) => { console.log('ERROR: '+err.message); }); ``` ### drain8+ drain(callback: AsyncCallback\): void Drains the playback buffer. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :---------------------- | :-------- | :---------------------------------------| | callback | AsyncCallback | Yes | Callback used to return the result. | | | | | | **Example:** ``` audioRenderer.drain((err) => { if (err) { console.error('Renderer drain failed'); } else { console.log('Renderer drained.'); } }); ``` ### drain8+ drain(): Promise\ Drains the playback buffer. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Return value:** | Type | Description | | :------------- | :--------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioRenderer.drain().then(() => { console.log('Renderer drained successfully'); }).catch((err) => { console.log('ERROR: '+err.message); }); ``` ### stop8+ stop(callback: AsyncCallback\): void Stops rendering. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :---------------------- | :-------- | :------------------------------------- | | callback | AsyncCallback | Yes | Callback used to return the result. | **Example:** ``` audioRenderer.stop((err) => { if (err) { console.error('Renderer stop failed'); } else { console.log('Renderer stopped.'); } }); ``` ### stop8+ stop(): Promise\ Stops rendering. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Return value:** | Type | Description | | :------------- | :--------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioRenderer.stop().then(() => { console.log('Renderer stopped successfully'); }).catch((err) => { console.log('ERROR: '+err.message); }); ``` ### release8+ release(callback: AsyncCallback\): void Releases the renderer. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :---------------------- | :-------- | :------------------------------------- | | callback | AsyncCallback | Yes | Callback used to return the result. | **Example:** ``` audioRenderer.release((err) => { if (err) { console.error('Renderer release failed'); } else { console.log('Renderer released.'); } }); ``` ### release8+ release(): Promise\ Releases the renderer. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Return value:** | Type | Description | | :------------- | :--------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioRenderer.release().then(() => { console.log('Renderer released successfully'); }).catch((err) => { console.log('ERROR: '+err.message); }); ``` ### write8+ write(buffer: ArrayBuffer, callback: AsyncCallback\): void Writes the buffer. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :---------------------- | :-------- | :--------------------------------------------------------------------------------------------------- | | buffer | ArrayBuffer | Yes | Buffer to be written. | | callback | AsyncCallback | Yes | Returns the number of bytes written if the operation is successful; returns an error code otherwise. | **Example:** ``` import audio from '@ohos.multimedia.audio'; import fileio from '@ohos.fileio'; let ss = fileio.createStreamSync(filePath, 'r'); let buf = new ArrayBuffer(bufferSize); ss.readSync(buf); audioRenderer.write(buf, (err, writtenbytes) => { if (writtenbytes < 0) { console.error('write failed.'); } else { console.log('Actual written bytes: ' + writtenbytes); } }); ``` ### write8+ write(buffer: ArrayBuffer): Promise\ Writes the buffer. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Return value:** | Type | Description | | :--------------- | :--------------------------------------------------------------------------------------------------- | | Promise | Returns the number of bytes written if the operation is successful; returns an error code otherwise. | **Example:** ``` 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 buf = new ArrayBuffer(bufferSize); ss.readSync(buf); audioRenderer.write(buf).then((writtenbytes) => { if (writtenbytes < 0) { console.error('write failed.'); } else { console.log('Actual written bytes: ' + writtenbytes); } }).catch((err) => { console.log('ERROR: '+err.message); }); ``` ### getAudioTime8+ getAudioTime(callback: AsyncCallback\): void Obtains the timestamp in Unix epoch time (starts from January 1, 1970), in nanoseconds. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :--------------------- | :-------- | :------------------------------------- | | callback | AsyncCallback | Yes | Callback used to return the timestamp. | **Example:** ``` audioRenderer.getAudioTime((err, timestamp) => { console.log('Current timestamp: ' + timestamp); }); ``` ### getAudioTime8+ getAudioTime(): Promise\ Obtains the timestamp in Unix epoch time (starts from January 1, 1970), in nanoseconds. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Return value:** | Type | Description | | :--------------- | :------------------------------------ | | Promise | Promise used to return the timestamp. | **Example:** ``` audioRenderer.getAudioTime().then((timestamp) => { console.log('Current timestamp: ' + timestamp); }).catch((err) => { console.log('ERROR: '+err.message); }); ``` ### getBufferSize8+ getBufferSize(callback: AsyncCallback\): void Obtains a reasonable minimum buffer size in bytes for rendering. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :--------------------- | :-------- | :--------------------------------------- | | callback | AsyncCallback | Yes | Callback used to return the buffer size. | **Example:** ``` audioRenderer.getBufferSize((err, bufferSize) => { if (err) { console.error('getBufferSize error'); } }); let buf = new ArrayBuffer(bufferSize); ss.readSync(buf); ``` ### getBufferSize8+ getBufferSize(): Promise\ Obtains a reasonable minimum buffer size in bytes for rendering. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Return value:** | Type | Description | | :--------------- | :-------------------------------------- | | Promise | Promise used to return the buffer size. | **Example:** ``` audioRenderer.getBufferSize().then((bufferSize) => { let buf = new ArrayBuffer(bufferSize); ss.readSync(buf); }).catch((err) => { console.log('ERROR: '+err.message); }); ``` ### setRenderRate8+ setRenderRate(rate: AudioRendererRate, callback: AsyncCallback\): void Sets the render rate. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :------------------------------------------ | :-------- | :---------------------------------- | | rate | [AudioRendererRate](#audiorendererrate8) | Yes | Audio render rate. | | callback | AsyncCallback | Yes | Callback used to return the result. | **Example:** ``` audioRenderer.setRenderRate(audio.AudioRendererRate.RENDER_RATE_NORMAL, (err) => { if (err) { console.error('Failed to set params'); } else { console.log('Callback invoked to indicate a successful render rate setting.'); } }); ``` ### setRenderRate8+ setRenderRate(rate: AudioRendererRate): Promise\ Sets the render rate. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :--- | :--------------------------------------- | :-------- | :----------------- | | rate | [AudioRendererRate](#audiorendererrate8) | Yes | Audio render rate. | **Return value:** | Type | Description | | :------------- | :--------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioRenderer.setRenderRate(audio.AudioRendererRate.RENDER_RATE_NORMAL).then(() => { console.log('setRenderRate SUCCESS'); }).catch((err) => { console.log('ERROR: '+err.message); }); ``` ### getRenderRate8+ getRenderRate(callback: AsyncCallback\): void Obtains the current render rate. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :------------------------------------------------------- | :-------- | :--------------------------------------------- | | callback | AsyncCallback<[AudioRendererRate](#audiorendererrate8)\> | Yes | Callback used to return the audio render rate. | **Example:** ``` audioRenderer.getRenderRate((err, renderrate) => { console.log('getRenderRate: ' + renderrate); }); ``` ### getRenderRate8+ getRenderRate(): Promise\ Obtains the current render rate. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Return value:** | Type | Description | | :-------------------------------------------------- | :-------------------------------------------- | | Promise<<[AudioRendererRate](#audiorendererrate8)\> | Promise used to return the audio render rate. | **Example:** ``` audioRenderer.getRenderRate().then((renderRate) => { console.log('getRenderRate: ' + renderRate); }).catch((err) => { console.log('ERROR: '+err.message); }); ``` ### on('interrupt')9+ on(type: 'interrupt', callback: Callback\): void Subscribes to audio interrupt events. This API uses a callback to get interrupt events. The interrupt event is triggered when audio rendering is interrupted. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :-------------------------------------------- | :-------- | :---------------------------------------------- | | type | string | Yes | Type of the playback event to subscribe to. | | callback | Callback<[InterruptEvent](#interruptevent9)\> | Yes | Callback used to listen for interrupt callback. | **Example:** ``` audioRenderer.on('interrupt', (interruptEvent) => { if (interruptEvent.forceType == audio.InterruptForceType.INTERRUPT_FORCE) { switch (interruptEvent.hintType) { case audio.InterruptHint.INTERRUPT_HINT_PAUSE: console.log('Force paused. Stop writing'); isPlay = false; break; case audio.InterruptHint.INTERRUPT_HINT_STOP: console.log('Force stopped. Stop writing'); isPlay = false; break; } } else if (interruptEvent.forceType == audio.InterruptForceType.INTERRUPT_SHARE) { switch (interruptEvent.hintType) { case audio.InterruptHint.INTERRUPT_HINT_RESUME: console.log('Resume force paused renderer or ignore'); startRenderer(); break; case audio.InterruptHint.INTERRUPT_HINT_PAUSE: console.log('Choose to pause or ignore'); pauseRenderer(); break; } } }); ``` ### on('markReach')8+ on(type: 'markReach', frame: number, callback: (position: number) => {}): void Subscribes to mark reached events. When the number of frames rendered reaches the value of the frame parameter, the callback is invoked. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :------------------------ | :-------- | :----------------------------------------------------------------------- | | type | string | Yes | Type of the renderer event to subscribe to. | | frame | number | Yes | Number of frames to trigger the event. The value must be greater than 0. | | callback | (position: number) => {} | Yes | Callback invoked when the event is triggered. | **Example:** ``` audioRenderer.on('markReach', 1000, (position) => { if (position == "1000") { console.log('ON Triggered successfully'); } }); ``` ### off('markReach') 8+ off(type: 'markReach'): void Unsubscribes from mark reached events. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :------------------------ | :-------- | :----------------------------------------------- | | type | string | Yes | Type of the renderer event to unsubscribe from. | **Example:** ``` audioRenderer.off('markReach'); ``` ### on('periodReach') 8+ on(type: "periodReach", frame: number, callback: (position: number) => {}): void Subscribes to period reached events. When the period of frame rendering reaches the value of frame parameter, the callback is invoked. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :------------------------ | :-------- | :--------------------------------------------------------------------------------- | | type | string | Yes | Type of the renderer event to subscribe to. | | frame | number | Yes | Period during which frame rendering is listened. The value must be greater than 0. | | callback | (position: number) => {} | Yes | Callback invoked when the event is triggered. | **Example:** ``` audioRenderer.on('periodReach', 1000, (position) => { if (position == "1000") { console.log('ON Triggered successfully'); } }); ``` ### off('periodReach') 8+ off(type: 'periodReach'): void Unsubscribes from period reached events. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :------------------------ | :-------- | :----------------------------------------------- | | type | string | Yes | Type of the renderer event to unsubscribe from. | **Example:** ``` audioRenderer.off('periodReach') ``` ### on('stateChange') 8+ on(type: 'stateChange', callback: Callback): void Subscribes to state change events. **System capability:** SystemCapability.Multimedia.Audio.Renderer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :------------------------- | :-------- | :--------------------------------------------------------------------------------------- | | type | string | Yes | Type of the event to subscribe to. The value 'stateChange' means the state change event. | | callback | [AudioState](#AudioState8) | Yes | Callback used to return the state change. | **Example:** ``` audioRenderer.on('stateChange', (state) => { if (state == 1) { console.log("audio renderer state is: STATE_PREPARED"); } if (state == 2) { console.log("audio renderer state is: STATE_RUNNING"); } }); ``` ## AudioCapturer8+ Provides related APIs for audio capture. Before calling the API of AudioCapturer, you need to create an instance through [createAudioCapturer](#audiocreateaudiocapturer8). ### state8+ readonly state: AudioState Defines the current capture state. **System capability:** SystemCapability.Multimedia.Audio.Capturer | Name | Type | Readable | Writable | Description | | :---- | :------------------------- | :------- | :------- | :------------------- | | state | [AudioState](#audiostate8) | Yes | No | Audio capture state. | **Example:** ``` var state = audioCapturer.state; ``` ### getCapturerInfo8+ getCapturerInfo(callback: AsyncCallback): void Obtains the capturer information provided while creating a capturer instance. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :------------------------------------------------------- | :-------- | :------------------------------------------------ | | callback | AsyncCallback<[AudioCapturerInfo](#audioCapturerInfo)\> | Yes | Callback used to return the capturer information. | **Example:** ``` audioCapturer.getCapturerInfo((err, capturerInfo) => { if (err) { console.error('Failed to get capture info'); } else { console.log('Capturer getCapturerInfo:'); console.log('Capturer source:' + capturerInfo.source); console.log('Capturer flags:' + capturerInfo.capturerFlags); } }); ``` ### getCapturerInfo8+ getCapturerInfo(): Promise Obtains the capturer information provided while creating a capturer instance. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Return value:** | Type | Description | | :-------------------------------------------------- | :----------------------------------------------- | | Promise<[AudioCapturerInfo](#audiocapturerinfo)\> | Promise used to return the capturer information. | **Example:** ``` audioCapturer.getCapturerInfo().then((audioParamsGet) => { if (audioParamsGet != undefined) { console.info('AudioFrameworkRecLog: Capturer CapturerInfo:'); console.info('AudioFrameworkRecLog: Capturer SourceType:' + audioParamsGet.source); console.info('AudioFrameworkRecLog: Capturer capturerFlags:' + audioParamsGet.capturerFlags); }else { console.info('AudioFrameworkRecLog: audioParamsGet is : '+audioParamsGet); console.info('AudioFrameworkRecLog: audioParams getCapturerInfo are incorrect: '); } }).catch((err) => { console.log('AudioFrameworkRecLog: CapturerInfo :ERROR: '+err.message); }); ``` ### getStreamInfo8+ getStreamInfo(callback: AsyncCallback): void Obtains the capturer stream information. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :----------------------------------------------------------- | :-------- | :---------------------------------------------- | | callback | AsyncCallback<[AudioStreamInfo](#AudioRendererOptions8)\> | Yes | Callback used to return the stream information. | **Example:** ``` audioCapturer.getStreamInfo((err, streamInfo) => { if (err) { console.error('Failed to get stream info'); } else { console.log('Capturer GetStreamInfo:'); console.log('Capturer sampling rate:' + streamInfo.samplingRate); console.log('Capturer channel:' + streamInfo.channels); console.log('Capturer format:' + streamInfo.sampleFormat); console.log('Capturer encoding type:' + streamInfo.encodingType); } }); ``` ### getStreamInfo8+ getStreamInfo(): Promise Obtains the capturer stream information. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Return value:** | Type | Description | | :---------------------------------------------------- | :----------------------------------------------- | | Promise<[AudioStreamInfo](#AudioRendererOptions8)\> | Promise used to return the stream information. | **Example:** ``` audioCapturer.getStreamInfo().then((audioParamsGet) => { console.info('getStreamInfo:'); console.info('sampleFormat:' + audioParamsGet.sampleFormat); console.info('samplingRate:' + audioParamsGet.samplingRate); console.info('channels:' + audioParamsGet.channels); console.info('encodingType:' + audioParamsGet.encodingType); }).catch((err) => { console.log('getStreamInfo :ERROR: ' + err.message); }); ``` ### start8+ start(callback: AsyncCallback): void Starts capturing. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :---------------------- | :-------- | :-------------------------------------- | | callback | AsyncCallback | Yes | Callback used to return the result. | **Example:** ``` audioCapturer.start((err) => { if (err) { console.error('Capturer start failed.'); } else { console.info('Capturer start success.'); } }); ``` ### start8+ start(): Promise Starts capturing. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Return value:** | Type | Description | | :------------- | :--------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioCapturer.start().then(() => { console.info('AudioFrameworkRecLog: ---------START---------'); console.info('AudioFrameworkRecLog: Capturer started :SUCCESS '); 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; }); ``` ### stop8+ stop(callback: AsyncCallback): void Stops capturing. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :---------------------- | :-------- | :------------------------------------- | | callback | AsyncCallback | Yes | Callback used to return the result. | **Example:** ``` audioCapturer.stop((err) => { if (err) { console.error('Capturer stop failed'); } else { console.log('Capturer stopped.'); } }); ``` ### stop8+ stop(): Promise Stops capturing. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Return value:** | Type | Description | | :------------- | :--------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioCapturer.stop().then(() => { console.info('AudioFrameworkRecLog: ---------RELEASE RECORD---------'); console.info('AudioFrameworkRecLog: Capturer stopped : SUCCESS'); 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; }); ``` ### release8+ release(callback: AsyncCallback): void Releases the capturer. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :---------------------- | :-------- | :------------------------------------- | | callback | AsyncCallback | Yes | Callback used to return the result. | **Example:** ``` audioCapturer.release((err) => { if (err) { console.error('capturer release failed'); } else { console.log('capturer released.'); } }); ``` ### release8+ release(): Promise Releases the capturer. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Return value:** | Type | Description | | :------------- | :--------------------------------- | | Promise | Promise used to return the result. | **Example:** ``` audioCapturer.release().then(() => { console.info('AudioFrameworkRecLog: ---------RELEASE RECORD---------'); console.info('AudioFrameworkRecLog: Capturer release : SUCCESS'); 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 }); ``` ### read8+ read(size: number, isBlockingRead: boolean, callback: AsyncCallback): void Reads the buffer from the audio capturer. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Parameters:** | Name | Type | Mandatory | Description | | :------------- | :-------------------------- | :-------- | :-------------------------------------------- | | size | number | Yes | Number of bytes to read. | | isBlockingRead | boolean | Yes | Whether the read operation should be blocked. | | callback | AsyncCallback | Yes | Callback used to return the buffer. | **Example:** ``` audioCapturer.read(bufferSize, true, async(err, buffer) => { if (!err) { console.log("Success in reading the buffer data"); } }; ``` ### read8+ read(size: number, isBlockingRead: boolean): Promise Reads the buffer from the audio capturer. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Parameters:** | Name | Type | Mandatory | Description | | :------------- | :--------- | :-------- | :-------------------------------------------- | | size | number | Yes | Number of bytes to read. | | isBlockingRead | boolean | Yes | Whether the read operation should be blocked. | **Return value:** | Type | Description | | :-------------------- | :----------------------------------------------------------------------------------------------- | | Promise | Returns the buffer data read if the operation is successful; returns an error code otherwise. | **Example:** ``` audioCapturer.read(bufferSize, true).then((buffer) => { console.info('buffer read successfully'); }).catch((err) => { console.info('ERROR : '+err.message); }); ``` ### getAudioTime8+ getAudioTime(callback: AsyncCallback): void Obtains the timestamp in Unix epoch time (starts from January 1, 1970), in nanoseconds. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :--------------------- | :-------- | :------------------------------------- | | callback | AsyncCallback | Yes | Callback used to return the timestamp. | | | | | | **Example:** ``` audioCapturer.getAudioTime((err, timestamp) => { console.log('Current timestamp: ' + timestamp); }); ``` ### getAudioTime8+ getAudioTime(): Promise Obtains the timestamp in Unix epoch time (starts from January 1, 1970), in nanoseconds. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Return value:** | Type | Description | | :--------------- | :------------------------------------ | | Promise | Promise used to return the timestamp. | **Example:** ``` audioCapturer.getAudioTime().then((audioTime) => { console.info('AudioFrameworkRecLog: AudioCapturer getAudioTime : Success' + audioTime ); }).catch((err) => { console.info('AudioFrameworkRecLog: AudioCapturer Created : ERROR : '+err.message); }); ``` ### getBufferSize8+ getBufferSize(callback: AsyncCallback): void Obtains a reasonable minimum buffer size in bytes for capturing. This API uses an asynchronous callback to return the result. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :--------------------- | :-------- | :--------------------------------------- | | callback | AsyncCallback | Yes | Callback used to return the buffer size. | | | | | | **Example:** ``` audioCapturer.getBufferSize((err, bufferSize) => { if (!err) { console.log('BufferSize : ' + bufferSize); audioCapturer.read(bufferSize, true).then((buffer) => { console.info('Buffer read is ' + buffer ); }).catch((err) => { console.info('AudioFrameworkRecLog: AudioCapturer Created : ERROR : '+err.message); }); } }); ``` ### getBufferSize8+ getBufferSize(): Promise Obtains a reasonable minimum buffer size in bytes for capturing. This API uses a promise to return the result. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Return value:** | Type | Description | | :--------------- | :-------------------------------------- | | Promise | Promise used to return the buffer size. | **Example:** ``` audioCapturer.getBufferSize().then((bufferSize) => { if (!err) { console.log('BufferSize : ' + bufferSize); audioCapturer.read(bufferSize, true).then((buffer) => { console.info('Buffer read is ' + buffer ); }).catch((err) => { console.info('ERROR : '+err.message); }); } }); ``` ### on('markReach')8+ on(type: 'markReach', frame: number, callback: (position: number) => {}): void Subscribes to mark reached events. When the number of frames captured reaches the value of the frame parameter, the callback is invoked. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :------------------------ | :-------- | :----------------------------------------------------------------------- | | type | string | Yes | Type of the capturer event to subscribe to. | | frame | number | Yes | Number of frames to trigger the event. The value must be greater than 0. | | callback | position: number) => {} | Yes | Callback invoked when the event is triggered. | **Example:** ``` audioCapturer.on('markReach', 1000, (position) => { if (position == "1000") { console.log('ON Triggered successfully'); } }); ``` ### off('markReach')8+ off(type: 'markReach'): void Unsubscribes from the mark reached events. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :------------------------ | :-------- | :---------------------------------------------- | | type | string | Yes | Type of the capturer event to unsubscribe from. | **Example:** ``` audioCapturer.off('markReach'); ``` ### on('periodReach')8+ on(type: "periodReach", frame: number, callback: (position: number) => {}): void Subscribes to period reached events. When the period of frame capturing reaches the value of frame parameter, the callback is invoked. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :------------------------ | :-------- | :--------------------------------------------------------------------------------- | | type | string | Yes | Type of the capturer event to subscribe to. | | frame | number | Yes | Period during which frame capturing is listened. The value must be greater than 0. | | callback | (position: number) => {} | Yes | Callback invoked when the event is triggered. | **Example:** ``` audioCapturer.on('periodReach', 1000, (position) => { if (position == "1000") { console.log('ON Triggered successfully'); } }); ``` ### off('periodReach')8+ off(type: 'periodReach'): void Unsubscribes from period reached events. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :------------------------ | :-------- | :---------------------------------------------- | | type | string | Yes | Type of the capturer event to unsubscribe from. | **Example:** ``` audioCapturer.off('periodReach') ``` ### on('stateChange') 8+ on(type: 'stateChange', callback: Callback): void Subscribes to state change events. **System capability:** SystemCapability.Multimedia.Audio.Capturer **Parameters:** | Name | Type | Mandatory | Description | | :------- | :------------------------- | :-------- | :--------------------------------------------------------------------------------------- | | type | string | Yes | Type of the event to subscribe to. The value 'stateChange' means the state change event. | | callback | [AudioState](#AudioState8) | Yes | Callback used to return the state change. | **Example:** ``` audioCapturer.on('stateChange', (state) => { if (state == 1) { console.log("audio capturer state is: STATE_PREPARED"); } if (state == 2) { console.log("audio capturer state is: STATE_RUNNING"); } }); ```