https://github.com/QuantStack/xwebrtc

C++ backend for the jupyter webrtc widget
https://github.com/QuantStack/xwebrtc

Last synced: about 1 month ago
JSON representation

C++ backend for the jupyter webrtc widget

• Host: GitHub
• URL: https://github.com/QuantStack/xwebrtc
• Owner: QuantStack
• License: bsd-3-clause
• Created: 2018-05-04T10:04:36.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-09-19T17:27:57.000Z (about 3 years ago)
• Last Synced: 2024-11-11T15:17:35.144Z (about 1 month ago)
• Language: C++
• Size: 3.17 MB
• Stars: 14
• Watchers: 8
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-jupyter - xwebrtc - C++ Backend for ipywebrtc. (Visualization)
• -awesome-jupyter - xwebrtc - C++ Backend for ipywebrtc. (Visualization)

README

        
# xwebrtc

[![Travis](https://travis-ci.org/QuantStack/xwebrtc.svg?branch=master)](https://travis-ci.org/QuantStack/xwebrtc)

[![Appveyor](https://ci.appveyor.com/api/projects/status/5vjulggfcaknmxsh?svg=true)](https://ci.appveyor.com/project/QuantStack/xwebrtc/branch/master)

[![Binder](https://img.shields.io/badge/launch-binder-brightgreen.svg)](https://mybinder.org/v2/gh/QuantStack/xwebrtc/stable?filepath=notebooks)

C++ backend for WebRTC in the Jupyter notebook/lab

**xwebrtc is an early developer preview, and is not suitable for general usage yet. Features and implementation are subject to change.**

## Trying it online

To try out xwebrtc interactively in your web browser, just click on the binder link:

[![Binder](docs/source/binder-logo.svg)](https://mybinder.org/v2/gh/QuantStack/xwebrtc/stable?filepath=notebooks)

## Installation

We provide a package for the mamba (or conda) package manager.

- Installing `xwebrtc` and the C++ kernel

```bash

mamba install xeus-cling xwebrtc -c conda-forge

```

Then, the front-end extension must be installed for either the classic notebook or JupyterLab.

- Installing the extensions for the classic notebook

```

mamba install widgetsnbextension -c conda-forge

mamba install ipywebrtc -c conda-forge

```

## Installation from sources

Or you can directly install it from the sources if you have all the dependencies already installed:

```bash

cmake -D CMAKE_INSTALL_PREFIX=your_install_prefix

make install

```

## Dependencies

All the dependencies of xleaflet are available for the mamba (or conda) package manager.

| `xwebrtc`  | `xwidgets`    |  `xeus`         |

|------------|---------------|-----------------|

|  master    | >=0.23.0,<25  |  >=0.24.1,<26   |

|  0.6.1     | >=0.23.0,<25  |  >=0.24.1,<26   |

|  0.6.0     |   ~0.23.0     |  ~0.24.1        |

|  0.5.0     |   ~0.20.0     |  ~0.23.3        |

|  0.4.1     |   ~0.16.1     |  ~0.18.1        |

|  0.4.0     |   ~0.16.0     |  ~0.18.1        |

|  0.3.0     |   ~0.15.0     |  ~0.17.0        |

|  0.2.0     |   ~0.14.0     |  ~0.15.0        |

## License

We use a shared copyright model that enables all contributors to maintain the

copyright on their contributions.

This software is licensed under the BSD-3-Clause license. See the [LICENSE](LICENSE) file for details.