Class LiveEvent

A class that provides methods for a host and participants to stream and receive media during a live event.

Hierarchy

EventTarget<LiveEventEventMap>
- LiveEvent

Constructors

constructor

new LiveEvent(__namedParameters: LiveEventParams): LiveEvent
Parameters
- __namedParameters: LiveEventParams
Returns LiveEvent

Overrides EventTarget.constructor

Properties

`Protected` _listeners

_listeners: { disconnected?: EventListener<{ args: [LiveEvent, Error] }>[]; hostConnected?: EventListener<{ args: [LiveEvent, Host] }>[]; hostDisconnected?: EventListener<{ args: [LiveEvent, Host] }>[]; hostEntered?: EventListener<{ args: [LiveEvent, Host] }>[]; hostExited?: EventListener<{ args: [LiveEvent, Host] }>[]; hostMutedAudio?: EventListener<{ args: [LiveEvent, Host] }>[]; hostStartedVideo?: EventListener<{ args: [LiveEvent, Host] }>[]; hostStoppedVideo?: EventListener<{ args: [LiveEvent, Host] }>[]; hostUnmutedAudio?: EventListener<{ args: [LiveEvent, Host] }>[]; liveEventEnded?: EventListener<{ args: [LiveEvent] }>[]; liveEventReady?: EventListener<{ args: [LiveEvent] }>[]; liveEventStarted?: EventListener<{ args: [LiveEvent] }>[]; participantEntered?: EventListener<{ args: [LiveEvent, Participant] }>[]; participantExited?: EventListener<{ args: [LiveEvent, Participant] }>[] } = {}

Type declaration

Optional disconnected?: EventListener<{ args: [LiveEvent, Error] }>[]
Optional hostConnected?: EventListener<{ args: [LiveEvent, Host] }>[]
Optional hostDisconnected?: EventListener<{ args: [LiveEvent, Host] }>[]
Optional hostEntered?: EventListener<{ args: [LiveEvent, Host] }>[]
Optional hostExited?: EventListener<{ args: [LiveEvent, Host] }>[]
Optional hostMutedAudio?: EventListener<{ args: [LiveEvent, Host] }>[]
Optional hostStartedVideo?: EventListener<{ args: [LiveEvent, Host] }>[]
Optional hostStoppedVideo?: EventListener<{ args: [LiveEvent, Host] }>[]
Optional hostUnmutedAudio?: EventListener<{ args: [LiveEvent, Host] }>[]
Optional liveEventEnded?: EventListener<{ args: [LiveEvent] }>[]
Optional liveEventReady?: EventListener<{ args: [LiveEvent] }>[]
Optional liveEventStarted?: EventListener<{ args: [LiveEvent] }>[]
Optional participantEntered?: EventListener<{ args: [LiveEvent, Participant] }>[]
Optional participantExited?: EventListener<{ args: [LiveEvent, Participant] }>[]

createdAt

createdAt: number

The timestamp of when the live event was created, in miliseconds.

createdBy

createdBy: string

User ID of the user that created the live event.

cumulativeParticipantCount

cumulativeParticipantCount: number

The sum of all participants that entered and exited a live event.

currentLiveUser

currentLiveUser: Participant

customItems

customItems: Record<string, any>

A unique key-value pair of information stored in a live event.

duration

duration: number

The period from the time when the live event was created to the time the live event was ended.

endedAt

endedAt: number

The timestamp of when the live event was ended, in miliseconds.

endedBy

endedBy: string

User ID of the user that ended the live event.

host

host: Host

Host of the live event.

isHostStreaming

isHostStreaming: boolean

Indicates whether the host is streaming media.

liveEventId

liveEventId: string

Unique identifier for the live event.

off

off: (<K>(type: K, callback: EventListener<LiveEventEventMap[K]>) => void) = ...

Type declaration

- <K>(type: K, callback: EventListener<LiveEventEventMap[K]>): void
- Type Parameters
  - K extends keyof LiveEventEventMap
  Parameters
  - type: K
  - callback: EventListener<LiveEventEventMap[K]>
  Returns void

on

on: (<K>(type: K, callback: EventListener<LiveEventEventMap[K]>) => (() => void)) = ...

Type declaration

- <K>(type: K, callback: EventListener<LiveEventEventMap[K]>): (() => void)
- Type Parameters
  - K extends keyof LiveEventEventMap
  Parameters
  - type: K
  - callback: EventListener<LiveEventEventMap[K]>
  Returns (() => void)
  - - (): void
    - Returns void

openChannel

