Added in API level 34

CallEndpoint


class CallEndpoint : Parcelable
kotlin.Any
   ↳ android.telecom.CallEndpoint

Encapsulates the endpoint where call media can flow

Summary

Constants
static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

Inherited constants
Public constructors
CallEndpoint(name: CharSequence, type: Int, id: ParcelUuid)

Constructor for a CallEndpoint object.

Public methods
Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Boolean
equals(other: Any?)

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

CharSequence

Int

ParcelUuid

Int

Returns a hash code value for the object.

String

Returns a string representation of the object.

Unit
writeToParcel(destination: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<CallEndpoint!>

Responsible for creating CallEndpoint objects for deserialized Parcels.

Constants

TYPE_BLUETOOTH

Added in API level 34
static val TYPE_BLUETOOTH: Int

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

Value: 2

TYPE_EARPIECE

Added in API level 34
static val TYPE_EARPIECE: Int

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

Value: 1

TYPE_SPEAKER

Added in API level 34
static val TYPE_SPEAKER: Int

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

Value: 4

TYPE_STREAMING

Added in API level 34
static val TYPE_STREAMING: Int

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

Value: 5

TYPE_UNKNOWN

Added in API level 34
static val TYPE_UNKNOWN: Int

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

Value: -1

TYPE_WIRED_HEADSET

Added in API level 34
static val TYPE_WIRED_HEADSET: Int

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

Value: 3

Public constructors

CallEndpoint

Added in API level 34
CallEndpoint(
    name: CharSequence,
    type: Int,
    id: ParcelUuid)

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 android.telecom.CallEndpoint#TYPE_UNKNOWN, android.telecom.CallEndpoint#TYPE_EARPIECE, android.telecom.CallEndpoint#TYPE_BLUETOOTH, android.telecom.CallEndpoint#TYPE_WIRED_HEADSET, android.telecom.CallEndpoint#TYPE_SPEAKER, or android.telecom.CallEndpoint#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
fun describeContents(): Int

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.

Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 34
fun equals(other: Any?): Boolean

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 the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getEndpointName

Added in API level 34
fun getEndpointName(): CharSequence
Return
CharSequence Human-readable name associated with the endpoint This value cannot be null.

getIdentifier

Added in API level 34
fun getIdentifier(): ParcelUuid
Return
ParcelUuid A unique identifier for this endpoint on the device This value cannot be null.

hashCode

Added in API level 34
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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.
Return
Int a hash code value for this object.

toString

Added in API level 34
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

Added in API level 34
fun writeToParcel(
    destination: Parcel,
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest 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_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES
destination Parcel: This value cannot be null.

Properties

CREATOR

Added in API level 34
static val CREATOR: Parcelable.Creator<CallEndpoint!>

Responsible for creating CallEndpoint objects for deserialized Parcels.