aiortc-dc 0.5.0

data channel feature only version of aiortc which implements WebRTC and ORTC

this repo is special version of aiortc which can be install data channel feature only and it works on windows palatrom.

PRs is already requested. So this is tempolary repository.

Install procedure
======
Because, switch dependent packages from pip.

I add a special version of setup.py (setup_dc.py).

procedure is like below.


- $ git clone https://github.com/aiortc/aiortc-dc.git --depth 1
- $ cd aiortc
- $ python setup_dc.py install

Attention
======
Due to same package name, data channel only version of aiortc can't coexist with normal version of it.

If you want coexistance, youl should use tool like virtualenv.


Additional codes to switch data channel feature only mode
======
User should insert this codes on top of his or her startup script.

::

import os
os.environ['AIORTC_SPECIAL_MODE'] = 'DC_ONLY'

File transfer example of P2P direct communication over NAT (which can run on Windows platform!)
======
Please See: `README_WS_SIGNALING_VERSION`_

.. _README_WS_SIGNALING_VERSION: https://github.com/ryogrid/aiortc-dc/blob/pr-websocket-version-filexfer/examples/datachannel-filexfer/README_WS_SIGNALING_VERSION.rst

-----------------------

aiortc
======

|rtd| |pypi-v| |pypi-pyversions| |pypi-l| |travis| |codecov| |gitter|

.. |rtd| image:: https://readthedocs.org/projects/aiortc/badge/?version=latest
:target: https://aiortc.readthedocs.io/

.. |pypi-v| image:: https://img.shields.io/pypi/v/aiortc.svg
:target: https://pypi.python.org/pypi/aiortc

.. |pypi-pyversions| image:: https://img.shields.io/pypi/pyversions/aiortc.svg
:target: https://pypi.python.org/pypi/aiortc

.. |pypi-l| image:: https://img.shields.io/pypi/l/aiortc.svg
:target: https://pypi.python.org/pypi/aiortc

.. |travis| image:: https://img.shields.io/travis/com/aiortc/aiortc.svg
:target: https://travis-ci.com/aiortc/aiortc

.. |codecov| image:: https://img.shields.io/codecov/c/github/aiortc/aiortc.svg
:target: https://codecov.io/gh/aiortc/aiortc

.. |gitter| image:: https://img.shields.io/gitter/room/aiortc/Lobby.svg
:target: https://gitter.im/aiortc/Lobby

What is ``aiortc``?
-------------------

``aiortc`` is a library for `Web Real-Time Communication (WebRTC)`_ and
`Object Real-Time Communication (ORTC)`_ in Python. It is built on top of
``asyncio``, Python's standard asynchronous I/O framework.

The API closely follows its Javascript counterpart while using pythonic
constructs:

- promises are replaced by coroutines
- events are emitted using ``pyee.EventEmitter``

To learn more about ``aiortc`` please `read the documentation`_.

.. _Web Real-Time Communication (WebRTC): https://webrtc.org/
.. _Object Real-Time Communication (ORTC): https://ortc.org/
.. _read the documentation: https://aiortc.readthedocs.io/en/latest/

Why should I use ``aiortc``?
----------------------------

The main WebRTC and ORTC implementations are either built into web browsers,
or come in the form of native code. While they are extensively battle tested,
their internals are complex and they do not provide Python bindings.
Furthermore they are tightly coupled to a media stack, making it hard to plug
in audio or video processing algorithms.

In contrast, the ``aiortc`` implementation is fairly simple and readable. As
such it is a good starting point for programmers wishing to understand how
WebRTC works or tinker with its internals. It is also easy to create innovative
products by leveraging the extensive modules available in the Python ecosystem.
For instance you can build a full server handling both signaling and data
channels or apply computer vision algorithms to video frames using OpenCV.

Furthermore, a lot of effort has gone into writing an extensive test suite for
the ``aiortc`` code to ensure best-in-class code quality.

Implementation status
---------------------

``aiortc`` allows you to exchange audio, video and data channels and
interoperability is regularly tested against both Chrome and Firefox. Here are
some of its features:

- SDP generation / parsing
- Interactive Connectivity Establishment, including half-trickle
- DTLS key and certificate generation
- DTLS handshake, encryption / decryption (for SCTP)
- SRTP keying, encryption and decryption for RTP and RTCP
- Pure Python SCTP implementation
- Data Channels
- Sending and receiving audio (Opus / PCMU / PCMA)
- Sending and receiving video (VP8 / H.264)
- Bundling audio / video / data channels
- RTCP reports, including NACK / PLI to recover from packet loss

Requirements
------------

In addition to aiortc's Python dependencies you need a couple of libraries
installed on your system for media codecs. FFmpeg 3.2 or greater is required.

On Debian/Ubuntu run:

.. code:: bash

apt install libavdevice-dev libavfilter-dev libopus-dev libvpx-dev pkg-config

On OS X run:

.. code:: bash

brew install ffmpeg opus libvpx pkg-config

License
-------

``aiortc`` is released under the `BSD license`_.

.. _BSD license: https://aiortc.readthedocs.io/en/latest/license.html