Open WebRTC Toolkit Native SDK

Introduction

Open WebRTC Toolkit client SDK for native Windows/Linux/iOS applications are built upon the W3C WebRTC standard to accelerate the development of real time communication applications on these platforms. It supports peer to peer and conference mode communication working with Open Media Stream MCU server.

Supported Windows platform: Windows 7 and above.
Supported Linux platform: Ubuntu 16.04.
Supported iOS platform: iOS 9.0 and above.

Documentation

To generate the API document, go to scripts directory, and run python build-win.py --docs for Windows or ./gendoc.sh in talk/owt/docs/ios for iOS.

You need Doxygen in your path.

How to build

Prepare the development environment

Before you start, make sure you have following prerequisites installed/built:

Following dependencies are for Windows only:

Get the code

Make sure you clone the source code to src dir.
Create file named .gclient under the same directory of src dir, with below contents:

solutions = [ 
  {  
     "managed": False,  
     "name": "src",  
     "url": "https://github.com/open-webrtc-toolkit/owt-client-native.git",  
     "custom_deps": {},  
     "deps_file": "DEPS",  
     "safesync_url": "",  
  },  
]  
target_os = []

Build

Windows

Set environmental variable BOOST_ROOT to your boost source tree.
Run gclient sync. It may take a long time to download large amount of data.
Go to src/srcitps/ directory, and run: python build-win.py --gn_gen --sdk --tests --ssl_root /path/to/ssl --msdk_root /path/to/msdk --output_path /path/to/out. The built binary will be under output_path, the document for sdk will also be copied to this directory if docs has been generated. If not set output_path, the built binary will be under src/out directory. Be noted the first time you run this would take a long time to pull chromium/webrtc dependencies and require a network accessible to Google's code/storage infrastructure. ssl_root to the directory of your OpenSSL 1.1.0 binary. msdk_root to the directory of your Intel Media SDK for Windows, version 2018 R1 or higher. gn_gen to generate args.gn, you need to add --gn_gen at the first time build or when you changed msdk_root and ssl_root path.

Linux

Run gclient sync. It may take a long time to download large amount of data.
Go to src/srcitps/ directory, and run: python build_linux.py --gn_gen --sdk --tests --ssl_root /path/to/ssl --output_path /path/to/out. The built binary will be under output_path, the document for sdk will also be copied to this directory if docs has been generated. If not set output_path, the built binary will be under src/out directory. Be noted the first time you run this would take a long time to pull chromium/webrtc dependencies and require a network accessible to Google's code/storage infrastructure. ssl_root to the directory of your OpenSSL 1.1.0 binary. gn_gen to generate args.gn, you need to add --gn_gen at the first time build or when you changed ssl_root path.

iOS

Run gclient sync. It may take a long time to download large amount of data.
Build OWT iOS SDK with scripts\build.py.

Android

This branch does not support Android build, please switch to 4.2.x branch.

How to contribute

We warmly welcome community contributions to owt-client-native repository. If you are willing to contribute your features and ideas to OWT, follow the process below:

Make sure your patch will not break anything, including all the build and tests.
Submit a pull request onto Pull Requests.
Watch your patch for review comments if any, until it is accepted and merged.

OWT project is licensed under Apache License, Version 2.0. By contributing to the project, you agree to the license and copyright terms therein and release your contributions under these terms.

How to report issues

Use the "Issues" tab on Github.

spring-zh/owt-client-native