/*
* Copyright (c) 2021-2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit AudioKit
*/
import { ErrorCallback, AsyncCallback, Callback } from './@ohos.base';
/**
* @namespace audio
* @since 7
*/
/**
* @namespace audio
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
declare namespace audio {
/**
* Enumerates audio errors.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 9
*/
/**
* Enumerates audio errors.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
enum AudioErrors {
/**
* Invalid parameter.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 9
*/
/**
* Invalid parameter.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
ERROR_INVALID_PARAM = 6800101,
/**
* Allocate memory failed.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 9
*/
/**
* Allocate memory failed.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
ERROR_NO_MEMORY = 6800102,
/**
* Operation not permit at current state.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 9
*/
/**
* Operation not permit at current state.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
ERROR_ILLEGAL_STATE = 6800103,
/**
* Unsupported option.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 9
*/
/**
* Unsupported option.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
ERROR_UNSUPPORTED = 6800104,
/**
* Time out.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 9
*/
ERROR_TIMEOUT = 6800105,
/**
* Audio specific errors.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 9
*/
ERROR_STREAM_LIMIT = 6800201,
/**
* Default error.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 9
*/
/**
* Default error.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
ERROR_SYSTEM = 6800301
}
/**
* Define local device network id for audio
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 9
*/
const LOCAL_NETWORK_ID: string;
/**
* Define default volume group id for audio
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 9
*/
/**
* Define default volume group id for audio
* @syscap SystemCapability.Multimedia.Audio.Volume
* @crossplatform
* @since 12
*/
const DEFAULT_VOLUME_GROUP_ID: number;
/**
* Define default interrupt group id for audio
* @syscap SystemCapability.Multimedia.Audio.Interrupt
* @since 9
*/
const DEFAULT_INTERRUPT_GROUP_ID: number;
/**
* Obtains an {@link AudioManager} instance.
* @returns { AudioManager } this {@link AudioManager} object.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 7
*/
/**
* Obtains an {@link AudioManager} instance.
* NOTE:
* The {@link AudioManager} instance is not a singleton.
*
*
* @returns { AudioManager } this {@link AudioManager} object.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
function getAudioManager(): AudioManager;
/**
* Obtains an {@link AudioCapturer} instance.
* Success: This method uses an asynchronous callback to return the capturer instance.
* Failure: This method uses an asynchronous callback to return the error instance. Possible causes:
* 6800301: Parameter verification failed, Permission denied, System error;
* 6800101: Mandatory parameters are left unspecified, Incorrect parameter types.
* @param { AudioCapturerOptions } options - Capturer configurations.
* @param { AsyncCallback } callback - Callback used to return the audio capturer instance.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @since 8
*/
/**
* Obtains an {@link AudioCapturer} instance. This method uses an asynchronous callback to return the capturer instance.
* @param { AudioCapturerOptions } options - Capturer configurations.
* @param { AsyncCallback } callback - Callback used to return the audio capturer instance.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @crossplatform
* @since 12
*/
function createAudioCapturer(options: AudioCapturerOptions, callback: AsyncCallback): void;
/**
* Obtains an {@link AudioCapturer} instance.
* Success: This method uses a promise to return the capturer instance.
* Failure: This method uses a promise to return the error instance. Possible causes:
* 6800301: Parameter verification failed, Permission denied, System error;
* 6800101: Mandatory parameters are left unspecified, Incorrect parameter types.
* @param { AudioCapturerOptions } options - Capturer configurations.
* @returns { Promise } Promise used to return the audio capturer instance.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @since 8
*/
/**
* Obtains an {@link AudioCapturer} instance. This method uses a promise to return the capturer instance.
* @param { AudioCapturerOptions } options - Capturer configurations.
* @returns { Promise } Promise used to return the audio capturer instance.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @crossplatform
* @since 12
*/
function createAudioCapturer(options: AudioCapturerOptions): Promise;
/**
* Obtains an {@link AudioRenderer} instance.
* This method uses an asynchronous callback to return the renderer instance.
* @param { AudioRendererOptions } options - Renderer configurations.
* @param { AsyncCallback } callback - Callback used to return the audio renderer instance.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 8
*/
/**
* Obtains an {@link AudioRenderer} instance.
* This method uses a promise to return the renderer instance.
*
* The AudioRenderer instance is used to play streaming audio data.
* When using AudioRenderer apis, there are many instructions for application
* to achieve better performance and lower power consumption:
* In music or audiobook background playback situation, you can have low power
* consumption by following this best practices document **Low-Power Rules in Music Playback Scenarios**.
* And for navigation situation, you can follow **Low-Power Rules in Navigation and Positioning Scenarios**.
*
* Application developer should also be careful when app goes to background, please check if your audio playback
* is still needed, see **Audio Resources** in best practices document.
* And avoiding to send silence audio data continuously to waste system resources, otherwise system will take
* control measures when this behavior is detected, see **Audio Playback** in best practices document.
*
* If you want to use AudioRenderer api to implement a music playback application, there are also many interactive
* scenes to consider, see **Developing an Audio Application** in best practices document.
*
* @param { AudioRendererOptions } options - Renderer configurations.
* @param { AsyncCallback } callback - Callback used to return the audio renderer instance.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @since 12
*/
function createAudioRenderer(options: AudioRendererOptions, callback: AsyncCallback): void;
/**
* Obtains an {@link AudioRenderer} instance.
* This method uses a promise to return the renderer instance.
* @param { AudioRendererOptions } options - Renderer configurations.
* @returns { Promise } Promise used to return the audio renderer instance.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 8
*/
/**
* Obtains an {@link AudioRenderer} instance.
* This method uses a promise to return the renderer instance.
*
* The AudioRenderer instance is used to play streaming audio data.
* When using AudioRenderer apis, there are many instructions for application
* to achieve better performance and lower power consumption:
* In music or audiobook background playback situation, you can have low power
* consumption by following this best practices document **Low-Power Rules in Music Playback Scenarios**.
* And for navigation situation, you can follow **Low-Power Rules in Navigation and Positioning Scenarios**.
*
* Application developer should also be careful when app goes to background, please check if your audio playback
* is still needed, see **Audio Resources** in best practices document.
* And avoiding to send silence audio data continuously to waste system resources, otherwise system will take
* control measures when this behavior is detected, see **Audio Playback** in best practices document.
*
* If you want to use AudioRenderer api to implement a music playback application, there are also many interactive
* scenes to consider, see **Developing an Audio Application** in best practices document.
*
* @param { AudioRendererOptions } options - Renderer configurations.
* @returns { Promise } Promise used to return the audio renderer instance.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @since 12
*/
function createAudioRenderer(options: AudioRendererOptions): Promise;
/**
* Obtains a {@link TonePlayer} instance. This method uses an asynchronous callback to return the renderer instance.
* @param { AudioRendererInfo } options - Tone playing attribute.
* @param { AsyncCallback } callback - Callback used to return the tonePlayer instance.
* @syscap SystemCapability.Multimedia.Audio.Tone
* @systemapi
* @since 9
*/
function createTonePlayer(options: AudioRendererInfo, callback: AsyncCallback): void;
/**
* Obtains a {@link TonePlayer} instance. This method uses a promise to return the renderer instance.
* @param { AudioRendererInfo } options - Tone playing attribute.
* @returns { Promise } Promise used to return the tonePlayer instance.
* @syscap SystemCapability.Multimedia.Audio.Tone
* @systemapi
* @since 9
*/
function createTonePlayer(options: AudioRendererInfo): Promise;
/**
* Creates an AudioLoopback instance, which provides low-latency in-ear monitoring using a fast capturer and renderer.
*
* @permission ohos.permission.MICROPHONE
* @param { AudioLoopbackMode } mode Audio loopback mode.
* @returns { Promise } Promise used to return the AudioLoopback instance.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 801 - Unsupported API.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @throws { BusinessError } 6800104 - Loopback mode is unsupported.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @since 20
*/
function createAudioLoopback(mode: AudioLoopbackMode): Promise;
/**
* Enumerates the audio states.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Enumerates the audio states.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
enum AudioState {
/**
* Invalid state.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Invalid state.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
STATE_INVALID = -1,
/**
* Create new instance state.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Create new instance state.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
STATE_NEW = 0,
/**
* Prepared state.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Prepared state.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
STATE_PREPARED = 1,
/**
* Running state.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Running state.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
STATE_RUNNING = 2,
/**
* Stopped state.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Stopped state.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
STATE_STOPPED = 3,
/**
* Released state.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Released state.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
STATE_RELEASED = 4,
/**
* Paused state.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Paused state.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
STATE_PAUSED = 5
}
/**
* Enumerates audio loopback mode.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @since 20
*/
enum AudioLoopbackMode {
/**
* The hardware mode of audio loopback.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @since 20
*/
HARDWARE = 0,
}
/**
* Enumerates audio loopback status.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @since 20
*/
enum AudioLoopbackStatus {
/**
* Audio loopback unavailable by the output or input device. For example, the device change.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @since 20
*/
UNAVAILABLE_DEVICE = -2,
/**
* Audio loopback unavailable by the audio scene. For example, the audio interrupt.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @since 20
*/
UNAVAILABLE_SCENE = -1,
/**
* Audio loopback available and idle.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @since 20
*/
AVAILABLE_IDLE = 0,
/**
* Audio loopback available and running.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @since 20
*/
AVAILABLE_RUNNING = 1,
}
/**
* Enumerates audio stream types.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 7
*/
/**
* Enumerates audio stream types.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Volume
* @crossplatform
* @since 12
*/
enum AudioVolumeType {
/**
* Audio streams for voice calls.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 8
*/
/**
* Audio volume type for voice calls.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @crossplatform
* @since 12
*/
VOICE_CALL = 0,
/**
* Audio streams for ringtones.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 7
*/
/**
* Audio volume type for ringtones.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @crossplatform
* @since 12
*/
RINGTONE = 2,
/**
* Audio streams for media purpose.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 7
*/
/**
* Audio volume type for media purpose.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @crossplatform
* @since 12
*/
MEDIA = 3,
/**
* Audio volume for alarm purpose.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 10
*/
/**
* Audio volume type for alarm purpose.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @crossplatform
* @since 12
*/
ALARM = 4,
/**
* Audio volume for accessibility purpose.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 10
*/
/**
* Audio volume type for accessibility purpose.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @crossplatform
* @since 12
*/
ACCESSIBILITY = 5,
/**
* Audio volume for system sound.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @systemapi
* @since 20
*/
SYSTEM = 6,
/**
* Audio volume type for voice assistant.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 8
*/
VOICE_ASSISTANT = 9,
/**
* Audio volume type for ultrasonic.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @systemapi
* @since 10
*/
ULTRASONIC = 10,
/**
* Audio volume type for notification.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @systemapi
* @since 20
*/
NOTIFICATION = 11,
/**
* Audio volume type for navigation.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @systemapi
* @since 20
*/
NAVIGATION = 12,
/**
* Audio volume type for all common.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @systemapi
* @since 9
*/
ALL = 100,
}
/**
* Enumerates audio device flags.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* Enumerates audio device flags.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
enum DeviceFlag {
/**
* None devices.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 9
*/
NONE_DEVICES_FLAG = 0,
/**
* Output devices.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* Output devices.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
OUTPUT_DEVICES_FLAG = 1,
/**
* Input devices.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* Input devices.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
INPUT_DEVICES_FLAG = 2,
/**
* All devices.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* All devices.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
ALL_DEVICES_FLAG = 3,
/**
* Distributed output devices.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 9
*/
DISTRIBUTED_OUTPUT_DEVICES_FLAG = 4,
/**
* Distributed input devices.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 9
*/
DISTRIBUTED_INPUT_DEVICES_FLAG = 8,
/**
* All Distributed devices.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 9
*/
ALL_DISTRIBUTED_DEVICES_FLAG = 12,
}
/**
* Enumerates audio device for usage.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 12
*/
enum DeviceUsage {
/**
* Media output devices.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 12
*/
MEDIA_OUTPUT_DEVICES = 1,
/**
* Media input devices.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 12
*/
MEDIA_INPUT_DEVICES = 2,
/**
* All media devices.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 12
*/
ALL_MEDIA_DEVICES = 3,
/**
* Call output devices.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 12
*/
CALL_OUTPUT_DEVICES = 4,
/**
* Call input devices.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 12
*/
CALL_INPUT_DEVICES = 8,
/**
* All call devices.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 12
*/
ALL_CALL_DEVICES = 12,
}
/**
* Enumerates device roles.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* Enumerates device roles.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @atomicservice
* @since 12
*/
enum DeviceRole {
/**
* Input role.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* Input role.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @atomicservice
* @since 12
*/
INPUT_DEVICE = 1,
/**
* Output role.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* Output role.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @atomicservice
* @since 12
*/
OUTPUT_DEVICE = 2,
}
/**
* Enumerates device types.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* Enumerates device types.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @atomicservice
* @since 12
*/
enum DeviceType {
/**
* Invalid device.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* Invalid device.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @atomicservice
* @since 12
*/
INVALID = 0,
/**
* Built-in earpiece.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* Built-in earpiece.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @atomicservice
* @since 12
*/
EARPIECE = 1,
/**
* Built-in speaker.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* Built-in speaker.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @atomicservice
* @since 12
*/
SPEAKER = 2,
/**
* Wired headset, which is a combination of a pair of earpieces and a microphone.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* Wired headset, which is a combination of a pair of earpieces and a microphone.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @atomicservice
* @since 12
*/
WIRED_HEADSET = 3,
/**
* A pair of wired headphones.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* A pair of wired headphones.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @atomicservice
* @since 12
*/
WIRED_HEADPHONES = 4,
/**
* Bluetooth device using the synchronous connection oriented link (SCO).
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* Bluetooth device using the synchronous connection oriented link (SCO).
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @atomicservice
* @since 12
*/
BLUETOOTH_SCO = 7,
/**
* Bluetooth device using advanced audio distribution profile (A2DP).
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* Bluetooth device using advanced audio distribution profile (A2DP).
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @atomicservice
* @since 12
*/
BLUETOOTH_A2DP = 8,
/**
* Built-in microphone.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* Built-in microphone.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @atomicservice
* @since 12
*/
MIC = 15,
/**
* USB audio headset.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* USB audio headset.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @atomicservice
* @since 12
*/
USB_HEADSET = 22,
/**
* Display port device.
* @syscap SystemCapability.Multimedia.Audio.Device
* @atomicservice
* @since 12
*/
DISPLAY_PORT = 23,
/**
* Device type for rerouting audio to other remote devices by system application
* @syscap SystemCapability.Multimedia.Audio.Device
* @atomicservice
* @since 12
*/
REMOTE_CAST = 24,
/**
* USB audio device.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 18
*/
USB_DEVICE = 25,
/**
* Accessory devices, such as the mic on remote control.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 19
*/
ACCESSORY = 26,
/**
* HDMI device, such as HDMI, ARC, eARC
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 19
*/
HDMI = 27,
/**
* Line connected digital output device, such as s/pdif
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 19
*/
LINE_DIGITAL = 28,
/**
* Distributed virtualization audio device.
* @syscap SystemCapability.Multimedia.Audio.Device
* @atomicservice
* @since 18
*/
REMOTE_DAUDIO = 29,
/**
* Hearing aid audio device.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 20
*/
HEARING_AID = 30,
/**
* Nearlink Device.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 20
*/
NEARLINK = 31,
/**
* Default device type.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 9
*/
/**
* Default device type.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @atomicservice
* @since 12
*/
DEFAULT = 1000,
}
/**
* Enumerates the active device types.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.CommunicationDeviceType
*/
enum ActiveDeviceType {
/**
* Speaker.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.CommunicationDeviceType.SPEAKER
*/
SPEAKER = 2,
/**
* Bluetooth device using the SCO link.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
* @deprecated since 9
*/
BLUETOOTH_SCO = 7,
}
/**
* Enumerates the available device types for communication.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 9
*/
/**
* Enumerates the available device types for communication.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Communication
* @crossplatform
* @since 12
*/
enum CommunicationDeviceType {
/**
* Speaker.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 9
*/
/**
* Speaker.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @crossplatform
* @since 12
*/
SPEAKER = 2
}
/**
* Enumerates ringer modes.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 7
*/
/**
* Enumerates ringer modes.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Communication
* @crossplatform
* @since 12
*/
enum AudioRingMode {
/**
* Silent mode.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 7
*/
/**
* Silent mode.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @crossplatform
* @since 12
*/
RINGER_MODE_SILENT = 0,
/**
* Vibration mode.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 7
*/
/**
* Vibration mode.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @crossplatform
* @since 12
*/
RINGER_MODE_VIBRATE = 1,
/**
* Normal mode.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 7
*/
/**
* Normal mode.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @crossplatform
* @since 12
*/
RINGER_MODE_NORMAL = 2,
}
/**
* Enumerates type.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Volume
* @systemapi
* @since 12
*/
enum PolicyType {
/**
* EDM type.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @systemapi
* @since 12
*/
EDM = 0,
/**
* PRIVACY type.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @systemapi
* @since 12
*/
PRIVACY = 1,
}
/**
* Enumerates the audio sample formats.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Enumerates the audio sample formats.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
enum AudioSampleFormat {
/**
* Invalid format.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Invalid format.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
SAMPLE_FORMAT_INVALID = -1,
/**
* Unsigned 8 format.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Unsigned 8 format.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
SAMPLE_FORMAT_U8 = 0,
/**
* Signed 16 bit integer, little endian.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Signed 16 bit integer, little endian.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
SAMPLE_FORMAT_S16LE = 1,
/**
* Signed 24 bit integer, little endian.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Signed 24 bit integer, little endian.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
SAMPLE_FORMAT_S24LE = 2,
/**
* Signed 32 bit integer, little endian.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Signed 32 bit integer, little endian.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
SAMPLE_FORMAT_S32LE = 3,
/**
* Signed 32 bit float, little endian.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 9
*/
/**
* Signed 32 bit float, little endian.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
SAMPLE_FORMAT_F32LE = 4,
}
/**
* Enumerates the audio channel.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Enumerates the audio channel.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
enum AudioChannel {
/**
* Channel 1.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Channel 1.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
CHANNEL_1 = 1,
/**
* Channel 2.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Channel 2.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
CHANNEL_2 = 2,
/**
* Channel 3.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 11
*/
/**
* Channel 3.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
CHANNEL_3 = 3,
/**
* Channel 4.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 11
*/
/**
* Channel 4.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
CHANNEL_4 = 4,
/**
* Channel 5.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 11
*/
/**
* Channel 5.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
CHANNEL_5 = 5,
/**
* Channel 6.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 11
*/
/**
* Channel 6.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
CHANNEL_6 = 6,
/**
* Channel 7.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 11
*/
/**
* Channel 7.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
CHANNEL_7 = 7,
/**
* Channel 8.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 11
*/
/**
* Channel 8.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
CHANNEL_8 = 8,
/**
* Channel 9.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 11
*/
/**
* Channel 9.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
CHANNEL_9 = 9,
/**
* Channel 10.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 11
*/
/**
* Channel 10.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
CHANNEL_10 = 10,
/**
* Channel 12.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 11
*/
/**
* Channel 12.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
CHANNEL_12 = 12,
/**
* Channel 14.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 11
*/
/**
* Channel 14.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
CHANNEL_14 = 14,
/**
* Channel 16.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 11
*/
/**
* Channel 16.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
CHANNEL_16 = 16
}
/**
* Enumerates the audio sampling rate.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Enumerates the audio sampling rate.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
enum AudioSamplingRate {
/**
* 8kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* 8kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
SAMPLE_RATE_8000 = 8000,
/**
* 11.025kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* 11.025kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
SAMPLE_RATE_11025 = 11025,
/**
* 12kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* 12kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
SAMPLE_RATE_12000 = 12000,
/**
* 16kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* 16kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
SAMPLE_RATE_16000 = 16000,
/**
* 22.05kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* 22.05kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
SAMPLE_RATE_22050 = 22050,
/**
* 24kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* 24kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
SAMPLE_RATE_24000 = 24000,
/**
* 32kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* 32kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
SAMPLE_RATE_32000 = 32000,
/**
* 44.1kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* 44.1kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
SAMPLE_RATE_44100 = 44100,
/**
* 48kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* 48kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
SAMPLE_RATE_48000 = 48000,
/**
* 64kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* 64kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
SAMPLE_RATE_64000 = 64000,
/**
* 88.2kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 12
*/
SAMPLE_RATE_88200 = 88200,
/**
* 96kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* 96kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
SAMPLE_RATE_96000 = 96000,
/**
* 176.4kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 12
*/
SAMPLE_RATE_176400 = 176400,
/**
* 192kHz sample rate.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 12
*/
SAMPLE_RATE_192000 = 192000
}
/**
* Enumerates the audio encoding type.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Enumerates the audio encoding type.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
enum AudioEncodingType {
/**
* Invalid type.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Invalid type.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
ENCODING_TYPE_INVALID = -1,
/**
* PCM encoding.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* PCM encoding.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
ENCODING_TYPE_RAW = 0
}
/**
* Enumerates the audio content type.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 7
* @deprecated since 10
* @useinstead ohos.multimedia.audio.StreamUsage
*/
enum ContentType {
/**
* Unknown content.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 7
* @deprecated since 10
* @useinstead ohos.multimedia.audio.StreamUsage.STREAM_USAGE_UNKNOWN
*/
CONTENT_TYPE_UNKNOWN = 0,
/**
* Speech content.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 7
* @deprecated since 10
* @useinstead ohos.multimedia.audio.StreamUsage.STREAM_USAGE_VOICE_COMMUNICATION
*/
CONTENT_TYPE_SPEECH = 1,
/**
* Music content.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 7
* @deprecated since 10
* @useinstead ohos.multimedia.audio.StreamUsage.STREAM_USAGE_MUSIC
*/
CONTENT_TYPE_MUSIC = 2,
/**
* Movie content.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 7
* @deprecated since 10
* @useinstead ohos.multimedia.audio.StreamUsage.STREAM_USAGE_MOVIE
*/
CONTENT_TYPE_MOVIE = 3,
/**
* Notification content.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 7
* @deprecated since 10
* @useinstead ohos.multimedia.audio.StreamUsage.STREAM_USAGE_NOTIFICATION
*/
CONTENT_TYPE_SONIFICATION = 4,
/**
* Ringtone content.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
* @deprecated since 10
* @useinstead ohos.multimedia.audio.StreamUsage.STREAM_USAGE_RINGTONE
*/
CONTENT_TYPE_RINGTONE = 5,
}
/**
* Enumerates the stream usage.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 7
*/
/**
* Enumerates the stream usage.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
enum StreamUsage {
/**
* Unknown usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 7
*/
/**
* Unknown usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
STREAM_USAGE_UNKNOWN = 0,
/**
* Media usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 7
* @deprecated since 10
* @useinstead ohos.multimedia.audio.StreamUsage.STREAM_USAGE_MUSIC or
* ohos.multimedia.audio.StreamUsage.STREAM_USAGE_MOVIE or
* ohos.multimedia.audio.StreamUsage.STREAM_USAGE_GAME or
* ohos.multimedia.audio.StreamUsage.STREAM_USAGE_AUDIOBOOK
*/
STREAM_USAGE_MEDIA = 1,
/**
* Music usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 10
*/
/**
* Music usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
STREAM_USAGE_MUSIC = 1,
/**
* Voice communication usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 7
*/
/**
* Voice communication usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
STREAM_USAGE_VOICE_COMMUNICATION = 2,
/**
* Voice assistant broadcast usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 9
*/
/**
* Voice assistant broadcast usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
STREAM_USAGE_VOICE_ASSISTANT = 3,
/**
* Alarm usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 10
*/
/**
* Alarm usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
STREAM_USAGE_ALARM = 4,
/**
* Voice message usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 10
*/
/**
* Voice message usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @atomicservice
* @since 12
*/
STREAM_USAGE_VOICE_MESSAGE = 5,
/**
* Notification or ringtone usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 7
* @deprecated since 10
* @useinstead ohos.multimedia.audio.StreamUsage.STREAM_USAGE_RINGTONE
*/
STREAM_USAGE_NOTIFICATION_RINGTONE = 6,
/**
* Ringtone usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 10
*/
/**
* Ringtone usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
STREAM_USAGE_RINGTONE = 6,
/**
* Notification usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 10
*/
/**
* Notification usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
STREAM_USAGE_NOTIFICATION = 7,
/**
* Accessibility usage, such as screen reader.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 10
*/
/**
* Accessibility usage, such as screen reader.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
STREAM_USAGE_ACCESSIBILITY = 8,
/**
* System usage, such as screen lock or key click.
* @syscap SystemCapability.Multimedia.Audio.Core
* @systemapi
* @since 10
*/
STREAM_USAGE_SYSTEM = 9,
/**
* Movie or video usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 10
*/
/**
* Movie or video usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
STREAM_USAGE_MOVIE = 10,
/**
* Game sound effect usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 10
*/
/**
* Game sound effect usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
STREAM_USAGE_GAME = 11,
/**
* Audiobook usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 10
*/
/**
* Audiobook usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
STREAM_USAGE_AUDIOBOOK = 12,
/**
* Navigation usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 10
*/
/**
* Navigation usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
STREAM_USAGE_NAVIGATION = 13,
/**
* DTMF dial tone usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @systemapi
* @since 10
*/
STREAM_USAGE_DTMF = 14,
/**
* Enforced tone usage, such as camera shutter.
* @syscap SystemCapability.Multimedia.Audio.Core
* @systemapi
* @since 10
*/
STREAM_USAGE_ENFORCED_TONE = 15,
/**
* Ultrasonic playing usage. This type is only used for msdp condition.
* @syscap SystemCapability.Multimedia.Audio.Core
* @systemapi
* @since 10
*/
STREAM_USAGE_ULTRASONIC = 16,
/**
* Video communication or video conference usage.
* @syscap SystemCapability.Multimedia.Audio.Core
* @atomicservice
* @since 12
*/
STREAM_USAGE_VIDEO_COMMUNICATION = 17,
/**
* Voice call assistant type. This type is only used for call assistant functionalities.
* @syscap SystemCapability.Multimedia.Audio.Core
* @systemapi
* @since 12
*/
STREAM_USAGE_VOICE_CALL_ASSISTANT = 21,
}
/**
* Enumerates the audio interrupt request type.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Interrupt
* @systemapi
* @since 9
*/
enum InterruptRequestType {
/**
* Default type to request audio interrupt.
* @syscap SystemCapability.Multimedia.Audio.Interrupt
* @systemapi
* @since 9
*/
INTERRUPT_REQUEST_TYPE_DEFAULT = 0,
}
/**
* Enumerates volume related operations.
* Flags should be powers of 2!
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Volume
* @systemapi
* @since 12
*/
enum VolumeFlag {
/**
* Show system volume bar.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @systemapi
* @since 12
*/
FLAG_SHOW_SYSTEM_UI = 1,
}
/**
* Describes audio stream information.
* @typedef AudioStreamInfo
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Describes audio stream information.
* @typedef AudioStreamInfo
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
interface AudioStreamInfo {
/**
* Sampling rate.
* @type { AudioSamplingRate }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Sampling rate.
* @type { AudioSamplingRate }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
samplingRate: AudioSamplingRate;
/**
* Audio channels.
* @type { AudioChannel }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Audio channels.
* @type { AudioChannel }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
channels: AudioChannel;
/**
* Audio sample format.
* @type { AudioSampleFormat }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Audio sample format.
* @type { AudioSampleFormat }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
sampleFormat: AudioSampleFormat;
/**
* Audio encoding type.
* @type { AudioEncodingType }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Audio encoding type.
* @type { AudioEncodingType }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
encodingType: AudioEncodingType;
/**
* Audio channel layout.
* @type { ?AudioChannelLayout }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 11
*/
/**
* Audio channel layout.
* @type { ?AudioChannelLayout }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
channelLayout?: AudioChannelLayout;
}
/**
* Describes audio renderer information.
* @typedef AudioRendererInfo
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Describes audio renderer information.
* @typedef AudioRendererInfo
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
interface AudioRendererInfo {
/**
* Content type.
* @type { ContentType }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
* @deprecated since 10
* @useinstead ohos.multimedia.audio.AudioRendererInfo#usage
*/
/**
* Content type.
* @type { ?ContentType }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 10
*/
content?: ContentType;
/**
* Stream usage.
* @type { StreamUsage }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Stream usage.
* @type { StreamUsage }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
usage: StreamUsage;
/**
* Audio renderer flags.
* @type { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 8
*/
/**
* Audio renderer flags. This method is currently reserved, suggest setting the default value to 0.
* @type { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @atomicservice
* @since 12
*/
rendererFlags: number;
/**
* Audio volume mode config. If volumeMode is set to {@link AudioVolumeMode.APP_INDIVIDUAL}, this audio renderer
* will be affeted by app volume percentage setted by {@link setAppVolumePercentage}
* @type { ?AudioVolumeMode }
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 19
*/
volumeMode?: AudioVolumeMode;
}
/**
* Describes audio renderer filter.
* @typedef AudioRendererFilter
* @syscap SystemCapability.Multimedia.Audio.Core
* @systemapi
* @since 9
*/
interface AudioRendererFilter {
/**
* Application uid.
* @type { ?number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @systemapi
* @since 9
*/
uid?: number;
/**
* Renderer information.
* @type { ?AudioRendererInfo }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @systemapi
* @since 9
*/
rendererInfo?: AudioRendererInfo;
/**
* AudioRenderer id.
* @type { ?number }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @systemapi
* @since 9
*/
rendererId?: number;
}
/**
* Describe audio capturer filter.
* @typedef AudioCapturerFilter
* @syscap SystemCapability.Multimedia.Audio.Core
* @systemapi
* @since 18
*/
interface AudioCapturerFilter {
/**
* Application uid.
* @type { ?number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @systemapi
* @since 18
*/
uid?: number;
/**
* Capturer information.
* @type { ?AudioCapturerInfo }
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @systemapi
* @since 18
*/
capturerInfo?: AudioCapturerInfo;
}
/**
* Describes audio renderer configuration options.
* @typedef AudioRendererOptions
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 8
*/
/**
* Describes audio renderer configuration options.
* @typedef AudioRendererOptions
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @since 12
*/
interface AudioRendererOptions {
/**
* Stream information.
* @type { AudioStreamInfo }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 8
*/
/**
* Stream information.
* @type { AudioStreamInfo }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @since 12
*/
streamInfo: AudioStreamInfo;
/**
* Renderer information.
* @type { AudioRendererInfo }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 8
*/
/**
* Renderer information.
* @type { AudioRendererInfo }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @since 12
*/
rendererInfo: AudioRendererInfo;
/**
* Privacy configuration.
* @type { ?AudioPrivacyType }
* @syscap SystemCapability.Multimedia.Audio.PlaybackCapture
* @since 10
*/
/**
* Privacy configuration.
* @type { ?AudioPrivacyType }
* @syscap SystemCapability.Multimedia.Audio.PlaybackCapture
* @crossplatform
* @since 12
*/
privacyType?: AudioPrivacyType;
}
/**
* Enumerates audio stream privacy type for playback capture.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.PlaybackCapture
* @since 10
*/
/**
* Enumerates audio stream privacy type for playback capture.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.PlaybackCapture
* @crossplatform
* @since 12
*/
enum AudioPrivacyType {
/**
* Privacy type that stream can be captured by third party applications.
* @syscap SystemCapability.Multimedia.Audio.PlaybackCapture
* @since 10
*/
/**
* Privacy type that stream can be captured by third party applications.
* @syscap SystemCapability.Multimedia.Audio.PlaybackCapture
* @crossplatform
* @since 12
*/
PRIVACY_TYPE_PUBLIC = 0,
/**
* Privacy type that stream can not be captured.
* @syscap SystemCapability.Multimedia.Audio.PlaybackCapture
* @since 10
*/
/**
* Privacy type that stream can not be captured.
* @syscap SystemCapability.Multimedia.Audio.PlaybackCapture
* @crossplatform
* @since 12
*/
PRIVACY_TYPE_PRIVATE = 1,
}
/**
* Enumerates the interrupt modes.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Interrupt
* @since 9
*/
/**
* Enumerates the interrupt modes.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Interrupt
* @crossplatform
* @atomicservice
* @since 12
*/
enum InterruptMode {
/**
* Mode that different stream share one interrupt unit.
* @syscap SystemCapability.Multimedia.Audio.Interrupt
* @since 9
*/
/**
* Mode that different stream share one interrupt unit.
* @syscap SystemCapability.Multimedia.Audio.Interrupt
* @crossplatform
* @atomicservice
* @since 12
*/
SHARE_MODE = 0,
/**
* Mode that each stream has independent interrupt unit.
* @syscap SystemCapability.Multimedia.Audio.Interrupt
* @since 9
*/
/**
* Mode that each stream has independent interrupt unit.
* @syscap SystemCapability.Multimedia.Audio.Interrupt
* @crossplatform
* @atomicservice
* @since 12
*/
INDEPENDENT_MODE = 1
}
/**
* Enumerates the audio renderer rates.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 8
*/
enum AudioRendererRate {
/**
* Normal playback render rate.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 8
*/
RENDER_RATE_NORMAL = 0,
/**
* Double playback render rate.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 8
*/
RENDER_RATE_DOUBLE = 1,
/**
* Half playback render rate.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 8
*/
RENDER_RATE_HALF = 2
}
/**
* Enumerates the interrupt types.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 7
*/
/**
* Enumerates the interrupt types.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @atomicservice
* @since 12
*/
enum InterruptType {
/**
* Audio playback interruption started.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 7
*/
/**
* Audio playback interruption started.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @atomicservice
* @since 12
*/
INTERRUPT_TYPE_BEGIN = 1,
/**
* Audio playback interruption ended.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 7
*/
/**
* Audio playback interruption ended.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @atomicservice
* @since 12
*/
INTERRUPT_TYPE_END = 2
}
/**
* Enumerates the interrupt hints.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 7
*/
/**
* Enumerates the interrupt hints.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @atomicservice
* @since 12
*/
enum InterruptHint {
/**
* None.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 8
*/
/**
* None.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @atomicservice
* @since 12
*/
INTERRUPT_HINT_NONE = 0,
/**
* Resume the playback.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 7
*/
/**
* Resume the playback.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @atomicservice
* @since 12
*/
INTERRUPT_HINT_RESUME = 1,
/**
* Paused/Pause the playback.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 7
*/
/**
* Paused/Pause the playback.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @atomicservice
* @since 12
*/
INTERRUPT_HINT_PAUSE = 2,
/**
* Stopped/Stop the playback.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 7
*/
/**
* Stopped/Stop the playback.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @atomicservice
* @since 12
*/
INTERRUPT_HINT_STOP = 3,
/**
* Ducked the playback. (In ducking, the audio volume is reduced, but not silenced.)
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 7
*/
/**
* Ducked the playback. (In ducking, the audio volume is reduced, but not silenced.)
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @atomicservice
* @since 12
*/
INTERRUPT_HINT_DUCK = 4,
/**
* Unducked the playback.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 8
*/
/**
* Unducked the playback.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @atomicservice
* @since 12
*/
INTERRUPT_HINT_UNDUCK = 5,
/**
* Mute the stream.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 20
*/
INTERRUPT_HINT_MUTE = 6,
/**
* Unmute the stream.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 20
*/
INTERRUPT_HINT_UNMUTE = 7,
}
/**
* Enumerates the interrupt force types.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 9
*/
/**
* Enumerates the interrupt force types.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @atomicservice
* @since 12
*/
enum InterruptForceType {
/**
* Forced action taken by system.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 9
*/
/**
* Forced action taken by system.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @atomicservice
* @since 12
*/
INTERRUPT_FORCE = 0,
/**
* Share type, application can choose to take action or ignore.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 9
*/
/**
* Share type, application can choose to take action or ignore.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @atomicservice
* @since 12
*/
INTERRUPT_SHARE = 1
}
/**
* Describes the interrupt event received by the app when playback is interrupted.
* @typedef InterruptEvent
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 9
*/
/**
* Describes the interrupt event received by the app when playback is interrupted.
* @typedef InterruptEvent
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @atomicservice
* @since 12
*/
interface InterruptEvent {
/**
* Indicates whether the interruption has started or finished.
* @type { InterruptType }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 9
*/
/**
* Indicates whether the interruption has started or finished.
* @type { InterruptType }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @atomicservice
* @since 12
*/
eventType: InterruptType;
/**
* Indicates whether the action is taken by system or to be taken by the app.
* @type { InterruptForceType }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 9
*/
/**
* Indicates whether the action is taken by system or to be taken by the app.
* @type { InterruptForceType }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @atomicservice
* @since 12
*/
forceType: InterruptForceType;
/**
* Indicates the kind of action.
* @type { InterruptHint }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 9
*/
/**
* Indicates the kind of action.
* @type { InterruptHint }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @atomicservice
* @since 12
*/
hintType: InterruptHint;
}
/**
* Enumerates interrupt action types.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 7
* @deprecated since 9
*/
enum InterruptActionType {
/**
* Focus gain event.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 7
* @deprecated since 9
*/
TYPE_ACTIVATED = 0,
/**
* Audio interruption event.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 7
* @deprecated since 9
*/
TYPE_INTERRUPT = 1
}
/**
* Enumerates device change types.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* Enumerates device change types.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
enum DeviceChangeType {
/**
* Device connection.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* Device connection.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
CONNECT = 0,
/**
* Device disconnection.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
*/
/**
* Device disconnection.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
DISCONNECT = 1,
}
/**
* Enumerates audio scenes.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 8
*/
/**
* Enumerates audio scenes.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Communication
* @crossplatform
* @since 12
*/
enum AudioScene {
/**
* Default audio scene
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 8
*/
/**
* Default audio scene
* @syscap SystemCapability.Multimedia.Audio.Communication
* @crossplatform
* @since 12
*/
AUDIO_SCENE_DEFAULT = 0,
/**
* Ringing audio scene
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 12
*/
AUDIO_SCENE_RINGING = 1,
/**
* Phone call audio scene
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 12
*/
AUDIO_SCENE_PHONE_CALL = 2,
/**
* Voice chat audio scene
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 8
*/
/**
* Voice chat audio scene
* @syscap SystemCapability.Multimedia.Audio.Communication
* @crossplatform
* @since 12
*/
AUDIO_SCENE_VOICE_CHAT = 3
}
/**
* Enumerates volume adjustment types.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Volume
* @systemapi
* @since 10
*/
enum VolumeAdjustType {
/**
* Adjust volume up.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @systemapi
* @since 10
*/
VOLUME_UP = 0,
/**
* Adjust volume down.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @systemapi
* @since 10
*/
VOLUME_DOWN = 1,
}
/**
* Implements audio volume and audio device management.
* @typedef AudioManager
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 7
*/
/**
* Implements audio stream, volume, device, effect and many other management functions.
* @typedef AudioManager
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
interface AudioManager {
/**
* Sets the volume for a volume type. This method uses an asynchronous callback to return the result.
* @permission ohos.permission.ACCESS_NOTIFICATION_POLICY
* @param { AudioVolumeType } volumeType - Audio volume type.
* @param { number } volume - Volume to set. The value range can be obtained by calling getMinVolume and getMaxVolume.
* @param { AsyncCallback } callback - Callback used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#setVolume
*/
setVolume(volumeType: AudioVolumeType, volume: number, callback: AsyncCallback): void;
/**
* Sets the volume for a volume type. This method uses a promise to return the result.
* @permission ohos.permission.ACCESS_NOTIFICATION_POLICY
* @param { AudioVolumeType } volumeType - Audio volume type.
* @param { number } volume - Volume to set. The value range can be obtained by calling getMinVolume and getMaxVolume.
* @returns { Promise } Promise used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#setVolume
*/
setVolume(volumeType: AudioVolumeType, volume: number): Promise;
/**
* Obtains the volume of a volume type. This method uses an asynchronous callback to return the query result.
* @param { AudioVolumeType } volumeType - Audio volume type.
* @param { AsyncCallback } callback - Callback used to return the volume.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#getVolume
*/
getVolume(volumeType: AudioVolumeType, callback: AsyncCallback): void;
/**
* Obtains the volume of a volume type. This method uses a promise to return the query result.
* @param { AudioVolumeType } volumeType - Audio volume type.
* @returns { Promise } Promise used to return the volume.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#getVolume
*/
getVolume(volumeType: AudioVolumeType): Promise;
/**
* Obtains the minimum volume allowed for a stream. This method uses an asynchronous callback to return the query result.
* @param { AudioVolumeType } volumeType - Audio stream type.
* @param { AsyncCallback } callback - Callback used to return the minimum volume.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#getMinVolume
*/
getMinVolume(volumeType: AudioVolumeType, callback: AsyncCallback): void;
/**
* Obtains the minimum volume allowed for a stream. This method uses a promise to return the query result.
* @param { AudioVolumeType } volumeType - Audio stream type.
* @returns { Promise } Promise used to return the minimum volume.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#getMinVolume
*/
getMinVolume(volumeType: AudioVolumeType): Promise;
/**
* Obtains the maximum volume allowed for a volume type. This method uses an asynchronous callback to return the query result.
* @param { AudioVolumeType } volumeType - Audio volume type.
* @param { AsyncCallback } callback - Callback used to return the maximum volume.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#getMaxVolume
*/
getMaxVolume(volumeType: AudioVolumeType, callback: AsyncCallback): void;
/**
* Obtains the maximum volume allowed for a volume type. This method uses a promise to return the query result.
* @param { AudioVolumeType } volumeType - Audio volume type.
* @returns { Promise } Promise used to return the maximum volume.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#getMaxVolume
*/
getMaxVolume(volumeType: AudioVolumeType): Promise;
/**
* Obtains the audio devices with a specific flag. This method uses an asynchronous callback to return the query result.
* @param { DeviceFlag } deviceFlag - Audio device flag.
* @param { AsyncCallback } callback - Callback used to return the device list.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioRoutingManager#getDevices
*/
getDevices(deviceFlag: DeviceFlag, callback: AsyncCallback): void;
/**
* Obtains the audio devices with a specific flag. This method uses a promise to return the query result.
* @param { DeviceFlag } deviceFlag - Audio device flag.
* @returns { Promise } Promise used to return the device list.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioRoutingManager#getDevices
*/
getDevices(deviceFlag: DeviceFlag): Promise;
/**
* Mutes a volume type. This method uses an asynchronous callback to return the result.
* @param { AudioVolumeType } volumeType - Audio volume type.
* @param { boolean } mute - Mute status to set. The value true means to mute the volume type, and false means the opposite.
* @param { AsyncCallback } callback - Callback used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#mute
*/
mute(volumeType: AudioVolumeType, mute: boolean, callback: AsyncCallback): void;
/**
* Mutes a volume type. This method uses a promise to return the result.
* @param { AudioVolumeType } volumeType - Audio volume type.
* @param { boolean } mute - Mute status to set. The value true means to mute the volume type, and false means the opposite.
* @returns { Promise } Promise used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#mute
*/
mute(volumeType: AudioVolumeType, mute: boolean): Promise;
/**
* Checks whether a stream is muted. This method uses an asynchronous callback to return the query result.
* @param { AudioVolumeType } volumeType - Audio stream type.
* @param { AsyncCallback } callback - Callback used to return the mute status of the stream.
* The value true means that the stream is muted, and false means the opposite.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#isMute
*/
isMute(volumeType: AudioVolumeType, callback: AsyncCallback): void;
/**
* Checks whether a stream is muted. This method uses a promise to return the result.
* @param { AudioVolumeType } volumeType - Audio stream type.
* @returns { 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.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#isMute
*/
isMute(volumeType: AudioVolumeType): Promise;
/**
* Checks whether a stream is active. This method uses an asynchronous callback to return the query result.
* @param { AudioVolumeType } volumeType - Audio stream type.
* @param { AsyncCallback } callback - Callback used to return the active status of the stream.
* The value true means that the stream is active, and false means the opposite.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioStreamManager#isActive
*/
isActive(volumeType: AudioVolumeType, callback: AsyncCallback): void;
/**
* Checks whether a stream is active. This method uses a promise to return the query result.
* @param { AudioVolumeType } volumeType - Audio stream type.
* @returns { 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.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioStreamManager#isActive
*/
isActive(volumeType: AudioVolumeType): Promise;
/**
* Mutes or unmutes the microphone. This method uses an asynchronous callback to return the result.
* @permission ohos.permission.MICROPHONE
* @param { boolean } mute - Mute status to set. The value true means to mute the microphone, and false means the opposite.
* @param { AsyncCallback } callback - Callback used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#setMicrophoneMute
*/
setMicrophoneMute(mute: boolean, callback: AsyncCallback): void;
/**
* Mutes or unmutes the microphone. This method uses a promise to return the result.
* @permission ohos.permission.MICROPHONE
* @param { boolean } mute - Mute status to set. The value true means to mute the microphone, and false means the opposite.
* @returns { Promise } Promise used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#setMicrophoneMute
*/
setMicrophoneMute(mute: boolean): Promise;
/**
* Checks whether the microphone is muted. This method uses an asynchronous callback to return the query result.
* @permission ohos.permission.MICROPHONE
* @param { AsyncCallback } callback - used to return the mute status of the microphone. The value
* true means that the microphone is muted, and false means the opposite.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#isMicrophoneMute
*/
isMicrophoneMute(callback: AsyncCallback): void;
/**
* Checks whether the microphone is muted. This method uses a promise to return the query result.
* @permission ohos.permission.MICROPHONE
* @returns { 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.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#isMicrophoneMute
*/
isMicrophoneMute(): Promise;
/**
* Sets the ringer mode. This method uses an asynchronous callback to return the result.
* @permission ohos.permission.ACCESS_NOTIFICATION_POLICY
* @param { AudioRingMode } mode - Ringer mode.
* @param { AsyncCallback } callback - Callback used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#setRingerMode
*/
setRingerMode(mode: AudioRingMode, callback: AsyncCallback): void;
/**
* Sets the ringer mode. This method uses a promise to return the result.
* @permission ohos.permission.ACCESS_NOTIFICATION_POLICY
* @param { AudioRingMode } mode - Ringer mode.
* @returns { Promise } Promise used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#setRingerMode
*/
setRingerMode(mode: AudioRingMode): Promise;
/**
* Obtains the ringer mode. This method uses an asynchronous callback to return the query result.
* @param { AsyncCallback } callback - Callback used to return the ringer mode.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#getRingerMode
*/
getRingerMode(callback: AsyncCallback): void;
/**
* Obtains the ringer mode. This method uses a promise to return the query result.
* @returns { Promise } Promise used to return the ringer mode.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#getRingerMode
*/
getRingerMode(): Promise;
/**
* Sets an audio parameter. This method uses an asynchronous callback to return the result.
* @permission ohos.permission.MODIFY_AUDIO_SETTINGS
* @param { string } key - Key of the audio parameter to set.
* @param { string } value - Value of the audio parameter to set.
* @param { AsyncCallback } callback - Callback used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 7
* @deprecated since 11
* @useinstead ohos.multimedia.audio.AudioManager#setExtraParameters
*/
setAudioParameter(key: string, value: string, callback: AsyncCallback): void;
/**
* Sets an audio parameter. This method uses a promise to return the result.
* @permission ohos.permission.MODIFY_AUDIO_SETTINGS
* @param { string } key - Key of the audio parameter to set.
* @param { string } value - Value of the audio parameter to set.
* @returns { Promise } Promise used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 7
* @deprecated since 11
* @useinstead ohos.multimedia.audio.AudioManager#setExtraParameters
*/
setAudioParameter(key: string, value: string): Promise;
/**
* Obtains the value of an audio parameter. This method uses an asynchronous callback to return the query result.
* @param { string } key - Key of the audio parameter whose value is to be obtained.
* @param { AsyncCallback } callback - Callback used to return the value of the audio parameter.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 7
* @deprecated since 11
* @useinstead ohos.multimedia.audio.AudioManager#getExtraParameters
*/
getAudioParameter(key: string, callback: AsyncCallback): void;
/**
* Obtains the value of an audio parameter. This method uses a promise to return the query result.
* @param { string } key - Key of the audio parameter whose value is to be obtained.
* @returns { Promise } Promise used to return the value of the audio parameter.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 7
* @deprecated since 11
* @useinstead ohos.multimedia.audio.AudioManager#getExtraParameters
*/
getAudioParameter(key: string): Promise;
/**
* Sets extra audio parameters. This method uses a promise to return the result.
* @permission ohos.permission.MODIFY_AUDIO_SETTINGS
* @param { string } mainKey - Main key of the audio parameters to set.
* @param { Record } kvpairs - Key-value pairs with subkeys and values to set.
* @returns { Promise } Promise used to return the result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system App.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Core
* @systemapi
* @since 11
*/
setExtraParameters(mainKey: string, kvpairs: Record): Promise;
/**
* Obtains the values of a certain key. This method uses a promise to return the query result.
* @param { string } mainKey - Main key of the audio parameters to get.
* @param { Array } subKeys - Sub keys of the audio parameters to get.
* @returns { Promise> } Promise used to return the key-value pairs.
* @throws { BusinessError } 202 - Not system App.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Core
* @systemapi
* @since 11
*/
getExtraParameters(mainKey: string, subKeys?: Array): Promise>;
/**
* Sets a device to the active state. Applications that are not in a call state cannot modify the calling device by this method.
* This method uses an asynchronous callback to return the result.
* @param { ActiveDeviceType } deviceType - Audio device type.
* @param { boolean } active - Active status to set. The value true means to set the device to the active
* status, and false means the opposite.
* @param { AsyncCallback } callback - Callback used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioRoutingManager#setCommunicationDevice
*/
setDeviceActive(deviceType: ActiveDeviceType, active: boolean, callback: AsyncCallback): void;
/**
* Sets a device to the active state. Applications that are not in a call state cannot modify the calling device by this method.
* This method uses a promise to return the result.
* @param { ActiveDeviceType } deviceType - Audio device type.
* @param { boolean } active - Active status to set. The value true means to set the device to the active
* status, and false means the opposite.
* @returns { Promise } Promise used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioRoutingManager#setCommunicationDevice
*/
setDeviceActive(deviceType: ActiveDeviceType, active: boolean): Promise;
/**
* Checks whether a device is active. This method uses an asynchronous callback to return the query result.
* @param { ActiveDeviceType } deviceType - Audio device type.
* @param { AsyncCallback } callback - Callback used to return the active status of the device.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioRoutingManager#isCommunicationDeviceActive
*/
isDeviceActive(deviceType: ActiveDeviceType, callback: AsyncCallback): void;
/**
* Checks whether a device is active. This method uses a promise to return the query result.
* @param { ActiveDeviceType } deviceType - Audio device type.
* @returns { Promise } Promise used to return the active status of the device.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioRoutingManager#isCommunicationDeviceActive
*/
isDeviceActive(deviceType: ActiveDeviceType): Promise;
/**
* Listens for system volume change events. This method uses a callback to get volume change events.
* @param { 'volumeChange' } type - Type of the event to listen for. Only the volumeChange event is supported.
* @param { Callback } callback - Callback used to get the system volume change event.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeManager#event:volumeChange
*/
on(type: 'volumeChange', callback: Callback): void;
/**
* Listens for ringer mode change events. This method uses a callback to get ringer mode changes.
* @param { 'ringerModeChange' } type - Type of the event to listen for. Only the ringerModeChange event is supported.
* @param { Callback } callback - Callback used to get the updated ringer mode.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @systemapi
* @since 8
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioVolumeGroupManager#event:ringerModeChange
*/
on(type: 'ringerModeChange', callback: Callback): void;
/**
* Sets the audio scene mode to change audio strategies. This method uses an asynchronous callback to return the
* result.
* @param { AudioScene } scene - Audio scene mode.
* @param { AsyncCallback } callback - Callback used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @systemapi
* @since 8
*/
setAudioScene(scene: AudioScene, callback: AsyncCallback): void;
/**
* Sets the audio scene mode to change audio strategies. This method uses a promise to return the result.
* @param { AudioScene } scene - Audio scene mode.
* @returns { Promise } Promise used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @systemapi
* @since 8
*/
setAudioScene(scene: AudioScene): Promise;
/**
* Obtains the audio scene mode. This method uses an asynchronous callback to return the query result.
* @param { AsyncCallback } callback - Callback used to return the audio scene mode.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 8
*/
/**
* Obtains the audio scene mode. This method uses an asynchronous callback to return the query result.
* @param { AsyncCallback } callback - Callback used to return the audio scene mode.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @crossplatform
* @since 12
*/
getAudioScene(callback: AsyncCallback): void;
/**
* Obtains the audio scene mode. This method uses a promise to return the query result.
* @returns { Promise } Promise used to return the audio scene mode.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 8
*/
/**
* Obtains the audio scene mode. This method uses a promise to return the query result.
* @returns { Promise } Promise used to return the audio scene mode.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @crossplatform
* @since 12
*/
getAudioScene(): Promise;
/**
* Obtains the audio scene mode.
* @returns { AudioScene } Current audio scene mode.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 10
*/
/**
* Obtains the audio scene mode.
* @returns { AudioScene } Current audio scene mode.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @crossplatform
* @since 12
*/
getAudioSceneSync(): AudioScene;
/**
* Subscribes to audio scene change events. When system changes to communication status, registered clients
* will receive the callback.
* @param { 'audioSceneChange' } type - Type of the event to listen for. Only the audioSceneChange event is
* supported.
* @param { Callback } callback - Callback used to obtain the latest audio scene.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 20
*/
on(type: 'audioSceneChange', callback: Callback): void;
/**
* Unsubscribes to audio scene change events.
* @param { 'audioSceneChange' } type - Type of the event to listen for. Only the audioSceneChange event is
* supported.
* @param { Callback } callback - Callback used in subscription.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 20
*/
off(type: 'audioSceneChange', callback?: Callback): void;
/**
* Subscribes to device change events. When a device is connected/disconnected, registered clients will receive
* the callback.
* @param { 'deviceChange' } type - Type of the event to listen for. Only the deviceChange event is supported.
* @param { Callback } callback - Callback used to obtain the device update details.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioRoutingManager#event:deviceChange
*/
on(type: 'deviceChange', callback: Callback): void;
/**
* UnSubscribes to device change events.
* @param { 'deviceChange' } type - Type of the event to listen for. Only the deviceChange event is supported.
* @param { Callback } callback - Callback used to obtain the device update details.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 7
* @deprecated since 9
* @useinstead ohos.multimedia.audio.AudioRoutingManager#event:deviceChange
*/
off(type: 'deviceChange', callback?: Callback): void;
/**
* Listens for audio interruption events. When the audio of an application is interrupted by another application,
* the callback is invoked to notify the former application.
* @param { 'interrupt' } type - Type of the event to listen for. Only the interrupt event is supported.
* @param { AudioInterrupt } interrupt - Parameters of the audio interruption event type.
* @param { Callback } callback - Callback invoked for the audio interruption event.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 7
* @deprecated since 11
* @useinstead ohos.multimedia.audio.AudioRenderer#event:audioInterrupt
*/
on(type: 'interrupt', interrupt: AudioInterrupt, callback: Callback): void;
/**
* Cancels the listening of audio interruption events.
* @param { 'interrupt' } type - Type of the event to listen for. Only the interrupt event is supported.
* @param { AudioInterrupt } interrupt - Input parameters of the audio interruption event.
* @param { Callback } callback - Callback invoked for the audio interruption event.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 7
* @deprecated since 11
* @useinstead ohos.multimedia.audio.AudioRenderer#event:audioInterrupt
*/
off(type: 'interrupt', interrupt: AudioInterrupt, callback?: Callback): void;
/**
* Obtains an {@link AudioVolumeManager} instance.
* @returns { AudioVolumeManager } AudioVolumeManager instance.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 9
*/
/**
* Obtains an {@link AudioVolumeManager} instance.
* @returns { AudioVolumeManager } AudioVolumeManager instance.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @crossplatform
* @since 12
*/
getVolumeManager(): AudioVolumeManager;
/**
* Obtains an {@link AudioStreamManager} instance.
* @returns { AudioStreamManager } AudioStreamManager instance.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 9
*/
/**
* Obtains an {@link AudioStreamManager} instance.
* @returns { AudioStreamManager } AudioStreamManager instance.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
getStreamManager(): AudioStreamManager;
/**
* Obtains an {@link AudioRoutingManager} instance.
* @returns { AudioRoutingManager } AudioRoutingManager instance.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 9
*/
/**
* Obtains an {@link AudioRoutingManager} instance.
* @returns { AudioRoutingManager } AudioRoutingManager instance.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
getRoutingManager(): AudioRoutingManager;
/**
* Obtains an {@link AudioSessionManager} instance.
* @returns { AudioSessionManager } AudioSessionManager instance.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
getSessionManager(): AudioSessionManager;
/**
* Obtains an {@link AudioSpatializationManager} instance.
* @returns { AudioSpatializationManager } AudioSpatializationManager instance.
* @syscap SystemCapability.Multimedia.Audio.Spatialization
* @since 18
*/
getSpatializationManager(): AudioSpatializationManager;
/**
* Obtains an {@link AudioEffectManager} instance.
* @returns { AudioEffectManager } AudioEffectManager instance.
* @throws { BusinessError } 202 - Not system App.
* @syscap SystemCapability.Multimedia.Audio.Core
* @systemapi
* @since 18
*/
getEffectManager(): AudioEffectManager;
/**
* Obtains a collaborative playback management instance.
* @returns { AudioCollaborativeManager } Returns a collaborative playback management instance.
* @throws { BusinessError } 202 - Not system App.
* @syscap SystemCapability.Multimedia.Audio.Core
* @systemapi
* @since 20
*/
getCollaborativeManager(): AudioCollaborativeManager;
/**
* user disable the safe media volume state.
* @permission ohos.permission.MODIFY_AUDIO_SETTINGS
* @returns { Promise } Promise used to return the result.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not system App.
* @syscap SystemCapability.Multimedia.Audio.Core
* @systemapi
* @since 12
*/
disableSafeMediaVolume(): Promise;
}
/**
* Enumerates audio interrupt request result type.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Interrupt
* @systemapi
* @since 9
*/
enum InterruptRequestResultType {
/**
* Request audio interrupt success
* @syscap SystemCapability.Multimedia.Audio.Interrupt
* @systemapi
* @since 9
*/
INTERRUPT_REQUEST_GRANT = 0,
/**
* Request audio interrupt fail, may have higher priority type
* @syscap SystemCapability.Multimedia.Audio.Interrupt
* @systemapi
* @since 9
*/
INTERRUPT_REQUEST_REJECT = 1
}
/**
* Describes audio interrupt operation results.
* @typedef InterruptResult
* @syscap SystemCapability.Multimedia.Audio.Interrupt
* @systemapi
* @since 9
*/
interface InterruptResult {
/**
* Interrupt request or abandon result.
* @type { InterruptRequestResultType }
* @syscap SystemCapability.Multimedia.Audio.Interrupt
* @systemapi
* @since 9
*/
requestResult: InterruptRequestResultType;
/**
* Interrupt node as a unit to receive interrupt change event.
* @type { number }
* @syscap SystemCapability.Multimedia.Audio.Interrupt
* @systemapi
* @since 9
*/
interruptNode: number;
}
/**
* Desribes audio device block status. By default, the device is consider as unblocked.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 13
*/
enum DeviceBlockStatus {
/**
* Device is unblocked.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 13
*/
UNBLOCKED = 0,
/**
* Device is blocked.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 13
*/
BLOCKED = 1,
}
/**
* Desribes audio device block status info.
* @typedef DeviceBlockStatusInfo
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 13
*/
interface DeviceBlockStatusInfo {
/**
* Device block status.
* @type {DeviceBlockStatus}
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 13
*/
blockStatus: DeviceBlockStatus;
/**
* Audio device descriptors whose block status has changed.
* @type {AudioDeviceDescriptors}
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 13
*/
devices: AudioDeviceDescriptors;
}
/**
* Implements audio router management.
* @typedef AudioRoutingManager
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 9
*/
/**
* Implements audio router management.
* @typedef AudioRoutingManager
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
interface AudioRoutingManager {
/**
* Obtains the audio devices with a specific flag. This method uses an asynchronous callback to return the query result.
* @param { DeviceFlag } deviceFlag - Audio device flag.
* @param { AsyncCallback } callback - Callback used to return the device list.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 9
*/
/**
* Obtains the audio devices with a specific flag. This method uses an asynchronous callback to return the query result.
* @param { DeviceFlag } deviceFlag - Audio device flag.
* @param { AsyncCallback } callback - Callback used to return the device list.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
getDevices(deviceFlag: DeviceFlag, callback: AsyncCallback): void;
/**
* Obtains the audio devices with a specific flag. This method uses a promise to return the query result.
* @param { DeviceFlag } deviceFlag - Audio device flag.
* @returns { Promise } Promise used to return the device list.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 9
*/
/**
* Obtains the audio devices with a specific flag. This method uses a promise to return the query result.
* @param { DeviceFlag } deviceFlag - Audio device flag.
* @returns { Promise } Promise used to return the device list.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
getDevices(deviceFlag: DeviceFlag): Promise;
/**
* Obtains the audio devices with a specific flag.
* @param { DeviceFlag } deviceFlag - Audio device flag.
* @returns { AudioDeviceDescriptors } The device list.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 10
*/
/**
* Obtains the audio devices with a specific flag.
* @param { DeviceFlag } deviceFlag - Audio device flag.
* @returns { AudioDeviceDescriptors } The device list.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
getDevicesSync(deviceFlag: DeviceFlag): AudioDeviceDescriptors;
/**
* Subscribes to device change events. When a device is connected/disconnected, registered clients will receive
* the callback.
* @param { 'deviceChange' } type - Type of the event to listen for. Only the deviceChange event is supported.
* @param { DeviceFlag } deviceFlag - Audio device flag.
* @param { Callback } callback - Callback used to obtain the device update details.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 9
*/
/**
* Subscribes to device change events. When a device is connected/disconnected, registered clients will receive
* the callback.
* @param { 'deviceChange' } type - Type of the event to listen for. Only the deviceChange event is supported.
* @param { DeviceFlag } deviceFlag - Audio device flag.
* @param { Callback } callback - Callback used to obtain the device update details.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
on(type: 'deviceChange', deviceFlag: DeviceFlag, callback: Callback): void;
/**
* UnSubscribes to device change events.
* @param { 'deviceChange' } type - Type of the event to listen for. Only the deviceChange event is supported.
* @param { Callback } callback - Callback used to obtain the device update details.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 9
*/
/**
* UnSubscribes to device change events.
* @param { 'deviceChange' } type - Type of the event to listen for. Only the deviceChange event is supported.
* @param { Callback } callback - Callback used to obtain the device update details.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
off(type: 'deviceChange', callback?: Callback): void;
/**
* Obtains all the available audio devices with a specific device usage.
* @param { DeviceUsage } deviceUsage - Audio device usage.
* @returns { AudioDeviceDescriptors } The device list.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 12
*/
getAvailableDevices(deviceUsage: DeviceUsage): AudioDeviceDescriptors;
/**
* Subscribes to available device change events. When a device is connected/disconnected, registered clients will receive
* the callback.
* @param { 'availableDeviceChange' } type - Type of the event to listen for. Only the availableDeviceChange event is supported.
* @param { DeviceUsage } deviceUsage - Audio device usage.
* @param { Callback } callback - Callback used to obtain the device update details.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 12
*/
on(type: 'availableDeviceChange', deviceUsage: DeviceUsage, callback: Callback): void;
/**
* UnSubscribes to available device change events.
* @param { 'availableDeviceChange' } type - Type of the event to listen for. Only the availableDeviceChange event is supported.
* @param { Callback } callback - Callback used to obtain the device update details.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 12
*/
off(type: 'availableDeviceChange', callback?: Callback): void;
/**
* Sets a device to the active state. This method uses an asynchronous callback to return the result.
* @param { CommunicationDeviceType } deviceType - Audio device type.
* @param { boolean } active - Active status to set. The value true means to set the device to
* the active status, and false means the opposite.
* @param { AsyncCallback } callback - Callback used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 9
*/
/**
* Sets a device to the active state. Only the current calling application can be set to take effect.
* This method uses an asynchronous callback to return the result.
* @param { CommunicationDeviceType } deviceType - Audio device type.
* @param { boolean } active - Active status to set. The value true means to set the device to
* the active status, and false means the opposite.
* @param { AsyncCallback } callback - Callback used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @crossplatform
* @since 12
*/
setCommunicationDevice(deviceType: CommunicationDeviceType, active: boolean, callback: AsyncCallback): void;
/**
* Sets a device to the active state. This method uses a promise to return the result.
* @param { CommunicationDeviceType } deviceType - Audio device type.
* @param { boolean } active - Active status to set. The value true means to set the device to the active status,
* and false means the opposite.
* @returns { Promise } Promise used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 9
*/
/**
* Sets a device to the active state. Only the current calling application can be set to take effect.
* This method uses a promise to return the result.
* @param { CommunicationDeviceType } deviceType - Audio device type.
* @param { boolean } active - Active status to set. The value true means to set the device to the active status,
* and false means the opposite.
* @returns { Promise } Promise used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @crossplatform
* @since 12
*/
setCommunicationDevice(deviceType: CommunicationDeviceType, active: boolean): Promise;
/**
* Checks whether a device is active. This method uses an asynchronous callback to return the query result.
* @param { CommunicationDeviceType } deviceType - Audio device type.
* @param { AsyncCallback } callback - Callback used to return the active status of the device.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 9
*/
/**
* Checks whether a device is active. This method uses an asynchronous callback to return the query result.
* @param { CommunicationDeviceType } deviceType - Audio device type.
* @param { AsyncCallback } callback - Callback used to return the active status of the device.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @crossplatform
* @since 12
*/
isCommunicationDeviceActive(deviceType: CommunicationDeviceType, callback: AsyncCallback): void;
/**
* Checks whether a device is active. This method uses a promise to return the query result.
* @param { CommunicationDeviceType } deviceType - Audio device type.
* @returns { Promise } Promise used to return the active status of the device.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 9
*/
/**
* Checks whether a device is active. This method uses a promise to return the query result.
* @param { CommunicationDeviceType } deviceType - Audio device type.
* @returns { Promise } Promise used to return the active status of the device.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @crossplatform
* @since 12
*/
isCommunicationDeviceActive(deviceType: CommunicationDeviceType): Promise;
/**
* Checks whether a device is active.
* @param { CommunicationDeviceType } deviceType - Audio device type.
* @returns { boolean } The active status of the device.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @since 10
*/
/**
* Checks whether a device is active.
* @param { CommunicationDeviceType } deviceType - Audio device type.
* @returns { boolean } The active status of the device.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Communication
* @crossplatform
* @since 12
*/
isCommunicationDeviceActiveSync(deviceType: CommunicationDeviceType): boolean;
/**
* Select the output device. This method uses an asynchronous callback to return the result.
* @param { AudioDeviceDescriptors } outputAudioDevices - Audio device description
* @param { AsyncCallback } callback - Callback used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 9
*/
selectOutputDevice(outputAudioDevices: AudioDeviceDescriptors, callback: AsyncCallback): void;
/**
* Select the output device. This method uses a promise to return the result.
* @param { AudioDeviceDescriptors } outputAudioDevices - Audio device description
* @returns { Promise } Promise used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 9
*/
selectOutputDevice(outputAudioDevices: AudioDeviceDescriptors): Promise;
/**
* Select the output device with desired AudioRenderer. This method uses an asynchronous callback to return the result.
* @param { AudioRendererFilter } filter - Filter for AudioRenderer.
* @param { AudioDeviceDescriptors } outputAudioDevices - Audio device description.
* @param { AsyncCallback } callback - Callback used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 9
*/
selectOutputDeviceByFilter(filter: AudioRendererFilter, outputAudioDevices: AudioDeviceDescriptors, callback: AsyncCallback): void;
/**
* Select the output device with desired AudioRenderer. This method uses a promise to return the result.
* @param { AudioRendererFilter } filter - Filter for AudioRenderer.
* @param { AudioDeviceDescriptors } outputAudioDevices - Audio device description
* @returns { Promise } Promise used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 9
*/
selectOutputDeviceByFilter(filter: AudioRendererFilter, outputAudioDevices: AudioDeviceDescriptors): Promise;
/**
* Select the input device. This method uses an asynchronous callback to return the result.
* @param { AudioDeviceDescriptors } inputAudioDevices - Audio device description
* @param { AsyncCallback } callback - Callback used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 9
*/
selectInputDevice(inputAudioDevices: AudioDeviceDescriptors, callback: AsyncCallback): void;
/**
* Select the input device. This method uses a promise to return the result.
* @param { AudioDeviceDescriptors } inputAudioDevices - Audio device description
* @returns { Promise } Promise used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 9
*/
selectInputDevice(inputAudioDevices: AudioDeviceDescriptors): Promise;
/**
* Select the input device with desired AudioCapturer. This method uses a promise to return the result.
* @param { AudioCapturerFilter } filter - Filter for AudioCapturer.
* @param { AudioDeviceDescriptors } inputAudioDevices - Audio device descriptions
* @returns { Promise } Promise used to return the result.
* @throws { BusinessError } 202 - Not system App.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 18
*/
selectInputDeviceByFilter(filter: AudioCapturerFilter, inputAudioDevices: AudioDeviceDescriptors): Promise;
/**
* Get output device for target audio renderer info.
* @param { AudioRendererInfo } rendererInfo - Audio renderer information
* @param { AsyncCallback } callback - Callback used to return the result.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed. Return by callback.
* @throws { BusinessError } 6800301 - System error. Return by callback.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 10
*/
/**
* Get output device for target audio renderer info.
* @param { AudioRendererInfo } rendererInfo - Audio renderer information
* @param { AsyncCallback } callback - Callback used to return the result.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed. Return by callback.
* @throws { BusinessError } 6800301 - System error. Return by callback.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo, callback: AsyncCallback): void;
/**
* Get output device for target audio renderer info.
* @param { AudioRendererInfo } rendererInfo - Audio renderer information.
* @returns { Promise } Promise used to return the result.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed. Return by promise.
* @throws { BusinessError } 6800301 - System error. Return by promise.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 10
*/
/**
* Get output device for target audio renderer info.
* @param { AudioRendererInfo } rendererInfo - Audio renderer information.
* @returns { Promise } Promise used to return the result.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed. Return by promise.
* @throws { BusinessError } 6800301 - System error. Return by promise.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
getPreferOutputDeviceForRendererInfo(rendererInfo: AudioRendererInfo): Promise;
/**
* Gets preferred output device for target audio renderer info.
* @param { AudioRendererInfo } rendererInfo - Audio renderer information.
* @returns { AudioDeviceDescriptors } The preferred devices.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 10
*/
/**
* Gets preferred output device for target audio renderer info.
* @param { AudioRendererInfo } rendererInfo - Audio renderer information.
* @returns { AudioDeviceDescriptors } The preferred devices.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
getPreferredOutputDeviceForRendererInfoSync(rendererInfo: AudioRendererInfo): AudioDeviceDescriptors;
/**
* Get the preferred output devices by the target audio renderer filter.
* @param { AudioRendererFilter } filter - Audio renderer filter.
* @returns { AudioDeviceDescriptors } The preferred devices.
* @throws { BusinessError } 202 - Not system App.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 18
*/
getPreferredOutputDeviceByFilter(filter: AudioRendererFilter): AudioDeviceDescriptors;
/**
* Subscribes to prefer output device change events. When prefer device for target audio renderer info changes,
* registered clients will receive the callback.
* @param { 'preferOutputDeviceChangeForRendererInfo' } type - Type of the event to listen for. Only the
* preferOutputDeviceChangeForRendererInfo event is supported.
* @param { AudioRendererInfo } rendererInfo - Audio renderer information.
* @param { Callback } callback - Callback used to obtain the changed prefer devices information.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 10
*/
/**
* Subscribes to prefer output device change events. When prefer device for target audio renderer info changes,
* registered clients will receive the callback.
* @param { 'preferOutputDeviceChangeForRendererInfo' } type - Type of the event to listen for. Only the
* preferOutputDeviceChangeForRendererInfo event is supported.
* @param { AudioRendererInfo } rendererInfo - Audio renderer information.
* @param { Callback } callback - Callback used to obtain the changed prefer devices information.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
on(type: 'preferOutputDeviceChangeForRendererInfo', rendererInfo: AudioRendererInfo, callback: Callback): void;
/**
* UnSubscribes to prefer output device change events.
* @param { 'preferOutputDeviceChangeForRendererInfo' } type - Type of the event to listen for. Only the
* preferOutputDeviceChangeForRendererInfo event is supported.
* @param { Callback } callback - Callback used to obtain the changed prefer devices in subscribe.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 10
*/
/**
* UnSubscribes to prefer output device change events.
* @param { 'preferOutputDeviceChangeForRendererInfo' } type - Type of the event to listen for. Only the
* preferOutputDeviceChangeForRendererInfo event is supported.
* @param { Callback } callback - Callback used to obtain the changed prefer devices in subscribe.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
off(type: 'preferOutputDeviceChangeForRendererInfo', callback?: Callback): void;
/**
* Get input device for target audio capturer info.
* @param { AudioCapturerInfo } capturerInfo - Audio capturer information.
* @param { AsyncCallback } callback - Callback used to return the result.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed. Return by callback.
* @throws { BusinessError } 6800301 - System error. Return by callback.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 10
*/
/**
* Get input device for target audio capturer info.
* @param { AudioCapturerInfo } capturerInfo - Audio capturer information.
* @param { AsyncCallback } callback - Callback used to return the result.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed. Return by callback.
* @throws { BusinessError } 6800301 - System error. Return by callback.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
getPreferredInputDeviceForCapturerInfo(capturerInfo: AudioCapturerInfo, callback: AsyncCallback): void;
/**
* Get input device for target audio capturer info.
* @param { AudioCapturerInfo } capturerInfo - Audio capturer information.
* @returns { Promise } Promise used to return the result.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed. Return by promise.
* @throws { BusinessError } 6800301 - System error. Return by promise.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 10
*/
/**
* Get input device for target audio capturer info.
* @param { AudioCapturerInfo } capturerInfo - Audio capturer information.
* @returns { Promise } Promise used to return the result.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed. Return by promise.
* @throws { BusinessError } 6800301 - System error. Return by promise.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
getPreferredInputDeviceForCapturerInfo(capturerInfo: AudioCapturerInfo): Promise;
/**
* Get the preferred input device for the target audio capturer filter.
* @param { AudioCapturerFilter } filter - Audio capturer filter.
* @returns { AudioDeviceDescriptors } The preferred devices.
* @throws { BusinessError } 202 - Not system App.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 18
*/
getPreferredInputDeviceByFilter(filter: AudioCapturerFilter): AudioDeviceDescriptors;
/**
* Subscribes to preferred input device change events. When preferred device for target audio capturer info changes,
* registered clients will receive the callback.
* @param { 'preferredInputDeviceChangeForCapturerInfo' } type - Type of the event to listen for.
* @param { AudioCapturerInfo } capturerInfo - Audio capturer information.
* @param { Callback } callback - Callback used to obtain the changed preferred devices information.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 10
*/
/**
* Subscribes to preferred input device change events. When preferred device for target audio capturer info changes,
* registered clients will receive the callback.
* @param { 'preferredInputDeviceChangeForCapturerInfo' } type - Type of the event to listen for.
* @param { AudioCapturerInfo } capturerInfo - Audio capturer information.
* @param { Callback } callback - Callback used to obtain the changed preferred devices information.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
on(type: 'preferredInputDeviceChangeForCapturerInfo', capturerInfo: AudioCapturerInfo, callback: Callback): void;
/**
* Unsubscribes to preferred input device change events.
* @param { 'preferredInputDeviceChangeForCapturerInfo' } type - Type of the event to listen for.
* @param { Callback } callback - Callback used to obtain the changed preferred devices in subscribe.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 10
*/
/**
* Unsubscribes to preferred input device change events.
* @param { 'preferredInputDeviceChangeForCapturerInfo' } type - Type of the event to listen for.
* @param { Callback } callback - Callback used to obtain the changed preferred devices in subscribe.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
off(type: 'preferredInputDeviceChangeForCapturerInfo', callback?: Callback): void;
/**
* Gets preferred input device for target audio capturer info.
* @param { AudioCapturerInfo } capturerInfo - Audio capturer information.
* @returns { AudioDeviceDescriptors } The preferred devices.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 10
*/
/**
* Gets preferred input device for target audio capturer info.
* @param { AudioCapturerInfo } capturerInfo - Audio capturer information.
* @returns { AudioDeviceDescriptors } The preferred devices.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @crossplatform
* @since 12
*/
getPreferredInputDeviceForCapturerInfoSync(capturerInfo: AudioCapturerInfo): AudioDeviceDescriptors;
/**
* Query whether microphone block detection is supported on current device.
* @returns { Promise } Promise used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 13
*/
isMicBlockDetectionSupported():Promise;
/**
* Subscribes microphone blocked events. Before subscribing, users should query whether block detection is supported
* on current device. The caller will receive the callback only when it is recording and the used
* microphones' block status have changed. Currently, block detecting is only support for microphones located on
* the local device.
* @param { 'micBlockStatusChanged' } type - Type of the event to listen for.
* @param { Callback } callback - Callback used to obtain the microphone block status.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 13
*/
on(type: 'micBlockStatusChanged', callback: Callback): void;
/**
* Unsubscribes microphone blocked events.
* @param { 'microphoneBlockStatusChanged' } type - Type of the event to listen for.
* @param { Callback } callback - Callback used to obtain the microphone block status.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 13
*/
off(type: 'micBlockStatusChanged', callback?: Callback): void;
/**
* Exclude output devices. After calling this function successfully, audio will not be played on the specified
* devices. Note that only the external ouput device can be excluded by this function. Local output devices is not
* accepted.
* @permission ohos.permission.MANAGE_AUDIO_CONFIG
* @param { DeviceUsage } usage - Device usage, only output device usages can be accepted.
* @param { AudioDeviceDescriptors } devices - The devices to be excluded.
* @returns { Promise } Promise used to return result.
* @throws { BusinessError } 201 - Permisson denied.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 18
*/
excludeOutputDevices(usage: DeviceUsage, devices: AudioDeviceDescriptors): Promise;
/**
* Unexclude output devices.
* @permission ohos.permission.MANAGE_AUDIO_CONFIG
* @param { DeviceUsage } usage - Device usage, only output device usages can be accepted.
* @param { AudioDeviceDescriptors } devices - The devices to be unexcluded.
* @returns { Promise } Promise used to return result.
* @throws { BusinessError } 201 - Permisson denied.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 18
*/
unexcludeOutputDevices(usage: DeviceUsage, devices: AudioDeviceDescriptors): Promise;
/**
* Unexclude output devices. This function will unexclude all output devices belong to specific usage.
* @permission ohos.permission.MANAGE_AUDIO_CONFIG
* @param { DeviceUsage } usage - Device usage, only output device usages can be accepted.
* @returns { Promise } Promise used to return result.
* @throws { BusinessError } 201 - Permisson denied.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 18
*/
unexcludeOutputDevices(usage: DeviceUsage): Promise;
/**
* Get excluded devices by filter.
* @param { DeviceUsage } usage - Device usage, only output device usages can be accepted.
* @returns { AudioDeviceDescriptors } Exclueded devices.
* @throws { BusinessError } 202 - Not system application.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Device
* @systemapi
* @since 18
*/
getExcludedDevices(usage: DeviceUsage): AudioDeviceDescriptors;
}
/**
* Implements audio stream management.
* @typedef AudioStreamManager
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 9
*/
/**
* Implements audio stream management.
* @typedef AudioStreamManager
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
interface AudioStreamManager {
/**
* Get information of current existing audio renderers.
* @param { AsyncCallback } callback - Callback used to return the information
* of current existing audio renderers.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 9
*/
/**
* Get information of current existing audio renderers.
* @param { AsyncCallback } callback - Callback used to return the information
* of current existing audio renderers.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @since 12
*/
getCurrentAudioRendererInfoArray(callback: AsyncCallback): void;
/**
* Get information of current existing audio renderers.
* @returns { Promise } Promise used to return the information of current
* existing audio renderers.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 9
*/
/**
* Get information of current existing audio renderers.
* @returns { Promise } Promise used to return the information of current
* existing audio renderers.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @since 12
*/
getCurrentAudioRendererInfoArray(): Promise;
/**
* Get information of current existing audio renderers.
* @returns { AudioRendererChangeInfoArray } The information of current existing audio renderers.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 10
*/
/**
* Get information of current existing audio renderers.
* @returns { AudioRendererChangeInfoArray } The information of current existing audio renderers.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @since 12
*/
getCurrentAudioRendererInfoArraySync(): AudioRendererChangeInfoArray;
/**
* Get information of current existing audio capturers.
* @param { AsyncCallback } callback - Callback used to return the information
* of current existing audio capturers.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 9
*/
/**
* Get information of current existing audio capturers.
* @param { AsyncCallback } callback - Callback used to return the information
* of current existing audio capturers.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @since 12
*/
getCurrentAudioCapturerInfoArray(callback: AsyncCallback): void;
/**
* Get information of current existing audio capturers.
* @returns { Promise } Promise used to return the information of current existing
* audio capturers.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 9
*/
/**
* Get information of current existing audio capturers.
* @returns { Promise } Promise used to return the information of current existing
* audio capturers.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @since 12
*/
getCurrentAudioCapturerInfoArray(): Promise;
/**
* Get information of current existing audio capturers.
* @returns { AudioCapturerChangeInfoArray } The information of current existing audio capturers.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @since 10
*/
/**
* Get information of current existing audio capturers.
* @returns { AudioCapturerChangeInfoArray } The information of current existing audio capturers.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @crossplatform
* @since 12
*/
getCurrentAudioCapturerInfoArraySync(): AudioCapturerChangeInfoArray;
/**
* Gets information of audio effects.
* @param { StreamUsage } usage - Stream usage.
* @param { AsyncCallback } callback - Callback used to return the information of audio effects.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed. Return by callback.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 10
*/
getAudioEffectInfoArray(usage: StreamUsage, callback: AsyncCallback): void;
/**
* Gets information of audio effects.
* @param { StreamUsage } usage - Stream usage.
* @returns { Promise } Promise used to return the information of audio effects.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed. Return by promise.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 10
*/
getAudioEffectInfoArray(usage: StreamUsage): Promise;
/**
* Gets information of audio effects.
* @param { StreamUsage } usage - Stream usage.
* @returns { AudioEffectInfoArray } The information of audio effects.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 10
*/
getAudioEffectInfoArraySync(usage: StreamUsage): AudioEffectInfoArray;
/**
* Listens for audio renderer change events. When there is any audio renderer change,
* registered clients will receive the callback.
* @param { 'audioRendererChange' } type - Type of the event to listen for. Only the audioRendererChange event is supported.
* @param { Callback } callback - Callback invoked for the audio renderer change event.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 9
*/
/**
* Listens for audio renderer change events. When there is any audio renderer change,
* registered clients will receive the callback.
* @param { 'audioRendererChange' } type - Type of the event to listen for. Only the audioRendererChange event is supported.
* @param { Callback } callback - Callback invoked for the audio renderer change event.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @since 12
*/
on(type: 'audioRendererChange', callback: Callback): void;
/**
* UnSubscribes to audio renderer change events.
* @param { 'audioRendererChange' } type - Type of the event to listen for. Only the audioRendererChange event is supported.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 9
*/
/**
* UnSubscribes to audio renderer change events.
* @param { 'audioRendererChange' } type - Type of the event to listen for. Only the audioRendererChange event is supported.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @since 12
*/
/**
* Unsubscribes to audio renderer change events.
* @param { 'audioRendererChange' } type - Type of the event to listen for. Only the audioRendererChange event is supported.
* @param { Callback } callback - Callback invoked for the audio renderer change event.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @since 18
*/
off(type: 'audioRendererChange', callback?: Callback): void;
/**
* Listens for audio capturer change events. When there is any audio capturer change,
* registered clients will receive the callback.
* @param { 'audioCapturerChange' } type - Type of the event to listen for. Only the audioCapturerChange event is supported.
* @param { Callback } callback - Callback invoked for the audio capturer change event.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @since 9
*/
/**
* Listens for audio capturer change events. When there is any audio capturer change,
* registered clients will receive the callback.
* @param { 'audioCapturerChange' } type - Type of the event to listen for. Only the audioCapturerChange event is supported.
* @param { Callback } callback - Callback invoked for the audio capturer change event.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @crossplatform
* @since 12
*/
on(type: 'audioCapturerChange', callback: Callback): void;
/**
* UnSubscribes to audio capturer change events.
* @param { 'audioCapturerChange' } type - Type of the event to listen for. Only the audioCapturerChange event is supported.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @since 9
*/
/**
* UnSubscribes to audio capturer change events.
* @param { 'audioCapturerChange' } type - Type of the event to listen for. Only the audioCapturerChange event is supported.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @crossplatform
* @since 12
*/
/**
* Unsubscribes to audio capturer change events.
* @param { 'audioCapturerChange' } type - Type of the event to listen for. Only the audioCapturerChange event is supported.
* @param { Callback } callback - Callback invoked for the audio capturer change event.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @crossplatform
* @since 18
*/
off(type: 'audioCapturerChange', callback?: Callback): void;
/**
* Checks whether a stream is active. This method uses an asynchronous callback to return the query result.
* @param { AudioVolumeType } volumeType - Audio stream type.
* @param { AsyncCallback } callback - Callback used to return the active status of the stream.
* The value true means that the stream is active, and false means the opposite.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 9
*/
/**
* Checks whether a stream is active. This method uses an asynchronous callback to return the query result.
* @param { AudioVolumeType } volumeType - Audio stream type.
* @param { AsyncCallback } callback - Callback used to return the active status of the stream.
* The value true means that the stream is active, and false means the opposite.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @since 12
* @deprecated since 20
* @useinstead ohos.multimedia.audio.AudioStreamManager#isStreamActive
*/
isActive(volumeType: AudioVolumeType, callback: AsyncCallback): void;
/**
* Checks whether a stream is active. This method uses a promise to return the query result.
* @param { AudioVolumeType } volumeType - Audio stream type.
* @returns { 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.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 9
*/
/**
* Checks whether a stream is active. This method uses a promise to return the query result.
* @param { AudioVolumeType } volumeType - Audio stream type.
* @returns { 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.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @since 12
* @deprecated since 20
* @useinstead ohos.multimedia.audio.AudioStreamManager#isStreamActive
*/
isActive(volumeType: AudioVolumeType): Promise;
/**
* Checks whether a stream is active.
* @param { AudioVolumeType } volumeType - Audio stream type.
* @returns { boolean } The active status of the stream.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 10
*/
/**
* Checks whether a stream is active.
* @param { AudioVolumeType } volumeType - Audio stream type.
* @returns { boolean } The active status of the stream.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @crossplatform
* @since 12
* @deprecated since 20
* @useinstead ohos.multimedia.audio.AudioStreamManager#isStreamActive
*/
isActiveSync(volumeType: AudioVolumeType): boolean;
/**
* Checks whether a stream is active.
* @param { StreamUsage } streamUsage - Audio stream type.
* @returns { boolean } The active status of the stream.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Renderer
* @since 20
*/
isStreamActive(streamUsage: StreamUsage): boolean;
/**
* Checks whether the specified audio source type supports echo cancellation
* @param { SourceType } sourceType Type of audio source.
* @returns { boolean } Check result. The value true means that the audio source type supports echo
* cancellation, and false means the opposite.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @since 20
*/
isAcousticEchoCancelerSupported(sourceType: SourceType): boolean;
/**
* Checks whether the current platform supports audio loopback.
* @param { AudioLoopbackMode } mode Audio loopback mode.
* @returns { boolean } Check result. The value true means that the current platform supports audio loopback,
* and false means the opposite.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @since 20
*/
isAudioLoopbackSupported(mode: AudioLoopbackMode): boolean;
/**
* Checks whether the audio recording for specific capturer info can start.
* Usually this function will be used before audio recording start, because
* other existing recording stream may deny it.
* @param { AudioCapturerInfo } capturerInfo - Audio capturer infomation used in creation.
* @returns { boolean } Value means audio recording can start.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Capturer
* @since 20
*/
isRecordingAvailable(capturerInfo: AudioCapturerInfo): boolean;
}
/**
* Audio concurrency mode.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
enum AudioConcurrencyMode {
/**
* Default concurrency mode.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
CONCURRENCY_DEFAULT = 0,
/**
* Mix with others mode.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
CONCURRENCY_MIX_WITH_OTHERS = 1,
/**
* Duck others mode.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
CONCURRENCY_DUCK_OTHERS = 2,
/**
* Pause others mode.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
CONCURRENCY_PAUSE_OTHERS = 3,
}
/**
* Audio session deactivated reason.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
enum AudioSessionDeactivatedReason {
/**
* Lower priority.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
DEACTIVATED_LOWER_PRIORITY = 0,
/**
* Time out.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
DEACTIVATED_TIMEOUT = 1,
}
/**
* Audio session scene.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
enum AudioSessionScene {
/**
* Scene for media.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
AUDIO_SESSION_SCENE_MEDIA = 0,
/**
* Scene for game.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
AUDIO_SESSION_SCENE_GAME = 1,
/**
* Scene for voice communication.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
AUDIO_SESSION_SCENE_VOICE_COMMUNICATION = 2,
}
/**
* Enumerates the session state change hints.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
enum AudioSessionStateChangeHint {
/**
* Resume the playback.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
AUDIO_SESSION_STATE_CHANGE_HINT_RESUME = 0,
/**
* Paused/Pause the playback.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
AUDIO_SESSION_STATE_CHANGE_HINT_PAUSE = 1,
/**
* Stopped/Stop the playback due to focus priority.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
AUDIO_SESSION_STATE_CHANGE_HINT_STOP = 2,
/**
* Stopped/Stop the playback due to no audio stream for a long time.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
AUDIO_SESSION_STATE_CHANGE_HINT_TIME_OUT_STOP = 3,
/**
* Ducked the playback. (In ducking, the audio volume is reduced, but not silenced.)
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
AUDIO_SESSION_STATE_CHANGE_HINT_DUCK = 4,
/**
* Unducked the playback.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
AUDIO_SESSION_STATE_CHANGE_HINT_UNDUCK = 5,
}
/**
* Enumerates the recommend action when device change.
* @enum { number }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
enum OutputDeviceChangeRecommendedAction {
/**
* Recommend to continue the playback.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
DEVICE_CHANGE_RECOMMEND_TO_CONTINUE = 0,
/**
* Recommend to stop the playback.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
DEVICE_CHANGE_RECOMMEND_TO_STOP = 1,
}
/**
* Audio session strategy.
* @typedef AudioSessionStrategy
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
interface AudioSessionStrategy {
/**
* Audio concurrency mode.
* @type { AudioConcurrencyMode }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
concurrencyMode: AudioConcurrencyMode;
}
/**
* Audio session deactivated event.
* @typedef AudioSessionDeactivatedEvent
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
interface AudioSessionDeactivatedEvent {
/**
* Audio session deactivated reason.
* @type { AudioSessionDeactivatedReason }
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
reason: AudioSessionDeactivatedReason;
}
/**
* Audio session state change event.
* @typedef AudioSessionStateChangedEvent
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
interface AudioSessionStateChangedEvent {
/**
* Audio session state change hints.
* @type { AudioSessionStateChangeHint }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
stateChangeHint: AudioSessionStateChangeHint;
}
/**
* Audio session device change info.
* @typedef CurrentOutputDeviceChangedEvent
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
interface CurrentOutputDeviceChangedEvent {
/**
* Audio device descriptors after change.
* @type { AudioDeviceDescriptors }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
devices: AudioDeviceDescriptors;
/**
* Audio device change reason.
* @type { AudioStreamDeviceChangeReason }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
changeReason: AudioStreamDeviceChangeReason;
/**
* Recommend action when device change.
* @type { OutputDeviceChangeRecommendedAction }
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
recommendedAction: OutputDeviceChangeRecommendedAction;
}
/**
* Implements audio session management.
* @typedef AudioSessionManager
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
interface AudioSessionManager {
/**
* Activate the audio session for the current pid application.
* If {@link setAudioSessionScene} is called, it will take focus when calling this method.
* @param { AudioSessionStrategy } strategy - Audio session strategy.
* @returns { Promise } Promise used to return the result.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters unspecified.
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @throws { BusinessError } 6800301 - System error. Returned by promise.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
activateAudioSession(strategy: AudioSessionStrategy): Promise;
/**
* Deactivate the audio session for the current pid application.
* @returns { Promise } Promise used to return the result.
* @throws { BusinessError } 6800301 - System error. Returned by promise.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
deactivateAudioSession(): Promise;
/**
* Check whether the audio session is activated for the current pid application.
* @returns { boolean } The active audio session status for the current pid application.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
isAudioSessionActivated(): boolean;
/**
* Listens for audio session deactivated event. When the audio session is deactivated,
* registered clients will receive the callback.
* @param { 'audioSessionDeactivated' } type - Type of the event to listen for. Only the audioSessionDeactivated event is supported.
* @param { Callback } callback - Callback invoked for the audio session deactivated event.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters unspecified.
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
on(type: 'audioSessionDeactivated', callback: Callback): void;
/**
* Unsubscribes to audio session deactivated event.
* @param { 'audioSessionDeactivated' } type - Type of the event to listen for. Only the audioSessionDeactivated event is supported.
* @param { Callback } callback - Callback invoked for the audio session deactivated event.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @syscap SystemCapability.Multimedia.Audio.Core
* @crossplatform
* @since 12
*/
off(type: 'audioSessionDeactivated', callback?: Callback): void;
/**
* Set scene for audio session.
* @param { AudioSessionScene } scene - Audio session scene.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @throws { BusinessError } 6800103 - Operation not permit at current state.
* @throws { BusinessError } 6800301 - Audio client call audio service error, System error.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
setAudioSessionScene(scene: AudioSessionScene): void;
/**
* Listens for audio session state change event. When the audio session state change,
* registered clients will receive the callback.
* @param { 'audioSessionStateChanged' } type - Type of the event to listen for.
* Only the audioSessionStateChanged event is supported.
* @param { Callback } callback - Callback invoked for the audio session state change event.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @throws { BusinessError } 6800102 - Allocate memory failed.
* @throws { BusinessError } 6800301 - Audio client call audio service error, System error.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
on(type: 'audioSessionStateChanged', callback: Callback): void;
/**
* Unsubscribes to audio session deactivated event.
* @param { 'audioSessionStateChanged' } type - Type of the event to listen for.
* Only the audioSessionStateChanged event is supported.
* @param { Callback } [callback] - Callback invoked for the audio session state change event.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @throws { BusinessError } 6800301 - Audio client call audio service error, System error.
* @syscap SystemCapability.Multimedia.Audio.Core
* @since 20
*/
off(type: 'audioSessionStateChanged', callback?: Callback): void;
/**
* Gets the default output device.
* @returns { DeviceType } - the available deviceTypes are
* EARPIECE: Built-in earpiece
* SPEAKER: Built-in speaker
* DEFAULT: System default output device
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @throws { BusinessError } 6800103 - Operation not permit at current state. Return by promise.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 20
*/
getDefaultOutputDevice(): DeviceType;
/**
* Temporarily changes the current audio device
* This function applys on audiorenderers whose StreamUsage are
* STREAM_USAGE_VOICE_COMMUNICATION/STREAM_USAGE_VIDEO_COMMUNICATION/STREAM_USAGE_VOICE_MESSAGE.
* Setting the device will only takes effect if no other accessory such as headphones are in use
* @param { DeviceType } deviceType - the available deviceTypes are
* EARPIECE: Built-in earpiece
* SPEAKER: Built-in speaker
* DEFAULT: System default output device
* @returns { Promise } Promise used to return the result.
* @throws { BusinessError } 6800101 - Parameter verification failed. Return by promise.
* @throws { BusinessError } 6800102 - Allocate memory failed. Return by promise.
* @throws { BusinessError } 6800301 - Audio client call audio service error, System error.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 20
*/
setDefaultOutputDevice(deviceType: DeviceType): Promise;
/**
* Subscribes output device change event callback.
* The event is triggered when device change.
* @param { 'currentOutputDeviceChanged' } type - Type of the event to listen for.
* @param { Callback } callback - Callback used to listen device change event.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @throws { BusinessError } 6800102 - Allocate memory failed.
* @throws { BusinessError } 6800301 - Audio client call audio service error, System error.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 20
*/
on(type: 'currentOutputDeviceChanged', callback: Callback): void;
/**
* UnSubscribes output device change event callback.
* @param { 'currentOutputDeviceChanged' } type - Type of the event to listen for.
* @param { Callback } [callback] - Callback used to listen device change event.
* @throws { BusinessError } 6800101 - Parameter verification failed.
* @throws { BusinessError } 6800301 - Audio client call audio service error, System error.
* @syscap SystemCapability.Multimedia.Audio.Device
* @since 20
*/
off(type: 'currentOutputDeviceChanged', callback?: Callback): void;
}
/**
* Array of StreamUsages.
* @typedef { Array } StreamUsageArray
* @syscap SystemCapability.Multimedia.Audio.Core
* @systemapi
* @since 20
*/
type StreamUsageArray = Array;
/**
* Implements audio volume management.
* @typedef AudioVolumeManager
* @syscap SystemCapability.Multimedia.Audio.Volume
* @since 9
*/
/**
* Implements audio volume management.
* @typedef AudioVolumeManager
* @syscap SystemCapability.Multimedia.Audio.Volume
* @crossplatform
* @since 12
*/
interface AudioVolumeManager {
/**
* Get the volume group list for a networkId. This method uses an asynchronous callback to return the result.
* @param { string } networkId - Distributed deice net work id
* @param { AsyncCallback } callback - Callback used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @systemapi
* @since 9
*/
getVolumeGroupInfos(networkId: string, callback: AsyncCallback): void;
/**
* Get the volume group list for a networkId. This method uses a promise to return the result.
* @param { string } networkId - Distributed deice net work id
* @returns { Promise } Promise used to return the result.
* @syscap SystemCapability.Multimedia.Audio.Volume
* @systemapi
* @since 9
*/
getVolumeGroupInfos(networkId: string): Promise