# Print output for @column tags ?>
Developers

- Design
- Develop
- Distribute

Developer Console

## Most visited

## Recently visited

## Results for

Summary: Nested Classes | Constants | Ctors | Methods | Inherited Methods

# Connection

`public abstract class Connection`
`` `extends Conferenceable` ``

java.lang.Object
↳ | android.telecom.Conferenceable
| ↳ | android.telecom.Connection

Represents a phone call or connection to a remote endpoint that carries voice and/or video traffic.

Implementations create a custom subclass of `Connection` and return it to the framework as the return value of `ConnectionService#onCreateIncomingConnection(PhoneAccountHandle, ConnectionRequest)` or `ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)`. Implementations are then responsible for updating the state of the `Connection`, and must call `destroy()` to signal to the framework that the `Connection` is no longer used and associated resources may be recovered.

Subclasses of `Connection` override the `on*` methods to provide the the `ConnectionService`'s implementation of calling functionality. The `on*` methods are called by Telecom to inform an instance of a `Connection` of actions specific to that `Connection` instance.

Basic call support requires overriding the following methods: `onAnswer()`, `onDisconnect()`, `onReject()`, `onAbort()`

Where a `Connection` has `CAPABILITY_SUPPORT_HOLD`, the `onHold()` and `onUnhold()` methods should be overridden to provide hold support for the `Connection`.

Where a `Connection` supports a variation of video calling (e.g. the `CAPABILITY_SUPPORTS_VT_*` capability bits), `onAnswer(int)` should be overridden to support answering a call as a video call.

Where a `Connection` has `PROPERTY_IS_EXTERNAL_CALL` and `CAPABILITY_CAN_PULL_CALL`, `onPullExternalCall()` should be overridden to provide support for pulling the external call.

Where a `Connection` supports conference calling `onSeparate()` should be overridden.

There are a number of other `on*` methods which a `Connection` can choose to implement, depending on whether it is concerned with the associated calls from Telecom. If, for example, call events from a `InCallService` are handled, `onCallEvent(java.lang.String, android.os.Bundle)` should be overridden. Another example is `onExtrasChanged(android.os.Bundle)`, which should be overridden if the `Connection` wishes to make use of extra information provided via the `Call#putExtras(Bundle)` and `Call#removeExtras(String...)` methods.

## Summary

### Nested classes
`class` | `Connection.RttModifyStatus` Provides constants to represent the results of responses to session modify requests sent via `Call#sendRttRequest()`
`class` | `Connection.RttTextStream` Provides methods to read and write RTT data to/from the in-call app.
`class` | `Connection.VideoProvider` Provides a means of controlling the video session associated with a `Connection`.

### Constants
`int` | `AUDIO_CODEC_AMR` Adaptive Multi-rate audio codec.
`int` | `AUDIO_CODEC_AMR_WB` Adaptive Multi-rate wideband audio codec.
`int` | `AUDIO_CODEC_EVRC` Enhanced Variable Rate Codec.
`int` | `AUDIO_CODEC_EVRC_B` Enhanced Variable Rate Codec B.
`int` | `AUDIO_CODEC_EVRC_NW` Enhanced Variable Rate Narrowband-Wideband Codec.
`int` | `AUDIO_CODEC_EVRC_WB` Enhanced Variable Rate Wideband Codec.
`int` | `AUDIO_CODEC_EVS_FB` Enhanced Voice Services Fullband audio codec.
`int` | `AUDIO_CODEC_EVS_NB` Enhanced Voice Services Narrowband audio codec.
`int` | `AUDIO_CODEC_EVS_SWB` Enhanced Voice Services Super-Wideband audio codec.
`int` | `AUDIO_CODEC_EVS_WB` Enhanced Voice Services Wideband audio codec.
`int` | `AUDIO_CODEC_G711A` ITU-T G711A audio codec.
`int` | `AUDIO_CODEC_G711AB` ITU-T G711AB audio codec.
`int` | `AUDIO_CODEC_G711U` ITU-T G711U audio codec.
`int` | `AUDIO_CODEC_G722` ITU-T G722 audio codec.
`int` | `AUDIO_CODEC_G723` ITU-T G723 audio codec.
`int` | `AUDIO_CODEC_G729` ITU-T G729 audio codec.
`int` | `AUDIO_CODEC_GSM_EFR` GSM Enhanced Full-Rate audio codec, also known as GSM-EFR, GSM 06.60, or simply EFR.
`int` | `AUDIO_CODEC_GSM_FR` GSM Full-Rate audio codec, also known as GSM-FR, GSM 06.10, GSM, or simply FR.
`int` | `AUDIO_CODEC_GSM_HR` GSM Half Rate audio codec.
`int` | `AUDIO_CODEC_NONE` Indicates that the audio codec is currently not specified or is unknown.
`int` | `AUDIO_CODEC_QCELP13K` Qualcomm code-excited linear prediction 13 kilobit audio codec.
`int` | `CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO` When set, prevents a video call from being downgraded to an audio-only call.
`int` | `CAPABILITY_CAN_PAUSE_VIDEO` For video calls, indicates whether the outgoing video for the call can be paused using the `VideoProfile.STATE_PAUSED` VideoState.
`int` | `CAPABILITY_CAN_PULL_CALL` When set for an external connection, indicates that this `Connection` can be pulled from a remote device to the current device.
`int` | `CAPABILITY_CAN_SEND_RESPONSE_VIA_CONNECTION` Indicates that the connection itself wants to handle any sort of reply response, rather than relying on SMS.
`int` | `CAPABILITY_CAN_UPGRADE_TO_VIDEO` This constant is deprecated. Use `CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL` and `CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL` to indicate for a call whether or not video calling is supported.
`int` | `CAPABILITY_DISCONNECT_FROM_CONFERENCE` Connection is able to be individually disconnected when in a `Conference`.
`int` | `CAPABILITY_HOLD` Connection can currently be put on hold or unheld.
`int` | `CAPABILITY_MANAGE_CONFERENCE` Connection supports conference management.
`int` | `CAPABILITY_MERGE_CONFERENCE` Connections within a conference can be merged.
`int` | `CAPABILITY_MUTE` Connection can be muted.
`int` | `CAPABILITY_RESPOND_VIA_TEXT` Connection supports responding via text option.
`int` | `CAPABILITY_SEPARATE_FROM_CONFERENCE` Connection is able to be separated from its parent `Conference`, if any.
`int` | `CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL` Local device supports bidirectional video calling.
`int` | `CAPABILITY_SUPPORTS_VT_LOCAL_RX` Local device supports receiving video.
`int` | `CAPABILITY_SUPPORTS_VT_LOCAL_TX` Local device supports transmitting video.
`int` | `CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL` Remote device supports bidirectional video calling.
`int` | `CAPABILITY_SUPPORTS_VT_REMOTE_RX` Remote device supports receiving video.
`int` | `CAPABILITY_SUPPORTS_VT_REMOTE_TX` Remote device supports transmitting video.
`int` | `CAPABILITY_SUPPORT_DEFLECT` Call supports the deflect feature.
`int` | `CAPABILITY_SUPPORT_HOLD` Connection supports the hold feature.
`int` | `CAPABILITY_SWAP_CONFERENCE` Connections within a conference can be swapped between foreground and background.
`String` | `EVENT_CALL_HOLD_FAILED` Connection event used to inform Telecom when a hold operation on a call has failed.
`String` | `EVENT_CALL_MERGE_FAILED` Connection event used to inform `InCallService`s when the merging of two calls has failed.
`String` | `EVENT_CALL_PULL_FAILED` Connection event used to inform `InCallService`s when pulling of an external call has failed.
`String` | `EVENT_CALL_REMOTELY_HELD` Connection event used to inform `InCallService`s when a call has been put on hold by the remote party.
`String` | `EVENT_CALL_REMOTELY_UNHELD` Connection event used to inform `InCallService`s when a call which was remotely held (see `EVENT_CALL_REMOTELY_HELD`) has been un-held by the remote party.
`String` | `EVENT_CALL_SWITCH_FAILED` Connection event used to inform Telecom when a switch operation on a call has failed.
`String` | `EVENT_MERGE_COMPLETE` Connection event used to inform `InCallService`s when the process of merging a Connection into a conference has completed.
`String` | `EVENT_MERGE_START` Connection event used to inform `InCallService`s when the process of merging a Connection into a conference has begun.
`String` | `EVENT_ON_HOLD_TONE_END` Connection event used to inform Telecom that it should stop the on hold tone.
`String` | `EVENT_ON_HOLD_TONE_START` Connection event used to inform Telecom that it should play the on hold tone.
`String` | `EVENT_RTT_AUDIO_INDICATION_CHANGED` Connection event used to inform an `InCallService` that the RTT audio indication has changed.
`String` | `EXTRA_ANSWERING_DROPS_FG_CALL` Boolean connection extra key set on a `Connection` in `Connection#STATE_RINGING` state to indicate that answering the call will cause the current active foreground call to be dropped.
`String` | `EXTRA_ANSWERING_DROPS_FG_CALL_APP_NAME` String connection extra key set on a `Connection` in `Connection#STATE_RINGING` state to indicate the name of the third-party app which is responsible for the current foreground call.
`String` | `EXTRA_AUDIO_CODEC` The audio codec in use for the current `Connection`, if known.
`String` | `EXTRA_CALL_SUBJECT` Connection extra key used to store the subject for an incoming call.
`String` | `EXTRA_CHILD_ADDRESS` Connection extra key used to store a child number associated with the current connection.
`String` | `EXTRA_IS_RTT_AUDIO_PRESENT` Boolean connection extra key set on the extras passed to `Connection#sendConnectionEvent` which indicates that audio is present on the RTT call when the extra value is true.
`String` | `EXTRA_LAST_FORWARDED_NUMBER` Connection extra key used to store the last forwarded number associated with the current connection.
`String` | `EXTRA_SIP_INVITE` String Connection extra key used to store SIP invite fields for an incoming call for IMS call
`int` | `PROPERTY_ASSISTED_DIALING` Set by the framework to indicate that a connection is using assisted dialing.
`int` | `PROPERTY_HAS_CDMA_VOICE_PRIVACY` Indicates that the connection has CDMA Enhanced Voice Privacy enabled.
`int` | `PROPERTY_HIGH_DEF_AUDIO` Connection is using high definition audio.
`int` | `PROPERTY_IS_EXTERNAL_CALL` When set, indicates that the `Connection` does not actually exist locally for the `ConnectionService`.
`int` | `PROPERTY_IS_RTT` Set by the framework to indicate that a connection has an active RTT session associated with it.
`int` | `PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL` Set by the framework to indicate that the network has identified a Connection as an emergency call.
`int` | `PROPERTY_SELF_MANAGED` Set by the framework to indicate that the `Connection` originated from a self-managed `ConnectionService`.
`int` | `PROPERTY_WIFI` Connection is using WIFI.
`int` | `STATE_ACTIVE` A connection is active.
`int` | `STATE_DIALING` An outgoing connection is in the dialing state.
`int` | `STATE_DISCONNECTED` A connection has been disconnected.
`int` | `STATE_HOLDING` A connection is on hold.
`int` | `STATE_INITIALIZING` The connection is initializing.
`int` | `STATE_NEW` The connection is new and not connected.
`int` | `STATE_PULLING_CALL` The state of an external connection which is in the process of being pulled from a remote device to the local device.
`int` | `STATE_RINGING` An incoming connection is in the ringing state.
`int` | `VERIFICATION_STATUS_FAILED` Indicates that verification by the network failed.
`int` | `VERIFICATION_STATUS_NOT_VERIFIED` Indicates that the network could not perform verification.
`int` | `VERIFICATION_STATUS_PASSED` Indicates that verification by the network passed.

