Skip to main content
Version: 1.1.x

Room Class Properties - Flutter

id

  • type: String

  • Unique id of the room where the participant has joined.


activeSpeakerId

  • type: String?

  • It will be the id of the participant who is actively speaking in the room. If no participant is speaking, at that time value of activeSpeakerId will be null.


activePresenterId

  • type: String?

  • It will be the id of the participant who started Presenting / Screen sharing in the room. If no participant is sharing the screen, at that time value of activePresenterId will be null.


camEnabled

  • type: bool
  • It indicates if camera device is enabled or not.

selectedCamId

  • type: String?
  • It will be the id of camera device, which is currently selected. If camera device is disabled, at that time, value of selectedCamId will be null.

micEnabled

  • type: bool
  • It indicates if microphone device is enabled or not.

selectedMicId

  • type: String?
  • It will be the id of microphone, which is currently selected. If no microphone is selected, at that time, value of selectedMicId will be null.

localParticipant

  • type: Participant

  • It will be the instance of Participant class for the local participant(You) who joined the room.


participants

  • type: Map of String and Participant

  • Map<String, Participant>

  • It will contain all joined participants in the room except the localParticipant.

  • This will be the Map what will container all participants attached with the key as id of that participant.

String remoteParticipantId = "ajf897";

Participant? remoteParticipant = room.participants[remoteParticipantId];

pinnedParticipants

  • type: Map of String and ParticipantPinState

  • Map<String, ParticipantPinState>

    • Map<participantId, ParticipantPinState>
  • It will contain all participants who are pinned in the room.

  • This will be the Map which will contain all participant who are currently pinned's pin state attached with the key as id of that


hlsState

  • type: String

  • It will return the state of HLS for the room.


liveStreamState

  • type: String

  • It will return the state of Live stream for the room.


recordingState

  • type: String

  • It will return the state of Recording for the room.


hlsDownstreamUrl

  • type: String?

  • It will return the downstream URL for the ongoing HLS of the room if any.


pubSub

  • type: PubSub
  • It is used to enable Publisher-Subscriber feature in room class.

Learn more about PubSub, here

Got a Question? Ask us on discord