Participant

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

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

Since

1.6.0

  • A unique identifier for a participant in a room.

    Since

    1.6.0

    Declaration

    Swift

    public let participantId: String

  • Indicates a user in Calls who corresponds to the participant.

    Since

    1.6.0

    Declaration

    Swift

    public let user: User

  • The participant’s SendBirdVideoView.

    Since

    1.6.0

    Declaration

    Swift

    weak public var videoView: SendBirdVideoView? { get set }

  • The timestamp of when the participant enter the room, in Unix milliseconds.

    Since

    1.6.0

    Declaration

    Swift

    public private(set) var enteredAt: Int64 { get }

  • The timestamp of when the participant information was updated within the room, in Unix milliseconds.

    Since

    1.6.0

    Declaration

    Swift

    public private(set) var updatedAt: Int64 { get }

  • The timestamp of when the participant exited the room, in Unix milliseconds. If the value is 0, it means the participant is present in the room.

    Since

    1.6.0

    Declaration

    Swift

    public private(set) var exitedAt: Int64 { get }

  • The period from the time when the participant entered the room to the time the participant left the room, measured in seconds. If the value is 0, it means the participant is present in the room.

    Since

    1.6.0

    Declaration

    Swift

    public private(set) var duration: Int64 { get }

  • The state of the participant. Valid values are entered, exited, and connected.

    Since

    1.6.0

    Declaration

    Swift

    public internal(set) var state: State { get }

  • Indicates whether the participant has enabled their audio.

    Since

    1.6.0

    Declaration

    Swift

    public internal(set) var isAudioEnabled: Bool { get }

  • Indicates whether the participant has enabled their video.

    Since

    1.6.0

    Declaration

    Swift

    public internal(set) var isVideoEnabled: Bool { get }

  • A enum that provides information about the state of a participant.

    Since

    1.6.0
    See more

    Declaration

    Swift

    @objc(SBCParticipantState)
public enum State : Int, RawRepresentable, Codable

  • Declaration

    Swift

    required public init(from decoder: Decoder) throws

  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws

Equatable

  • The hash value of Participant.

    Declaration

    Swift

    public override var hash: Int { get }

  • Undocumented

    Declaration

    Swift

    public override func isEqual(_ object: Any?) -> Bool