### Public constructors
`Connection()` Create a new Connection.

### Public methods
`static String` | `capabilitiesToString(int capabilities)` Renders a set of capability bits (`CAPABILITY_*`) as a human readable string.
`static Connection` | `createCanceledConnection()` Return a `Connection` which represents a canceled connection attempt.
`static Connection` | `createFailedConnection(DisconnectCause disconnectCause)` Return a `Connection` which represents a failed connection attempt.
`final void` | `destroy()` Tears down the Connection object.
`final Uri` | `getAddress()`
`final int` | `getAddressPresentation()`
`final boolean` | `getAudioModeIsVoip()`
`final CallAudioState` | `getCallAudioState()`
`final String` | `getCallerDisplayName()`
`final int` | `getCallerDisplayNamePresentation()`
`final int` | `getCallerNumberVerificationStatus()` Gets the verification status for the phone number of an incoming call as identified in ATIS-1000082.
`final Conference` | `getConference()`
`final List<Conferenceable>` | `getConferenceables()` Returns the connections or conferences with which this connection can be conferenced.
`final int` | `getConnectionCapabilities()` Returns the connection's capabilities, as a bit mask of the `CAPABILITY_*` constants.
`final int` | `getConnectionProperties()` Returns the connection's properties, as a bit mask of the `PROPERTY_*` constants.
`final DisconnectCause` | `getDisconnectCause()`
`final Bundle` | `getExtras()` Returns the extras associated with this connection.
`final int` | `getState()`
`final StatusHints` | `getStatusHints()`
`final Connection.VideoProvider` | `getVideoProvider()`
`final int` | `getVideoState()` Returns the video state of the connection.
`void` | `handleRttUpgradeResponse(Connection.RttTextStream rttTextStream)` Notifies this connection of a response to a previous remotely-initiated RTT upgrade request sent via `sendRemoteRttRequest()`.
`final boolean` | `isRingbackRequested()` Returns whether this connection is requesting that the system play a ringback tone on its behalf.
`final void` | `notifyConferenceMergeFailed()` Called by a `ConnectionService` to notify Telecom that a `Conference#onMerge()` request failed.
`void` | `onAbort()` Notifies this Connection of a request to abort.
`void` | `onAnswer(int videoState)` Notifies this Connection, which is in `STATE_RINGING`, of a request to accept.
`void` | `onAnswer()` Notifies this Connection, which is in `STATE_RINGING`, of a request to accept.
`void` | `onCallAudioStateChanged(CallAudioState state)` Notifies this Connection that the `getCallAudioState()` property has a new value.
`void` | `onCallEvent(String event, Bundle extras)` Notifies this Connection of a `Call` event initiated from an `InCallService`.
`void` | `onDeflect(Uri address)` Notifies this Connection, which is in `STATE_RINGING`, of a request to deflect.
`void` | `onDisconnect()` Notifies this Connection of a request to disconnect.
`void` | `onExtrasChanged(Bundle extras)` Notifies this `Connection` of a change to the extras made outside the `ConnectionService`.
`void` | `onHandoverComplete()` Notifies this `Connection` that a handover has completed.
`void` | `onHold()` Notifies this Connection of a request to hold.
`void` | `onPlayDtmfTone(char c)` Notifies this Connection of a request to play a DTMF tone.
`void` | `onPostDialContinue(boolean proceed)` Notifies this Connection whether the user wishes to proceed with the post-dial DTMF codes.
`void` | `onPullExternalCall()` Notifies this Connection of a request to pull an external call to the local device.
`void` | `onReject()` Notifies this Connection, which is in `STATE_RINGING`, of a request to reject.
`void` | `onReject(int rejectReason)` Notifies this Connection, which is in `STATE_RINGING`, of a request to reject.
`void` | `onReject(String replyMessage)` Notifies this Connection, which is in `STATE_RINGING`, of a request to reject with a message.
`void` | `onSeparate()` Notifies this Connection of a request to separate from its parent conference.
`void` | `onShowIncomingCallUi()` Notifies this `Connection` that its `ConnectionService` is responsible for displaying its incoming call user interface for the `Connection`.
`void` | `onSilence()` Notifies this Connection of a request to silence the ringer.
`void` | `onStartRtt(Connection.RttTextStream rttTextStream)` Notifies this `Connection` that the user has requested an RTT session.
`void` | `onStateChanged(int state)` Notifies this Connection of an internal state change.
`void` | `onStopDtmfTone()` Notifies this Connection of a request to stop any currently playing DTMF tones.
`void` | `onStopRtt()` Notifies this `Connection` that it should terminate any existing RTT communication channel.
`void` | `onUnhold()` Notifies this Connection of a request to exit a hold state.
`static String` | `propertiesToString(int properties)` Renders a set of property bits (`PROPERTY_*`) as a human readable string.
`final void` | `putExtras(Bundle extras)` Adds some extras to this `Connection`.
`final void` | `removeExtras(String... keys)` Removes extras from this `Connection`.
`final void` | `removeExtras(List<String> keys)` Removes extras from this `Connection`.
`void` | `requestBluetoothAudio(BluetoothDevice bluetoothDevice)` Request audio routing to a specific bluetooth device.
`void` | `sendConnectionEvent(String event, Bundle extras)` Sends an event associated with this `Connection` with associated event extras to the `InCallService`.
`final void` | `sendRemoteRttRequest()` Informs listeners that the remote side of the call has requested an upgrade to include an RTT session in the call.
`final void` | `sendRttInitiationFailure(int reason)` Informs listeners that a previously requested RTT session via `ConnectionRequest#isRequestingRtt()` or `onStartRtt(android.telecom.Connection.RttTextStream)` has failed.
`final void` | `sendRttInitiationSuccess()` Informs listeners that a previously requested RTT session via `ConnectionRequest#isRequestingRtt()` or `onStartRtt(android.telecom.Connection.RttTextStream)` has succeeded.
`final void` | `sendRttSessionRemotelyTerminated()` Informs listeners that a currently active RTT session has been terminated by the remote side of the coll.
`final void` | `setActive()` Sets state to active (e.g., an ongoing connection where two or more parties can actively communicate).
`final void` | `setAddress(Uri address, int presentation)` Sets the value of the `getAddress()` property.
`final void` | `setAudioModeIsVoip(boolean isVoip)` Requests that the framework use VOIP audio mode for this connection.
`final void` | `setAudioRoute(int route)` Sets the audio route (speaker, bluetooth, etc...).
`final void` | `setCallerDisplayName(String callerDisplayName, int presentation)` Sets the caller display name (CNAP).
`final void` | `setCallerNumberVerificationStatus(int callerNumberVerificationStatus)` Sets the verification status for the phone number of an incoming call as identified in ATIS-1000082.
`final void` | `setConferenceableConnections(List<Connection> conferenceableConnections)` Sets the connections with which this connection can be conferenced.
`final void` | `setConferenceables(List<Conferenceable> conferenceables)` Similar to `setConferenceableConnections(java.util.List)`, sets a list of connections or conferences with which this connection can be conferenced.
`final void` | `setConnectionCapabilities(int connectionCapabilities)` Sets the connection's capabilities as a bit mask of the `CAPABILITY_*` constants.
`final void` | `setConnectionProperties(int connectionProperties)` Sets the connection's properties as a bit mask of the `PROPERTY_*` constants.
`final void` | `setDialing()` Sets state to dialing (e.g., dialing an outbound connection).
`final void` | `setDisconnected(DisconnectCause disconnectCause)` Sets state to disconnected.
`final void` | `setExtras(Bundle extras)` Set some extras that can be associated with this `Connection`.
`final void` | `setInitialized()` Sets state to initialized (the Connection has been set up and is now ready to be used).
`final void` | `setInitializing()` Sets state to initializing (this Connection is not yet ready to be used).
`final void` | `setNextPostDialChar(char nextChar)` Informs listeners that this `Connection` has processed a character in the post-dial started state.
`final void` | `setOnHold()` Sets state to be on hold.
`final void` | `setPostDialWait(String remaining)` Informs listeners that this `Connection` is in a post-dial wait state.
`final void` | `setPulling()` Sets state to pulling (e.g. the connection is being pulled to the local device from another device).
`final void` | `setRingbackRequested(boolean ringback)` Requests that the framework play a ringback tone.
`final void` | `setRinging()` Sets state to ringing (e.g., an inbound ringing connection).
`final void` | `setStatusHints(StatusHints statusHints)` Sets the label and icon status to display in the in-call UI.
`final void` | `setVideoProvider(Connection.VideoProvider videoProvider)` Sets the video connection provider.
`final void` | `setVideoState(int videoState)` Set the video state for the connection.
`static String` | `stateToString(int state)`

