The EnxRoom is a derived Class from EnxRtc. It handles all room related functions to communicate with EnableX, e.g. Connection of End-Points to EnableX Room, publishing & subscribing of streams etc.

References: AttributesMethodsEvents

Attributes

  • roomID – Room ID
  • clientID – Unique Client ID assigned by EnableX to the End-Point
  • streams – Dummy Streams to subscribe. Active Talker Notifications gives list of Streams carrying Media
  • remoteStreams – List of Remote Streams
  • localStreams – List of Local Streams
  • status – Room Connect Status: Enum (1=Connecting, 2=Connected, 0=Disconnected)
  • awaitedParticipants – List of Clients waiting for Moderator approval to get into a knock-enabled Room
  • raisedHands – List of Clients requested Floor Access in a Lecture Mode
  • approvedHands – List of Clients with approved Floor Access in a Lecture Mode

Methods

Given below a categorized listing of methods:

Connection

  • connect() – To connect End-Client to the Room
  • disconnect() – To disconnect End-Point from the room
  • whoami() – To know information of the Client connected to the Room using the End-Point

Streaming

Moderator Controls

Floor Access Controls

  • requestFloor() – To request moderator for Floor Access to publish
  • grantFloor() – To grant Floor Access participant allowing him to publish
  • releaseFloor() – To release Floor Access from a participant granted access earlier
  • denyFloor() – To deny Floor Access to a participant who had requested access

Miscellaneous

  • postClientLogs() – To submit Client End Point logs to EnableX Team to audit
  • addEventListener() – To add listener for Room Bound events to receive notifications

Events

Given below a categorized listing of events:

Connection

  • room-connected – Client End Point is connected to the room successfully
  • room-disconnected – Client End Point got disconnected to the room
  • room-failed – Client End Point’s attempt to connect to room has failed
  • room-awaited – Client End Poin is connected to the knock-enabled Room successfully, but awaited for Moderator’s approval to join the Room
  • user-connected – Everyone is notified that a new user is connected to the Room
  • user-disconnected – Everyone is notified that a connected user is disconnected from the Room
  • bandwidth-updated – A Client End Point is notified that there is a significant change in available Bandwidth (Applied on Down Stream)

Streaming

  • stream-added – Everyone is notified that a new Stream is added to the Room
  • stream-removed – Everyone is notified that a Published Stream is unpublished or removed from the Room
  • stream-failed – Publisher of a Stream is notified that he has failed to publish his stream
  • stream-subscribed – Participant is notified that he successfully subscribed to a stream
  • stream-unsubscribed – Participant is notified that he successfully unsubscribed a subscribed stream
  • user-subscribed – Publisher of a Stream is notified that the Stream is subscribed by a User
  • user-unsubscribed – Publisher of a Stream is notified that the Stream is unsubscribed by a User
  • active-talkers-updated – Everyone is notified with a updated list of Active Talkers list
  • active-talker-data-in – When text messages are received
  • canvas-started – Everyone is notified that a Canvas Streaming has started
  • canvas-stopped – Everyone is notified that ongoing Canvas Streaming has stopped
  • share-started – Everyone is notified that a Screen Share has started
  • share-stopped – Everyone is notified that ongoing Screen Share has stopped
  • user-audio-muted – Everyone is notified when when user’s audio is muted
  • user-video-muted – Everyone is notified when when user’s video is muted
  • user-audio-unmuted – Everyone is notified when when user’s audio is unmuted
  • user-video-unmuted – Everyone is notified when when user’s video is unmuted

Moderator Controls

  • user-awaited – Moderator is notified about a User awaited to join the knock-enabled Room
  • room-record-on – Notification to all that the Session is being recorded
  • room-record-off – Notification to all that Session recording has stopped
  • room-muted – Notification to all that the Room has been hard muted
  • room-unmuted – Notification to all that hard-mute restriction on Room has been lifted
  • hardmute-user-audio – Participant is notified that his audio is hard muted
  • hardmute-user-video – Participant is notified that his video is hard muted
  • hardunmute-user-audio – Participant is notified that moderator has lifted audio hard-mute state
  • hardunmute-user-video – Participant is notified that moderator has lifted video hard-mute state

Floor Access Controls

  • floor-requested – Moderator is notified that a Participant has requested Floor Access
  • floor-granted – Participant is notified that he has been granted Floor Access
  • release-floor – Participant is notified that Moderator has revoked Floor Access from him
  • floor-released – Moderator is notified that Participant has released Floor Access
  • floor-denied – Participant is notified that his request for Floor Access has been denied by Moderator

Explore Web SDK