Host

class Host : Serializable, LiveEventUser

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

Since

1.0.0

Properties

connectedAt

var connectedAt: Long?

Timestamp when the host was connected to the live event.

disconnectedAt

var disconnectedAt: Long?

Timestamp when the host was disconnected from the live event.

duration

val duration: Long

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

enteredAt

var enteredAt: Long?

Timestamp when the host entered the live event.

exitedAt

var exitedAt: Long?

Timestamp when the host exited the live event.

hostId

var hostId: String

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

isAudioOn

var isAudioOn: Boolean

Indicates whether the host has turned on their audio.

isVideoOn

var isVideoOn: Boolean

Indicates whether the host has turned on their video.

liveEventId

var liveEventId: String

The unique ID of the live event.

liveEventUserId

open override val liveEventUserId: String

nickname

var nickname: String

The nickname of the user.

profileURL

var profileURL: String

The profile image of the user.

rtmpStream

var rtmpStream: RTMPStreamData?

state

var state: HostState

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

streamType

var streamType: StreamType

userId

var userId: String

The unique ID of the user.