openChannel: OpenChannel

An open channel that is used for the live event.

participantCount

participantCount: number

The number of participants in a live event which is counted by the number of devices and browsers concurrently connected to Sendbird server.

peakParticipantCount

peakParticipantCount: number

The highest number of participantCount measured at a given time during a live event.

setReadyAt

setReadyAt: number

The timestamp of when the live event was set ready, in miliseconds.

setReadyBy

setReadyBy: string

User ID of the user that set the live event ready.

startedAt

startedAt: number

The timestamp of when the live event was started, in miliseconds.

startedBy

startedBy: string

User ID of the user that started the live event.

state

state: LiveEventState

The state of a live event. Valid values are created, ready, ongoing, and ended.

userIdsForHost

userIdsForHost: string[]

Accessors

isActiveHost

get isActiveHost(): boolean
Returns boolean

isHost

get isHost(): boolean
Returns boolean

myRole

get myRole(): LiveEventRole
The role of the user in a live event.

Returns LiveEventRole

Methods

`Protected` _dispatchEvent

_dispatchEvent<K>(type: K, ...args: ArgsType<LiveEventEventMap[K]>): void
Type Parameters
- K extends keyof LiveEventEventMap
Parameters
- type: K
- Rest ...args: ArgsType<LiveEventEventMap[K]>
Returns void

Inherited from EventTarget._dispatchEvent

_getOpenChannel

_getOpenChannel(): Promise<OpenChannel>
Returns Promise<OpenChannel>

addEventListener

addEventListener<K>(type: K, callback: EventListener<LiveEventEventMap[K]>): (() => void)
Type Parameters
- K extends keyof LiveEventEventMap
Parameters
- type: K
- callback: EventListener<LiveEventEventMap[K]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from EventTarget.addEventListener

endEvent

endEvent(): Promise<void>
Ends a live event. Only the host can perform this action. Calling this method implicitly calls endStreaming().

Returns Promise<void>

endStreaming

endStreaming(): void
Ends media streaming of a host in the live event. Only the host can perform this action.

Returns void

enter

enter(): Promise<void>
Enters a live event.

Returns Promise<void>

enterAsHost

enterAsHost(mediaOption: MediaOption): Promise<void>
Enters a live event as a host. Only the host can perform this action.
Parameters
- mediaOption: MediaOption
Returns Promise<void>

exit

exit(): Promise<void>
Exits a live event.

Returns Promise<void>

exitAsHost

exitAsHost(): Promise<void>
Exits a live event as a host.

Returns Promise<void>

fetchOpenChannel

fetchOpenChannel(): Promise<OpenChannel>
Returns Promise<OpenChannel>

muteAudioInput

muteAudioInput(): void
Mutes the audio of a live event. Only the host can perform this action.

Returns void

once

once<K>(type: K, givenCb: EventListener<LiveEventEventMap[K]>): (() => void)
Type Parameters
- K extends keyof LiveEventEventMap
Parameters
- type: K
- givenCb: EventListener<LiveEventEventMap[K]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from EventTarget.once

removeAllEventListeners

removeAllEventListeners(): void
Returns void

Inherited from EventTarget.removeAllEventListeners

removeEventListener

removeEventListener<K>(type: K, callback: EventListener<LiveEventEventMap[K]>): void
Type Parameters
- K extends keyof LiveEventEventMap
Parameters
- type: K
- callback: EventListener<LiveEventEventMap[K]>
Returns void

Inherited from EventTarget.removeEventListener

selectAudioInput

selectAudioInput(mediaDeviceInfo: InputDeviceInfo): void
Selects a device for audio input for a live event. Only the host can perform this action.
Parameters
- mediaDeviceInfo: InputDeviceInfo
Returns void

selectVideoInput

selectVideoInput(mediaDeviceInfo: InputDeviceInfo): void
Selects a device for video output during a live event. Only the host can perform this action.
Parameters
- mediaDeviceInfo: InputDeviceInfo
Returns void

setEventReady

setEventReady(): Promise<void>
Sets a live event ready before starting a live event. Only the host can perform this action.

Returns Promise<void>

setVideoViewForLiveEvent

setVideoViewForLiveEvent(mediaView: HTMLMediaElement, hostId: string): void
Parameters
- mediaView: HTMLMediaElement
- hostId: string
Returns void

startEvent

startEvent(mediaOption: MediaOption): Promise<void>
Starts the live event. Only the host can perform this action. Calling this method implicitly calls startStreaming().
Parameters
- mediaOption: MediaOption
Returns Promise<void>

