Skip to main content
Version: 0.1.x

useMeeting Hook Properties - React

meetingId​

  • type : string
  • meetingId represents the meeting id for the meeting

meeting​

  • type : Meeting
  • meeting is the object for the meeting

localParticipant​

  • type : Participant
  • It will be the instance of Participant object for the local participant (You).

mainParticipant​

  • type : Participant
  • It will be the instance of Participant object for the main participant

activeSpeakerId​

  • type : string
  • activeSpeakerId will be the id of the participant who is actively speaking in the meeting. If no participant is speaking, at that time value of activeSpeakerId will be null.

participants​

  • type : Map of Participant
    • Map<participantId, Participant>
  • Contains all the connected participants of the meeting.

pinnedParticipants​

  • type : Map<string, { cam: bool, share: bool }}>
  • pinnedParticipants will return a Map which maps participantId of all the pinned participants with a object represting their camera and screen share status.

presenterId​

  • type : string
  • presenterId will be the id of the participant who started Presenting / Screen sharing in the meeting. If no participant is sharing the screen, at that time value of presenterId will be null.

localMicOn​

  • type : boolean
  • localMicOn will be true if the local participants mic is on else false.

localWebcamOn​

  • type : boolean
  • localWebcamOn will be true if the local participants webcam is on else false.

isRecording​

  • type : boolean
  • isRecording will be true if the meeting is being recorded else false.

isLiveStreaming​

  • type : boolean
  • isLiveStreaming will be true if live stream is on else false.

isHls​

  • type : boolean
  • isHls will be true if the HLS streaming is being running else false.

hlsUrls​

  • type : Object
    • playbackHlsUrl: String
    • livestreamUrl: String
  • hlsUrls will proide all the URLs for the ongoing meeting HLS.

hlsState​

  • type : string
  • hlsState will be the current state of the meeting HLS.

livestreamState​

  • type : string
  • livestreamState will be the current state of the meeting Livestream.

recordingState​

  • type : string
  • recordingState will be the current state of the meeting recording.

localScreenShareOn​

  • type : boolean
  • localScreenShareOn will be true if the local participants screen share is on else false.

selectedCameraDevice​

  • type : InputDeviceInfo
  • selectedCameraDevice will be return InputDeviceInfo object describing the camera device used during the meeting.

selectedMicrophoneDevice​

  • type : InputDeviceInfo
  • selectedMicrophoneDevice will be return InputDeviceInfo object describing the microphone device used during the meeting.

Got a Question? Ask us on discord

Last updated on by BhumiSalat

Was this helpful?