Live SDKs JavaScript v1
Live SDKs JavaScript
Live SDKs
JavaScript
Version 1

Change the state of a live event

Copy link

Before starting an event, hosts can change the event state to ready by calling the setEventReady() method. This action allows participants to enter the event and chat among themselves or with the host. At this point, the participants can't receive the host's media streaming yet. However, hosts can receive the media stream of other hosts when the live event is in ready state. This allows them to discuss with one another and check for stable internet connection before the live event begins.

try {
    await liveEvent.setEventReady();
} catch (e) {
    // Handle error.
}

List of live event states

Copy link
StateHostParticipant

Created

Host can create, enter, start, stop, and exit without ending the live event, and configure media settings.

Participants can't enter the live event.

Ready

Host can enter, start, stop, and exit without ending the live event, and view their own media stream.

Participants can enter live event, and use the chat, but can't receive the host's media stream yet.

Ongoing

Host can turn on/off media stream, update live event information, and exit without ending the live event.

Participants can receive the host's media stream, and use the chat.

Ended

Host can end the live event.

Participants are notified that the live event has ended.