Added in API level 23

Summary: Constants | Inherited Constants | Fields | Ctors | Methods | Inherited Methods

CallAudioState

---

Kotlin |Java

public final class CallAudioState
extends Object implements Parcelable

java.lang.Object
↳	android.telecom.CallAudioState

---

Encapsulates the telecom audio state, including the current audio routing, supported audio routing and mute.

Summary

Constants
int	ROUTE_BLUETOOTH Direct the audio stream through Bluetooth.
int	ROUTE_EARPIECE Direct the audio stream through the device's earpiece.
int	ROUTE_SPEAKER Direct the audio stream through the device's speakerphone.
int	ROUTE_STREAMING Direct the audio stream through another device.
int	ROUTE_WIRED_HEADSET Direct the audio stream through a wired headset.
int	ROUTE_WIRED_OR_EARPIECE Direct the audio stream through the device's earpiece or wired headset if one is connected.

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<CallAudioState>	CREATOR Responsible for creating AudioState objects for deserialized Parcels.

Public constructors
CallAudioState(boolean muted, int route, int supportedRouteMask) Constructor for a CallAudioState object.

Public methods
static String	audioRouteToString(int route) Converts the provided audio route into a human readable string representation.
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
BluetoothDevice	getActiveBluetoothDevice()
int	getRoute()
Collection<BluetoothDevice>	getSupportedBluetoothDevices()
int	getSupportedRouteMask()
boolean	isMuted()
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel destination, int flags) Writes AudioState object into a serializeable 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

ROUTE_BLUETOOTH

Added in API level 23

public static final int ROUTE_BLUETOOTH

Direct the audio stream through Bluetooth.

Constant Value: 2 (0x00000002)

ROUTE_EARPIECE

Added in API level 23

public static final int ROUTE_EARPIECE

Direct the audio stream through the device's earpiece.

Constant Value: 1 (0x00000001)

ROUTE_SPEAKER

Added in API level 23

public static final int ROUTE_SPEAKER

Direct the audio stream through the device's speakerphone.

Constant Value: 8 (0x00000008)

ROUTE_STREAMING

Added in API level 34

public static final int ROUTE_STREAMING

Direct the audio stream through another device.

Constant Value: 16 (0x00000010)

ROUTE_WIRED_HEADSET

Added in API level 23

public static final int ROUTE_WIRED_HEADSET

Direct the audio stream through a wired headset.

Constant Value: 4 (0x00000004)

ROUTE_WIRED_OR_EARPIECE

Added in API level 23

public static final int ROUTE_WIRED_OR_EARPIECE

Direct the audio stream through the device's earpiece or wired headset if one is connected.

Constant Value: 5 (0x00000005)

Fields

CREATOR

Added in API level 23

public static final Creator<CallAudioState> CREATOR

Responsible for creating AudioState objects for deserialized Parcels.

Public constructors

CallAudioState

Added in API level 23

public CallAudioState (boolean muted, 
                int route, 
                int supportedRouteMask)

Constructor for a CallAudioState object.

Parameters
muted	boolean: true if the call is muted, false otherwise.
route	int: The current audio route being used. Allowed values: ROUTE_EARPIECE ROUTE_BLUETOOTH ROUTE_WIRED_HEADSET ROUTE_SPEAKER Value is either 0 or a combination of ROUTE_EARPIECE, ROUTE_BLUETOOTH, ROUTE_WIRED_HEADSET, and ROUTE_SPEAKER
supportedRouteMask	int: Bit mask of all routes supported by this call. This should be a bitwise combination of the following values: ROUTE_EARPIECE ROUTE_BLUETOOTH ROUTE_WIRED_HEADSET ROUTE_SPEAKER Value is either 0 or a combination of ROUTE_EARPIECE, ROUTE_BLUETOOTH, ROUTE_WIRED_HEADSET, and ROUTE_SPEAKER

Public methods

audioRouteToString

Added in API level 23

public static String audioRouteToString (int route)

Converts the provided audio route into a human readable string representation.

Parameters
route	int: to convert into a string.

Returns
String	String representation of the provided audio route.

describeContents

Added in API level 23

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	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 23

public boolean equals (Object obj)

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
obj	Object: the reference object with which to compare.

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

getActiveBluetoothDevice

Added in API level 28

public BluetoothDevice getActiveBluetoothDevice ()

Returns
BluetoothDevice	The BluetoothDevice through which audio is being routed. Will not be null if getRoute() returns ROUTE_BLUETOOTH.

getRoute

Added in API level 23

public int getRoute ()

Returns
int	The current audio route being used. Value is either 0 or a combination of ROUTE_EARPIECE, ROUTE_BLUETOOTH, ROUTE_WIRED_HEADSET, and ROUTE_SPEAKER

getSupportedBluetoothDevices

Added in API level 28

public Collection<BluetoothDevice> getSupportedBluetoothDevices ()

Returns
Collection<BluetoothDevice>	List of BluetoothDevices that can be used for this call.

getSupportedRouteMask

Added in API level 23

public int getSupportedRouteMask ()

Returns
int	Bit mask of all routes supported by this call. Value is either 0 or a combination of ROUTE_EARPIECE, ROUTE_BLUETOOTH, ROUTE_WIRED_HEADSET, and ROUTE_SPEAKER

isMuted

Added in API level 23

public boolean isMuted ()

Returns
boolean	true if the call is muted, false otherwise.

toString

Added in API level 23

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 23

public void writeToParcel (Parcel destination, 
                int flags)

Writes AudioState object into a serializeable Parcel.

Parameters
destination	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. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES