Audio Management

• Modules to Import

• Required Permissions

• Functions

• getAudioManager()

• Enums

• AudioVolumeType

• DeviceFlag

• DeviceRole

• DeviceType

• Appendixes

• AudioManager

  • setVolume(AudioVolumeType, number, AsyncCallback<void>)
  • setVolume(AudioVolumeType, number)
  • getVolume(AudioVolumeType, AsyncCallback<number>)
  • getVolume(AudioVolumeType)
  • getMinVolume(AudioVolumeType, AsyncCallback<number>)
  • getMinVolume(AudioVolumeType)
  • getMaxVolume(AudioVolumeType, AsyncCallback<number>)
  • getMaxVolume(AudioVolumeType)
  • getDevices(DeviceFlag, AsyncCallback<AudioDeviceDescriptors>)
  • getDevices(DeviceFlag)

• AudioDeviceDescriptor

• AudioDeviceDescriptors

NOTE: Due to permission issues, these feature are temporarily unavailable for the standard system.

Modules to Import

import audio from '@ohos.multimedia.audio';

Required Permissions

None

Functions

getAudioManager()

Obtains an AudioManager instance.

Return Values

Example

var audioManager = audio.getAudioManager();

Enums

AudioVolumeType

Enumerates audio stream types.

DeviceFlag

Enumerates audio device flags.

DeviceRole

Enumerates device roles.

DeviceType

Enumerates device types.

Appendixes

AudioManager

Manages audio volume and audio device information.

setVolume(AudioVolumeType, number, AsyncCallback<void>)

Sets volume for a stream. This method uses an asynchronous callback to return the execution result.

Parameters

Example

audioManager.setVolume(audio.AudioVolumeType.MEDIA, 30, (err)=>{
   if (err) {
	   console.error(`failed to set volume ${err.message}`);
	   return;
   }
   console.log(`Media setVolume successful callback`);
})

setVolume(AudioVolumeType, number)

Sets volume for a stream. This method uses a promise to return the execution result.

Parameters

Return Values

Example

audioManager.setVolume(audio.AudioVolumeType.MEDIA, 30).then(()=>
    console.log(`Media setVolume successful callback`);
)

getVolume(AudioVolumeType, AsyncCallback<number>)

Obtains volume of a stream. This method uses an asynchronous callback to return the execution result.

Parameters

Example

audioManager.getVolume(audio.AudioVolumeType.MEDIA, (err, value)=>{
   if (err) {
	   console.error(`failed to get volume ${err.message}`);
	   return;
   }
   console.log(`Media getVolume successful callback`);
})

getVolume(AudioVolumeType)

Obtains the volume of a stream. This method uses a promise to return the execution result.

Parameters

Return Values

Example

audioManager.getVolume(audio.AudioVolumeType.MEDIA).then((data)=>
    console.log(`Media getVolume successful callback`);
)

getMinVolume(AudioVolumeType, AsyncCallback<number>)

Obtains the minimum volume allowed for a stream. This method uses an asynchronous callback to return the execution result.

Parameters

Example

audioManager.getMinVolume(audio.AudioVolumeType.MEDIA, (err, value)=>{
   if (err) {
	   console.error(`failed to get minvolume ${err.message}`);
	   return;
   }
   console.log(`Media getMinVolume successful callback`);
})

getMinVolume(AudioVolumeType)

Obtains the minimum volume allowed for a stream. This method uses a promise to return the execution result.

Parameters

Return Values

Example

audioManager.getMinVolume(audio.AudioVolumeType.MEDIA).then((data)=>
    console.log(`Media getMinVolume successful callback`);
)

getMaxVolume(AudioVolumeType, AsyncCallback<number>)

Obtains the maximum volume allowed for a stream. This method uses an asynchronous callback to return the execution result.

Parameters

Example

audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA, (err, value)=>{
   if (err) {
	   console.error(`failed to get maxvolume ${err.message}`);
	   return;
   }
   console.log(`Media getMaxVolume successful callback`);
})

getMaxVolume(AudioVolumeType)

Obtains the maximum volume allowed for a stream. This method uses a promise to return the execution result.

Parameters

Return Values

Example

audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA).then((data)=>
    console.log(`Media getMaxVolume successful callback`);
)

getDevices(DeviceFlag, AsyncCallback<AudioDeviceDescriptors>)

Obtains the audio devices of a specified flag. This method uses an asynchronous callback to return the execution result.

Parameters

Example

audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG, (err, value)=>{
   if (err) {
	   console.error(`failed to get getdevices ${err.message}`);
	   return;
   }
   console.log(`Media getDevices successful callback`);
})

getDevices(DeviceFlag)

Obtains the audio devices with a specified flag. This method uses a promise to return the execution result.

Parameters

Return Values

Example

audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG).then((data)=>
    console.log(`Media getDevices successful callback`);
)

AudioDeviceDescriptor

Describes audio devices.

AudioDeviceDescriptors