Video API v1.8 iOS SDK

The EnableX iOS SDK is for developing Native RTC Applications for iOS Devices. The SDK has all the methods to interface with EnableX Signaling Server and Media Servers and to listen to event based notifications during a session.

Released: November 2, 2020

Table of Contents

• How to use iOS SDK?
• Classes – Attributes, Methods & Notifications
  • EnxRtc – Base Class
  • EnxRoom – Room Handler
  • EnxStream – Stream Handler
• Basic Functions
  • Get list of Audio Devices
  • Get selected Audio Device by User
  • Initiate a Room
  • Connect to Room
  • Initiate Local Stream
  • Join a Room with Stream
  • Disconnect from a Room
  • Publish / Unpublish Local Stream
    • Publish Stream
    • Unpublish Stream
  • Subscribe Remote Streams
  • Handle Active Talkers
    • Get maximum permissible Talker Count
    • Get Talker Count
    • Set Talker Count
  • Play Stream
  • Adjust Layout
  • Know Stream Information
    • Get Stream ID
    • Get Stream Attributes
    • Verify availability of Media Tracks in Stream
    • Check Audio Video Track Status in Stream
    • Know if Stream is Local or Remote
    • Know current state of Stream
    • Get Media of a Stream
  • Get Room Information
    • Get Room ID
    • Get Room Meta Data
    • Get Room Mode
    • Get connected User Id or Client Id
    • Get connected User Name
    • Get connected User Role
    • Get connected User Information
    • Get list of connected Users
    • Get Local Stream ID
    • Get Stream by Stream ID
    • Get list of Remote Streams
    • Get Publish Status of Local Stream
• Advance Features
  • Switch Source Media Devices of Published Stream
    • Switch between Rear & Front Camera
    • Switch to alternate Microphone
  • Update Stream Configuration
  • Mute / Unmute Audio in a Stream
  • Mute / Unmute Video in a Stream
  • Send Chat Data
  • Public, Private & Group Messaging
  • File Sharing
    • Upload file to share
    • Download file
  • Share Screen
  • Use Canvas Streaming
    • Start Canvas Streaming
    • Stop Canvas Streaming
    • Receive & Play Canvas Streaming
  • Annotation
    • Annotation Toolbar
    • Start / Stop Toolbar
  • Change to Audio Only Call
  • Receiving Streaming Stats
  • Handle Device Updates
  • Handle Application Switching from Foreground to Background
  • Opt to receive desired Video Quality
  • Use Custom Signaling
  • Make Outbound PSTN/SIP Calls
  • Share Log to audit
• Moderator Controls
  • Record a Session
    • Auto Recording
    • On-Demand Recording
  • Hard Mute / Unmute Room
  • Hard Mute / Unmute Participants
  • Lock / Unlock Room
  • Disconnect User
  • Destroy Session
  • 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
  • Start / Stop Live Streaming
  • Pin User Stream(s)

How to use iOS SDK?

The EnxiOS directory contains the EnxRTCiOS.framework iOS SDK, Add this framework in your project. The EnxRTCiOS iOS SDK is supported by  iOS 10 or higher. XCode 9 and later.

• Install CocoaPods as described in CocoaPods Getting Started.
• In Terminal, go to project directory and run pod init
• To integrate EnxRTCiOS into your Xcode project using CocoaPods, specify pod name EnxRTCiOS.
• After adding all required library in PodFile go to terminal and run pod Install
• Reopen your project in Xcode using the new .xcworkspace file.

Note:

To use EnableXiOS SDK, please add  GoogleWebRTC and Socket.IO-Client-Swift(15.0.0 in your project with the following pod names:

'GoogleWebRTC', '~> 1.1.29229’
'Socket.IO-Client-Swift', '~> 15.0.0' 

---

Explore iOS SDK

• EnxRtc – Base Class →
• ↑ Top