join(options)

Call this method to join the Room.

JavaScript

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
receiveVideoStreamType	default: only_individual Available options: none no video stream will be sent to the user. only_individual: individual video stream of each participant will be sent to the user only_composed: this option only works when composition is turned on in the meeting room, if only_composed is selected then only the composed video stream is sent to the user. all: both individual and composed stream is sent to the user.	No
receiveAudioStreamType	default: only_individual Available options: none: no audio stream will be sent to the user only_individual: individual audio stream of each participant will be sent to the user only_composed: this option only works when composition is turned on in the meeting room. only_composed is selected then only the composed audio stream is sent to the user. When only_composed is selected for the audio stream and the participant is sharing their audio they will hear their own voice. all - both individual and composed stream will be sent to the user.	No

Properties

This method returns meetingInfo 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