startStreaming

startStreaming(mediaOption: MediaOption): void
Starts media streaming of a host in the live event. Only the host can perform this action.
Parameters
- mediaOption: MediaOption
Returns void

startVideo

startVideo(): void
Turns on the video of a live event. Only the host can perform this action.

Returns void

stopVideo

stopVideo(): void
Turns off the video of a live event. Only the host can perform this action.

Returns void

teardown

teardown(): void
Returns void

unmuteAudioInput

unmuteAudioInput(): void
Unmutes the audio of a live event. Only the host can perform this action.

Returns void

upsert

upsert(props: Partial<LiveEvent>): void
Parameters
- props: Partial<LiveEvent>
Returns void

Class LiveEvent

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: LiveEventParams

Returns LiveEvent

Properties

Protected _listeners

Type declaration

Optional disconnected?: EventListener<{ args: [LiveEvent, Error] }>[]

Optional hostConnected?: EventListener<{ args: [LiveEvent, Host] }>[]

Optional hostDisconnected?: EventListener<{ args: [LiveEvent, Host] }>[]

Optional hostEntered?: EventListener<{ args: [LiveEvent, Host] }>[]

Optional hostExited?: EventListener<{ args: [LiveEvent, Host] }>[]

Optional hostMutedAudio?: EventListener<{ args: [LiveEvent, Host] }>[]

Optional hostStartedVideo?: EventListener<{ args: [LiveEvent, Host] }>[]

Optional hostStoppedVideo?: EventListener<{ args: [LiveEvent, Host] }>[]

Optional hostUnmutedAudio?: EventListener<{ args: [LiveEvent, Host] }>[]

Optional liveEventEnded?: EventListener<{ args: [LiveEvent] }>[]

Optional liveEventReady?: EventListener<{ args: [LiveEvent] }>[]

Optional liveEventStarted?: EventListener<{ args: [LiveEvent] }>[]

Optional participantEntered?: EventListener<{ args: [LiveEvent, Participant] }>[]

Optional participantExited?: EventListener<{ args: [LiveEvent, Participant] }>[]

createdAt

createdBy

cumulativeParticipantCount

currentLiveUser

customItems

duration

endedAt

endedBy

host

isHostStreaming

liveEventId

off

Type declaration

Type Parameters

K extends keyof LiveEventEventMap

Parameters

type: K

callback: EventListener<LiveEventEventMap[K]>

Returns void

on

Type declaration

Type Parameters

K extends keyof LiveEventEventMap

Parameters

type: K

callback: EventListener<LiveEventEventMap[K]>

Returns (() => void)

Returns void

openChannel

participantCount

peakParticipantCount

setReadyAt

setReadyBy

startedAt

startedBy

state

userIdsForHost

Accessors

isActiveHost

Returns boolean

isHost

Returns boolean

myRole

Returns LiveEventRole

Methods

Protected _dispatchEvent

Type Parameters

K extends keyof LiveEventEventMap

Parameters

type: K

Rest ...args: ArgsType<LiveEventEventMap[K]>

`Protected` _listeners

`Optional` disconnected?: EventListener<{ args: [LiveEvent, Error] }>[]

`Optional` hostConnected?: EventListener<{ args: [LiveEvent, Host] }>[]

`Optional` hostDisconnected?: EventListener<{ args: [LiveEvent, Host] }>[]

`Optional` hostEntered?: EventListener<{ args: [LiveEvent, Host] }>[]

`Optional` hostExited?: EventListener<{ args: [LiveEvent, Host] }>[]

`Optional` hostMutedAudio?: EventListener<{ args: [LiveEvent, Host] }>[]

`Optional` hostStartedVideo?: EventListener<{ args: [LiveEvent, Host] }>[]

`Optional` hostStoppedVideo?: EventListener<{ args: [LiveEvent, Host] }>[]

`Optional` hostUnmutedAudio?: EventListener<{ args: [LiveEvent, Host] }>[]

`Optional` liveEventEnded?: EventListener<{ args: [LiveEvent] }>[]

`Optional` liveEventReady?: EventListener<{ args: [LiveEvent] }>[]

`Optional` liveEventStarted?: EventListener<{ args: [LiveEvent] }>[]

`Optional` participantEntered?: EventListener<{ args: [LiveEvent, Participant] }>[]

`Optional` participantExited?: EventListener<{ args: [LiveEvent, Participant] }>[]

`Protected` _dispatchEvent

`Rest` ...args: ArgsType<LiveEventEventMap[K]>