BluetoothLeAudioCodecStatus

public final class BluetoothLeAudioCodecStatus
extends Object implements Parcelable

java.lang.Object
   ↳ android.bluetooth.BluetoothLeAudioCodecStatus


Represents the codec status (configuration and capability) for a Bluetooth Le Audio source device.

See also:

Summary

Constants

String EXTRA_LE_AUDIO_CODEC_STATUS

Extra for the codec configuration intents of the individual profiles.

Inherited constants

Fields

public static final Creator<BluetoothLeAudioCodecStatus> CREATOR

Parcelable.Creator interface implementation.

Public constructors

BluetoothLeAudioCodecStatus(BluetoothLeAudioCodecConfig inputCodecConfig, BluetoothLeAudioCodecConfig outputCodecConfig, List<BluetoothLeAudioCodecConfig> inputCodecsLocalCapabilities, List<BluetoothLeAudioCodecConfig> outputCodecsLocalCapabilities, List<BluetoothLeAudioCodecConfig> inputCodecsSelectableCapabilities, List<BluetoothLeAudioCodecConfig> outputCodecsSelectableCapabilities)

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

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.

BluetoothLeAudioCodecConfig getInputCodecConfig()

Returns the current Input codec configuration.

List<BluetoothLeAudioCodecConfig> getInputCodecLocalCapabilities()

Returns the input codecs local capabilities.

List<BluetoothLeAudioCodecConfig> getInputCodecSelectableCapabilities()

Returns the Input codecs selectable capabilities.

BluetoothLeAudioCodecConfig getOutputCodecConfig()

Returns the current Output codec configuration.

List<BluetoothLeAudioCodecConfig> getOutputCodecLocalCapabilities()

Returns the output codecs local capabilities.

List<BluetoothLeAudioCodecConfig> getOutputCodecSelectableCapabilities()

Returns the Output codecs selectable capabilities.

int hashCode()

Returns a hash based on the codec config and local capabilities.

boolean isInputCodecConfigSelectable(BluetoothLeAudioCodecConfig codecConfig)

Checks whether the Input codec config matches the selectable capabilities.

boolean isOutputCodecConfigSelectable(BluetoothLeAudioCodecConfig codecConfig)

Checks whether the Output codec config matches the selectable capabilities.

String toString()

Returns a String that describes each BluetoothLeAudioCodecStatus parameter current value.

void writeToParcel(Parcel out, int flags)

Flattens the object to a parcel.

Inherited methods

Constants

EXTRA_LE_AUDIO_CODEC_STATUS

Added in API level 33
public static final String EXTRA_LE_AUDIO_CODEC_STATUS

Extra for the codec configuration intents of the individual profiles.

This extra represents the current codec status of the Le Audio profile.

Constant Value: "android.bluetooth.extra.LE_AUDIO_CODEC_STATUS"

Fields

CREATOR

Added in API level 33
public static final Creator<BluetoothLeAudioCodecStatus> CREATOR

Parcelable.Creator interface implementation.

Public constructors

BluetoothLeAudioCodecStatus

Added in API level 33
public BluetoothLeAudioCodecStatus (BluetoothLeAudioCodecConfig inputCodecConfig, 
                BluetoothLeAudioCodecConfig outputCodecConfig, 
                List<BluetoothLeAudioCodecConfig> inputCodecsLocalCapabilities, 
                List<BluetoothLeAudioCodecConfig> outputCodecsLocalCapabilities, 
                List<BluetoothLeAudioCodecConfig> inputCodecsSelectableCapabilities, 
                List<BluetoothLeAudioCodecConfig> outputCodecsSelectableCapabilities)

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

Parameters
inputCodecConfig BluetoothLeAudioCodecConfig: the current input codec configuration. This value may be null.

outputCodecConfig BluetoothLeAudioCodecConfig: the current output codec configuration. This value may be null.

inputCodecsLocalCapabilities List: the local input codecs capabilities. This value cannot be null.

outputCodecsLocalCapabilities List: the local output codecs capabilities. This value cannot be null.

inputCodecsSelectableCapabilities List: the selectable input codecs capabilities. This value cannot be null.

outputCodecsSelectableCapabilities List: the selectable output codecs capabilities. This value cannot be null.

Public methods

describeContents

Added in API level 33
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(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int 0

equals

Added in API level 33
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.

getInputCodecConfig

Added in API level 33
public BluetoothLeAudioCodecConfig getInputCodecConfig ()

Returns the current Input codec configuration.

Returns
BluetoothLeAudioCodecConfig The current input codec config. This value may be null.

getInputCodecLocalCapabilities

Added in API level 33
public List<BluetoothLeAudioCodecConfig> getInputCodecLocalCapabilities ()

Returns the input codecs local capabilities.

Returns
List<BluetoothLeAudioCodecConfig> The list of codec config that supported by the local system. This value cannot be null.

getInputCodecSelectableCapabilities

Added in API level 33
public List<BluetoothLeAudioCodecConfig> getInputCodecSelectableCapabilities ()

Returns the Input codecs selectable capabilities.

Returns
List<BluetoothLeAudioCodecConfig> The list of codec config that supported by both of the local system and remote devices. This value cannot be null.

getOutputCodecConfig

Added in API level 33
public BluetoothLeAudioCodecConfig getOutputCodecConfig ()

Returns the current Output codec configuration.

Returns
BluetoothLeAudioCodecConfig The current output codec config. This value may be null.

getOutputCodecLocalCapabilities

Added in API level 33
public List<BluetoothLeAudioCodecConfig> getOutputCodecLocalCapabilities ()

Returns the output codecs local capabilities.

Returns
List<BluetoothLeAudioCodecConfig> The list of codec config that supported by the local system. This value cannot be null.

getOutputCodecSelectableCapabilities

Added in API level 33
public List<BluetoothLeAudioCodecConfig> getOutputCodecSelectableCapabilities ()

Returns the Output codecs selectable capabilities.

Returns
List<BluetoothLeAudioCodecConfig> The list of codec config that supported by both of the local system and remote devices. This value cannot be null.

hashCode

Added in API level 33
public int hashCode ()

Returns a hash based on the codec config and local capabilities.

Returns
int a hash code value for this object.

isInputCodecConfigSelectable

Added in API level 33
public boolean isInputCodecConfigSelectable (BluetoothLeAudioCodecConfig codecConfig)

Checks whether the Input codec config matches the selectable capabilities. Any parameters of the codec config with NONE value will be considered a wildcard matching.

Parameters
codecConfig BluetoothLeAudioCodecConfig: the codec config to compare against This value may be null.

Returns
boolean true if the codec config matches, false otherwise

isOutputCodecConfigSelectable

Added in API level 33
public boolean isOutputCodecConfigSelectable (BluetoothLeAudioCodecConfig codecConfig)

Checks whether the Output codec config matches the selectable capabilities. Any parameters of the codec config with NONE value will be considered a wildcard matching.

Parameters
codecConfig BluetoothLeAudioCodecConfig: the codec config to compare against This value may be null.

Returns
boolean true if the codec config matches, false otherwise

toString

Added in API level 33
public String toString ()

Returns a String that describes each BluetoothLeAudioCodecStatus parameter current value.

Returns
String a string representation of the object.

writeToParcel

Added in API level 33
public void writeToParcel (Parcel out, 
                int flags)

Flattens the object to a parcel.

Parameters
out Parcel: The Parcel in which the object should be written This value cannot be null.

flags int: Additional flags about how the object should be written