iOS SDK – Video API

The Platform iOS SDK is used to integrate platform RTC sessions with your Native iOS Applications. The SDK consists of APIs required to communicate with the Platform Signaling Server and Media Server and to listen to event-based notifications during a session.

Table of Contents

• General
  • How to use iOS SDK?
• Media Device
  • Get List of Audio Devices
  • Get Selected Audio Device by User
  • Handle Audio Device Updates
• Create Local Stream
• Room Connection
  • Initiate a Room
  • Connect to Room
  • Join a Room with Stream
  • Disconnect from a Room
  • Handle Disconnection & Reconnection
  • Quality Adjustment based on available Bandwidth
• Handle Local Stream
  • Publish Stream
  • Unpublish Stream
  • Switch Source Media Devices of Published Stream
    • Switch between Rear & Front Camera
    • Switch to alternate Microphone
  • Mute / Unmute Audio in a Stream
  • Mute / Unmute Video in a Stream
• Handle Remote Streams
  • Subscribe Remote Streams
  • Handle Active Talkers
    • Get maximum permissible Talker Count
    • Get Talker Count
    • Set Talker Count
    • Switch Active Talker View
    • Switch to Player View
  • Opt to receive desired Video Quality
• Know your Stream
  • Get Stream ID
  • Verify availability of Media Tracks in Stream
  • Know if Stream is Local or Remote
  • Get Local Stream ID
  • Get Stream by Stream ID
  • Get list of Remote Streams
  • Play Stream
• Know your Room
  • Get Room ID
  • Get Room Meta Data
  • Get Client Id of the connected User
  • Get Name of the connected User
  • Get Role of the connected User
  • Get Information of the connected User
  • Get list of the connected Users
• In-Session Communication
  • Private, Public & Group Messaging
  • Custom Signalling
  • File Sharing
  • Share Screen
  • Canvas Streaming
  • Annotation
• Session Management
  • Record Session
  • Hard Mute / Unmute Room
  • Hard Mute / Unmute Participants
  • Lock / Unlock Room
  • Disconnect User
  • Extend & Destroy Session
  • Moderate Participants’ entry to Session
  • Change Participant’s 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
  • Pause/Resume Parent Room
  • Mute/Unmute Parent Room
  • Disconnect from Break-Out Room
  • Cancel All Break-Out Rooms
  • Handle Destroyed Break-Out Room
  • Handle All Destroyed Break-Out Rooms
• 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
  • Adjust Layout
  • Change to Audio Only Call
  • Handle Application Switching from Foreground to Background
  • Share Log to audit
  • Take Image Snapshot
  • Pre-Call Test
  • Update Stream Configuration
• SDK Method Index (By Class)
  • EnxRtc – Base Class
  • EnxRoom – Room Handler
  • EnxStream – Stream Handler

---