### 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 timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void` | `wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void` | `wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

## Constants

### AUDIO_CODEC_AMR

    public static final int AUDIO_CODEC_AMR

Adaptive Multi-rate audio codec.

Constant Value: 1 (0x00000001)

### AUDIO_CODEC_AMR_WB

    public static final int AUDIO_CODEC_AMR_WB

Adaptive Multi-rate wideband audio codec.

Constant Value: 2 (0x00000002)

### AUDIO_CODEC_EVRC

    public static final int AUDIO_CODEC_EVRC

Enhanced Variable Rate Codec. See 3GPP2 C.S0014-A.

Constant Value: 4 (0x00000004)

### AUDIO_CODEC_EVRC_B

    public static final int AUDIO_CODEC_EVRC_B

Enhanced Variable Rate Codec B. Commonly used on CDMA networks.

Constant Value: 5 (0x00000005)

### AUDIO_CODEC_EVRC_NW

    public static final int AUDIO_CODEC_EVRC_NW

Enhanced Variable Rate Narrowband-Wideband Codec.

Constant Value: 7 (0x00000007)

### AUDIO_CODEC_EVRC_WB

    public static final int AUDIO_CODEC_EVRC_WB

Enhanced Variable Rate Wideband Codec. See RFC5188.

Constant Value: 6 (0x00000006)

### AUDIO_CODEC_EVS_FB

    public static final int AUDIO_CODEC_EVS_FB

Enhanced Voice Services Fullband audio codec. See 3GPP TS 26.441.

Constant Value: 20 (0x00000014)

### AUDIO_CODEC_EVS_NB

    public static final int AUDIO_CODEC_EVS_NB

Enhanced Voice Services Narrowband audio codec. See 3GPP TS 26.441.

Constant Value: 17 (0x00000011)

### AUDIO_CODEC_EVS_SWB

    public static final int AUDIO_CODEC_EVS_SWB

Enhanced Voice Services Super-Wideband audio codec. See 3GPP TS 26.441.

Constant Value: 19 (0x00000013)

### AUDIO_CODEC_EVS_WB

    public static final int AUDIO_CODEC_EVS_WB

Enhanced Voice Services Wideband audio codec. See 3GPP TS 26.441.

Constant Value: 18 (0x00000012)

### AUDIO_CODEC_G711A

    public static final int AUDIO_CODEC_G711A

ITU-T G711A audio codec.

Constant Value: 13 (0x0000000d)

### AUDIO_CODEC_G711AB

    public static final int AUDIO_CODEC_G711AB

ITU-T G711AB audio codec.

Constant Value: 15 (0x0000000f)

### AUDIO_CODEC_G711U

    public static final int AUDIO_CODEC_G711U

ITU-T G711U audio codec.

Constant Value: 11 (0x0000000b)

### AUDIO_CODEC_G722

    public static final int AUDIO_CODEC_G722

ITU-T G722 audio codec.

Constant Value: 14 (0x0000000e)

### AUDIO_CODEC_G723

    public static final int AUDIO_CODEC_G723

ITU-T G723 audio codec.

Constant Value: 12 (0x0000000c)

### AUDIO_CODEC_G729

    public static final int AUDIO_CODEC_G729

ITU-T G729 audio codec.

Constant Value: 16 (0x00000010)

### AUDIO_CODEC_GSM_EFR

    public static final int AUDIO_CODEC_GSM_EFR

GSM Enhanced Full-Rate audio codec, also known as GSM-EFR, GSM 06.60, or simply EFR.

Constant Value: 8 (0x00000008)

### AUDIO_CODEC_GSM_FR

    public static final int AUDIO_CODEC_GSM_FR

GSM Full-Rate audio codec, also known as GSM-FR, GSM 06.10, GSM, or simply FR.

Constant Value: 9 (0x00000009)

### AUDIO_CODEC_GSM_HR

    public static final int AUDIO_CODEC_GSM_HR

GSM Half Rate audio codec.

Constant Value: 10 (0x0000000a)

### AUDIO_CODEC_NONE

    public static final int AUDIO_CODEC_NONE

Indicates that the audio codec is currently not specified or is unknown.

Constant Value: 0 (0x00000000)

### AUDIO_CODEC_QCELP13K

    public static final int AUDIO_CODEC_QCELP13K

Qualcomm code-excited linear prediction 13 kilobit audio codec.

Constant Value: 3 (0x00000003)

### CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO

    public static final int CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO

When set, prevents a video call from being downgraded to an audio-only call.

Should be set when the VideoState has the `VideoProfile#STATE_TX_ENABLED` or `VideoProfile#STATE_RX_ENABLED` bits set to indicate that the connection cannot be downgraded from a video call back to a VideoState of `VideoProfile#STATE_AUDIO_ONLY`.

Intuitively, a call which can be downgraded to audio should also have local and remote video capabilities (see `CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL` and `CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL`).

Constant Value: 8388608 (0x00800000)

### CAPABILITY_CAN_PAUSE_VIDEO

    public static final int CAPABILITY_CAN_PAUSE_VIDEO

For video calls, indicates whether the outgoing video for the call can be paused using the `VideoProfile.STATE_PAUSED` VideoState.

Constant Value: 1048576 (0x00100000)

### CAPABILITY_CAN_PULL_CALL

    public static final int CAPABILITY_CAN_PULL_CALL

When set for an external connection, indicates that this `Connection` can be pulled from a remote device to the current device.

Should only be set on a `Connection` where `PROPERTY_IS_EXTERNAL_CALL` is set.

Constant Value: 16777216 (0x01000000)

### CAPABILITY_CAN_SEND_RESPONSE_VIA_CONNECTION

    public static final int CAPABILITY_CAN_SEND_RESPONSE_VIA_CONNECTION

Indicates that the connection itself wants to handle any sort of reply response, rather than relying on SMS.

Constant Value: 4194304 (0x00400000)

### CAPABILITY_CAN_UPGRADE_TO_VIDEO

    public static final int CAPABILITY_CAN_UPGRADE_TO_VIDEO

This constant is deprecated.
Use `CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL` and `CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL` to indicate for a call whether or not video calling is supported.

Call can be upgraded to a video call.

Constant Value: 524288 (0x00080000)

### CAPABILITY_DISCONNECT_FROM_CONFERENCE

    public static final int CAPABILITY_DISCONNECT_FROM_CONFERENCE

Connection is able to be individually disconnected when in a `Conference`.

Constant Value: 8192 (0x00002000)

### CAPABILITY_HOLD

    public static final int CAPABILITY_HOLD

Connection can currently be put on hold or unheld. This is distinct from `CAPABILITY_SUPPORT_HOLD` in that although a connection may support 'hold' most times, it does not at the moment support the function. This can be true while the call is in the state `STATE_DIALING`, for example. During this condition, an in-call UI may display a disabled 'hold' button.

