Web SDK – Video API

The EnableX Web SDK is used to integrate EnableX RTC sessions with your Web Applications. The SDK consists of a JavaScript Library with APIs required to communicate with EnableX Signaling Server and Media Server and to listen to event-based notifications during a session. The library needs to be added in the HTML page.

Released: December 14, 2022

Table of Contents

• General
  • How to use Web SDK?
• Media Device
  • Get list of Audio & Video Devices
• Create Local Stream
  • Initiate Stream with default Devices
  • Initiate Stream with specified Devices
  • Handle Device Access for Audio/Video Stream
  • Initiate Stream with Local File & Remote URL
  • Initiate Stream with Screen Share
  • Initiate Stream with Multiple Video Layers
• Room Connection
  • Initiate a Room
  • Connect to Room
  • Join a Room without or with Stream
  • Disconnect from a Room
  • Handle Disconnection & Re-connections
  • Quality Adaption with Bandwidth
• Handle Local Stream
  • Publish Stream
  • Unpublish Stream
  • Close Stream
  • Switch Source Media Devices of Published Stream
    • Switch Camera & Microphone of Published Stream
    • Switch Camera of Published Stream
    • Switch Microphone of Published Stream
    • Switch Speaker
  • Mute / Unmute Audio in a Stream
  • Mute / Unmute Video in a Stream
• Handle Remote Streams
  • Subscribe / Unsubscibe Remote Streams
  • Handle Active Talkers
    • Get Talker Count
    • Set Talker Count
    • Get Maximum Permissible Talker Count
  • Opt to receive desired Video Quality
• Know Your Stream
  • Get Stream ID
  • Get Stream Attributes
  • Configure Stream
  • Update Stream Attributes
  • Verify availability of Media Tracks in Stream
  • Play Stream
• In-Session Communication
  • Public, Private & Group Messaging
  • Custom Signalling
  • File Sharing
    • Upload File to share
    • Download shared File
    • Initiate File Download
    • Cancel File Upload
    • Cancel File Download
  • Screen Share
  • Canvas Streaming
  • RTMP Live Streaming
  • HLS Streaming
  • Annotation
  • Live Transcription – Speech to Text
• Session Management
  • Record a Session
  • Hard Mute / Unmute Room
  • Hard Mute / Unmute Participants
  • Lock / Unlock Room
  • Disconnect User
  • Destroy Session
  • Moderate Participants’ entry to Session
  • Wait for Moderator
  • Change Participant Role
  • Pin User Stream(s)
  • Spotlight
  • Switch Room Mode
• Break-Out Room
  • Create Break-Out Room
  • Invite Users to join a Break-Out Room
  • Create Break-Out Room & Auto-Invite Users to join
  • Join Break-Out Room
  • Reject Break-Out Room Invitation
  • Pause/Resume Parent Room
  • Mute/Unmute Parent Room
  • Disconnect from Break-Out Room
  • Clear All Break-Out Rooms
  • Handle All Destroyed Break-Out Room
• Floor Access Control in Lecture Mode
  • Request Floor Access
  • Cancel Requested Floor Access
  • Deny Floor Access
  • Grant Floor Access
  • Finish Granted Floor Access
  • Release Granted Floor Access
  • Invite Participant to Floor
• Live Stats
  • Get Live Media Statistics
  • Get Talker Notification
• Utilities
  • Extend Session
  • Make Outbound PSTN/SIP Call
  • Manage Console Log
  • Pre-Call Test
  • Get Bitrate Status of Client
  • Make Image Snapshot from Video Stream
  • Change to Audio Only Mode
• SDK Method Index (By Class)
  • EnxRtc – The Base Class
  • EnxRoom – Room Handler
  • EnxStream – Stream Handler
  • Logger – Log Manager

---