Wrapper lib between matrix-ios-sdk and openwebrtc-ios-sdk
  • Objective-C 87.4%
  • Ruby 12.6%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2015-09-15 10:40:23 +02:00
MatrixOpenWebRTCWrapper Applied MXCallStack API changes which will be availaable on next matrix-ios-sdk (0.5.4) 2015-09-15 10:40:23 +02:00
MatrixOpenWebRTCWrapper.xcodeproj Copy MXOpenWebRTCallStack* source code files from matrix-ios-sdk to here 2015-07-20 16:16:20 +02:00
MatrixOpenWebRTCWrapperTests Added files as generated by Xcode for a new framework project 2015-07-20 15:47:19 +02:00
.gitignore Added pod dependencies 2015-07-20 16:09:50 +02:00
LICENSE Initial commit 2015-07-20 15:26:29 +02:00
MatrixOpenWebRTCWrapper.podspec Applied MXCallStack API changes which will be availaable on next matrix-ios-sdk (0.5.4) 2015-09-15 10:40:23 +02:00
Podfile Applied MXCallStack API changes which will be availaable on next matrix-ios-sdk (0.5.4) 2015-09-15 10:40:23 +02:00
Podfile.lock Podfile.lock: Updated CocoaPods version 2015-07-21 10:19:31 +02:00
README.rst README.rst: Flagged the lib as experimental 2015-07-21 14:32:37 +02:00

Matrix OpenWebRTC wrapper for iOS
=================================

This library enables OpenWebRTC voice and video calls in a Matrix application.

It is a wrapper between matrix-ios-sdk (https://github.com/matrix-org/matrix-ios-sdk) and openwebrtc-ios-sdk (https://github.com/EricssonResearch/openwebrtc-ios-sdk). It implements the VoIP protocol defined in MatrixSDK by using the OpenWebRTC iOS SDK.

**Warning:** Both openwebrtc-ios-sdk and VoIP in matrix-ios-sdk are for experimental purpose. Do not use matrix-ios-openwebrtc-wrapper in commercial products.

To enable OpenWebRTC into an application running the Matrix SDK:

1. Add this lib into the application podfile (note it has not been submitted yet to CocoaPods)::

    # MatrixOpenWebRTCWrapper
    pod 'MatrixOpenWebRTCWrapper', :git => 'https://github.com/matrix-org/matrix-ios-openwebrtc-wrapper.git', :branch => 'master'
    
    # OpenWebRTC-SDK (Matrix.org fork of it)
    pod 'OpenWebRTC-SDK', :git => 'https://github.com/matrix-org/openwebrtc-ios-sdk.git', :branch => 'cvo_support'


2. Pass an instance of it to the Matrix SDK MXSession object::

    id<MXCallStack> callStack = [[MXOpenWebRTCCallStack alloc] init];
    [mxSession enableVoIPWithCallStack:callStack];
    
2. Or, if you use MatrixKit, pass the MXOpenWebRTCCallStack class to the MXKAccountManager before opening any MXSession instances::

    MXKAccountManager *accountManager = [MXKAccountManager sharedManager];
    accountManager.callStackClass = [MXOpenWebRTCCallStack class];


Known issues
============
1. The lib does not build for iOS simulator because OpenWebRTC-SDK does not provide libraries built for x86_64 architecture. See https://github.com/EricssonResearch/openwebrtc-examples/issues/79.