音頻管理

導(dǎo)入模塊

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

常量

示例：

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

const defaultVolumeGroupId = audio.DEFAULT_VOLUME_GROUP_ID;
const defaultInterruptGroupId = audio.DEFAULT_INTERRUPT_GROUP_ID;

audio.getAudioManager

getAudioManager(): AudioManager

獲取音頻管理器。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

返回值：

示例：

let audioManager = audio.getAudioManager();

audio.createAudioRenderer8+

createAudioRenderer(options: AudioRendererOptions, callback: AsyncCallback<AudioRenderer>): void

獲取音頻渲染器。使用callback方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Renderer

參數(shù)：

示例：

import featureAbility from '@ohos.ability.featureAbility';
import fs from '@ohos.file.fs';
import audio from '@ohos.multimedia.audio';

let audioStreamInfo = {
  samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
  channels: audio.AudioChannel.CHANNEL_1,
  sampleFormat: audio.AudioSampleFormat.SAMPLE_FORMAT_S16LE,
  encodingType: audio.AudioEncodingType.ENCODING_TYPE_RAW
}

let audioRendererInfo = {
  content: audio.ContentType.CONTENT_TYPE_SPEECH,
  usage: audio.StreamUsage.STREAM_USAGE_VOICE_COMMUNICATION,
  rendererFlags: 0
}

let audioRendererOptions = {
  streamInfo: audioStreamInfo,
  rendererInfo: audioRendererInfo
}

audio.createAudioRenderer(audioRendererOptions,(err, data) => {
  if (err) {
    console.error(`AudioRenderer Created: Error: ${err}`);
  } else {
    console.info('AudioRenderer Created: Success: SUCCESS');
    let audioRenderer = data;
  }
});

audio.createAudioRenderer8+

createAudioRenderer(options: AudioRendererOptions): Promise<AudioRenderer>

獲取音頻渲染器。使用Promise方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Renderer

參數(shù)：

返回值：

示例：

import featureAbility from '@ohos.ability.featureAbility';
import fs from '@ohos.file.fs';
import audio from '@ohos.multimedia.audio';

let audioStreamInfo = {
  samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
  channels: audio.AudioChannel.CHANNEL_1,
  sampleFormat: audio.AudioSampleFormat.SAMPLE_FORMAT_S16LE,
  encodingType: audio.AudioEncodingType.ENCODING_TYPE_RAW
}

let audioRendererInfo = {
  content: audio.ContentType.CONTENT_TYPE_SPEECH,
  usage: audio.StreamUsage.STREAM_USAGE_VOICE_COMMUNICATION,
  rendererFlags: 0
}

let audioRendererOptions = {
  streamInfo: audioStreamInfo,
  rendererInfo: audioRendererInfo
}

let audioRenderer;
audio.createAudioRenderer(audioRendererOptions).then((data) => {
  audioRenderer = data;
  console.info('AudioFrameworkRenderLog: AudioRenderer Created : Success : Stream Type: SUCCESS');
}).catch((err) => {
  console.error(`AudioFrameworkRenderLog: AudioRenderer Created : ERROR : ${err}`);
});

audio.createAudioCapturer8+

createAudioCapturer(options: AudioCapturerOptions, callback: AsyncCallback<AudioCapturer>): void

獲取音頻采集器。使用callback方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Capturer

需要權(quán)限： ohos.permission.MICROPHONE

參數(shù)：

示例：

import audio from '@ohos.multimedia.audio';
let audioStreamInfo = {
  samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
  channels: audio.AudioChannel.CHANNEL_2,
  sampleFormat: audio.AudioSampleFormat.SAMPLE_FORMAT_S16LE,
  encodingType: audio.AudioEncodingType.ENCODING_TYPE_RAW
}

let audioCapturerInfo = {
  source: audio.SourceType.SOURCE_TYPE_MIC,
  capturerFlags: 0
}

let audioCapturerOptions = {
  streamInfo: audioStreamInfo,
  capturerInfo: audioCapturerInfo
}

audio.createAudioCapturer(audioCapturerOptions, (err, data) => {
  if (err) {
    console.error(`AudioCapturer Created : Error: ${err}`);
  } else {
    console.info('AudioCapturer Created : Success : SUCCESS');
    let audioCapturer = data;
  }
});