Constant Value: 1 (0x00000001)

### CAPABILITY_MANAGE_CONFERENCE

    public static final int CAPABILITY_MANAGE_CONFERENCE

Connection supports conference management. This capability only applies to `Conference`s which can have `Connection`s as children.

Constant Value: 128 (0x00000080)

### CAPABILITY_MERGE_CONFERENCE

    public static final int CAPABILITY_MERGE_CONFERENCE

Connections within a conference can be merged. A `ConnectionService` has the option to add a `Conference` before the child `Connection`s are merged. This is how CDMA-based `Connection`s are implemented. For these unmerged `Conference`s, this capability allows a merge button to be shown while the conference is in the foreground of the in-call UI.

This is only intended for use by a `Conference`.

Constant Value: 4 (0x00000004)

### CAPABILITY_MUTE

    public static final int CAPABILITY_MUTE

Connection can be muted.

Constant Value: 64 (0x00000040)

### CAPABILITY_RESPOND_VIA_TEXT

    public static final int CAPABILITY_RESPOND_VIA_TEXT

Connection supports responding via text option.

Constant Value: 32 (0x00000020)

### CAPABILITY_SEPARATE_FROM_CONFERENCE

    public static final int CAPABILITY_SEPARATE_FROM_CONFERENCE

Connection is able to be separated from its parent `Conference`, if any.

Constant Value: 4096 (0x00001000)

### CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL

    public static final int CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL

Local device supports bidirectional video calling.

Constant Value: 768 (0x00000300)

### CAPABILITY_SUPPORTS_VT_LOCAL_RX

    public static final int CAPABILITY_SUPPORTS_VT_LOCAL_RX

Local device supports receiving video.

Constant Value: 256 (0x00000100)

### CAPABILITY_SUPPORTS_VT_LOCAL_TX

    public static final int CAPABILITY_SUPPORTS_VT_LOCAL_TX

Local device supports transmitting video.

Constant Value: 512 (0x00000200)

### CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL

    public static final int CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL

Remote device supports bidirectional video calling.

Constant Value: 3072 (0x00000c00)

### CAPABILITY_SUPPORTS_VT_REMOTE_RX

    public static final int CAPABILITY_SUPPORTS_VT_REMOTE_RX

Remote device supports receiving video.

Constant Value: 1024 (0x00000400)

### CAPABILITY_SUPPORTS_VT_REMOTE_TX

    public static final int CAPABILITY_SUPPORTS_VT_REMOTE_TX

Remote device supports transmitting video.

Constant Value: 2048 (0x00000800)

### CAPABILITY_SUPPORT_DEFLECT

    public static final int CAPABILITY_SUPPORT_DEFLECT

Call supports the deflect feature.

Constant Value: 33554432 (0x02000000)

### CAPABILITY_SUPPORT_HOLD

    public static final int CAPABILITY_SUPPORT_HOLD

Connection supports the hold feature.

Constant Value: 2 (0x00000002)

### CAPABILITY_SWAP_CONFERENCE

    public static final int CAPABILITY_SWAP_CONFERENCE

Connections within a conference can be swapped between foreground and background. See `CAPABILITY_MERGE_CONFERENCE` for additional information.

This is only intended for use by a `Conference`.

Constant Value: 8 (0x00000008)

### EVENT_CALL_HOLD_FAILED

    public static final String EVENT_CALL_HOLD_FAILED

Connection event used to inform Telecom when a hold operation on a call has failed.

Sent via `sendConnectionEvent(java.lang.String, android.os.Bundle)`. The `Bundle` parameter is expected to be null when this connection event is used.

Constant Value: "android.telecom.event.CALL_HOLD_FAILED"

### EVENT_CALL_MERGE_FAILED

    public static final String EVENT_CALL_MERGE_FAILED

Connection event used to inform `InCallService`s when the merging of two calls has failed. The User Interface should use this message to inform the user of the error.

Sent via `sendConnectionEvent(java.lang.String, android.os.Bundle)`. The `Bundle` parameter is expected to be null when this connection event is used.

Constant Value: "android.telecom.event.CALL_MERGE_FAILED"

### EVENT_CALL_PULL_FAILED

    public static final String EVENT_CALL_PULL_FAILED

Connection event used to inform `InCallService`s when pulling of an external call has failed. The user interface should inform the user of the error.

Expected to be used by the `ConnectionService` when the `Call#pullExternalCall()` API is called on a `Call` with the properties `Call.Details#PROPERTY_IS_EXTERNAL_CALL` and `Call.Details#CAPABILITY_CAN_PULL_CALL`, but the `ConnectionService` could not pull the external call due to an error condition.

Sent via `sendConnectionEvent(java.lang.String, android.os.Bundle)`. The `Bundle` parameter is expected to be null when this connection event is used.

Constant Value: "android.telecom.event.CALL_PULL_FAILED"

### EVENT_CALL_REMOTELY_HELD

    public static final String EVENT_CALL_REMOTELY_HELD

Connection event used to inform `InCallService`s when a call has been put on hold by the remote party.

This is different than the `Connection#STATE_HOLDING` state which indicates that the call is being held locally on the device. When a capable `ConnectionService` receives signalling to indicate that the remote party has put the call on hold, it can send this connection event.

Constant Value: "android.telecom.event.CALL_REMOTELY_HELD"

### EVENT_CALL_REMOTELY_UNHELD

    public static final String EVENT_CALL_REMOTELY_UNHELD

Connection event used to inform `InCallService`s when a call which was remotely held (see `EVENT_CALL_REMOTELY_HELD`) has been un-held by the remote party.

This is different than the `Connection#STATE_HOLDING` state which indicates that the call is being held locally on the device. When a capable `ConnectionService` receives signalling to indicate that the remote party has taken the call off hold, it can send this connection event.

Constant Value: "android.telecom.event.CALL_REMOTELY_UNHELD"

### EVENT_CALL_SWITCH_FAILED

    public static final String EVENT_CALL_SWITCH_FAILED

Connection event used to inform Telecom when a switch operation on a call has failed.

Sent via `sendConnectionEvent(java.lang.String, android.os.Bundle)`. The `Bundle` parameter is expected to be null when this connection event is used.

Constant Value: "android.telecom.event.CALL_SWITCH_FAILED"

### EVENT_MERGE_COMPLETE

    public static final String EVENT_MERGE_COMPLETE

Connection event used to inform `InCallService`s when the process of merging a Connection into a conference has completed.

Sent via `sendConnectionEvent(java.lang.String, android.os.Bundle)`. The `Bundle` parameter is expected to be null when this connection event is used.

Constant Value: "android.telecom.event.MERGE_COMPLETE"

### EVENT_MERGE_START

    public static final String EVENT_MERGE_START

Connection event used to inform `InCallService`s when the process of merging a Connection into a conference has begun.

Sent via `sendConnectionEvent(java.lang.String, android.os.Bundle)`. The `Bundle` parameter is expected to be null when this connection event is used.

Constant Value: "android.telecom.event.MERGE_START"

### EVENT_ON_HOLD_TONE_END

    public static final String EVENT_ON_HOLD_TONE_END

Connection event used to inform Telecom that it should stop the on hold tone. This is used to stop a tone when the peer puts the current call on hold. Sent to Telecom via `sendConnectionEvent(java.lang.String, android.os.Bundle)`.

Constant Value: "android.telecom.event.ON_HOLD_TONE_END"

### EVENT_ON_HOLD_TONE_START

    public static final String EVENT_ON_HOLD_TONE_START

Connection event used to inform Telecom that it should play the on hold tone. This is used to play a tone when the peer puts the current call on hold. Sent to Telecom via `sendConnectionEvent(java.lang.String, android.os.Bundle)`.

Constant Value: "android.telecom.event.ON_HOLD_TONE_START"

### EVENT_RTT_AUDIO_INDICATION_CHANGED

    public static final String EVENT_RTT_AUDIO_INDICATION_CHANGED

Connection event used to inform an `InCallService` that the RTT audio indication has changed.

Constant Value: "android.telecom.event.RTT_AUDIO_INDICATION_CHANGED"

### EXTRA_ANSWERING_DROPS_FG_CALL

    public static final String EXTRA_ANSWERING_DROPS_FG_CALL

Boolean connection extra key set on a `Connection` in `Connection#STATE_RINGING` state to indicate that answering the call will cause the current active foreground call to be dropped.

Constant Value: "android.telecom.extra.ANSWERING_DROPS_FG_CALL"

### EXTRA_ANSWERING_DROPS_FG_CALL_APP_NAME

    public static final String EXTRA_ANSWERING_DROPS_FG_CALL_APP_NAME

String connection extra key set on a `Connection` in `Connection#STATE_RINGING` state to indicate the name of the third-party app which is responsible for the current foreground call.

Used when `EXTRA_ANSWERING_DROPS_FG_CALL` is true to ensure that the default Phone app is able to inform the user that answering the new incoming call will cause a call owned by another app to be dropped when the incoming call is answered.

