BluetoothLeAudioCodecConfig | API reference

BluetoothLeAudioCodecConfig | API reference | Android Developers

public final class BluetoothLeAudioCodecConfig
extends Object implements Parcelable

Represents the codec configuration for a Bluetooth LE Audio source device.

Contains the source codec type.

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

Nested classes

BluetoothLeAudioCodecConfig.Builder

Builder for BluetoothLeAudioCodecConfig.

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_COUNT_1` Codec channel mode MONO.
`int`	`CHANNEL_COUNT_2` Codec channel mode STEREO.
`int`	`CHANNEL_COUNT_NONE` Codec channel mode NONE.
`int`	`CODEC_PRIORITY_DEFAULT` Codec priority default.
`int`	`CODEC_PRIORITY_DISABLED` Codec priority disabled.
`int`	`CODEC_PRIORITY_HIGHEST` Codec priority highest.
`int`	`FRAME_DURATION_10000` Frame duration 10000 us.
`int`	`FRAME_DURATION_7500` Frame duration 7500 us.
`int`	`FRAME_DURATION_NONE` Frame duration 0.
`int`	`SAMPLE_RATE_11025` Codec sample rate 11025 Hz.
`int`	`SAMPLE_RATE_16000` Codec sample rate 16000 Hz.
`int`	`SAMPLE_RATE_176400` Codec sample rate 176400 Hz.
`int`	`SAMPLE_RATE_192000` Codec sample rate 192000 Hz.
`int`	`SAMPLE_RATE_22050` Codec sample rate 22050 Hz.
`int`	`SAMPLE_RATE_24000` Codec sample rate 24000 Hz.
`int`	`SAMPLE_RATE_32000` Codec sample rate 32000 Hz.
`int`	`SAMPLE_RATE_384000` Codec sample rate 384000 Hz.
`int`	`SAMPLE_RATE_44100` Codec sample rate 44100 Hz.
`int`	`SAMPLE_RATE_48000` Codec sample rate 48000 Hz.
`int`	`SAMPLE_RATE_8000` Codec sample rate 8000 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_INVALID`
`int`	`SOURCE_CODEC_TYPE_LC3` Source codec type for LC3.
`int`	`SOURCE_CODEC_TYPE_OPUS` Source codec type for Opus.
`int`	`SOURCE_CODEC_TYPE_OPUS_HI_RES` Source codec type for Opus High Resolution.
`int`	`SOURCE_CODEC_TYPE_VENDOR_SPECIFIC` Source codec type used for Vendor Specific codecs.

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<BluetoothLeAudioCodecConfig>`	`CREATOR` `Parcelable.Creator` interface implementation.

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`int`	`getBitsPerSample()` Returns the codec bits per sample.
`int`	`getChannelCount()` Returns the codec channel mode.
`long`	`getCodecId()` Returns the unique codec identifier.
`String`	`getCodecName()` Gets the codec name.
`int`	`getCodecPriority()` Returns the codec selection priority.
`int`	`getCodecType()` Gets the codec type.
`int`	`getFrameDuration()` Returns the frame duration.
`int`	`getMaxOctetsPerFrame()` Returns the maximum octets per frame
`int`	`getMinOctetsPerFrame()` Returns the minimum octets per frame
`int`	`getOctetsPerFrame()` Returns the octets per frame
`int`	`getSampleRate()` Returns the codec sample rate.
`int`	`hashCode()` Returns a hash representation of this BluetoothLeAudioCodecConfig based on all the config values.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel out, int flags)` Flatten this object in to a Parcel.

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: 8 (0x00000008)

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_COUNT_1

public static final int CHANNEL_COUNT_1

Codec channel mode MONO.

Constant Value: 1 (0x00000001)

CHANNEL_COUNT_2

public static final int CHANNEL_COUNT_2

Codec channel mode STEREO.

Constant Value: 2 (0x00000002)

CHANNEL_COUNT_NONE

public static final int CHANNEL_COUNT_NONE

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

Constant Value: 0 (0x00000000)

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)

FRAME_DURATION_10000

public static final int FRAME_DURATION_10000

Frame duration 10000 us.

Constant Value: 2 (0x00000002)

FRAME_DURATION_7500

public static final int FRAME_DURATION_7500

Frame duration 7500 us.

Constant Value: 1 (0x00000001)

FRAME_DURATION_NONE

public static final int FRAME_DURATION_NONE

Frame duration 0. Default value of the frame duration.

Constant Value: 0 (0x00000000)

SAMPLE_RATE_11025

public static final int SAMPLE_RATE_11025

Codec sample rate 11025 Hz.

