State

enum State

Call state.

Entries

Link copied to clipboard

Default/initial state; call state cannot be determined.

Link copied to clipboard

Outgoing call: INVITE sent, waiting for provisional response.

Link copied to clipboard

Outgoing call: remote party is ringing (180 Ringing received).

Link copied to clipboard

Outgoing call: called party is busy (486 response). Terminal, Failed.

Link copied to clipboard

Incoming call: user answered, media setup in progress.

Link copied to clipboard

Incoming call: protocol-level setup in progress, user has not answered.

Link copied to clipboard

Incoming call: alerting the user (ringing locally). This is the initial state for pushed incoming calls received from SIPIS.

Link copied to clipboard

Incoming call: user explicitly ignored the call on call screen or silenced the ringer.

Link copied to clipboard

Incoming call: user explicitly rejected. Terminal.

Link copied to clipboard

Incoming call: caller hung up or timed out before user answered. Terminal.

Link copied to clipboard

Call connected: signaling/media session established; actual media may be muted/on hold/one-way.

Link copied to clipboard

Call failed due to RTP, transport, or logic error. Terminal, Failed.

Link copied to clipboard

Authentication with server failed. Terminal, Failed.

Link copied to clipboard

Call ended normally (BYE exchanged or clean hangup). Terminal.

Link copied to clipboard

Incoming call: forwarded to another destination by user. Terminal.

Link copied to clipboard

Incoming call: answered on another device (same account). Terminal.

Link copied to clipboard

Outgoing call: server redirected to alternative service (3xx/location). Terminal.

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
open fun getLabel(): String
Get label for this state.
Link copied to clipboard
open fun isFailed(): Boolean
open fun isFailed(@NonNull state: Call.State): Boolean
Check if the call state is failed.
Link copied to clipboard
open fun isTerminal(): Boolean
open fun isTerminal(@NonNull state: Call.State): Boolean
Check if the call state is terminal.
Link copied to clipboard
open fun valueOf(name: String): Call.State

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard
open fun values(): Array<Call.State>

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.