Constant Value: "android.telecom.extra.ANSWERING_DROPS_FG_CALL_APP_NAME"

### EXTRA_AUDIO_CODEC

    public static final String EXTRA_AUDIO_CODEC

The audio codec in use for the current `Connection`, if known. Examples of valid values include `AUDIO_CODEC_AMR_WB` and `AUDIO_CODEC_EVS_WB`.
Value is `AUDIO_CODEC_NONE`, `AUDIO_CODEC_AMR`, `AUDIO_CODEC_AMR_WB`, `AUDIO_CODEC_QCELP13K`, `AUDIO_CODEC_EVRC`, `AUDIO_CODEC_EVRC_B`, `AUDIO_CODEC_EVRC_WB`, `AUDIO_CODEC_EVRC_NW`, `AUDIO_CODEC_GSM_EFR`, `AUDIO_CODEC_GSM_FR`, `AUDIO_CODEC_GSM_HR`, `AUDIO_CODEC_G711U`, `AUDIO_CODEC_G723`, `AUDIO_CODEC_G711A`, `AUDIO_CODEC_G722`, `AUDIO_CODEC_G711AB`, `AUDIO_CODEC_G729`, `AUDIO_CODEC_EVS_NB`, `AUDIO_CODEC_EVS_SWB`, or `AUDIO_CODEC_EVS_FB`

Constant Value: "android.telecom.extra.AUDIO_CODEC"

### EXTRA_CALL_SUBJECT

    public static final String EXTRA_CALL_SUBJECT

Connection extra key used to store the subject for an incoming call. The user interface can query this extra and display its contents for incoming calls. Will only be used if the `PhoneAccount` supports the capability `PhoneAccount#CAPABILITY_CALL_SUBJECT`.

Constant Value: "android.telecom.extra.CALL_SUBJECT"

### EXTRA_CHILD_ADDRESS

    public static final String EXTRA_CHILD_ADDRESS

Connection extra key used to store a child number associated with the current connection. Used to communicate to the user interface that the connection was received via a child address (i.e. phone number) associated with the `PhoneAccount`'s primary address.

Constant Value: "android.telecom.extra.CHILD_ADDRESS"

### EXTRA_IS_RTT_AUDIO_PRESENT

    public static final String EXTRA_IS_RTT_AUDIO_PRESENT

Boolean connection extra key set on the extras passed to `Connection#sendConnectionEvent` which indicates that audio is present on the RTT call when the extra value is true.

Constant Value: "android.telecom.extra.IS_RTT_AUDIO_PRESENT"

### EXTRA_LAST_FORWARDED_NUMBER

    public static final String EXTRA_LAST_FORWARDED_NUMBER

Connection extra key used to store the last forwarded number associated with the current connection. Used to communicate to the user interface that the connection was forwarded via the specified number.

Constant Value: "android.telecom.extra.LAST_FORWARDED_NUMBER"

### EXTRA_SIP_INVITE

    public static final String EXTRA_SIP_INVITE

String Connection extra key used to store SIP invite fields for an incoming call for IMS call

Constant Value: "android.telecom.extra.SIP_INVITE"

### PROPERTY_ASSISTED_DIALING

    public static final int PROPERTY_ASSISTED_DIALING

Set by the framework to indicate that a connection is using assisted dialing.

This is used for outgoing calls.

See also:

- `TelecomManager.EXTRA_USE_ASSISTED_DIALING`

Constant Value: 512 (0x00000200)

### PROPERTY_HAS_CDMA_VOICE_PRIVACY

    public static final int PROPERTY_HAS_CDMA_VOICE_PRIVACY

Indicates that the connection has CDMA Enhanced Voice Privacy enabled.

Constant Value: 32 (0x00000020)

### PROPERTY_HIGH_DEF_AUDIO

    public static final int PROPERTY_HIGH_DEF_AUDIO

Connection is using high definition audio.

Indicates that the `Connection` is using a "high definition" audio codec. This usually implies something like AMR wideband, but the interpretation of when a call is considered high definition is left to the `ConnectionService` to decide.

Translates to `Call.Details.PROPERTY_HIGH_DEF_AUDIO`.

Constant Value: 4 (0x00000004)

### PROPERTY_IS_EXTERNAL_CALL

    public static final int PROPERTY_IS_EXTERNAL_CALL

When set, indicates that the `Connection` does not actually exist locally for the `ConnectionService`.

Consider, for example, a scenario where a user has two devices with the same phone number. When a user places a call on one devices, the telephony stack can represent that call on the other device by adding is to the `ConnectionService` with the `PROPERTY_IS_EXTERNAL_CALL` capability set.

An `ConnectionService` should not assume that all `InCallService`s will handle external connections. Only those `InCallService`s which have the `TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS` metadata set to `true` in its manifest will see external connections.

Constant Value: 16 (0x00000010)

### PROPERTY_IS_RTT

    public static final int PROPERTY_IS_RTT

Set by the framework to indicate that a connection has an active RTT session associated with it.

Constant Value: 256 (0x00000100)

### PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL

    public static final int PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL

Set by the framework to indicate that the network has identified a Connection as an emergency call.

This is used for incoming (mobile-terminated) calls to indicate the call is from emergency services.

Constant Value: 1024 (0x00000400)

### PROPERTY_SELF_MANAGED

    public static final int PROPERTY_SELF_MANAGED

Set by the framework to indicate that the `Connection` originated from a self-managed `ConnectionService`.

See `PhoneAccount#CAPABILITY_SELF_MANAGED`.

Constant Value: 128 (0x00000080)

### PROPERTY_WIFI

    public static final int PROPERTY_WIFI

Connection is using WIFI.

Used to indicate that a call is taking place over WIFI versus a carrier network.

Translates to `Call.Details.PROPERTY_WIFI`.

Constant Value: 8 (0x00000008)

### STATE_ACTIVE

    public static final int STATE_ACTIVE

A connection is active. Both parties are connected to the call and can actively communicate.

Constant Value: 4 (0x00000004)

### STATE_DIALING

    public static final int STATE_DIALING

An outgoing connection is in the dialing state. In this state the other party has not yet answered the call and the user traditionally hears a ringback tone.

Constant Value: 3 (0x00000003)

### STATE_DISCONNECTED

    public static final int STATE_DISCONNECTED

A connection has been disconnected. This is the final state once the user has been disconnected from a call either locally, remotely or by an error in the service.

Constant Value: 6 (0x00000006)

### STATE_HOLDING

    public static final int STATE_HOLDING

A connection is on hold.

Constant Value: 5 (0x00000005)

### STATE_INITIALIZING

    public static final int STATE_INITIALIZING

The connection is initializing. This is generally the first state for a `Connection` returned by a `ConnectionService`.

Constant Value: 0 (0x00000000)

### STATE_NEW

    public static final int STATE_NEW

The connection is new and not connected.

Constant Value: 1 (0x00000001)

### STATE_PULLING_CALL

    public static final int STATE_PULLING_CALL

The state of an external connection which is in the process of being pulled from a remote device to the local device.

A connection can only be in this state if the `PROPERTY_IS_EXTERNAL_CALL` property and `CAPABILITY_CAN_PULL_CALL` capability bits are set on the connection.

Constant Value: 7 (0x00000007)

### STATE_RINGING

    public static final int STATE_RINGING

An incoming connection is in the ringing state. During this state, the user's ringer or vibration feature will be activated.

Constant Value: 2 (0x00000002)

### VERIFICATION_STATUS_FAILED

    public static final int VERIFICATION_STATUS_FAILED

Indicates that verification by the network failed. This indicates there is a high likelihood that the call did not originate from a valid source.

Constant Value: 2 (0x00000002)

### VERIFICATION_STATUS_NOT_VERIFIED

    public static final int VERIFICATION_STATUS_NOT_VERIFIED

Indicates that the network could not perform verification.

Constant Value: 0 (0x00000000)

### VERIFICATION_STATUS_PASSED

    public static final int VERIFICATION_STATUS_PASSED

Indicates that verification by the network passed. This indicates there is a high likelihood that the call originated from a valid source.

Constant Value: 1 (0x00000001)

## Public constructors

### Connection

    public Connection ()

Create a new Connection.

## Public methods

### capabilitiesToString

    public static String capabilitiesToString (int capabilities)

Renders a set of capability bits (`CAPABILITY_*`) as a human readable string.

Parameters
`capabilities` | `int`: A capability bit field.

Returns
`String` | A human readable string representation.

### createCanceledConnection

    public static Connection createCanceledConnection ()

Return a `Connection` which represents a canceled connection attempt. The returned `Connection` will have state `STATE_DISCONNECTED`, and cannot be moved out of that state. This connection should not be used for anything, and no other `Connection`s should be attempted.

so users of this method need not maintain a reference to its return value to destroy it.

Returns
`Connection` | A `Connection` which indicates that the underlying connection should be canceled.

### createFailedConnection

    public static Connection createFailedConnection (DisconnectCause disconnectCause)

