CallAttributesCompat
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 |
Used when answering or dialing a call to indicate that the call does not have a video component |
const Int |
Indicates video transmission is supported |
const Int |
Indicates that the call is an incoming call. |
const Int |
Indicates that the call is an outgoing call. |
const Int |
This call being created can be set to inactive (traditionally referred to as hold). |
const Int |
This call can be streamed from a root device to another device to continue the call without completely transferring it. |
const Int |
This call can be completely transferred from one endpoint to another. |
Public constructors |
|---|
CallAttributesCompat( |
Public properties |
|
|---|---|
Uri |
Address of the call. |
Int |
Allows a package to opt into capabilities on the telecom side, on a per-call basis |
Int |
Information related to data being transmitted (voice, video, etc. ) |
Int |
The direction (Outgoing/Incoming) of the new Call |
CharSequence |
Display name of the person on the other end of the call |
Boolean? |
Whether this call should be excluded from the call log. |
CallEndpointCompat? |
allows clients to specify a |
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
CallAttributesCompat(
displayName: CharSequence,
address: Uri,
direction: Int,
callType: Int = CALL_TYPE_AUDIO_CALL,
callCapabilities: Int = SUPPORTS_SET_INACTIVE,
preferredStartingCallEndpoint: CallEndpointCompat? = null,
isLogExcluded: Boolean? = 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 |
isLogExcluded: Boolean? = null |
Whether this call should be excluded from the call log. This is only applicable on sdks 36.1+. Pass null if the default platform behavior is desired or when running on older versions. |
Public functions
Public properties
address
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
val callCapabilities: Int
Allows a package to opt into capabilities on the telecom side, on a per-call basis
callType
val callType: Int
Information related to data being transmitted (voice, video, etc. )
displayName
val displayName: CharSequence
Display name of the person on the other end of the call
isLogExcluded
val isLogExcluded: Boolean?
Whether this call should be excluded from the call log. This is only applicable on sdks 36.1+. Pass null if the default platform behavior is desired or when running on older versions.
preferredStartingCallEndpoint
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.