Returns an object detailing the current meeting participants:
The object keys are
local for the local participant and the participant's
session_id for remote participants.
All participant objects include:
session_id- a unique id generated each time a participant joins a meeting
user_id- the user's id if set by a meeting token, otherwise the
user_name- the user's name if set by a meeting token or set from the account if the user is logged into a Daily account
truefor the local user
trueif set by a meeting token or the user is logged into a Daily account and is a member of the room's team
joined_at- js Date object, the time that the user joined the room
video_height- the current width and height of the live video stream.
video_heightcan change as network conditions change. If there is no current camera stream, this will be an empty object.
record- indicates whether a participant is recording a meeting (Note: recording is a Scale plan only feature)
tracks- an object whose keys are participant track types -
screenVideo- and whose values are objects with detailed information about each track.
Each track includes:
|Whether you (the local participant) are subscribed to a track|
|The values represent the complete set of mutually exclusive states a track can be in, from the user's point of view.|
|If the track is off, why it's off (this field only acquires a value if the track is off).||An optional object with the properties |
|If the track is blocked, why it's blocked (this field only acquires a value if the track is blocked).||An optional object with the properties |
|*Only available when using the Daily call object.||A MediaStreamTrack that is ready to be played.|
A note about the
These properties include the direct MediaStreamTrack that a participant is sending, if available.
While we detail these properties below, we recommend using the
tracks property's key for each kind of track instead for more accurate, detailed tracks state.
videoTrack- the camera video track this participant is sending, if available.
audioTrack- the microphone audio track this participant is sending, if available. Contains the same information as
videoTrack, with only the
kindvalue differing in that it specifies "video".
screenVideoTrack: the screenshare video track this participant is sending, if available.