@ohos.bluetooth.a2dp (Bluetooth A2DP Module)
The a2dp module provides APIs for using the Bluetooth Advanced Audio Distribution Profile (A2DP), which defines how to stream high quality audio from one device to another over a Bluetooth connection.
NOTE
The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.
Modules to Import
import a2dp from '@ohos.bluetooth.a2dp';
a2dp.createA2dpSrcProfile
createA2dpSrcProfile(): A2dpSourceProfile
Creates an A2dpSrcProfile instance.
System capability: SystemCapability.Communication.Bluetooth.Core
Return value
Type | Description |
---|---|
A2dpSourceProfile | A2dpSrcProfile instance created. |
Example
import { BusinessError } from '@ohos.base';
try {
let a2dpProfile = a2dp.createA2dpSrcProfile();
console.info('a2dp success');
} catch (err) {
console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
}
A2dpSourceProfile
Provides APIs for using the A2DP. Before using any API of A2dpSourceProfile, you need to create an instance of this class by using createA2dpSrcProfile().
getPlayingState
getPlayingState(deviceId: string): PlayingState
Obtains the playing state of a device.
Required permissions: ohos.permission.ACCESS_BLUETOOTH
System capability: SystemCapability.Communication.Bluetooth.Core
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
deviceId | string | Yes | Address of the target device. |
Return value
Type | Description |
---|---|
PlayingState | Playing state of the remote device obtained. |
Error codes
For details about the error codes, see Bluetooth Error Codes.
ID | Error Message |
---|---|
2900001 | Service stopped. |
2900003 | Bluetooth switch is off. |
2900004 | Profile is not supported. |
2900099 | Operation failed. |
Example
import { BusinessError } from '@ohos.base';
try {
let a2dpSrc = a2dp.createA2dpSrcProfile();
let state = a2dpSrc.getPlayingState('XX:XX:XX:XX:XX:XX');
} catch (err) {
console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
}
PlayingState
Enumerates the A2DP playing states.
System capability: SystemCapability.Communication.Bluetooth.Core
Name | Value | Description |
---|---|---|
STATE_NOT_PLAYING | 0x0000 | Not playing. |
STATE_PLAYING | 0x0001 | Playing. |
CodecInfo11+
Defines the codec information.
System capability: SystemCapability.Communication.Bluetooth.Core
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
codecType11+ | CodecType | Yes | Yes | Codec type. The default value is CODEC_TYPE_SBC. |
codecBitsPerSample11+ | CodecBitsPerSample | Yes | Yes | Number of bits of each sample. The default value is SCAN_MODE_LOW_POWER. |
codecChannelMode11+ | CodecChannelMode | Yes | Yes | Channel mode of the codec. The default value is CODEC_CHANNEL_MODE_NONE. |
codecSampleRate11+ | CodecSampleRate | Yes | Yes | Sampling rate of the codec. The default value is CODEC_BITS_PER_SAMPLE_NONE. |
CodecType11+
Enumerates the Bluetooth codec types.
System capability: SystemCapability.Communication.Bluetooth.Core
Name | Value | Description |
---|---|---|
CODEC_TYPE_INVALID11+ | -1 | Unknown type. |
CODEC_TYPE_SBC11+ | 0 | SBC. |
CODEC_TYPE_AAC11+ | 1 | AAC. |
CODEC_TYPE_L2HC11+ | 2 | L2HC. |
CodecChannelMode11+
Enumerates the channel modes of the Bluetooth codec.
System capability: SystemCapability.Communication.Bluetooth.Core
Name | Value | Description |
---|---|---|
CODEC_CHANNEL_MODE_NONE11+ | 0 | Unknown. |
CODEC_CHANNEL_MODE_MONO11+ | 1 | Mono. |
CODEC_CHANNEL_MODE_STEREO11+ | 2 | Stereo. |
CodecBitsPerSample11+
Enumerates the number of bits per sample for the Bluetooth codec.
System capability: SystemCapability.Communication.Bluetooth.Core
Name | Value | Description |
---|---|---|
CODEC_BITS_PER_SAMPLE_NONE11+ | 0 | Unknown. |
CODEC_BITS_PER_SAMPLE_1611+ | 1 | 16 bits per sample. |
CODEC_BITS_PER_SAMPLE_2411+ | 2 | 24 bits per sample. |
CODEC_BITS_PER_SAMPLE_3211+ | 3 | 32 bits per sample. |
CodecSampleRate11+
Enumerates the sampling rates of the Bluetooth codec.
System capability: SystemCapability.Communication.Bluetooth.Core
Name | Value | Description |
---|---|---|
CODEC_SAMPLE_RATE_NONE11+ | 0 | Unknown. |
CODEC_SAMPLE_RATE_4410011+ | 1 | 44.1 kHz. |
CODEC_SAMPLE_RATE_4800011+ | 2 | 48 kHz. |
CODEC_SAMPLE_RATE_8820011+ | 3 | 88.2 kHz. |
CODEC_SAMPLE_RATE_9600011+ | 4 | 96 kHz. |
CODEC_SAMPLE_RATE_17640011+ | 5 | 176.4 kHz. |
CODEC_SAMPLE_RATE_19200011+ | 6 | 192 kHz. |