Return a `Connection` which represents a failed connection attempt. The returned `Connection` will have a `DisconnectCause` and as specified, and a `getState()` of `STATE_DISCONNECTED`.

The returned `Connection` can be assumed to `destroy()` itself when appropriate, so users of this method need not maintain a reference to its return value to destroy it.

Parameters
`disconnectCause` | `DisconnectCause`: The disconnect cause, ().

Returns
`Connection` | A `Connection` which indicates failure.

### destroy

    public final void destroy ()

Tears down the Connection object.

### getAddress

    public final Uri getAddress ()

Returns
`Uri` | The address (e.g., phone number) to which this Connection is currently communicating.

### getAddressPresentation

    public final int getAddressPresentation ()

Returns
`int` | The presentation requirements for the address. See `TelecomManager` for valid values.

### getAudioModeIsVoip

    public final boolean getAudioModeIsVoip ()

Returns
`boolean` | True if the connection's audio mode is VOIP.

### getCallAudioState

    public final CallAudioState getCallAudioState ()

Returns
`CallAudioState` | The audio state of the connection, describing how its audio is currently being routed by the system. This is `null` if this Connection does not directly know about its audio state.

### getCallerDisplayName

    public final String getCallerDisplayName ()

Returns
`String` | The caller display name (CNAP).

### getCallerDisplayNamePresentation

    public final int getCallerDisplayNamePresentation ()

Returns
`int` | The presentation requirements for the handle. See `TelecomManager` for valid values.

### getCallerNumberVerificationStatus

    public final int getCallerNumberVerificationStatus ()

Gets the verification status for the phone number of an incoming call as identified in ATIS-1000082.

Returns
`int` | the verification status. Value is `VERIFICATION_STATUS_NOT_VERIFIED`, `VERIFICATION_STATUS_PASSED`, or `VERIFICATION_STATUS_FAILED`

### getConference

    public final Conference getConference ()

Returns
`Conference` | The conference that this connection is a part of. Null if it is not part of any conference.

### getConferenceables

    public final List<Conferenceable> getConferenceables ()

Returns the connections or conferences with which this connection can be conferenced.

Returns
`List<Conferenceable>` |

### getConnectionCapabilities

    public final int getConnectionCapabilities ()

Returns the connection's capabilities, as a bit mask of the `CAPABILITY_*` constants.

Returns
`int` |

### getConnectionProperties

    public final int getConnectionProperties ()

Returns the connection's properties, as a bit mask of the `PROPERTY_*` constants.

Returns
`int` |

### getDisconnectCause

    public final DisconnectCause getDisconnectCause ()

Returns
`DisconnectCause` | The `DisconnectCause` for this connection.

### getExtras

    public final Bundle getExtras ()

Returns the extras associated with this connection.

Extras should be updated using `putExtras(android.os.Bundle)`.

Telecom or an `InCallService` can also update the extras via `Call.putExtras(Bundle)`, and `Call#removeExtras(List)`.

The connection is notified of changes to the extras made by Telecom or an `InCallService` by `onExtrasChanged(android.os.Bundle)`.

Returns
`Bundle` | The extras associated with this connection.

### getState

    public final int getState ()

Returns
`int` | The state of this Connection.

### getStatusHints

    public final StatusHints getStatusHints ()

Returns
`StatusHints` | The status hints for this connection.

### getVideoProvider

    public final Connection.VideoProvider getVideoProvider ()

Returns
`Connection.VideoProvider` |

### getVideoState

    public final int getVideoState ()

Returns the video state of the connection. Valid values: `VideoProfile#STATE_AUDIO_ONLY`, `VideoProfile#STATE_BIDIRECTIONAL`, `VideoProfile#STATE_TX_ENABLED`, `VideoProfile#STATE_RX_ENABLED`.

Returns
`int` | The video state of the connection. Value is either `0` or a combination of `VideoProfile.STATE_AUDIO_ONLY`, `VideoProfile.STATE_TX_ENABLED`, `VideoProfile.STATE_RX_ENABLED`, `VideoProfile.STATE_BIDIRECTIONAL`, and `VideoProfile.STATE_PAUSED`

### handleRttUpgradeResponse

    public void handleRttUpgradeResponse (Connection.RttTextStream rttTextStream)

Notifies this connection of a response to a previous remotely-initiated RTT upgrade request sent via `sendRemoteRttRequest()`. Acceptance of the request is indicated by the supplied `RttTextStream` being non-null, and rejection is indicated by `rttTextStream` being `null`

Parameters
`rttTextStream` | `Connection.RttTextStream`: The object that should be used to send text to or receive text from the in-call app. This value may be `null`.

### isRingbackRequested

    public final boolean isRingbackRequested ()

Returns whether this connection is requesting that the system play a ringback tone on its behalf.

Returns
`boolean` |

### notifyConferenceMergeFailed

    public final void notifyConferenceMergeFailed ()

Called by a `ConnectionService` to notify Telecom that a `Conference#onMerge()` request failed.

### onAbort

    public void onAbort ()

Notifies this Connection of a request to abort.

### onAnswer

    public void onAnswer (int videoState)

Notifies this Connection, which is in `STATE_RINGING`, of a request to accept.

For managed `ConnectionService`s, this will be called when the user answers a call via the default dialer's `InCallService`.

Although a self-managed `ConnectionService` provides its own incoming call UI, the Telecom framework may request that the call is answered in the following circumstances:

- The user chooses to answer an incoming call via a Bluetooth device.
- A car mode `InCallService` is in use which has declared `TelecomManager#METADATA_INCLUDE_SELF_MANAGED_CALLS` in its manifest. Such an `InCallService` will be able to see calls from self-managed `ConnectionService`s, and will be able to display an incoming call UI on their behalf.

Parameters
`videoState` | `int`: The video state in which to answer the connection.

### onAnswer

    public void onAnswer ()

Notifies this Connection, which is in `STATE_RINGING`, of a request to accept.

For managed `ConnectionService`s, this will be called when the user answers a call via the default dialer's `InCallService`.

Although a self-managed `ConnectionService` provides its own incoming call UI, the Telecom framework may request that the call is answered in the following circumstances:

- The user chooses to answer an incoming call via a Bluetooth device.
- A car mode `InCallService` is in use which has declared `TelecomManager#METADATA_INCLUDE_SELF_MANAGED_CALLS` in its manifest. Such an `InCallService` will be able to see calls from self-managed `ConnectionService`s, and will be able to display an incoming call UI on their behalf.

### onCallAudioStateChanged

    public void onCallAudioStateChanged (CallAudioState state)

Notifies this Connection that the `getCallAudioState()` property has a new value.

Parameters
`state` | `CallAudioState`: The new connection audio state.

### onCallEvent

    public void onCallEvent (String event,
                    Bundle extras)

Notifies this Connection of a `Call` event initiated from an `InCallService`.

The `InCallService` issues a Call event via `Call#sendCallEvent(String, Bundle)`.

Where possible, the Connection should make an attempt to handle `Call` events which are part of the `android.telecom.*` namespace. The Connection should ignore any events it does not wish to handle. Unexpected events should be handled gracefully, as it is possible that a `InCallService` has defined its own Call events which a Connection is not aware of.

See also `Call#sendCallEvent(String, Bundle)`.

Parameters
`event` | `String`: The call event.
`extras` | `Bundle`: Extras associated with the call event.

### onDeflect

    public void onDeflect (Uri address)

Notifies this Connection, which is in `STATE_RINGING`, of a request to deflect.

Parameters
`address` | `Uri`

### onDisconnect

    public void onDisconnect ()

Notifies this Connection of a request to disconnect.

### onExtrasChanged

    public void onExtrasChanged (Bundle extras)

Notifies this `Connection` of a change to the extras made outside the `ConnectionService`.

These extras changes can originate from Telecom itself, or from an `InCallService` via the `Call.putExtras(Bundle)` and `Call#removeExtras(List)`.

Parameters
`extras` | `Bundle`: The new extras bundle.

### onHandoverComplete

    public void onHandoverComplete ()

Notifies this `Connection` that a handover has completed.

A handover is initiated with `Call.handoverTo(PhoneAccountHandle, int, Bundle)` on the initiating side of the handover, and `TelecomManager#acceptHandover(Uri, int, PhoneAccountHandle)`.

### onHold

    public void onHold ()

Notifies this Connection of a request to hold.

### onPlayDtmfTone

    public void onPlayDtmfTone (char c)

Notifies this Connection of a request to play a DTMF tone.

Parameters
`c` | `char`: A DTMF character.

### onPostDialContinue

    public void onPostDialContinue (boolean proceed)

Notifies this Connection whether the user wishes to proceed with the post-dial DTMF codes.

Parameters
`proceed` | `boolean`

### onPullExternalCall

    public void onPullExternalCall ()

Notifies this Connection of a request to pull an external call to the local device.

The `InCallService` issues a request to pull an external call to the local device via `Call#pullExternalCall()`.

For a Connection to be pulled, both the `Connection#CAPABILITY_CAN_PULL_CALL` capability and `Connection#PROPERTY_IS_EXTERNAL_CALL` property bits must be set.

