DirectCall

User Role of Direct Call

• Cases:

  • caller: The user who made the call.
  • callee: The user who received the call.

Call ID of the call. This value is generated from our Sendbird server and is String representation of a UUID

The UUID form of callId. Useful when dealing with CallKit.

The caller object.

The callee object.

Custom items of the DirectCall.

The remote user of the call.

guard let remoteUser = self.call.remoteUser else { return }
self.remoteUserIdLabel.text = remoteUser.userId

The local user of the call.

guard let localUser = self.call.localUser else { return }
self.localUserIdLabel.text = localUser.userId

The role of the current user.

Presents DirectCallLog instance that is a history of the call. The value is nil before the call is ended. The value just after ending can be different from the value after syncing with the server.

User that ended the call. Only exists for ended calls.

End Result of the ended call.

Boolean value indicating whether the call has ended.

Boolean value indicating whether the call is ongoing.

The start time of call. Int64 of miliseconds.

The ended time of call. Int64 of miliseconds.

The duration of the call. Int64 of miliseconds.

The audio status of the remote user.

The audio status of the local user.

The local SendBirdVideoView. This is a read-only property. If you want to update value, use updateLocalVideo(_:)

The remote SendBirdVideoView. This is a read-only property. If you want to update value, use updateRemoteVideo(_:)

The diplaying status of the local user.

The displaying staus of the remote user.

Indicates whether the call is on hold by either a callee or a caller, or by both.

Boolean value indicating whether the call supports video call. If false, the call is for audio only. The default value is false.

DirectCallDelegate for this call. DirectCall will notify this delegate for any call-specific events.

call.delegate?.someMethod()

Boolean value indicating whether the call is currently being recorded.

Value indicating the local recording status of the call.

Value indicating the remote recording status of the call.

Indicates whether the local user’s screen is being shared.

Accepts the incoming direct call. SendBirdCalls will continue to process the call with the server.

• Tag: accept(with)

Ends the call. DirectCallDelegate.didEnd(call:) delegate method will be called after successful ending. This delegate will also be called when the remote user ends the call.

// End a call
call.end();

// receives the event
class MyClass: DirectCallDelegate {
    ...
    func didEnd(_ call: DirectCall) {
        //
    }
    ...
}

Ends the call. This method has a closeHandler that is called when the end message is successfully sent to the server.

func provider(_ provider: CXProvider, perform action: CXEndCallAction) {
  // After Authenticating...

  // End the call
  call.end {
      action.fulfill()
  };
}

Holds the active call.

Removes the hold that you put on a call.

Mutes the audio of local user. Will trigger DirectCallDelegate.didRemoteAudioSettingsChange() delegate method of the remote user. If the remote user changes their audio settings, local user will be notified via same delegate method.

// mute my microphone
call.muteMicrophone();

// receives the event
class MyClass: DirectCallDelegate {
    ...
    func didRemoteAudioSettingsChange(_ call: DirectCall) {
        if (call.isRemoteAudioEnabled) {
            // The peer has been unmuted.
        } else {
            // The peer has been muted.
        }
    }
    ...
}

Unmutes the audio of local user. Will trigger DirectCallDelegate.didRemoteAudioSettingsChange() delegate method of the remote user. If the remote user changes their audio settings, local user will be notified via same delegate method.

// unmute my microphone
call.unmuteMicrophone();

// receives the event
class MyClass: DirectCallDelegate {
    ...
    func didRemoteAudioSettingsChange(_ call: DirectCall) {
        if (call.isRemoteAudioEnabled) {
            // The peer has been unmuted.
        } else {
            // The peer has been muted.
        }
    }
    ...
}

Updates custom items of the call.

Deletes custom items of the call.

Deletes all custom items of the call.

The hash value of DirectCall.

Returns a Boolean value that indicates whether the DirectCall and a given object are equal.

Returns a copied instance of the DirectCall.

Starts a media recording session of a direct call. Only one ongoing recording session is allowed.

let options = RecordingOptions(recordingType: .localRemoteAudios, directoryPath: FileManager.default.getDocumentsDirectory())

call.startRecording(options: options) { recorderId, error in
    if let id = recorderId {
        // Recording successfully started
    }
}

Stops a media recording session with the specified recordingId, and depending on the result of the recording, calls the didSaveRecording method of a SendBirdRecordingDelegate.

call.stopRecording(recorderId: recorderId)

Starts screen share of the local user. Used with Apple’s ReplayKit.

let recorder = RPScreenRecorder.shared()

call.startScreenShare { (bufferHandler, error) in
   guard error == nil else { return }

   recorder.startCapture { (buffer, bufferType, error) in
       bufferHandler?(buffer, error)
   } completionHandler: { (error) in
       guard error == nil else { return } // Handle error
       // Successfully started screen share
   }
}

Stops screen share of the local user.

RPScreenRecorder.stopCapture should be called before calling this method.

let recorder = RPScreenRecorder.shared()
...
recorder.stopCapture { (error) in
    self.call.stopScreenShare()
}

Starts local video. If the callee changes video settings, the caller is notified via the DirectCallDelegate.didRemoteVideoSettingsChange() delegate.

// Start my local video
call.startVideo()

// receives the event
class MyClass: DirectCallDelegate {
    ...
    func didRemoteVideoSettingsChange(_ call: DirectCall) {
        if (call.isRemoteVideoEnabled) {
            // The peer has been unmuted.
        } else {
            // The peer has been muted.
        }
    }
    ...
}

Stops local video. If the callee changes video settings, the caller is notified via the DirectCallDelegate.didRemoteVideoSettingsChange() delegate.

// Stop my local video
call.stopVideo()

// receives the event
class MyClass: DirectCallDelegate {
    ...
    func didRemoteVideoSettingsChange(_ call: DirectCall) {
        if (call.isRemoteVideoEnabled) {
            // The peer has been unmuted.
        } else {
            // The peer has been muted.
        }
    }
    ...
}

Updates local SendBirdVideoView

• Tag: updateLocalVideoView(_)

Updates remote SendBirdVideoView

• Tag: updateRemoteVideoView(_)

List of available video devices that support video capture.

Current video device using with capture device.

Changes current video device asynchronously and notifies callback on completion.

Toggles the selection between the front and the back camera.

func flipCamera(call: DirectCall) {
   call.switchCamera { error in
       // do something when error has occurred.
   }
}

Takes a snapshot of remote video view.

self.call.captureRemoteVideoView { [weak self] (image, error) in
    if let error = error {
       // error handling.
       return
    }
    self?.snapshotImageView.image = image
}

Takes a snapshot of local video view.

self.call.captureLocalVideoView { [weak self] (image, error) in
    if let error = error {
       // error handling.
       return
    }
    self?.snapshotImageView.image = image
}