Classes

The following classes are available globally.

  • Options for configuring the call.

    Since

    1.0.0
    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCCallOptions)
public class CallOptions : NSObject
    extension CallOptions: NSCopying

  • Undocumented

    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCChatOptions)
public class SendBirdChatOptions : NSObject, Codable

  • Parameter for accepting incoming call from another user. Contains initial configurations for the call.

    Since

    1.0.0
    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCAcceptParams)
public class AcceptParams : NSObject

  • Parameter for dialing another user. Contains initial configurations for the call.

    Since

    1.0.0
    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCDialParams)
public class DialParams : NSObject
    extension DialParams: NSCopying

  • A device for capture video.

    func flipCamera(call: DirectCall) {

   let current = call.currentVideoDevice
   let devices = call.availableVideoDevices

   guard let device = devices.first(where: { $0.position != current?.position }) else { return }

   call.selectVideoDevice(device) { error in
       // do something when error has occurred.
   }
}

    Since

    1.0.0
    • Tag: VideoDevice
    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCVideoDevice)
public class VideoDevice : NSObject

  • Custom Error class for SendBirdCalls. Subclass of NSError.

    Since

    1.0.0
    See more

    Declaration

    Swift

    @objc
public class SBCError : NSError

  • Configuration for authentication of SendBird user.

    Since

    1.0.0
    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCAuthenticateParams)
public class AuthenticateParams : NSObject

  • A Int64 Range with half-open interval from a lower bound up to, but not including, an upper bound. Default value is Int64.min..<Int64.max.

    Since

    1.7.0
    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCRange)
public class SendBirdRange : NSObject

  • Since

    1.0.0
    See more

    Declaration

    Swift

    @objc
public class SBCLogger : NSObject

  • DirectCall class for a call between two participants. Every call is identified with a unique key.

    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCDirectCall)
public class DirectCall : NSObject, SBTimerBoardDelegate, CallContextDataSource
    extension DirectCall: NSCopying

  • Direct Call Log containing information about a direct call.

    Since

    1.0.0
    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCDirectCallLog)
public class DirectCallLog : NSObject, Codable

  • A user’s call history is available via a DirectCallLogListQuery instance.

    let params = DirectCallLogListQuery.Params()
let query = SendBirdCall.createDirectCallLogListQuery(with: params)

query.next { callLogs, error in
    //
}

    Since

    1.0.0
    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCDirectCallLogListQuery)
public class DirectCallLogListQuery : NSObject

  • SendBirdCall

    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCSendBirdCall)
public class SendBirdCall : NSObject

  • Recording option that is used when starting a recording session.

    Since

    1.3.0
    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCRecordingOptions)
public class RecordingOptions : NSObject

  • A class that provides the enter(), exit(), and other methods, which handle information about the room and operate with other types of objects such as a participant.

    Since

    1.6.0
    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCRoom)
public class Room : NSObject, RoomDataSource, RoomSender

  • A class that provides information for creating a new room

    Since

    1.6.0
    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCRoomParams)
public class RoomParams : NSObject, Encodable

  • A class that contains all operational methods of a local participant to handle their audio and video.

    Note

    LocalParticipant contains all properties of Participant

    Since

    1.6.0

    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCLocalParticipant)
public class LocalParticipant : Participant

  • A class that provides information about a participant and methods to set a participant’s audio and video.

    Since

    1.6.0
    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCParticipant)
public class Participant : NSObject, Codable

  • A class that contains all operational methods of a remote participant.

    Since

    1.6.0

    Note

    RemoteParticipant contains all properties of Participant

    Declaration

    Swift

    @objc(SBCRemoteParticipant)
public class RemoteParticipant : Participant

  • A class that is used to query Rooms.

    Since

    1.7.0
    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCRoomListQuery)
public class RoomListQuery : NSObject

  • User class specific for direct call.

    Since

    1.0.0
    See more

    Declaration

    Swift

    @objc(SBCDirectCallUser)
public class DirectCallUser : User

  • Class for SendBirdCalls User.

    Since

    1.0.0
    See more

    Declaration

    Swift

    @objc(SBCUser)
public class User : NSObject, Codable
    extension User: NSCopying

  • Video renderring view. Add to your UIView to show video.

    @IBOutlet weak var localVideoView: UIView?
@IBOutlet weak var remoteVideoView: UIView?

...

 let localSBView = SendBirdVideoView(frame: self.localVideoView?.frame ?? CGRect.zero)
 let remoteSBView = SendBirdVideoView(frame: self.remoteVideoView?.frame ?? CGRect.zero)

 self.call.updateLocalVideoView(localSBView)
 self.call.updateRemoteVideoView(remoteSBView)

// When you make a call or accept an incoming call.
let callOptions = CallOptions(
                   isAudioEnabled = true,
                   isVideoEnabled = true,
                   localVideoView: localSBVideoView
                   remoteVideoView: remoteSBVideoView)

// Or when update local / remote view
self.call.updateLocalVideoView(localSBView)
self.call.updateRemoteVideoView(remoteSBView)

    Since

    1.0.0
    • Tag: SendBirdVideoView
    See more

  • Video renderring view. Add to your UIView to show video.

    @IBOutlet weak var localVideoView: UIView?
@IBOutlet weak var remoteVideoView: UIView?

...

 let localSBView = SendBirdVideoView(frame: self.localVideoView?.frame ?? CGRect.zero)
 let remoteSBView = SendBirdVideoView(frame: self.remoteVideoView?.frame ?? CGRect.zero)

 self.call.updateLocalVideoView(localSBView)
 self.call.updateRemoteVideoView(remoteSBView)

// When you make a call or accept an incoming call.
let callOptions = CallOptions(
                   isAudioEnabled = true,
                   isVideoEnabled = true,
                   localVideoView: localSBVideoView
                   remoteVideoView: remoteSBVideoView)

// Or when update local / remote view
self.call.updateLocalVideoView(localSBView)
self.call.updateRemoteVideoView(remoteSBView)

    Since

    1.0.0
    • Tag: SendBirdVideoView
    See more

    Declaration

    Swift

    @objcMembers
@objc(SBCVideoView)
public class SendBirdVideoView : RTCEAGLVideoView