For more information on external calls, see `Connection#PROPERTY_IS_EXTERNAL_CALL`.

### onReject

    public void onReject ()

Notifies this Connection, which is in `STATE_RINGING`, of a request to reject.

For managed `ConnectionService`s, this will be called when the user rejects a call via the default dialer's `InCallService`.

Although a self-managed `ConnectionService` provides its own incoming call UI, the Telecom framework may request that the call is rejected in the following circumstances:

- The user chooses to reject an incoming call via a Bluetooth device.
- A car mode `InCallService` is in use which has declared `TelecomManager#METADATA_INCLUDE_SELF_MANAGED_CALLS` in its manifest. Such an `InCallService` will be able to see calls from self-managed `ConnectionService`s, and will be able to display an incoming call UI on their behalf.

### onReject

    public void onReject (int rejectReason)

Notifies this Connection, which is in `STATE_RINGING`, of a request to reject.

For managed `ConnectionService`s, this will be called when the user rejects a call via the default dialer's `InCallService` using `Call#reject(int)`.

Parameters
`rejectReason` | `int`: the reason the user provided for rejecting the call. Value is `Call.REJECT_REASON_DECLINED`, or `Call.REJECT_REASON_UNWANTED`

### onReject

    public void onReject (String replyMessage)

Notifies this Connection, which is in `STATE_RINGING`, of a request to reject with a message.

Parameters
`replyMessage` | `String`

### onSeparate

    public void onSeparate ()

Notifies this Connection of a request to separate from its parent conference.

### onShowIncomingCallUi

    public void onShowIncomingCallUi ()

Notifies this `Connection` that its `ConnectionService` is responsible for displaying its incoming call user interface for the `Connection`.

Will only be called for incoming calls added via a self-managed `ConnectionService` (see `PhoneAccount#CAPABILITY_SELF_MANAGED`), where the `ConnectionService` should show its own incoming call user interface.

Where there are ongoing calls in other self-managed `ConnectionService`s, or in a regular `ConnectionService`, and it is not possible to hold these other calls, the Telecom framework will display its own incoming call user interface to allow the user to choose whether to answer the new incoming call and disconnect other ongoing calls, or to reject the new incoming call.

You should trigger the display of the incoming call user interface for your application by showing a `Notification` with a full-screen `Intent` specified. In your application code, you should create a `NotificationChannel` for incoming call notifications from your app:

     NotificationChannel channel = new NotificationChannel(YOUR_CHANNEL_ID, "Incoming Calls",
              NotificationManager.IMPORTANCE_MAX);
     // other channel setup stuff goes here.

     // We'll use the default system ringtone for our incoming call notification channel.  You can
     // use your own audio resource here.
     Uri ringtoneUri = RingtoneManager.getDefaultUri(RingtoneManager.TYPE_RINGTONE);
     channel.setSound(ringtoneUri, new AudioAttributes.Builder()
              // Setting the AudioAttributes is important as it identifies the purpose of your
              // notification sound.
              .setUsage(AudioAttributes.USAGE_NOTIFICATION_RINGTONE)
              .setContentType(AudioAttributes.CONTENT_TYPE_SONIFICATION)
          .build());

     NotificationManager mgr = getSystemService(NotificationManager.class);
     mgr.createNotificationChannel(channel);

When it comes time to post a notification for your incoming call, ensure it uses your incoming call `NotificationChannel`.

         // Create an intent which triggers your fullscreen incoming call user interface.
         Intent intent = new Intent(Intent.ACTION_MAIN, null);
         intent.setFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION | Intent.FLAG_ACTIVITY_NEW_TASK);
         intent.setClass(context, YourIncomingCallActivity.class);
         PendingIntent pendingIntent = PendingIntent.getActivity(context, 1, intent, 0);

         // Build the notification as an ongoing high priority item; this ensures it will show as
         // a heads up notification which slides down over top of the current content.
         final Notification.Builder builder = new Notification.Builder(context);
         builder.setOngoing(true);
         builder.setPriority(Notification.PRIORITY_HIGH);

         // Set notification content intent to take user to fullscreen UI if user taps on the
         // notification body.
         builder.setContentIntent(pendingIntent);
         // Set full screen intent to trigger display of the fullscreen UI when the notification
         // manager deems it appropriate.
         builder.setFullScreenIntent(pendingIntent, true);

         // Setup notification content.
         builder.setSmallIcon( yourIconResourceId );
         builder.setContentTitle("Your notification title");
         builder.setContentText("Your notification content.");

         // Set notification as insistent to cause your ringtone to loop.
         Notification notification = builder.build();
         notification.flags |= Notification.FLAG_INSISTENT;

         // Use builder.addAction(..) to add buttons to answer or reject the call.
         NotificationManager notificationManager = mContext.getSystemService(
             NotificationManager.class);
         notificationManager.notify(YOUR_CHANNEL_ID, YOUR_TAG, YOUR_ID, notification);

### onSilence

    public void onSilence ()

Notifies this Connection of a request to silence the ringer.

The ringer may be silenced by any of the following methods:

- `TelecomManager#silenceRinger()`
- The user presses the volume-down button while a call is ringing.

Self-managed `ConnectionService` implementations should override this method in their `Connection` implementation and implement logic to silence their app's ringtone. If your app set the ringtone as part of the incoming call `Notification` (see `onShowIncomingCallUi()`), it should re-post the notification now, except call `Notification.Builder.setOnlyAlertOnce(boolean)` with `true`. This will ensure the ringtone sound associated with your `NotificationChannel` stops playing.

### onStartRtt

    public void onStartRtt (Connection.RttTextStream rttTextStream)

Notifies this `Connection` that the user has requested an RTT session. The connection service should call `sendRttInitiationSuccess()` or `sendRttInitiationFailure(int)` to inform Telecom of the success or failure of the request, respectively.

Parameters
`rttTextStream` | `Connection.RttTextStream`: The object that should be used to send text to or receive text from the in-call app. This value cannot be `null`.

### onStateChanged

    public void onStateChanged (int state)

Notifies this Connection of an internal state change. This method is called after the state is changed.

Parameters
`state` | `int`: The new state, one of the `STATE_*` constants.

### onStopDtmfTone

    public void onStopDtmfTone ()

Notifies this Connection of a request to stop any currently playing DTMF tones.

### onStopRtt

    public void onStopRtt ()

Notifies this `Connection` that it should terminate any existing RTT communication channel. No response to Telecom is needed for this method.

### onUnhold

    public void onUnhold ()

Notifies this Connection of a request to exit a hold state.

### propertiesToString

    public static String propertiesToString (int properties)

Renders a set of property bits (`PROPERTY_*`) as a human readable string.

Parameters
`properties` | `int`: A property bit field.

Returns
`String` | A human readable string representation.

### putExtras

    public final void putExtras (Bundle extras)

Adds some extras to this `Connection`. Existing keys are replaced and new ones are added.

No assumptions should be made as to how an In-Call UI or service will handle these extras. Keys should be fully qualified (e.g., com.example.MY_EXTRA) to avoid conflicts.

Parameters
`extras` | `Bundle`: The extras to add. This value cannot be `null`.

### removeExtras

    public final void removeExtras (String... keys)

Removes extras from this `Connection`.

Parameters
`keys` | `String`: The keys of the extras to remove.

### removeExtras

    public final void removeExtras (List<String> keys)

Removes extras from this `Connection`.

Parameters
`keys` | `List`: The keys of the extras to remove.

### requestBluetoothAudio

    public void requestBluetoothAudio (BluetoothDevice bluetoothDevice)

Request audio routing to a specific bluetooth device. Calling this method may result in the device routing audio to a different bluetooth device than the one specified if the bluetooth stack is unable to route audio to the requested device. A list of available devices can be obtained via `CallAudioState#getSupportedBluetoothDevices()`

Used by self-managed `ConnectionService`s which wish to use bluetooth audio for a self-managed `Connection` (see `PhoneAccount#CAPABILITY_SELF_MANAGED`.)

See also `InCallService#requestBluetoothAudio(BluetoothDevice)`

Parameters
`bluetoothDevice` | `BluetoothDevice`: The bluetooth device to connect to. This value cannot be `null`.

### sendConnectionEvent

    public void sendConnectionEvent (String event,
                    Bundle extras)

Sends an event associated with this `Connection` with associated event extras to the `InCallService`.

Connection events are used to communicate point in time information from a `ConnectionService` to a `InCallService` implementations. An example of a custom connection event includes notifying the UI when a WIFI call has been handed over to LTE, which the InCall UI might use to inform the user that billing charges may apply. The Android Telephony framework will send the `EVENT_CALL_MERGE_FAILED` connection event when a call to `Call#mergeConference()` has failed to complete successfully. A connection event could also be used to trigger UI in the `InCallService` which prompts the user to make a choice (e.g. whether they want to incur roaming costs for making a call), which is communicated back via `Call#sendCallEvent(String, Bundle)`.

Events are exposed to `InCallService` implementations via `Call.Callback#onConnectionEvent(Call, String, Bundle)`.