Constant Value: 2 (0x00000002)

SAMPLE_RATE_16000

public static final int SAMPLE_RATE_16000

Codec sample rate 16000 Hz.

Constant Value: 4 (0x00000004)

SAMPLE_RATE_176400

public static final int SAMPLE_RATE_176400

Codec sample rate 176400 Hz.

Constant Value: 1024 (0x00000400)

SAMPLE_RATE_192000

public static final int SAMPLE_RATE_192000

Codec sample rate 192000 Hz.

Constant Value: 2048 (0x00000800)

SAMPLE_RATE_22050

public static final int SAMPLE_RATE_22050

Codec sample rate 22050 Hz.

Constant Value: 8 (0x00000008)

SAMPLE_RATE_24000

public static final int SAMPLE_RATE_24000

Codec sample rate 24000 Hz.

Constant Value: 16 (0x00000010)

SAMPLE_RATE_32000

public static final int SAMPLE_RATE_32000

Codec sample rate 32000 Hz.

Constant Value: 32 (0x00000020)

SAMPLE_RATE_384000

public static final int SAMPLE_RATE_384000

Codec sample rate 384000 Hz.

Constant Value: 4096 (0x00001000)

SAMPLE_RATE_44100

public static final int SAMPLE_RATE_44100

Codec sample rate 44100 Hz.

Constant Value: 64 (0x00000040)

SAMPLE_RATE_48000

public static final int SAMPLE_RATE_48000

Codec sample rate 48000 Hz.

Constant Value: 128 (0x00000080)

SAMPLE_RATE_8000

public static final int SAMPLE_RATE_8000

Codec sample rate 8000 Hz.

Constant Value: 1 (0x00000001)

SAMPLE_RATE_88200

public static final int SAMPLE_RATE_88200

Codec sample rate 88200 Hz.

Constant Value: 256 (0x00000100)

SAMPLE_RATE_96000

public static final int SAMPLE_RATE_96000

Codec sample rate 96000 Hz.

Constant Value: 512 (0x00000200)

SAMPLE_RATE_NONE

public static final int SAMPLE_RATE_NONE

Codec sample rate 0 Hz. Default value used for codec sample rate. Values are the bit mask as defined in the Bluetooth Assigned Numbers, Generic Audio, Supported_Sampling_Frequencies table.

Constant Value: 0 (0x00000000)

SOURCE_CODEC_TYPE_INVALID

public static final int SOURCE_CODEC_TYPE_INVALID

Constant Value: 1000000 (0x000f4240)

SOURCE_CODEC_TYPE_LC3

public static final int SOURCE_CODEC_TYPE_LC3

Source codec type for LC3.

Constant Value: 0 (0x00000000)

SOURCE_CODEC_TYPE_OPUS

public static final int SOURCE_CODEC_TYPE_OPUS

Source codec type for Opus.

Constant Value: 1 (0x00000001)

SOURCE_CODEC_TYPE_OPUS_HI_RES

public static final int SOURCE_CODEC_TYPE_OPUS_HI_RES

Source codec type for Opus High Resolution.

Constant Value: 2 (0x00000002)

SOURCE_CODEC_TYPE_VENDOR_SPECIFIC

public static final int SOURCE_CODEC_TYPE_VENDOR_SPECIFIC

Source codec type used for Vendor Specific codecs. When this type is used, getCodecId() should be used to get more information about the codec.

Constant Value: 255 (0x000000ff)

Fields

Public methods

describeContents

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

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

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

getCodecId

public long getCodecId ()

Returns the unique codec identifier.

The codec identifier is 40 bits as defined by Bluetooth ASCS v1.0.1 in chapter 4.1. Audio Stream Endpoints

Bits 0-7: Codec ID, as defined by Bluetooth Assigned numbers 2.11 Coding_Format and Codec_ID (HCI)
- 0x06: LC3
- 0xFF: Vendor
Bits 8-23: Company ID, set to 0, if octet 0 is not 0xFF.
Bits 24-39: Vendor-defined codec ID, set to 0, if octet 0 is not 0xFF.

Returns
`long`

getCodecName

public String getCodecName ()

Gets the codec name.

Returns
`String`	the codec name. This value cannot be `null`.

getMaxOctetsPerFrame

public int getMaxOctetsPerFrame ()

Returns the maximum octets per frame

Returns
`int`

getMinOctetsPerFrame

public int getMinOctetsPerFrame ()

Returns the minimum octets per frame

Returns
`int`

getOctetsPerFrame

public int getOctetsPerFrame ()

Returns the octets per frame

Returns
`int`

hashCode

public int hashCode ()

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

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

toString

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.