CallEndpoint


public final class CallEndpoint
extends Object implements Parcelable

java.lang.Object
   ↳ android.telecom.CallEndpoint


Encapsulates the endpoint where call media can flow

Summary

Constants

int TYPE_BLUETOOTH

Indicates that the type of endpoint through which call media flows is a Bluetooth.

int TYPE_EARPIECE

Indicates that the type of endpoint through which call media flows is an earpiece.

int TYPE_SPEAKER

Indicates that the type of endpoint through which call media flows is a speakerphone.

int TYPE_STREAMING

Indicates that the type of endpoint through which call media flows is an external.

int TYPE_UNKNOWN

Indicates that the type of endpoint through which call media flows is unknown type.

int TYPE_WIRED_HEADSET

Indicates that the type of endpoint through which call media flows is a wired headset.

Inherited constants

Fields

public static final Creator<CallEndpoint> CREATOR

Responsible for creating CallEndpoint objects for deserialized Parcels.

Public constructors

CallEndpoint(CharSequence name, int type, ParcelUuid id)

Constructor for a CallEndpoint object.

Public methods

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.

CharSequence getEndpointName()
int getEndpointType()
ParcelUuid getIdentifier()
int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel destination, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

TYPE_BLUETOOTH

Added in API level 34
public static final int TYPE_BLUETOOTH

Indicates that the type of endpoint through which call media flows is a Bluetooth.

Constant Value: 2 (0x00000002)

TYPE_EARPIECE

Added in API level 34
public static final int TYPE_EARPIECE

Indicates that the type of endpoint through which call media flows is an earpiece.

Constant Value: 1 (0x00000001)

TYPE_SPEAKER

Added in API level 34
public static final int TYPE_SPEAKER

Indicates that the type of endpoint through which call media flows is a speakerphone.

Constant Value: 4 (0x00000004)

TYPE_STREAMING

Added in API level 34
public static final int TYPE_STREAMING

Indicates that the type of endpoint through which call media flows is an external.

Constant Value: 5 (0x00000005)

TYPE_UNKNOWN

Added in API level 34
public static final int TYPE_UNKNOWN

Indicates that the type of endpoint through which call media flows is unknown type.

Constant Value: -1 (0xffffffff)

TYPE_WIRED_HEADSET

Added in API level 34
public static final int TYPE_WIRED_HEADSET

Indicates that the type of endpoint through which call media flows is a wired headset.

Constant Value: 3 (0x00000003)

Fields

CREATOR

Added in API level 34
public static final Creator<CallEndpoint> CREATOR

Responsible for creating CallEndpoint objects for deserialized Parcels.

Public constructors

CallEndpoint

Added in API level 34
public CallEndpoint (CharSequence name, 
                int type, 
                ParcelUuid id)

Constructor for a CallEndpoint object.

Parameters
name CharSequence: Human-readable name associated with the endpoint This value cannot be null.

type int: The type of endpoint through which call media being routed Allowed values: TYPE_EARPIECE TYPE_BLUETOOTH TYPE_WIRED_HEADSET TYPE_SPEAKER TYPE_STREAMING TYPE_UNKNOWN Value is TYPE_UNKNOWN, TYPE_EARPIECE, TYPE_BLUETOOTH, TYPE_WIRED_HEADSET, TYPE_SPEAKER, or TYPE_STREAMING

id ParcelUuid: A unique identifier for this endpoint on the device This value cannot be null.

Public methods

describeContents

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

getEndpointName

Added in API level 34
public CharSequence getEndpointName ()

Returns
CharSequence Human-readable name associated with the endpoint This value cannot be null.

getEndpointType

Added in API level 34
public int getEndpointType ()

Returns
int The type of endpoint through which call media being routed Value is TYPE_UNKNOWN, TYPE_EARPIECE, TYPE_BLUETOOTH, TYPE_WIRED_HEADSET, TYPE_SPEAKER, or TYPE_STREAMING

getIdentifier

Added in API level 34
public ParcelUuid getIdentifier ()

Returns
ParcelUuid A unique identifier for this endpoint on the device This value cannot be null.

hashCode

Added in API level 34
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

toString

Added in API level 34
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 34
public void writeToParcel (Parcel destination, 
                int flags)

Flatten this object in to a Parcel.

Parameters
destination Parcel: 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