CallAttributesCompat

Kotlin |Java

class CallAttributesCompat

CallAttributes represents a set of properties that define a new Call. Applications should build an instance of this class and use CallsManager.addCall to start a new call with Telecom.

Summary

Constants
`const Int`	`CALL_TYPE_AUDIO_CALL = 1` Used when answering or dialing a call to indicate that the call does not have a video component
`const Int`	`CALL_TYPE_VIDEO_CALL = 2` Indicates video transmission is supported
`const Int`	`DIRECTION_INCOMING = 1` Indicates that the call is an incoming call.
`const Int`	`DIRECTION_OUTGOING = 2` Indicates that the call is an outgoing call.
`const Int`	`SUPPORTS_SET_INACTIVE` This call being created can be set to inactive (traditionally referred to as hold).
`const Int`	`SUPPORTS_STREAM` This call can be streamed from a root device to another device to continue the call without completely transferring it.
`const Int`	`SUPPORTS_TRANSFER` This call can be completely transferred from one endpoint to another.

Public constructors
`CallAttributesCompat( displayName: CharSequence, address: Uri, direction: Int, callType: Int, callCapabilities: Int, preferredStartingCallEndpoint: CallEndpointCompat? )`

Public functions
`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`
`open String`	`toString()`

Public properties
`Uri`	`address` Address of the call.
`Int`	`callCapabilities` Allows a package to opt into capabilities on the telecom side, on a per-call basis
`Int`	`callType` Information related to data being transmitted (voice, video, etc. )
`Int`	`direction` The direction (Outgoing/Incoming) of the new Call
`CharSequence`	`displayName` Display name of the person on the other end of the call
`CallEndpointCompat?`	`preferredStartingCallEndpoint` allows clients to specify a `CallEndpointCompat` to start a new call on.

Constants

CALL_TYPE_AUDIO_CALL

const val CALL_TYPE_AUDIO_CALL = 1: Int

Used when answering or dialing a call to indicate that the call does not have a video component

CALL_TYPE_VIDEO_CALL

const val CALL_TYPE_VIDEO_CALL = 2: Int

Indicates video transmission is supported

DIRECTION_INCOMING

const val DIRECTION_INCOMING = 1: Int

Indicates that the call is an incoming call.

DIRECTION_OUTGOING

const val DIRECTION_OUTGOING = 2: Int

Indicates that the call is an outgoing call.

SUPPORTS_SET_INACTIVE

const val SUPPORTS_SET_INACTIVE: Int

This call being created can be set to inactive (traditionally referred to as hold). This means that once a new call goes active, if the active call needs to be held in order to place or receive an incoming call, the active call will be placed on hold. otherwise, the active call may be disconnected.

SUPPORTS_STREAM

const val SUPPORTS_STREAM: Int

This call can be streamed from a root device to another device to continue the call without completely transferring it. The call continues to take place on the source device, however media and control are streamed to another device.

SUPPORTS_TRANSFER

const val SUPPORTS_TRANSFER: Int

This call can be completely transferred from one endpoint to another.

Public constructors

CallAttributesCompat

Added in 1.0.0-beta01

CallAttributesCompat(
    displayName: CharSequence,
    address: Uri,
    direction: Int,
    callType: Int = CALL_TYPE_AUDIO_CALL,
    callCapabilities: Int = SUPPORTS_SET_INACTIVE,
    preferredStartingCallEndpoint: CallEndpointCompat? = null
)

Parameters
`displayName: CharSequence`	Display name of the person on the other end of the call
`address: Uri`	Address of the call. Note, this can be extended to a meeting link or a custom scheme. On sdks 26 & 27, the address should start with the "sip:" prefix (e.g Uri.parse("sip:")), otherwise the address will be replaced with "sip:" + packageName.
`direction: Int`	The direction (Outgoing/Incoming) of the new Call
`callType: Int = CALL_TYPE_AUDIO_CALL`	Information related to data being transmitted (voice, video, etc. )
`callCapabilities: Int = SUPPORTS_SET_INACTIVE`	Allows a package to opt into capabilities on the telecom side, on a per-call basis
`preferredStartingCallEndpoint: CallEndpointCompat? = null`	allows clients to specify a `CallEndpointCompat` to start a new call on. The `preferredStartingCallEndpoint` should be a value returned from `CallsManager.getAvailableStartingCallEndpoints`. Once the call is started, Core-Telecom will switch to the `preferredStartingCallEndpoint` before running the `CallControlScope`.

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

address

Added in 1.0.0-beta01

val address: Uri

Address of the call. Note, this can be extended to a meeting link or a custom scheme. On sdks 26 & 27, the address should start with the "sip:" prefix (e.g Uri.parse("sip:")), otherwise the address will be replaced with "sip:" + packageName.

callCapabilities

Added in 1.0.0-beta01

val callCapabilities: Int

Allows a package to opt into capabilities on the telecom side, on a per-call basis

callType

Added in 1.0.0-beta01

val callType: Int

Information related to data being transmitted (voice, video, etc. )

direction

Added in 1.0.0-beta01

val direction: Int

The direction (Outgoing/Incoming) of the new Call

displayName

Added in 1.0.0-beta01

val displayName: CharSequence

Display name of the person on the other end of the call

preferredStartingCallEndpoint

Added in 1.0.0-beta01

val preferredStartingCallEndpoint: CallEndpointCompat?

allows clients to specify a CallEndpointCompat to start a new call on. The preferredStartingCallEndpoint should be a value returned from CallsManager.getAvailableStartingCallEndpoints. Once the call is started, Core-Telecom will switch to the preferredStartingCallEndpoint before running the CallControlScope.