join(options)

Join a meeting room

Call this method to join the Room.

const meetingInfo = await meeting.join({
  roomURL: "screensharing.metered.live/eject-test",
  name: "James Bond",
  accessToken: "..."
});

Join Options

Parameter Name

Description

Required

roomURL

URL of your Room. The URL is your-app-name.metered.live/your-room-name

YES

name

name of the user, can be any string value.

YES

accessToken

Access Token can be generated using tokens api. If Room is private the token is required to join.

NO

Properties

This method returnsmeetingInfo object that has the following properties

Property

Description

roomId

roomId of the meeting room

meetingSessionId

meetingSessionId of the current meeting session

participantSessionId

participantSessionId of the current participant

onlineParticipants[]

Array of participants currently online in the meeting

onlineParticipants array contains the following properties

Property

Description

isAdmin: boolean

indicates the user is admin or not

meetingSessionId

meetingSessionId of the current meeting session

name

username of the participant

roomId

roomId of the meeting room

_id

participantSessionId of the participant