No assumptions should be made as to how an In-Call UI or service will handle these events. The `ConnectionService` must assume that the In-Call UI could even chose to ignore some events altogether.

Events should be fully qualified (e.g. `com.example.event.MY_EVENT`) to avoid conflicts between `ConnectionService` implementations. Further, custom `ConnectionService` implementations shall not re-purpose events in the `android.*` namespace, nor shall they define new event types in this namespace. When defining a custom event type, ensure the contents of the extras `Bundle` is clearly defined. Extra keys for this bundle should be named similar to the event type (e.g. `com.example.extra.MY_EXTRA`).

When defining events and the associated extras, it is important to keep their behavior consistent when the associated `ConnectionService` is updated. Support for deprecated events/extras should me maintained to ensure backwards compatibility with older `InCallService` implementations which were built to support the older behavior.

Parameters
`event` | `String`: The connection event.
`extras` | `Bundle`: Optional bundle containing extra information associated with the event.

### sendRemoteRttRequest

    public final void sendRemoteRttRequest ()

Informs listeners that the remote side of the call has requested an upgrade to include an RTT session in the call.

### sendRttInitiationFailure

    public final void sendRttInitiationFailure (int reason)

Informs listeners that a previously requested RTT session via `ConnectionRequest#isRequestingRtt()` or `onStartRtt(android.telecom.Connection.RttTextStream)` has failed.

Parameters
`reason` | `int`: One of the reason codes defined in `RttModifyStatus`, with the exception of `RttModifyStatus#SESSION_MODIFY_REQUEST_SUCCESS`.

### sendRttInitiationSuccess

    public final void sendRttInitiationSuccess ()

Informs listeners that a previously requested RTT session via `ConnectionRequest#isRequestingRtt()` or `onStartRtt(android.telecom.Connection.RttTextStream)` has succeeded.

### sendRttSessionRemotelyTerminated

    public final void sendRttSessionRemotelyTerminated ()

Informs listeners that a currently active RTT session has been terminated by the remote side of the coll.

### setActive

    public final void setActive ()

Sets state to active (e.g., an ongoing connection where two or more parties can actively communicate).

### setAddress

    public final void setAddress (Uri address,
                    int presentation)

Sets the value of the `getAddress()` property.

Parameters
`address` | `Uri`: The new address.
`presentation` | `int`: The presentation requirements for the address. See `TelecomManager` for valid values.

### setAudioModeIsVoip

    public final void setAudioModeIsVoip (boolean isVoip)

Requests that the framework use VOIP audio mode for this connection.

Parameters
`isVoip` | `boolean`: True if the audio mode is VOIP.

### setAudioRoute

    public final void setAudioRoute (int route)

Sets the audio route (speaker, bluetooth, etc...). When this request is honored, there will be change to the `getCallAudioState()`.

Used by self-managed `ConnectionService`s which wish to change the audio route for a self-managed `Connection` (see `PhoneAccount#CAPABILITY_SELF_MANAGED`.)

See also `InCallService#setAudioRoute(int)`.

Parameters
`route` | `int`: The audio route to use (one of `CallAudioState#ROUTE_BLUETOOTH`, `CallAudioState#ROUTE_EARPIECE`, `CallAudioState#ROUTE_SPEAKER`, or `CallAudioState#ROUTE_WIRED_HEADSET`).

### setCallerDisplayName

    public final void setCallerDisplayName (String callerDisplayName,
                    int presentation)

Sets the caller display name (CNAP).

Parameters
`callerDisplayName` | `String`: The new display name.
`presentation` | `int`: The presentation requirements for the handle. See `TelecomManager` for valid values.

### setCallerNumberVerificationStatus

    public final void setCallerNumberVerificationStatus (int callerNumberVerificationStatus)

Sets the verification status for the phone number of an incoming call as identified in ATIS-1000082.

This property can only be set at the time of creation of a `Connection` being returned by `ConnectionService#onCreateIncomingConnection(PhoneAccountHandle, ConnectionRequest)`.

Parameters
`callerNumberVerificationStatus` | `int`: Value is `VERIFICATION_STATUS_NOT_VERIFIED`, `VERIFICATION_STATUS_PASSED`, or `VERIFICATION_STATUS_FAILED`

### setConferenceableConnections

    public final void setConferenceableConnections (List<Connection> conferenceableConnections)

Sets the connections with which this connection can be conferenced.

Parameters
`conferenceableConnections` | `List`: The set of connections this connection can conference with.

### setConferenceables

    public final void setConferenceables (List<Conferenceable> conferenceables)

Similar to `setConferenceableConnections(java.util.List)`, sets a list of connections or conferences with which this connection can be conferenced.

Parameters
`conferenceables` | `List`: The conferenceables.

### setConnectionCapabilities

    public final void setConnectionCapabilities (int connectionCapabilities)

Sets the connection's capabilities as a bit mask of the `CAPABILITY_*` constants.

Parameters
`connectionCapabilities` | `int`: The new connection capabilities.

### setConnectionProperties

    public final void setConnectionProperties (int connectionProperties)

Sets the connection's properties as a bit mask of the `PROPERTY_*` constants.

Parameters
`connectionProperties` | `int`: The new connection properties.

### setDialing

    public final void setDialing ()

Sets state to dialing (e.g., dialing an outbound connection).

### setDisconnected

    public final void setDisconnected (DisconnectCause disconnectCause)

Sets state to disconnected.

Parameters
`disconnectCause` | `DisconnectCause`: The reason for the disconnection, as specified by `DisconnectCause`.

### setExtras

    public final void setExtras (Bundle extras)

Set some extras that can be associated with this `Connection`.

New or existing keys are replaced in the `Connection` extras. Keys which are no longer in the new extras, but were present the last time `setExtras` was called are removed.

Alternatively you may use the `putExtras(android.os.Bundle)`, and `removeExtras(java.lang.String)` methods to modify the extras.

No assumptions should be made as to how an In-Call UI or service will handle these extras. Keys should be fully qualified (e.g., com.example.MY_EXTRA) to avoid conflicts.

Parameters
`extras` | `Bundle`: The extras associated with this `Connection`. This value may be `null`.

### setInitialized

    public final void setInitialized ()

Sets state to initialized (the Connection has been set up and is now ready to be used).

### setInitializing

    public final void setInitializing ()

Sets state to initializing (this Connection is not yet ready to be used).

### setNextPostDialChar

    public final void setNextPostDialChar (char nextChar)

Informs listeners that this `Connection` has processed a character in the post-dial started state. This is done when (a) the `Connection` is issuing a DTMF sequence; and (b) it wishes to signal Telecom to play the corresponding DTMF tone locally.

Parameters
`nextChar` | `char`: The DTMF character that was just processed by the `Connection`.

### setOnHold

    public final void setOnHold ()

Sets state to be on hold.

### setPostDialWait

    public final void setPostDialWait (String remaining)

Informs listeners that this `Connection` is in a post-dial wait state. This is done when (a) the `Connection` is issuing a DTMF sequence; (b) it has encountered a "wait" character; and (c) it wishes to inform the In-Call app that it is waiting for the end-user to send an `onPostDialContinue(boolean)` signal.

Parameters
`remaining` | `String`: The DTMF character sequence remaining to be emitted once the `onPostDialContinue(boolean)` is received, including any "wait" characters that remaining sequence may contain.

### setPulling

    public final void setPulling ()

Sets state to pulling (e.g. the connection is being pulled to the local device from another device). Only applicable for `Connection`s with `Connection#PROPERTY_IS_EXTERNAL_CALL` and `Connection#CAPABILITY_CAN_PULL_CALL`.

### setRingbackRequested

    public final void setRingbackRequested (boolean ringback)

Requests that the framework play a ringback tone. This is to be invoked by implementations that do not play a ringback tone themselves in the connection's audio stream.

Parameters
`ringback` | `boolean`: Whether the ringback tone is to be played.

### setRinging

    public final void setRinging ()

Sets state to ringing (e.g., an inbound ringing connection).

### setStatusHints

    public final void setStatusHints (StatusHints statusHints)

Sets the label and icon status to display in the in-call UI.

Parameters
`statusHints` | `StatusHints`: The status label and icon to set.

### setVideoProvider

    public final void setVideoProvider (Connection.VideoProvider videoProvider)

Sets the video connection provider.

Parameters
`videoProvider` | `Connection.VideoProvider`: The video provider.

### setVideoState

    public final void setVideoState (int videoState)

Set the video state for the connection. Valid values: `VideoProfile#STATE_AUDIO_ONLY`, `VideoProfile#STATE_BIDIRECTIONAL`, `VideoProfile#STATE_TX_ENABLED`, `VideoProfile#STATE_RX_ENABLED`.

Parameters
`videoState` | `int`: The new video state.

### stateToString

    public static String stateToString (int state)

Parameters
`state` | `int`: An integer value of a `STATE_*` constant.

Returns
`String` | A string representation of the value.

Full name *
Email address *
Company / developer name
One of your Play Store app URLs *
Which best describes your business:*
Apps
Games
Apps & Games
*
*