audio.createAudioCapturer8+

createAudioCapturer(options: AudioCapturerOptions): Promise<AudioCapturer>

獲取音頻采集器。使用promise 方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Capturer

需要權(quán)限： ohos.permission.MICROPHONE

參數(shù)：

返回值：

示例：

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

let audioStreamInfo = {
  samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
  channels: audio.AudioChannel.CHANNEL_2,
  sampleFormat: audio.AudioSampleFormat.SAMPLE_FORMAT_S16LE,
  encodingType: audio.AudioEncodingType.ENCODING_TYPE_RAW
}

let audioCapturerInfo = {
  source: audio.SourceType.SOURCE_TYPE_MIC,
  capturerFlags: 0
}

let audioCapturerOptions = {
  streamInfo: audioStreamInfo,
  capturerInfo: audioCapturerInfo
}

let audioCapturer;
audio.createAudioCapturer(audioCapturerOptions).then((data) => {
  audioCapturer = data;
  console.info('AudioCapturer Created : Success : Stream Type: SUCCESS');
}).catch((err) => {
  console.error(`AudioCapturer Created : ERROR : ${err}`);
});

AudioVolumeType

枚舉，音頻流類型。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

InterruptMode9+

枚舉，焦點模型。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Interrupt

DeviceFlag

枚舉，可獲取的設(shè)備種類。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

DeviceRole

枚舉，設(shè)備角色。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

DeviceType

枚舉，設(shè)備類型。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

CommunicationDeviceType9+

枚舉，用于通信的可用設(shè)備類型。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Communication

AudioRingMode

枚舉，鈴聲模式。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Communication

AudioSampleFormat8+

枚舉，音頻采樣格式。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

AudioErrors9+

枚舉，音頻錯誤碼。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

AudioChannel8+

枚舉， 音頻聲道。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

AudioSamplingRate8+

枚舉，音頻采樣率，具體設(shè)備支持的采樣率規(guī)格會存在差異。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

AudioEncodingType8+

枚舉，音頻編碼類型。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

ContentType

枚舉，音頻內(nèi)容類型。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

StreamUsage

枚舉，音頻流使用類型。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

AudioState8+

枚舉，音頻狀態(tài)。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

AudioRendererRate8+

枚舉，音頻渲染速度。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Renderer

InterruptType

枚舉，中斷類型。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Renderer

InterruptForceType9+

枚舉，強制打斷類型。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Renderer

InterruptHint

枚舉，中斷提示。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Renderer

AudioStreamInfo8+

音頻流信息。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

AudioRendererInfo8+

音頻渲染器信息。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

AudioRendererOptions8+

音頻渲染器選項信息。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Renderer

InterruptEvent9+

播放中斷時，應(yīng)用接收的中斷事件。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Renderer

VolumeEvent9+

音量改變時，應(yīng)用接收的事件。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

MicStateChangeEvent9+

麥克風(fēng)狀態(tài)變化時，應(yīng)用接收的事件。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

DeviceChangeAction

描述設(shè)備連接狀態(tài)變化和設(shè)備信息。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

DeviceChangeType

枚舉，設(shè)備連接狀態(tài)變化。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

AudioCapturerOptions8+

音頻采集器選項信息。

系統(tǒng)能力： 以下各項對應(yīng)的系統(tǒng)能力均為SystemCapability.Multimedia.Audio.Capturer

AudioCapturerInfo8+

描述音頻采集器信息。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

SourceType8+

枚舉，音源類型。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

AudioScene8+

枚舉，音頻場景。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Communication

AudioManager

管理音頻音量和音頻設(shè)備。在調(diào)用AudioManager的接口前，需要先通過getAudioManager創(chuàng)建實例。

setAudioParameter

setAudioParameter(key: string, value: string, callback: AsyncCallback<void>): void

音頻參數(shù)設(shè)置，使用callback方式異步返回結(jié)果。

本接口的使用場景為根據(jù)硬件設(shè)備支持能力擴展音頻配置。在不同的設(shè)備平臺上，所支持的音頻參數(shù)會存在差異。示例代碼內(nèi)使用樣例參數(shù)，實際支持的音頻配置參數(shù)見具體設(shè)備平臺的資料描述。

需要權(quán)限： ohos.permission.MODIFY_AUDIO_SETTINGS

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

