BluetoothCodecConfig | Android Developers [proxy]

Represents the codec configuration for a Bluetooth A2DP source device.

Contains the source codec type, the codec priority, the codec sample rate, the codec bits per sample, and the codec channel mode.

The source codec type values are the same as those supported by the device hardware.

Nested classes

BluetoothCodecConfig.Builder

Builder for BluetoothCodecConfig.

Constants
`int`	`BITS_PER_SAMPLE_16` Codec bits per sample 16.
`int`	`BITS_PER_SAMPLE_24` Codec bits per sample 24.
`int`	`BITS_PER_SAMPLE_32` Codec bits per sample 32.
`int`	`BITS_PER_SAMPLE_NONE` Codec bits per sample 0.
`int`	`CHANNEL_MODE_MONO` Codec channel mode MONO.
`int`	`CHANNEL_MODE_NONE` Codec channel mode NONE.
`int`	`CHANNEL_MODE_STEREO` Codec channel mode STEREO.
`int`	`CODEC_PRIORITY_DEFAULT` Codec priority default.
`int`	`CODEC_PRIORITY_DISABLED` Codec priority disabled.
`int`	`CODEC_PRIORITY_HIGHEST` Codec priority highest.
`int`	`CODEC_SPECIFIC_1_LDAC_QUALITY_ADAPTIVE` Codec specific value for LDAC adaptive bitrate.
`int`	`CODEC_SPECIFIC_1_LDAC_QUALITY_HIGH` Codec specific value for LDAC high quality bitrate.
`int`	`CODEC_SPECIFIC_1_LDAC_QUALITY_LOW` Codec specific value for LDAC low quality bitrate.
`int`	`CODEC_SPECIFIC_1_LDAC_QUALITY_MID` Codec specific value for LDAC medium quality bitrate.
`int`	`SAMPLE_RATE_176400` Codec sample rate 176400 Hz.
`int`	`SAMPLE_RATE_192000` Codec sample rate 192000 Hz.
`int`	`SAMPLE_RATE_44100` Codec sample rate 44100 Hz.
`int`	`SAMPLE_RATE_48000` Codec sample rate 48000 Hz.
`int`	`SAMPLE_RATE_88200` Codec sample rate 88200 Hz.
`int`	`SAMPLE_RATE_96000` Codec sample rate 96000 Hz.
`int`	`SAMPLE_RATE_NONE` Codec sample rate 0 Hz.
`int`	`SOURCE_CODEC_TYPE_AAC` Source codec type AAC.
`int`	`SOURCE_CODEC_TYPE_APTX` Source codec type APTX.
`int`	`SOURCE_CODEC_TYPE_APTX_HD` Source codec type APTX HD.
`int`	`SOURCE_CODEC_TYPE_INVALID` Source codec type invalid.
`int`	`SOURCE_CODEC_TYPE_LC3` Source codec type LC3.
`int`	`SOURCE_CODEC_TYPE_LDAC` Source codec type LDAC.
`int`	`SOURCE_CODEC_TYPE_OPUS` Source codec type Opus.
`int`	`SOURCE_CODEC_TYPE_SBC` Source codec type SBC.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<BluetoothCodecConfig>`	`CREATOR`

Public methods
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`int`	`getBitsPerSample()` Returns the codec bits per sample.
`int`	`getChannelMode()` Returns the codec channel mode.
`int`	`getCodecPriority()` Returns the codec selection priority.
`long`	`getCodecSpecific1()` Returns the codec specific value1.
`long`	`getCodecSpecific2()` Returns the codec specific value2.
`long`	`getCodecSpecific3()` Returns the codec specific value3.
`long`	`getCodecSpecific4()` Returns the codec specific value4.
`int`	`getCodecType()` Returns the source codec type of this config.
`int`	`getSampleRate()` Returns the codec sample rate.
`int`	`hashCode()` Returns a hash representation of this BluetoothCodecConfig based on all the config values.
`boolean`	`isMandatoryCodec()` Checks whether the codec is mandatory.
`String`	`toString()` Returns a `String` that describes each BluetoothCodecConfig parameter current value.

Inherited methods

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

BITS_PER_SAMPLE_16

public static final int BITS_PER_SAMPLE_16

Codec bits per sample 16.

Constant Value: 1 (0x00000001)

BITS_PER_SAMPLE_24

public static final int BITS_PER_SAMPLE_24

Codec bits per sample 24.

Constant Value: 2 (0x00000002)

BITS_PER_SAMPLE_32

public static final int BITS_PER_SAMPLE_32

Codec bits per sample 32.

Constant Value: 4 (0x00000004)

BITS_PER_SAMPLE_NONE

public static final int BITS_PER_SAMPLE_NONE

Codec bits per sample 0. Default value of the codec bits per sample.

Constant Value: 0 (0x00000000)

CHANNEL_MODE_MONO

public static final int CHANNEL_MODE_MONO

Codec channel mode MONO.

Constant Value: 1 (0x00000001)

CHANNEL_MODE_NONE

public static final int CHANNEL_MODE_NONE

Codec channel mode NONE. Default value of the codec channel mode.

Constant Value: 0 (0x00000000)

CHANNEL_MODE_STEREO

public static final int CHANNEL_MODE_STEREO

Codec channel mode STEREO.

Constant Value: 2 (0x00000002)

CODEC_PRIORITY_DEFAULT

public static final int CODEC_PRIORITY_DEFAULT

Codec priority default. Default value used for codec priority.

Constant Value: 0 (0x00000000)

CODEC_PRIORITY_DISABLED

public static final int CODEC_PRIORITY_DISABLED

Codec priority disabled. Used to indicate that this codec is disabled and should not be used.

Constant Value: -1 (0xffffffff)

CODEC_PRIORITY_HIGHEST

public static final int CODEC_PRIORITY_HIGHEST

Codec priority highest. Used to indicate the highest priority a codec can have.

Constant Value: 1000000 (0x000f4240)

CODEC_SPECIFIC_1_LDAC_QUALITY_ADAPTIVE

public static final int CODEC_SPECIFIC_1_LDAC_QUALITY_ADAPTIVE

Codec specific value for LDAC adaptive bitrate.

Constant Value: 1003 (0x000003eb)

CODEC_SPECIFIC_1_LDAC_QUALITY_HIGH

public static final int CODEC_SPECIFIC_1_LDAC_QUALITY_HIGH

Codec specific value for LDAC high quality bitrate.

Constant Value: 1000 (0x000003e8)

CODEC_SPECIFIC_1_LDAC_QUALITY_LOW

public static final int CODEC_SPECIFIC_1_LDAC_QUALITY_LOW

Codec specific value for LDAC low quality bitrate.

Constant Value: 1002 (0x000003ea)

CODEC_SPECIFIC_1_LDAC_QUALITY_MID

public static final int CODEC_SPECIFIC_1_LDAC_QUALITY_MID

Codec specific value for LDAC medium quality bitrate.

Constant Value: 1001 (0x000003e9)

SAMPLE_RATE_176400

public static final int SAMPLE_RATE_176400

Codec sample rate 176400 Hz.

Constant Value: 16 (0x00000010)

SAMPLE_RATE_192000

public static final int SAMPLE_RATE_192000

Codec sample rate 192000 Hz.

Constant Value: 32 (0x00000020)

SAMPLE_RATE_44100

public static final int SAMPLE_RATE_44100

Codec sample rate 44100 Hz.

Constant Value: 1 (0x00000001)

SAMPLE_RATE_48000

public static final int SAMPLE_RATE_48000

Codec sample rate 48000 Hz.

Constant Value: 2 (0x00000002)

SAMPLE_RATE_88200

public static final int SAMPLE_RATE_88200

Codec sample rate 88200 Hz.

Constant Value: 4 (0x00000004)

SAMPLE_RATE_96000

public static final int SAMPLE_RATE_96000

Codec sample rate 96000 Hz.

Constant Value: 8 (0x00000008)

SAMPLE_RATE_NONE

public static final int SAMPLE_RATE_NONE

Codec sample rate 0 Hz. Default value used for codec sample rate.

Constant Value: 0 (0x00000000)

SOURCE_CODEC_TYPE_AAC

public static final int SOURCE_CODEC_TYPE_AAC

Source codec type AAC.

Constant Value: 1 (0x00000001)

SOURCE_CODEC_TYPE_APTX

public static final int SOURCE_CODEC_TYPE_APTX

Source codec type APTX.

Constant Value: 2 (0x00000002)

SOURCE_CODEC_TYPE_APTX_HD

public static final int SOURCE_CODEC_TYPE_APTX_HD

Source codec type APTX HD.

Constant Value: 3 (0x00000003)

SOURCE_CODEC_TYPE_INVALID

public static final int SOURCE_CODEC_TYPE_INVALID

Source codec type invalid. This is the default value used for codec type.

Constant Value: 1000000 (0x000f4240)

SOURCE_CODEC_TYPE_LC3

public static final int SOURCE_CODEC_TYPE_LC3

Source codec type LC3.

Constant Value: 5 (0x00000005)

SOURCE_CODEC_TYPE_LDAC

public static final int SOURCE_CODEC_TYPE_LDAC

Source codec type LDAC.

Constant Value: 4 (0x00000004)

SOURCE_CODEC_TYPE_OPUS

public static final int SOURCE_CODEC_TYPE_OPUS

Source codec type Opus.

Constant Value: 6 (0x00000006)

SOURCE_CODEC_TYPE_SBC

public static final int SOURCE_CODEC_TYPE_SBC

Source codec type SBC. This is the mandatory source codec type.

Constant Value: 0 (0x00000000)

Fields

Public methods

equals

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
`o`	`Object`: This value may be `null`.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getBitsPerSample

public int getBitsPerSample ()

Returns the codec bits per sample. The value can be a bitmask with all bits per sample supported.

Returns
`int`	Value is `BITS_PER_SAMPLE_NONE`, `BITS_PER_SAMPLE_16`, `BITS_PER_SAMPLE_24`, or `BITS_PER_SAMPLE_32`

getChannelMode

public int getChannelMode ()

Returns the codec channel mode. The value can be a bitmask with all supported channel modes.

Returns
`int`	Value is `CHANNEL_MODE_NONE`, `CHANNEL_MODE_MONO`, or `CHANNEL_MODE_STEREO`

getCodecPriority

public int getCodecPriority ()

Returns the codec selection priority.

The codec selection priority is relative to other codecs: larger value means higher priority.

Returns
`int`	Value is `CODEC_PRIORITY_DISABLED`, `CODEC_PRIORITY_DEFAULT`, or `CODEC_PRIORITY_HIGHEST`

getCodecSpecific1

public long getCodecSpecific1 ()

Returns the codec specific value1. As the value and usage differ for each codec, please refer to the concerned codec specification to obtain the codec specific information.

See section 4.3.2 of the Bluetooth A2dp specification for SBC codec specific information elements.

See section 4.4.2 of the Bluetooth A2dp specification for MPEG-1,2 Audio codec specific information elements.

See section 4.5.2 of the Bluetooth A2dp specification for MPEG-2, 4 AAC codec specific information elements.

See section 4.6.2 of the Bluetooth A2dp specification for ATRAC family codec specific information elements.

See section 4.7.2 of the Bluetooth A2dp specification for Vendor Specific A2DP codec specific information elements.

Returns
`long`

getCodecSpecific2

public long getCodecSpecific2 ()

Returns the codec specific value2. As the value and usage differ for each codec, please refer to the concerned codec specification to obtain the codec specific information.

See section 4.3.2 of the Bluetooth A2dp specification for SBC codec specific information elements.

See section 4.4.2 of the Bluetooth A2dp specification for MPEG-1,2 Audio codec specific information elements.

See section 4.5.2 of the Bluetooth A2dp specification for MPEG-2, 4 AAC codec specific information elements.

See section 4.6.2 of the Bluetooth A2dp specification for ATRAC family codec specific information elements.

See section 4.7.2 of the Bluetooth A2dp specification for Vendor Specific A2DP codec specific information elements.

Returns
`long`

getCodecSpecific3

public long getCodecSpecific3 ()

Returns the codec specific value3. As the value and usage differ for each codec, please refer to the concerned codec specification to obtain the codec specific information.

See section 4.3.2 of the Bluetooth A2dp specification for SBC codec specific information elements.

See section 4.4.2 of the Bluetooth A2dp specification for MPEG-1,2 Audio codec specific information elements.

See section 4.5.2 of the Bluetooth A2dp specification for MPEG-2, 4 AAC codec specific information elements.

See section 4.6.2 of the Bluetooth A2dp specification for ATRAC family codec specific information elements.

See section 4.7.2 of the Bluetooth A2dp specification for Vendor Specific A2DP codec specific information elements.

Returns
`long`

getCodecSpecific4

public long getCodecSpecific4 ()

Returns the codec specific value4. As the value and usage differ for each codec, please refer to the concerned codec specification to obtain the codec specific information.

See section 4.3.2 of the Bluetooth A2dp specification for SBC codec specific information elements.

See section 4.4.2 of the Bluetooth A2dp specification for MPEG-1,2 Audio codec specific information elements.

See section 4.5.2 of the Bluetooth A2dp specification for MPEG-2, 4 AAC codec specific information elements.

See section 4.6.2 of the Bluetooth A2dp specification for ATRAC family codec specific information elements.

See section 4.7.2 of the Bluetooth A2dp specification for Vendor Specific A2DP codec specific information elements.

Returns
`long`

getCodecType

public int getCodecType ()

Returns the source codec type of this config.

Returns
`int`	Value is `SOURCE_CODEC_TYPE_SBC`, `SOURCE_CODEC_TYPE_AAC`, `SOURCE_CODEC_TYPE_APTX`, `SOURCE_CODEC_TYPE_APTX_HD`, `SOURCE_CODEC_TYPE_LDAC`, `SOURCE_CODEC_TYPE_LC3`, `SOURCE_CODEC_TYPE_OPUS`, or `SOURCE_CODEC_TYPE_INVALID`

getSampleRate

public int getSampleRate ()

Returns the codec sample rate. The value can be a bitmask with all supported sample rates.

Returns
`int`	Value is `SAMPLE_RATE_NONE`, `SAMPLE_RATE_44100`, `SAMPLE_RATE_48000`, `SAMPLE_RATE_88200`, `SAMPLE_RATE_96000`, `SAMPLE_RATE_176400`, or `SAMPLE_RATE_192000`

hashCode

public int hashCode ()

Returns a hash representation of this BluetoothCodecConfig based on all the config values.

Returns
`int`	a hash code value for this object.

isMandatoryCodec

public boolean isMandatoryCodec ()

Checks whether the codec is mandatory.

The actual mandatory codec type for Android Bluetooth audio is SBC. See SOURCE_CODEC_TYPE_SBC.

Returns
`boolean`	`true` if the codec is mandatory, `false` otherwise

toString

public String toString ()

Returns a String that describes each BluetoothCodecConfig parameter current value.

Returns
`String`	a string representation of the object.