public class CallPeerState
extends java.lang.Object
Though not mandatory CallPeerState would generally have one of the following life cycles
In the case with your grand mother that we just described we have:
INITIATING_CALL -> CONNECTING -> ALERTING_REMOTE_USER -> CONNECTED -> DISCONNECTED
If your granny was already on the phone we have:
INITIATING_CALL -> CONNECTING -> BUSY -> DISCONNECTED
Whenever someone tries to reach you:
INCOMING_CALL -> CONNECTED -> DISCONNECTED
A FAILED state is prone to appear at any place in the above diagram and is generally followed by a disconnected state.
Information on call peer is shown in the phone user interface until they enter the DISCONNECTED state. At that point call peer information is automatically removed from the user interface and the call is considered terminated.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
_ALERTING_REMOTE_SIDE
This constant value indicates a String representation of the
ALERTING_REMOTE_SIDE call state.
|
static java.lang.String |
_BUSY
This constant value indicates a String representation of the BUSY
call state.
|
static java.lang.String |
_CONNECTED
This constant value indicates a String representation of the CONNECTED
call state.
|
static java.lang.String |
_CONNECTING
This constant value indicates a String representation of the CONNECTING
call state.
|
static java.lang.String |
_CONNECTING_WITH_EARLY_MEDIA
This constant value indicates a String representation of the CONNECTING
call state but in cases where early media is being exchanged.
|
static java.lang.String |
_DISCONNECTED
This constant value indicates a String representation of the DISCONNECTED
call state.
|
static java.lang.String |
_FAILED
This constant value indicates a String representation of the FAILED
call state.
|
static java.lang.String |
_INCOMING_CALL
This constant value indicates a String representation of the
INCOMING_CALL call state.
|
static java.lang.String |
_INITIATING_CALL
This constant value indicates a String representation of the
INITIATING_CALL call state.
|
static java.lang.String |
_ON_HOLD_LOCALLY
The constant value being a String representation of the ON_HOLD_LOCALLY
call peer state.
|
static java.lang.String |
_ON_HOLD_MUTUALLY
The constant value being a String representation of the ON_HOLD_MUTUALLY
call peer state.
|
static java.lang.String |
_ON_HOLD_REMOTELY
The constant value being a String representation of the ON_HOLD_REMOTELY
call peer state.
|
static java.lang.String |
_REFERRED
This constant value indicates a String representation of the REFERRED
call state.
|
static java.lang.String |
_UNKNOWN
This constant value indicates a String representation of the UNKNOWN
call state.
|
static CallPeerState |
ALERTING_REMOTE_SIDE
This constant value indicates that the state of the call peer is
is ALERTING_REMOTE_SIDE - which means that a network connection to that
peer has been established and peer's phone is currently alerting the
remote user of the current call.
|
static CallPeerState |
BUSY
This constant value indicates that the state of the call peer is
is BUSY - which means that an attempt to establish a call with that
peer has been made and that it has been turned down by them (e.g.
|
static CallPeerState |
CONNECTED
This constant value indicates that the state of the call peer is
is CONNECTED - which means that there is an ongoing call with that
peer.
|
static CallPeerState |
CONNECTING
This constant value indicates that the state of the call peer is
CONNECTING - which means that a network connection to that peer
is currently being established.
|
static CallPeerState |
CONNECTING_INCOMING_CALL
This constant value indicates that the state of the incoming call peer
is CONNECTING - which means that a network connection to that peer
is currently being established.
|
static CallPeerState |
CONNECTING_INCOMING_CALL_WITH_MEDIA
This constant value indicates that the state of the incoming call peer
is CONNECTING - which means that a network connection to that peer
is currently being established and during the process before hearing
the other peer we can still can hear media coming from the
server for example.
|
static CallPeerState |
CONNECTING_WITH_EARLY_MEDIA
This constant value indicates that the state of the call peer is
CONNECTING - which means that a network connection to that peer
is currently being established.
|
static CallPeerState |
DISCONNECTED
This constant value indicates that the state of the call peer is
is DISCONNECTED - which means that this peer is not participating :)
in the call any more.
|
static CallPeerState |
FAILED
This constant value indicates that the state of the call peer is
is ON_HOLD - which means that an attempt to establish a call with that
peer has failed for an unexpected reason.
|
static CallPeerState |
INCOMING_CALL
This constant value indicates that the state of the call peer is
is INCOMING_CALL - which means that the peer is willing to start
a call with us.
|
static CallPeerState |
INITIATING_CALL
This constant value indicates that the state of the call peer is
is INITIATING_CALL - which means that we're currently trying to open a
socket and send our request.
|
static CallPeerState |
ON_HOLD_LOCALLY
The constant value indicating that the state of a call peer is
locally put on hold.
|
static CallPeerState |
ON_HOLD_MUTUALLY
The constant value indicating that the state of a call peer is
mutually - locally and remotely - put on hold.
|
static CallPeerState |
ON_HOLD_REMOTELY
The constant value indicating that the state of a call peer is
remotely put on hold.
|
static CallPeerState |
REFERRED
This constant value indicates that the state of the call peer is
is REFERRED - which means that this peer has transfered us to another
peer.
|
static CallPeerState |
UNKNOWN
This constant value indicates that the state of the call peer is
is UNKNOWN - which means that there is no information on the state for
the time being (this constant should be used as a default value for
newly created call peer that don't yet have an attributed call
state.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getLocalizedStateString()
Returns a localized String representation of the CallPeerState.
|
java.lang.String |
getStateString()
Returns a String representation of the CallPeerState.
|
static boolean |
isOnHold(CallPeerState state)
Determines whether a specific CallPeerState value
signal a call hold regardless of the issuer (which may be local and/or
remote).
|
java.lang.String |
toString()
Returns a string representation of this call state.
|
public static final java.lang.String _UNKNOWN
public static final CallPeerState UNKNOWN
public static final java.lang.String _INITIATING_CALL
public static final CallPeerState INITIATING_CALL
public static final java.lang.String _CONNECTING
public static final CallPeerState CONNECTING
public static final java.lang.String _CONNECTING_WITH_EARLY_MEDIA
public static final CallPeerState CONNECTING_WITH_EARLY_MEDIA
public static final CallPeerState CONNECTING_INCOMING_CALL
public static final CallPeerState CONNECTING_INCOMING_CALL_WITH_MEDIA
public static final java.lang.String _ALERTING_REMOTE_SIDE
public static final CallPeerState ALERTING_REMOTE_SIDE
public static final java.lang.String _INCOMING_CALL
public static final CallPeerState INCOMING_CALL
public static final java.lang.String _CONNECTED
public static final CallPeerState CONNECTED
public static final java.lang.String _DISCONNECTED
public static final CallPeerState DISCONNECTED
public static final java.lang.String _REFERRED
public static final CallPeerState REFERRED
public static final java.lang.String _BUSY
public static final CallPeerState BUSY
public static final java.lang.String _FAILED
public static final CallPeerState FAILED
public static final java.lang.String _ON_HOLD_LOCALLY
This constant has the String value "Locally On Hold".
public static final CallPeerState ON_HOLD_LOCALLY
public static final java.lang.String _ON_HOLD_MUTUALLY
This constant has the String value "Mutually On Hold".
public static final CallPeerState ON_HOLD_MUTUALLY
public static final java.lang.String _ON_HOLD_REMOTELY
This constant has the String value "Remotely On Hold".
public static final CallPeerState ON_HOLD_REMOTELY
public static final boolean isOnHold(CallPeerState state)
state
- the CallPeerState value to be checked
whether it signals a call holdpublic java.lang.String getStateString()
public java.lang.String getLocalizedStateString()
public java.lang.String toString()
toString
in class java.lang.Object
Jitsi, the OpenSource Java VoIP and Instant Messaging client.
Distributable under Apache license.