/*
* Copyright 2014, The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.server.telecom;
import android.telecom.TelecomProtoEnums;
/**
* Defines call-state constants of the different states in which a call can exist. Although states
* have the notion of normal transitions, due to the volatile nature of telephony systems, code
* that uses these states should be resilient to unexpected state changes outside of what is
* considered traditional.
*/
public final class CallState {
private CallState() {}
/**
* Indicates that a call is new and not connected. This is used as the default state internally
* within Telecom and should not be used between Telecom and call services. Call services are
* not expected to ever interact with NEW calls, but {@link android.telecom.InCallService}s will
* see calls in this state.
*/
public static final int NEW = TelecomProtoEnums.NEW; // = 0
/**
* The initial state of an outgoing {@code Call}.
* Common transitions are to {@link #DIALING} state for a successful call or
* {@link #DISCONNECTED} if it failed.
*/
public static final int CONNECTING = TelecomProtoEnums.CONNECTING; // = 1
/**
* The state of an outgoing {@code Call} when waiting on user to select a
* {@link android.telecom.PhoneAccount} through which to place the call.
*/
public static final int SELECT_PHONE_ACCOUNT = TelecomProtoEnums.SELECT_PHONE_ACCOUNT; // = 2
/**
* Indicates that a call is outgoing and in the dialing state. A call transitions to this state
* once an outgoing call has begun (e.g., user presses the dial button in Dialer). Calls in this
* state usually transition to {@link #ACTIVE} if the call was answered or {@link #DISCONNECTED}
* if the call was disconnected somehow (e.g., failure or cancellation of the call by the user).
*/
public static final int DIALING = TelecomProtoEnums.DIALING; // = 3
/**
* Indicates that a call is incoming and the user still has the option of answering, rejecting,
* or doing nothing with the call. This state is usually associated with some type of audible
* ringtone. Normal transitions are to {@link #ACTIVE} if answered or {@link #DISCONNECTED}
* otherwise.
*/
public static final int RINGING = TelecomProtoEnums.RINGING; // = 4
/**
* Indicates that a call is currently connected to another party and a communication channel is
* open between them. The normal transition to this state is by the user answering a
* {@link #DIALING} call or a {@link #RINGING} call being answered by the other party.
*/
public static final int ACTIVE = TelecomProtoEnums.ACTIVE; // = 5
/**
* Indicates that the call is currently on hold. In this state, the call is not terminated
* but no communication is allowed until the call is no longer on hold. The typical transition
* to this state is by the user putting an {@link #ACTIVE} call on hold by explicitly performing
* an action, such as clicking the hold button.
*/
public static final int ON_HOLD = TelecomProtoEnums.ON_HOLD; // = 6
/**
* Indicates that a call is currently disconnected. All states can transition to this state
* by the call service giving notice that the connection has been severed. When the user
* explicitly ends a call, it will not transition to this state until the call service confirms
* the disconnection or communication was lost to the call service currently responsible for
* this call (e.g., call service crashes).
*/
public static final int DISCONNECTED = TelecomProtoEnums.DISCONNECTED; // = 7
/**
* Indicates that the call was attempted (mostly in the context of outgoing, at least at the
* time of writing) but cancelled before it was successfully connected.
*/
public static final int ABORTED = TelecomProtoEnums.ABORTED; // = 8
/**
* Indicates that the call is in the process of being disconnected and will transition next
* to a {@link #DISCONNECTED} state.
*
* This state is not expected to be communicated from the Telephony layer, but will be reported
* to the InCall UI for calls where disconnection has been initiated by the user but the
* ConnectionService has confirmed the call as disconnected.
*/
public static final int DISCONNECTING = TelecomProtoEnums.DISCONNECTING; // = 9
/**
* Indicates that the call is in the process of being pulled to the local device.
*
* This state should only be set on a call with
* {@link android.telecom.Connection#PROPERTY_IS_EXTERNAL_CALL} and
* {@link android.telecom.Connection#CAPABILITY_CAN_PULL_CALL}.
*/
public static final int PULLING = TelecomProtoEnums.PULLING; // = 10
/**
* Indicates that an incoming call has been answered by the in-call UI, but Telephony hasn't yet
* set the call to active.
*/
public static final int ANSWERED = TelecomProtoEnums.ANSWERED; // = 11
/**
* Indicates that the call is undergoing audio processing by a different app in the background.
* @see android.telecom.Call#STATE_AUDIO_PROCESSING
*/
public static final int AUDIO_PROCESSING = TelecomProtoEnums.AUDIO_PROCESSING; // = 12
/**
* Indicates that the call is in a fake ringing state.
* @see android.telecom.Call#STATE_SIMULATED_RINGING
*/
public static final int SIMULATED_RINGING = TelecomProtoEnums.SIMULATED_RINGING; // = 13
/**
* Determines if a given call state is "transitory". A transitory call state is one which a
* call should only be in for a short duration of time before lower levels move it to a more
* permanent stable state.
*
* It is tempting to consider {@link #DIALING}, for example, to be transitory, however the time
* spent in this state is entirely dependent on how long the call is actually in that state and
* it is expected a call can be {@link #DIALING} for potentially a minute or more.
* @param callState the state to check
* @return {@code true} if the state is transitory, {@code false} otherwise.
*/
public static boolean isTransitoryState(int callState) {
switch (callState) {
case NEW:
case CONNECTING:
case DISCONNECTING:
case ANSWERED:
return true;
default:
return false;
}
}
/**
* Determines if a given call state is "intermediate". An intermediate call state may exist
* before a stable call state, but may be longer than a transitory state.
*
* @param callState the state to check
* @return {@code true} if the state is intermediate, {@code false} otherwise.
*/
public static boolean isIntermediateState(int callState) {
switch (callState) {
case DIALING:
case RINGING:
return true;
default:
return false;
}
}
public static String toString(int callState) {
switch (callState) {
case NEW:
return "NEW";
case CONNECTING:
return "CONNECTING";
case SELECT_PHONE_ACCOUNT:
return "SELECT_PHONE_ACCOUNT";
case DIALING:
return "DIALING";
case RINGING:
return "RINGING";
case ACTIVE:
return "ACTIVE";
case ON_HOLD:
return "ON_HOLD";
case DISCONNECTED:
return "DISCONNECTED";
case ABORTED:
return "ABORTED";
case DISCONNECTING:
return "DISCONNECTING";
case PULLING:
return "PULLING";
case ANSWERED:
return "ANSWERED";
case AUDIO_PROCESSING:
return "AUDIO_PROCESSING";
case SIMULATED_RINGING:
return "SIMULATED_RINGING";
default:
return "UNKNOWN";
}
}
}