Live JavaScript v1
Live JavaScript
Live
JavaScript
Home
/
Live
/
JavaScript
/
UIKit

View a live event

Users can participate in a live event as a participant. When a user enters a live event as a participant, they can receive the host’s media stream and chat with other participants including the host.

ParticipantView includes a view displaying the host’s media stream, UI components for providing the live event information, and a chat where participants can send messages during the live event.

The following table lists the features included in ParticipantView.

List of features

FeatureDescription

Enter a live event

Allows a user to enter a live event.

Use the chat

Allows a participant to send messages to the chat.

Show a list of participants

Displays a list of participants watching the live event.


Customization

The following table lists a set of customizable properties of ParticipantView. These properties can be set in the customize.ParticipantView object in the App component's props.

Property nameTypeDescription

showDuration

boolean

Determines whether to display the duration of a live event in the view. If set to true, the duration of a live event is displayed. (Default: true)

showLiveEventStatus

boolean

Determines whether to display the live event status in the view. If set to true, the live event status is displayed. (Default: true)

showParticipantCount

boolean

Determines whether to display the number of participants in real time. If set to true, the number of views is displayed. (Default: true)

endedLiveEventView
DisplayTime

number

Specifies for how long the message that the live event has ended is displayed on the participant's view after the event has ended.

onEndLiveEventClicked

(props: { onClick: () => void }) => void

Called when a participant clicks the exit button. Participants can leave a live event at anytime.

String set

The following table lists the properties of stringSet you can customize to modify the live event’s participant view.

CategoryKeyString

Host view

CHANGE_EVENT_INFO_TITLE

Edit live event information

Host view

COVER_IMAGE

Cover image

Host view

CREATED_AT

Created on

Host view

CREATED_BY

Created by

Host view

DURATION

Duration

Host view

EDIT_LIVE_EVENT_USERS_FOR_HOST

Users who can be host

Host view

FREEZE_CHAT

Freeze chat

Host view

FREEZE_CHAT_DESCRIPTION

Only operators can send a message. This doesn't stop the live event.

Host view

HOST

Host

Host view

HOSTS

Host

Host view

HOST_LABEL

Host

Host view

LIVE_EVENT_DISCONNECTED_ALERT_DESCRIPTION

Try entering the live event again.

Host view

LIVE_EVENT_DISCONNECTED_ALERT_TITLE

Disconnected temporarily

Host view

LIVE_EVENT_ID

Live event ID

Host view

LIVE_EVENT_INFORMATION_TITLE

Live event information

Host view

LIVE_EVENT_MESSAGE_INPUT_PLACEHOLDER

Enter message

Host view

STARTED_AT

Started on

Host view

STARTED_BY

Started by

Host view

START_LIVE_EVENT_HEADER_BUTTON

Start live event

Host view

TITLE

Title

Host view

UPLOAD_IMAGE

Upload photo

Host view

USERS_FOR_HOST

Users who can be host

Host view

USERS_FOR_HOST_DESCRIPTION

Any one of the users in the list below can act as a host for the live event. If the current host leaves the event, another user can act as the host.

Live event information

PARTICIPANTS

Participants

Live event information

PARTICIPANT_LIST_HEADER_TITLE

Participants

Participant view

LIVE_EVENT_READY_BANNER_DESCRIPTION

Live event will begin soon.

Participant view

LIVE_EVENT_LIVE_BANNER_HOST_MUTED_DESCRIPTION

Host is muted.

Participant view

LIVE_EVENT_LIVE_BANNER_HOST_UNAVAILABLE_DESCRIPTION

Host is temporarily unavailable.

Participant view

LIVE_EVENT_ENDED_DIALOG_DESCRIPTION

Host has ended this live event.