Added in API level 34

Summary: Methods | Inherited Methods

CallControl

Kotlin |Java

public final class CallControl
extends Object

java.lang.Object
↳	android.telecom.CallControl

CallControl provides client side control of a call. Each Call will get an individual CallControl instance in which the client can alter the state of the associated call. Outgoing and incoming calls should move to active (via CallControl.setActive(Executor, OutcomeReceiver) or answered (via CallControl.answer(int, Executor, OutcomeReceiver) before 60 seconds. If the new call is not moved to active or answered before 60 seconds, the call will be disconnected.

Each method is Transactional meaning that it can succeed or fail. If a transaction succeeds, the OutcomeReceiver.onResult will be called by Telecom. Otherwise, the OutcomeReceiver.onError is called and provides a CallException that details why the operation failed.

Summary

Public methods
`void`	`answer(int videoState, Executor executor, OutcomeReceiver<Void, CallException> callback)` Request Telecom answer an incoming call.
`void`	`disconnect(DisconnectCause disconnectCause, Executor executor, OutcomeReceiver<Void, CallException> callback)` Request Telecom disconnect the call and remove the call from telecom tracking.
`ParcelUuid`	`getCallId()`
`void`	`requestCallEndpointChange(CallEndpoint callEndpoint, Executor executor, OutcomeReceiver<Void, CallException> callback)` Request a CallEndpoint change.
`void`	`requestMuteState(boolean isMuted, Executor executor, OutcomeReceiver<Void, CallException> callback)` Request a new mute state.
`void`	`requestVideoState(int videoState, Executor executor, OutcomeReceiver<Void, CallException> callback)` Request a new video state for the ongoing call.
`void`	`sendEvent(String event, Bundle extras)` Raises an event to the `InCallService` implementations tracking this call via `Call.Callback.onConnectionEvent(Call, String, Bundle)`.
`void`	`setActive(Executor executor, OutcomeReceiver<Void, CallException> callback)` Request Telecom set the call state to active.
`void`	`setInactive(Executor executor, OutcomeReceiver<Void, CallException> callback)` Request Telecom set the call state to inactive.
`void`	`startCallStreaming(Executor executor, OutcomeReceiver<Void, CallException> callback)` Request start a call streaming session.

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 timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

answer

Added in API level 34

public void answer (int videoState, 
                Executor executor, 
                OutcomeReceiver<Void, CallException> callback)

Request Telecom answer an incoming call. For outgoing calls and calls that have been placed on hold, use CallControl.setActive(Executor, OutcomeReceiver).

Parameters
`videoState`	`int`: to report to Telecom. Telecom will store VideoState in the event another service/device requests it in order to continue the call on another screen. Value is `CallAttributes.AUDIO_CALL`, or `CallAttributes.VIDEO_CALL`
`executor`	`Executor`: The `Executor` on which the `OutcomeReceiver` callback will be called on. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread. This value cannot be `null`.
`callback`	`OutcomeReceiver`: that will be completed on the Telecom side that details success or failure of the requested operation. `OutcomeReceiver.onResult` will be called if Telecom has successfully switched the call state to active `OutcomeReceiver.onError` will be called if Telecom has failed to set the call state to active. A `CallException` will be passed that details why the operation failed. This value cannot be `null`.

disconnect

Added in API level 34

public void disconnect (DisconnectCause disconnectCause, 
                Executor executor, 
                OutcomeReceiver<Void, CallException> callback)

Request Telecom disconnect the call and remove the call from telecom tracking.

Parameters

Parameters
`disconnectCause`	`DisconnectCause`: represents the cause for disconnecting the call. The only valid codes for the `DisconnectCause` passed in are: `DisconnectCause.LOCAL` `DisconnectCause.REMOTE` `DisconnectCause.REJECTED` `DisconnectCause.MISSED` This value cannot be `null`.
`executor`	`Executor`: The `Executor` on which the `OutcomeReceiver` callback will be called on. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread. This value cannot be `null`.
`callback`	`OutcomeReceiver`: That will be completed on the Telecom side that details success or failure of the requested operation. `OutcomeReceiver.onResult` will be called if Telecom has successfully disconnected the call. `OutcomeReceiver.onError` will be called if Telecom has failed to disconnect the call. A `CallException` will be passed that details why the operation failed. Note: After the call has been successfully disconnected, calling any CallControl API will result in the `OutcomeReceiver.onError` with `CallException.CODE_CALL_IS_NOT_BEING_TRACKED`. This value cannot be `null`.

disconnectCause

DisconnectCause: represents the cause for disconnecting the call. The only valid codes for the DisconnectCause passed in are:

This value cannot be null.

executor

Executor: The Executor on which the OutcomeReceiver callback will be called on. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread. This value cannot be null.

callback

OutcomeReceiver: That will be completed on the Telecom side that details success or failure of the requested operation. OutcomeReceiver.onResult will be called if Telecom has successfully disconnected the call. OutcomeReceiver.onError will be called if Telecom has failed to disconnect the call. A CallException will be passed that details why the operation failed.

Note: After the call has been successfully disconnected, calling any CallControl API will result in the OutcomeReceiver.onError with CallException.CODE_CALL_IS_NOT_BEING_TRACKED. This value cannot be null.

getCallId

Added in API level 34

public ParcelUuid getCallId ()

Returns
`ParcelUuid`	the callId Telecom assigned to this CallControl object which should be attached to an individual call. This value cannot be `null`.

requestCallEndpointChange

Added in API level 34

public void requestCallEndpointChange (CallEndpoint callEndpoint, 
                Executor executor, 
                OutcomeReceiver<Void, CallException> callback)

Request a CallEndpoint change. Clients should not define their own CallEndpoint when requesting a change. Instead, the new endpoint should be one of the valid endpoints provided by CallEventCallback.onAvailableCallEndpointsChanged(List).

Parameters
`callEndpoint`	`CallEndpoint`: The `CallEndpoint` to change to. This value cannot be `null`.
`executor`	`Executor`: The `Executor` on which the `OutcomeReceiver` callback will be called on. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread. This value cannot be `null`.
`callback`	`OutcomeReceiver`: The `OutcomeReceiver` that will be completed on the Telecom side that details success or failure of the requested operation. `OutcomeReceiver.onResult` will be called if Telecom has successfully changed the CallEndpoint that was requested. `OutcomeReceiver.onError` will be called if Telecom has failed to switch to the requested CallEndpoint. A `CallException` will be passed that details why the operation failed. This value cannot be `null`.

requestMuteState

Added in API level 35

public void requestMuteState (boolean isMuted, 
                Executor executor, 
                OutcomeReceiver<Void, CallException> callback)

Request a new mute state. Note: CallEventCallback.onMuteStateChanged(boolean) will be called every time the mute state is changed and can be used to track the current mute state.

Parameters
`isMuted`	`boolean`: The new mute state. Passing in a `Boolean.TRUE` for the isMuted parameter will mute the call. `Boolean.FALSE` will unmute the call.
`executor`	`Executor`: The `Executor` on which the `OutcomeReceiver` callback will be called on. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread. This value cannot be `null`.
`callback`	`OutcomeReceiver`: The `OutcomeReceiver` that will be completed on the Telecom side that details success or failure of the requested operation. `OutcomeReceiver.onResult` will be called if Telecom has successfully changed the mute state. `OutcomeReceiver.onError` will be called if Telecom has failed to switch to the mute state. A `CallException` will be passed that details why the operation failed. This value cannot be `null`.

requestVideoState

Added in API level 35

public void requestVideoState (int videoState, 
                Executor executor, 
                OutcomeReceiver<Void, CallException> callback)

Request a new video state for the ongoing call. This can only be changed if the application has registered a PhoneAccount with the PhoneAccount.CAPABILITY_SUPPORTS_VIDEO_CALLING and set the CallAttributes.SUPPORTS_VIDEO_CALLING when adding the call via TelecomManager.addCall(CallAttributes, Executor, OutcomeReceiver, CallControlCallback, CallEventCallback)

Parameters
`videoState`	`int`: to report to Telecom. To see the valid argument to pass, see `ERROR(CallAttributes.CallType/android.telecom.CallAttributes.CallType CallAttributes.CallType)`. Value is `CallAttributes.AUDIO_CALL`, or `CallAttributes.VIDEO_CALL`
`executor`	`Executor`: The `Executor` on which the `OutcomeReceiver` callback will be called on. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread. This value cannot be `null`.
`callback`	`OutcomeReceiver`: that will be completed on the Telecom side that details success or failure of the requested operation. `OutcomeReceiver.onResult` will be called if Telecom has successfully switched the video state. `OutcomeReceiver.onError` will be called if Telecom has failed to set the new video state. A `CallException` will be passed that details why the operation failed. This value cannot be `null`.

Throws
`IllegalArgumentException`	if the argument passed for videoState is invalid. To see a list of valid states, see `ERROR(CallAttributes.CallType/android.telecom.CallAttributes.CallType CallAttributes.CallType)`.

sendEvent

Added in API level 34

public void sendEvent (String event, 
                Bundle extras)

Raises an event to the InCallService implementations tracking this call via Call.Callback.onConnectionEvent(Call, String, Bundle). These events and the associated extra keys for the Bundle parameter are mutually defined by a VoIP application and InCallService. This API is used to relay additional information about a call other than what is specified in the CallAttributes to InCallServices. This might include, for example, a change to the list of participants in a meeting, or the name of the speakers who have their hand raised. Where appropriate, the InCallServices tracking this call may choose to render this additional information about the call. An automotive calling UX, for example may have enough screen real estate to indicate the number of participants in a meeting, but to prevent distractions could suppress the list of participants.

Parameters
`event`	`String`: a string event identifier agreed upon between a VoIP application and an `InCallService` This value cannot be `null`.
`extras`	`Bundle`: a `Bundle` containing information about the event, as agreed upon between a VoIP application and `InCallService`. This value cannot be `null`.

setActive

Added in API level 34

public void setActive (Executor executor, 
                OutcomeReceiver<Void, CallException> callback)

Request Telecom set the call state to active. This method should be called when either an outgoing call is ready to go active or a held call is ready to go active again. For incoming calls that are ready to be answered, use CallControl.answer(int, Executor, OutcomeReceiver).

Parameters

Parameters
`executor`	`Executor`: The `Executor` on which the `OutcomeReceiver` callback will be called on. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread. This value cannot be `null`.
`callback`	`OutcomeReceiver`: that will be completed on the Telecom side that details success or failure of the requested operation. `OutcomeReceiver.onResult` will be called if Telecom has successfully switched the call state to active `OutcomeReceiver.onError` will be called if Telecom has failed to set the call state to active. A `CallException` will be passed that details why the operation failed. This value cannot be `null`.

executor

callback

OutcomeReceiver: that will be completed on the Telecom side that details success or failure of the requested operation. OutcomeReceiver.onResult will be called if Telecom has successfully switched the call state to active OutcomeReceiver.onError will be called if Telecom has failed to set the call state to active. A CallException will be passed that details why the operation failed. This value cannot be null.

setInactive

Added in API level 34

public void setInactive (Executor executor, 
                OutcomeReceiver<Void, CallException> callback)

Request Telecom set the call state to inactive. This the same as hold for two call endpoints but can be extended to setting a meeting to inactive.

Parameters

Parameters
`executor`	`Executor`: The `Executor` on which the `OutcomeReceiver` callback will be called on. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread. This value cannot be `null`.
`callback`	`OutcomeReceiver`: that will be completed on the Telecom side that details success or failure of the requested operation. `OutcomeReceiver.onResult` will be called if Telecom has successfully switched the call state to inactive `OutcomeReceiver.onError` will be called if Telecom has failed to set the call state to inactive. A `CallException` will be passed that details why the operation failed. This value cannot be `null`.

executor

callback

OutcomeReceiver: that will be completed on the Telecom side that details success or failure of the requested operation. OutcomeReceiver.onResult will be called if Telecom has successfully switched the call state to inactive OutcomeReceiver.onError will be called if Telecom has failed to set the call state to inactive. A CallException will be passed that details why the operation failed. This value cannot be null.

startCallStreaming

Added in API level 34

public void startCallStreaming (Executor executor, 
                OutcomeReceiver<Void, CallException> callback)

Request start a call streaming session. On receiving valid request, telecom will bind to the CallStreamingService implemented by a general call streaming sender. So that the call streaming sender can perform streaming local device audio to another remote device and control the call during streaming.

Parameters

Parameters
`executor`	`Executor`: The `Executor` on which the `OutcomeReceiver` callback will be called on. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread. This value cannot be `null`.
`callback`	`OutcomeReceiver`: that will be completed on the Telecom side that details success or failure of the requested operation. `OutcomeReceiver.onResult` will be called if Telecom has successfully started the call streaming. `OutcomeReceiver.onError` will be called if Telecom has failed to start the call streaming. A `CallException` will be passed that details why the operation failed. This value cannot be `null`.

executor

callback

OutcomeReceiver: that will be completed on the Telecom side that details success or failure of the requested operation. OutcomeReceiver.onResult will be called if Telecom has successfully started the call streaming. OutcomeReceiver.onError will be called if Telecom has failed to start the call streaming. A CallException will be passed that details why the operation failed. This value cannot be null.