CallDelegate

public protocol CallDelegate : AnyObject
  • onDtmfReceived(call:dtmf:) Default implementation

    Callback for being notified of received DTMFs.

    Default Implementation

    Declaration

    Swift

    func onDtmfReceived(call: Call, dtmf: Int)

    Parameters

    call

    LinphoneCall object that received the dtmf
    dtmf

    The ascii code of the dtmf
  • onGoclearAckSent(call:) Default implementation

    GoClear ACK sent callback.

    Default Implementation

    Declaration

    Swift

    func onGoclearAckSent(call: Call)

    Parameters

    call

    the LinphoneCall on which the GoClear ACK was sent.

  • Call encryption changed callback.

    Default Implementation

    Declaration

    Swift

    func onEncryptionChanged(call: Call, on: Bool, authenticationToken: String)

    Parameters

    call

    LinphoneCall object whose encryption is changed.
    on

    Whether encryption is activated.
    authenticationToken

    An authentication_token, currently set for ZRTP kind of encryption only.

  • Call send master key changed callback.

    Default Implementation

    Declaration

    Swift

    func onSendMasterKeyChanged(call: Call, sendMasterKey: String)

    Parameters

    call

    LinphoneCall object whose encryption is changed.

  • Call receive master key changed callback.

    Default Implementation

    Declaration

    Swift

    func onReceiveMasterKeyChanged(call: Call, receiveMasterKey: String)

    Parameters

    call

    LinphoneCall object whose encryption is changed.
  • onInfoMessageReceived(call:message:) Default implementation

    Callback for receiving info messages.

    Default Implementation

    Declaration

    Swift

    func onInfoMessageReceived(call: Call, message: InfoMessage)

    Parameters

    call

    LinphoneCall whose info message belongs to.
    message

    LinphoneInfoMessage object.
  • onStateChanged(call:state:message:) Default implementation

    Call state notification callback.

    Default Implementation

    Declaration

    Swift

    func onStateChanged(call: Call, state: Call.State, message: String)

    Parameters

    call

    LinphoneCall whose state is changed.
    state

    The new LinphoneCallState of the call
    message

    An informational message about the state.
  • onStatsUpdated(call:stats:) Default implementation

    Callback for receiving quality statistics for calls.

    Default Implementation

    Declaration

    Swift

    func onStatsUpdated(call: Call, stats: CallStats)

    Parameters

    call

    LinphoneCall object whose statistics are notified
    stats

    LinphoneCallStats object
  • onTransferStateChanged(call:state:) Default implementation

    Callback for notifying progresses of transfers.

    Default Implementation

    Declaration

    Swift

    func onTransferStateChanged(call: Call, state: Call.State)

    Parameters

    call

    LinphoneCall that was transfered
    state

    The LinphoneCallState of the call to transfer target at the far end.
  • onAckProcessing(call:ack:isReceived:) Default implementation

    Callback for notifying the processing SIP ACK messages.

    Default Implementation

    Declaration

    Swift

    func onAckProcessing(call: Call, ack: Headers, isReceived: Bool)

    Parameters

    call

    LinphoneCall for which an ACK is being received or sent
    ack

    the ACK LinphoneHeaders
    isReceived

    if true this ACK is an incoming one, otherwise it is an ACK about to be sent.

  • Callback for notifying a received TMMBR.

    Default Implementation

    Declaration

    Swift

    func onTmmbrReceived(call: Call, streamIndex: Int, tmmbr: Int)

    Parameters

    call

    LinphoneCall for which the TMMBR has changed
    streamIndex

    the index of the current stream
    tmmbr

    the value of the received TMMBR
  • onSnapshotTaken(call:filePath:) Default implementation

    Callback for notifying a snapshot taken.

    Default Implementation

    Declaration

    Swift

    func onSnapshotTaken(call: Call, filePath: String)

    Parameters

    call

    LinphoneCall for which the snapshot was taken
    filePath

    the name of the saved file
  • onNextVideoFrameDecoded(call:) Default implementation

    Callback to notify a next video frame has been decoded.

    Default Implementation

    Declaration

    Swift

    func onNextVideoFrameDecoded(call: Call)

    Parameters

    call

    LinphoneCall for which the next video frame has been decoded
  • onCameraNotWorking(call:cameraName:) Default implementation

    Callback to notify that the camera is not working and has been changed to “No Webcam”. A camera is detected as mis-functionning as soon as it outputs no frames at all during a period of 5 seconds. This check is only performed on desktop platforms, in the purpose of notifying camera failures, for example if when a usb cable gets disconnected.

    Default Implementation

    Declaration

    Swift

    func onCameraNotWorking(call: Call, cameraName: String)

    Parameters

    call

    LinphoneCall for which the next video frame has been decoded

    cameraName

    the name of the non-working camera

  • Callback to notify that there are errors from the video rendering. The error code depends of the implementation.

    Default Implementation

    Declaration

    Swift

    func onVideoDisplayErrorOccurred(call: Call, errorCode: Int)

    Parameters

    call

    LinphoneCall
    errorCode

    error code from render. It depends of the renderer.

  • Callback to notify that the audio device has been changed.

    Default Implementation

    Declaration

    Swift

    func onAudioDeviceChanged(call: Call, audioDevice: AudioDevice)

    Parameters

    call

    LinphoneCall for which the audio device has changed
    audioDevice

    the new audio device used for this call
  • onRemoteRecording(call:recording:) Default implementation

    Callback to notify that the call is being recorded by the remote.

    Default Implementation

    Declaration

    Swift

    func onRemoteRecording(call: Call, recording: Bool)

    Parameters

    call

    LinphoneCall for which the audio is recorded
    recording

    true if the call is being recorded by the remote, false otherwise