VoiceCall

public protocol VoiceCall : AnyObject

The call object interface.

Properties

uuid
The unique local identifier. It is used for CallKit reporting.
Declaration
Swift

var uuid: UUID { get }
callId
The remote call identifier. The empty string is set for outgoing call.
Declaration
Swift

var callId: String { get }
state
The state of call object (connected, disconnected, etc). The client may adopt VoiceCallStateObserverProtocol and subscribe for changes.
Declaration
Swift

var state: VoiceCallState { get }
type
The type of the call - voip or pstn.
Declaration
Swift

var type: CallType { get }
direction
The direction of the call - inbound or outbound.
Declaration
Swift

var direction: CallDirection { get }
startTime
The locally assigned timestamp. It indicates the moment when call is registered by platform.
Declaration
Swift

var startTime: UInt { get }
deactivatedTime
The locally assigned timestamp. It is set on call disconnect.
Declaration
Swift

var deactivatedTime: UInt { get }
connectionQuality
The connection quality indicator. It is driven by information coming from Voice Stack. The client may adopt VoiceCallConnectionQualityObserverProtocol and subscribe for changes.
Declaration
Swift

var connectionQuality: CallConnectionQuality { get }
muted
The state of the microphone. The client may change the microphone state by modifying this property.
Declaration
Swift

var muted: CallMutedState { get set }
context
It contains the information provided by the platform in the push notification payload. The nil is set for outgoing call.
Declaration
Swift

var context: IncomingCallContext? { get }
contact
It describes the remote peer on the call.
Declaration
Swift

var contact: Contact? { get }
callFailedReason
It describes the reason for call fail.
Declaration
Swift

var callFailedReason: CallFailedReason? { get }

Callbacks


                    
                    
                    stateChangedCallback

It is invoked on call state change.

Declaration

Swift

var stateChangedCallback: VoiceCallStateChangedCallback? { get set }


                    
                    
                    connectionQualityChangedCallback

It is invoked on connection qulity change.

Declaration

Swift

var connectionQualityChangedCallback: VoiceCallConnectionQualityChangedCallback? { get set }


                    
                    
                    mutedStateChangedCallback

It is invoked on microphone state change.

Declaration

Swift

var mutedStateChangedCallback: VoiceCallMutedStateChangedCallback? { get set }

Functions


                    
                    
                    hangup(_:)

It hangs up the call.

Declaration

Swift

func hangup(_ completion: ((CallActionCompletionStatus) -> Void)?)


                    
                    
                    hold(_:)

It puts the call on hold.

Declaration

Swift

func hold(_ completion: ((CallActionCompletionStatus) -> Void)?)


                    
                    
                    resume(_:)

It resumes the call (unhold).

Declaration

Swift

func resume(_ completion: ((CallActionCompletionStatus) -> Void)?)

Notifications

addObserver(_:)
It registers observer object.
Declaration
Swift

func addObserver(_ observer: AnyObject)
removeObserver(_:)
It removes the observer object registration.
Declaration
Swift

func removeObserver(_ observer: AnyObject)