參數(shù)：

示例：

audioManager.setAudioParameter('key_example', 'value_example', (err) => {
  if (err) {
    console.error(`Failed to set the audio parameter. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate a successful setting of the audio parameter.');
});

setAudioParameter

setAudioParameter(key: string, value: string): Promise<void>

音頻參數(shù)設(shè)置，使用Promise方式異步返回結(jié)果。

本接口的使用場景為根據(jù)硬件設(shè)備支持能力擴展音頻配置。在不同的設(shè)備平臺上，所支持的音頻參數(shù)會存在差異。示例代碼內(nèi)使用樣例參數(shù)，實際支持的音頻配置參數(shù)見具體設(shè)備平臺的資料描述。

需要權(quán)限： ohos.permission.MODIFY_AUDIO_SETTINGS

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

參數(shù)：

返回值：

示例：

audioManager.setAudioParameter('key_example', 'value_example').then(() => {
  console.info('Promise returned to indicate a successful setting of the audio parameter.');
});

getAudioParameter

getAudioParameter(key: string, callback: AsyncCallback<string>): void

獲取指定音頻參數(shù)值，使用callback方式異步返回結(jié)果。

本接口的使用場景為根據(jù)硬件設(shè)備支持能力擴展音頻配置。在不同的設(shè)備平臺上，所支持的音頻參數(shù)會存在差異。示例代碼內(nèi)使用樣例參數(shù)，實際支持的音頻配置參數(shù)見具體設(shè)備平臺的資料描述。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

參數(shù)：

示例：

audioManager.getAudioParameter('key_example', (err, value) => {
  if (err) {
    console.error(`Failed to obtain the value of the audio parameter. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the value of the audio parameter is obtained ${value}.`);
});

getAudioParameter

getAudioParameter(key: string): Promise<string>

獲取指定音頻參數(shù)值，使用Promise方式異步返回結(jié)果。

本接口的使用場景為根據(jù)硬件設(shè)備支持能力擴展音頻配置。在不同的設(shè)備平臺上，所支持的音頻參數(shù)會存在差異。示例代碼內(nèi)使用樣例參數(shù)，實際支持的音頻配置參數(shù)見具體設(shè)備平臺的資料描述。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

參數(shù)：

返回值：

示例：

audioManager.getAudioParameter('key_example').then((value) => {
  console.info(`Promise returned to indicate that the value of the audio parameter is obtained ${value}.`);
});

getAudioScene8+

getAudioScene(callback: AsyncCallback<AudioScene>): void

獲取音頻場景模式，使用callback方式返回異步結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Communication

參數(shù)：

示例：

audioManager.getAudioScene((err, value) => {
  if (err) {
    console.error(`Failed to obtain the audio scene mode.? ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the audio scene mode is obtained ${value}.`);
});

getAudioScene8+

getAudioScene(): Promise<AudioScene>

獲取音頻場景模式，使用Promise方式返回異步結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Communication

返回值：

示例：

audioManager.getAudioScene().then((value) => {
  console.info(`Promise returned to indicate that the audio scene mode is obtained ${value}.`);
}).catch ((err) => {
  console.error(`Failed to obtain the audio scene mode ${err}`);
});

getVolumeManager9+

getVolumeManager(): AudioVolumeManager

獲取音頻音量管理器。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

示例：

let audioVolumeManager = audioManager.getVolumeManager();

getStreamManager9+

getStreamManager(): AudioStreamManager

獲取音頻流管理器。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Core

示例：

let audioStreamManager = audioManager.getStreamManager();

getRoutingManager9+

getRoutingManager(): AudioRoutingManager

獲取音頻路由設(shè)備管理器。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

示例：

let audioRoutingManager = audioManager.getRoutingManager();

setVolume(deprecated)

setVolume(volumeType: AudioVolumeType, volume: number, callback: AsyncCallback<void>): void

設(shè)置指定流的音量，使用callback方式異步返回結(jié)果。

需要權(quán)限： ohos.permission.ACCESS_NOTIFICATION_POLICY

僅設(shè)置鈴聲（即volumeType為AudioVolumeType.RINGTONE）在靜音和非靜音狀態(tài)切換時需要該權(quán)限。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

示例：

audioManager.setVolume(audio.AudioVolumeType.MEDIA, 10, (err) => {
  if (err) {
    console.error(`Failed to set the volume. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate a successful volume setting.');
});

setVolume(deprecated)

setVolume(volumeType: AudioVolumeType, volume: number): Promise<void>

設(shè)置指定流的音量，使用Promise方式異步返回結(jié)果。

需要權(quán)限： ohos.permission.ACCESS_NOTIFICATION_POLICY

僅設(shè)置鈴聲（即volumeType為AudioVolumeType.RINGTONE）在靜音和非靜音狀態(tài)切換時需要該權(quán)限。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

返回值：

示例：

audioManager.setVolume(audio.AudioVolumeType.MEDIA, 10).then(() => {
  console.info('Promise returned to indicate a successful volume setting.');
});

getVolume(deprecated)

getVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>): void

獲取指定流的音量，使用callback方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

示例：

audioManager.getVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
  if (err) {
    console.error(`Failed to obtain the volume. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the volume is obtained.');
});

getVolume(deprecated)

getVolume(volumeType: AudioVolumeType): Promise<number>

獲取指定流的音量，使用Promise方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

返回值：

示例：

audioManager.getVolume(audio.AudioVolumeType.MEDIA).then((value) => {
  console.info(`Promise returned to indicate that the volume is obtained ${value} .`);
});

getMinVolume(deprecated)

getMinVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>): void

獲取指定流的最小音量，使用callback方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

示例：

audioManager.getMinVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
  if (err) {
    console.error(`Failed to obtain the minimum volume. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the minimum volume is obtained. ${value}`);
});

getMinVolume(deprecated)

getMinVolume(volumeType: AudioVolumeType): Promise<number>

獲取指定流的最小音量，使用Promise方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

返回值：

示例：

audioManager.getMinVolume(audio.AudioVolumeType.MEDIA).then((value) => {
  console.info(`Promised returned to indicate that the minimum volume is obtained. ${value}`);
});

getMaxVolume(deprecated)

getMaxVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>): void

獲取指定流的最大音量，使用callback方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

示例：

audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
  if (err) {
    console.error(`Failed to obtain the maximum volume. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the maximum volume is obtained. ${value}`);
});

getMaxVolume(deprecated)

getMaxVolume(volumeType: AudioVolumeType): Promise<number>

獲取指定流的最大音量，使用Promise方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

返回值：

示例：

audioManager.getMaxVolume(audio.AudioVolumeType.MEDIA).then((data) => {
  console.info('Promised returned to indicate that the maximum volume is obtained.');
});

mute(deprecated)

mute(volumeType: AudioVolumeType, mute: boolean, callback: AsyncCallback<void>): void

設(shè)置指定音量流靜音，使用callback方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

示例：

audioManager.mute(audio.AudioVolumeType.MEDIA, true, (err) => {
  if (err) {
    console.error(`Failed to mute the stream. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the stream is muted.');
});

mute(deprecated)

mute(volumeType: AudioVolumeType, mute: boolean): Promise<void>

設(shè)置指定音量流靜音，使用Promise方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

返回值：

示例：

audioManager.mute(audio.AudioVolumeType.MEDIA, true).then(() => {
  console.info('Promise returned to indicate that the stream is muted.');
});

isMute(deprecated)

isMute(volumeType: AudioVolumeType, callback: AsyncCallback<boolean>): void

獲取指定音量流是否被靜音，使用callback方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

示例：

audioManager.isMute(audio.AudioVolumeType.MEDIA, (err, value) => {
  if (err) {
    console.error(`Failed to obtain the mute status. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the mute status of the stream is obtained. ${value}`);
});

isMute(deprecated)

isMute(volumeType: AudioVolumeType): Promise<boolean>

獲取指定音量流是否被靜音，使用Promise方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

返回值：

示例：

audioManager.isMute(audio.AudioVolumeType.MEDIA).then((value) => {
  console.info(`Promise returned to indicate that the mute status of the stream is obtained ${value}.`);
});

isActive(deprecated)

isActive(volumeType: AudioVolumeType, callback: AsyncCallback<boolean>): void

獲取指定音量流是否為活躍狀態(tài)，使用callback方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

示例：

audioManager.isActive(audio.AudioVolumeType.MEDIA, (err, value) => {
  if (err) {
    console.error(`Failed to obtain the active status of the stream. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the active status of the stream is obtained ${value}.`);
});

isActive(deprecated)

isActive(volumeType: AudioVolumeType): Promise<boolean>

獲取指定音量流是否為活躍狀態(tài)，使用Promise方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

返回值：

示例：

audioManager.isActive(audio.AudioVolumeType.MEDIA).then((value) => {
  console.info(`Promise returned to indicate that the active status of the stream is obtained ${value}.`);
});

setRingerMode(deprecated)

setRingerMode(mode: AudioRingMode, callback: AsyncCallback<void>): void

設(shè)置鈴聲模式，使用callback方式異步返回結(jié)果。

需要權(quán)限： ohos.permission.ACCESS_NOTIFICATION_POLICY

僅在靜音和非靜音狀態(tài)切換時需要該權(quán)限。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Communication

參數(shù)：

示例：

audioManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL, (err) => {
  if (err) {
    console.error(`Failed to set the ringer mode.? ${err}`);
    return;
  }
  console.info('Callback invoked to indicate a successful setting of the ringer mode.');
});

setRingerMode(deprecated)

setRingerMode(mode: AudioRingMode): Promise<void>

設(shè)置鈴聲模式，使用Promise方式異步返回結(jié)果。

需要權(quán)限： ohos.permission.ACCESS_NOTIFICATION_POLICY

僅在靜音和非靜音狀態(tài)切換時需要該權(quán)限。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Communication

參數(shù)：

返回值：

示例：

audioManager.setRingerMode(audio.AudioRingMode.RINGER_MODE_NORMAL).then(() => {
  console.info('Promise returned to indicate a successful setting of the ringer mode.');
});

getRingerMode(deprecated)

getRingerMode(callback: AsyncCallback<AudioRingMode>): void

獲取鈴聲模式，使用callback方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Communication

參數(shù)：

示例：

audioManager.getRingerMode((err, value) => {
  if (err) {
    console.error(`Failed to obtain the ringer mode.? ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the ringer mode is obtained ${value}.`);
});

getRingerMode(deprecated)

getRingerMode(): Promise<AudioRingMode>

獲取鈴聲模式，使用Promise方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Communication

返回值：

示例：

audioManager.getRingerMode().then((value) => {
  console.info(`Promise returned to indicate that the ringer mode is obtained ${value}.`);
});

getDevices(deprecated)

getDevices(deviceFlag: DeviceFlag, callback: AsyncCallback<AudioDeviceDescriptors>): void

獲取音頻設(shè)備列表，使用callback方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

參數(shù)：

示例：

audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG, (err, value) => {
  if (err) {
    console.error(`Failed to obtain the device list. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the device list is obtained.');
});

getDevices(deprecated)

getDevices(deviceFlag: DeviceFlag): Promise<AudioDeviceDescriptors>

獲取音頻設(shè)備列表，使用Promise方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

參數(shù)：

返回值：

示例：

audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG).then((data) => {
  console.info('Promise returned to indicate that the device list is obtained.');
});

setDeviceActive(deprecated)

setDeviceActive(deviceType: ActiveDeviceType, active: boolean, callback: AsyncCallback<void>): void

設(shè)置設(shè)備激活狀態(tài)，使用callback方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

參數(shù)：

示例：

audioManager.setDeviceActive(audio.ActiveDeviceType.SPEAKER, true, (err) => {
  if (err) {
    console.error(`Failed to set the active status of the device. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the device is set to the active status.');
});

setDeviceActive(deprecated)

setDeviceActive(deviceType: ActiveDeviceType, active: boolean): Promise<void>

設(shè)置設(shè)備激活狀態(tài)，使用Promise方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

參數(shù)：

返回值：

示例：

audioManager.setDeviceActive(audio.ActiveDeviceType.SPEAKER, true).then(() => {
  console.info('Promise returned to indicate that the device is set to the active status.');
});

isDeviceActive(deprecated)

isDeviceActive(deviceType: ActiveDeviceType, callback: AsyncCallback<boolean>): void

獲取指定設(shè)備的激活狀態(tài)，使用callback方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

參數(shù)：

示例：

audioManager.isDeviceActive(audio.ActiveDeviceType.SPEAKER, (err, value) => {
  if (err) {
    console.error(`Failed to obtain the active status of the device. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the active status of the device is obtained.');
});

isDeviceActive(deprecated)

isDeviceActive(deviceType: ActiveDeviceType): Promise<boolean>

獲取指定設(shè)備的激活狀態(tài)，使用Promise方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

參數(shù)：

返回值：

示例：

audioManager.isDeviceActive(audio.ActiveDeviceType.SPEAKER).then((value) => {
  console.info(`Promise returned to indicate that the active status of the device is obtained ${value}.`);
});

setMicrophoneMute(deprecated)

setMicrophoneMute(mute: boolean, callback: AsyncCallback<void>): void

設(shè)置麥克風(fēng)靜音狀態(tài)，使用callback方式異步返回結(jié)果。

需要權(quán)限： ohos.permission.MICROPHONE

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

參數(shù)：

示例：

audioManager.setMicrophoneMute(true, (err) => {
  if (err) {
    console.error(`Failed to mute the microphone. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the microphone is muted.');
});

setMicrophoneMute(deprecated)

setMicrophoneMute(mute: boolean): Promise<void>

設(shè)置麥克風(fēng)靜音狀態(tài)，使用Promise方式異步返回結(jié)果。

需要權(quán)限： ohos.permission.MICROPHONE

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

參數(shù)：

返回值：

示例：

audioManager.setMicrophoneMute(true).then(() => {
  console.info('Promise returned to indicate that the microphone is muted.');
});

isMicrophoneMute(deprecated)

isMicrophoneMute(callback: AsyncCallback<boolean>): void

獲取麥克風(fēng)靜音狀態(tài)，使用callback方式異步返回結(jié)果。

需要權(quán)限： ohos.permission.MICROPHONE

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

參數(shù)：

示例：

audioManager.isMicrophoneMute((err, value) => {
  if (err) {
    console.error(`Failed to obtain the mute status of the microphone. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the mute status of the microphone is obtained ${value}.`);
});

isMicrophoneMute(deprecated)

isMicrophoneMute(): Promise<boolean>

獲取麥克風(fēng)靜音狀態(tài)，使用Promise方式異步返回結(jié)果。

需要權(quán)限： ohos.permission.MICROPHONE

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

返回值：

示例：

audioManager.isMicrophoneMute().then((value) => {
  console.info(`Promise returned to indicate that the mute status of the microphone is obtained ${value}.`);
});

on('deviceChange')(deprecated)

on(type: 'deviceChange', callback: Callback<DeviceChangeAction>): void

設(shè)備更改。音頻設(shè)備連接狀態(tài)變化。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

參數(shù)：

示例：

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')(deprecated)

off(type: 'deviceChange', callback?: Callback<DeviceChangeAction>): void

取消訂閱音頻設(shè)備連接變化事件。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Device

參數(shù)：

示例：

audioManager.off('deviceChange', (deviceChanged) => {
  console.info('Should be no callback.');
});

on('interrupt')

on(type: 'interrupt', interrupt: AudioInterrupt, callback: Callback<InterruptAction>): void

請求焦點并開始監(jiān)聽音頻打斷事件（當(dāng)應(yīng)用程序的音頻被另一個播放事件中斷，回調(diào)通知此應(yīng)用程序）。

與on('audioInterrupt')作用一致，均用于監(jiān)聽焦點變化。為無音頻流的場景（未曾創(chuàng)建AudioRenderer對象），比如FM、語音喚醒等提供焦點變化監(jiān)聽功能。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Renderer

參數(shù)：

示例：

let interAudioInterrupt = {
  streamUsage:2,
  contentType:0,
  pauseWhenDucked:true
};
audioManager.on('interrupt', interAudioInterrupt, (InterruptAction) => {
  if (InterruptAction.actionType === 0) {
    console.info('An event to gain the audio focus starts.');
    console.info(`Focus gain event: ${InterruptAction} `);
  }
  if (InterruptAction.actionType === 1) {
    console.info('An audio interruption event starts.');
    console.info(`Audio interruption event: ${InterruptAction} `);
  }
});

off('interrupt')

off(type: 'interrupt', interrupt: AudioInterrupt, callback?: Callback<InterruptAction>): void

取消監(jiān)聽音頻打斷事件（刪除監(jiān)聽事件，取消打斷）。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Renderer

參數(shù)：

示例：

let interAudioInterrupt = {
  streamUsage:2,
  contentType:0,
  pauseWhenDucked:true
};
audioManager.off('interrupt', interAudioInterrupt, (InterruptAction) => {
  if (InterruptAction.actionType === 0) {
      console.info('An event to release the audio focus starts.');
      console.info(`Focus release event: ${InterruptAction} `);
  }
});

AudioVolumeManager9+

音量管理。在使用AudioVolumeManager的接口前，需要使用getVolumeManager獲取AudioVolumeManager實例。

getVolumeGroupManager9+

getVolumeGroupManager(groupId: number, callback: AsyncCallback<AudioVolumeGroupManager>): void

獲取音頻組管理器，使用callback方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

示例：

let groupid = audio.DEFAULT_VOLUME_GROUP_ID;
audioVolumeManager.getVolumeGroupManager(groupid, (err, value) => {
  if (err) {
    console.error(`Failed to obtain the volume group infos list. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the volume group infos list is obtained.');
});

getVolumeGroupManager9+

getVolumeGroupManager(groupId: number): Promise<AudioVolumeGroupManager>

獲取音頻組管理器，使用promise方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

返回值：

示例：

let groupid = audio.DEFAULT_VOLUME_GROUP_ID;
let audioVolumeGroupManager;
getVolumeGroupManager();
async function getVolumeGroupManager(){
  audioVolumeGroupManager = await audioVolumeManager.getVolumeGroupManager(groupid);
  console.info('Callback invoked to indicate that the volume group infos list is obtained.');
}

on('volumeChange')9+

on(type: 'volumeChange', callback: Callback<VolumeEvent>): void

監(jiān)聽系統(tǒng)音量變化事件，使用callback方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見音頻錯誤碼。

示例：

audioVolumeManager.on('volumeChange', (volumeEvent) => {
  console.info(`VolumeType of stream: ${volumeEvent.volumeType} `);
  console.info(`Volume level: ${volumeEvent.volume} `);
  console.info(`Whether to updateUI: ${volumeEvent.updateUi} `);
});

AudioVolumeGroupManager9+

管理音頻組音量。在調(diào)用AudioVolumeGroupManager的接口前，需要先通過 getVolumeGroupManager 創(chuàng)建實例。

getVolume9+

getVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>): void

獲取指定流的音量，使用callback方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

示例：

audioVolumeGroupManager.getVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
  if (err) {
    console.error(`Failed to obtain the volume. ${err}`);
    return;
  }
  console.info('Callback invoked to indicate that the volume is obtained.');
});

getVolume9+

getVolume(volumeType: AudioVolumeType): Promise<number>

獲取指定流的音量，使用Promise方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

返回值：

示例：

audioVolumeGroupManager.getVolume(audio.AudioVolumeType.MEDIA).then((value) => {
  console.info(`Promise returned to indicate that the volume is obtained ${value}.`);
});

getMinVolume9+

getMinVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>): void

獲取指定流的最小音量，使用callback方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

示例：

audioVolumeGroupManager.getMinVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
  if (err) {
    console.error(`Failed to obtain the minimum volume. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the minimum volume is obtained. ${value}`);
});

getMinVolume9+

getMinVolume(volumeType: AudioVolumeType): Promise<number>

獲取指定流的最小音量，使用Promise方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

返回值：

示例：

audioVolumeGroupManager.getMinVolume(audio.AudioVolumeType.MEDIA).then((value) => {
  console.info(`Promised returned to indicate that the minimum volume is obtained ${value}.`);
});

getMaxVolume9+

getMaxVolume(volumeType: AudioVolumeType, callback: AsyncCallback<number>): void

獲取指定流的最大音量，使用callback方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：

示例：

audioVolumeGroupManager.getMaxVolume(audio.AudioVolumeType.MEDIA, (err, value) => {
  if (err) {
    console.error(`Failed to obtain the maximum volume. ${err}`);
    return;
  }
  console.info(`Callback invoked to indicate that the maximum volume is obtained. ${value}`);
});

getMaxVolume9+

getMaxVolume(volumeType: AudioVolumeType): Promise<number>

獲取指定流的最大音量，使用Promise方式異步返回結(jié)果。

系統(tǒng)能力： SystemCapability.Multimedia.Audio.Volume

參數(shù)：