Host

public class Host : Codable, LiveUser

A class that provides general information about a host in a live event.

Since

1.0.0

  • The unique ID of the host. Host ID is generated each time the user enters a live event as a host.

    Since

    1.0.0

    Declaration

    Swift

    public let hostId: String

  • The unique ID of the user.

    Since

    1.0.0

    Declaration

    Swift

    public let userId: String

  • The nickname of the user

    Since

    1.0.0

    Declaration

    Swift

    public internal(set) var nickname: String? { get }

  • The profile image URL of the user

    Since

    1.0.0

    Declaration

    Swift

    public internal(set) var profileURL: String? { get }

  • Timestamp when the host entered the live event.

    Since

    1.0.0

    Declaration

    Swift

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

  • Timestamp when the host was connected to the live event.

    Since

    1.0.0

    Declaration

    Swift

    public internal(set) var connectedAt: Int64? { get }

  • Timestamp when the host was disconnected from the live event.

    Since

    1.0.0

    Declaration

    Swift

    public internal(set) var disconnectedAt: Int64? { get }

  • Timestamp when the host exited the live event.

    Since

    1.0.0

    Declaration

    Swift

    public internal(set) var exitedAt: Int64? { get }

  • The period from the time when the host entered the live event to the time the host exited the live event.

    Since

    1.0.0

    Declaration

    Swift

    public var duration: Int64 { get }

  • The state of the host. Valid values are the following: entered, connected, disconnected, and exited.

    Since

    1.0.0

    Declaration

    Swift

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

  • Indicates whether the host has turned on their audio.

    Since

    1.0.0

    Declaration

    Swift

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

  • Indicates whether the host has turned on their video.

    Since

    1.0.0

    Declaration

    Swift

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

  • The unique ID of the live event.

    Since

    1.0.0

    Declaration

    Swift

    public let liveEventId: String

  • Declaration

    Swift

    public required init(from decoder: Decoder) throws

  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws

  • An enum that provides information about the states of a host.

    Since

    1.0.0
    See more

    Declaration

    Swift

    public enum State : String, Codable