CallState

public enum CallState : Equatable

CallState represents the state of the call

  • NEW

    New call has been created in the client.

    Declaration

    Swift

    case NEW

  • The outbound call is being sent to the server.

    Declaration

    Swift

    case CONNECTING

  • Call is pending to be answered. Someone is attempting to call you.

    Declaration

    Swift

    case RINGING

  • Call is active when two clients are fully connected.

    Declaration

    Swift

    case ACTIVE

  • Call has been held.

    Declaration

    Swift

    case HELD

  • Call has ended.

    Declaration

    Swift

    case DONE(reason: CallTerminationReason? = nil)

  • The active call is being recovered. Usually after a network switch or bad network

    Declaration

    Swift

    case RECONNECTING(reason: Reason)

  • The active call is dropped. Usually when the network is lost.

    Declaration

    Swift

    case DROPPED(reason: Reason)

  • Enum to represent reasons for reconnection or call drop.

    See more

    Declaration

    Swift

    public enum Reason : String

  • Helper function to get the reason for the state (if applicable).

    Declaration

    Swift

    public func getReason() -> String?

  • Declaration

    Swift

    public static func == (lhs: CallState, rhs: CallState) -> Bool

  • Returns true if the call is considered active (ACTIVE or HELD states)

    Declaration

    Swift

    var isConsideredActive: Bool { get }

  • Returns the string representation of the enum case.

    Declaration

    Swift

    var value: String { get }