EnxRTCiOS

EnxRTCiOS is an iOS toolkit used for building native iOS applications to integrate real-time communication using the EnableX Platform. This toolkit exposes functions, methods, and notifications required to communicate with EnableX signaling and media servers using a valid token to carry out an RTC session.

Documentation

For API documentation, see the library's official documentation in Xcode or on the Web.

APIs Documentation

Adding EnxRTCiOS as a Dependency

To use the EnxRTCiOS library in a SwiftPM project, add the following line to the dependencies in your Package.swift file:

.package(url: "https://github.com/EnableX/EnxRTCiOS.git", from: "3.0.19"),

How to use

Go to your class, where you wanted to implement the Video/Audio/Chat feature, import the libraray

    import EnxRTCiOS

Create the objects for required SDK classes

    var enxRoom : EnxRoom!

This is the object of EnxRoom class, all room based functions/mothods need to call through this object. Once you are connected to the room , you will receive didConnect callBack with the reference of EnxRoom to be assign to the enxRoom object.

    var enxRTC : EnxRtc!

This is the object of EnxRTC class. EnxRTC will give you single method to connect with room. It will also do all internal formalities required for connection like creating EnxRoom, EnxStream etc.

    var enxStream : EnxStream!

This is the object of EnxStream class, all stream based functions/methods must be called through this object.

    var enxPlayerView : EnxPlayerView!

This is the object of EnxPlayerView class. This is used to play local or remote video streaming.

How to join the EnableX Room?
You need to call join method as code given below -

    enxRTC = EnxRtc()
    guard let steam = enxRTC.joinRoom(token, delegate: self, publishStreamInfo: localStreamInfo, roomInfo: roomInfo , advanceOptions: nil) else{return}
                self.localStream = steam
                self.localStream.delegate = self as EnxStreamDelegate

Function Parameters

• token is must be a valid EnableX session token as string.
• delegate is instance of class where you receive events notifications.
• publishStreamInfo contrains Local EnxStream information as [String : Any].
• roomInfo contains EnxRoom Basice information as [String : Any].
• advanceOptions this is an optional parameter, provide as [Any].

Callbacks

• On getting connected with EnableX Room, following callbacks are received:

    func room(_ room: EnxRoom?, didConnect roomMetadata: [String : Any]?)
    func room(_ room: EnxRoom?, didAddedStream stream: EnxStream?)
    func room(_ room: EnxRoom?, didActiveTalkerList Data: [EnxStream]?) or func room(_ room: EnxRoom?, didActiveTalkerView view: UIView?)
  

• On failing to connect with Enablex Room, following callback are received:

    func room(_ room: EnxRoom?, didError reason: [Any]?)
  

• On being disconnected from EnableX Room, following callbacks are received:

    func didRoomDisconnect(_ response: [Any]?)
  

• On joining or exiting EnabeX Room by others users, following callbacks are received:

    func room(_ room: EnxRoom?, userDidJoined Data: [Any]?)
  

Note: Developers must implement the above mentioned Callbacks as they are mandatory to handle. All other Callbacks, given in Developer Documentation; are optional and may be implemented if needed.