Skip to content

Commit

Permalink
docs: improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuagruenstein committed Jun 2, 2024
1 parent 533b8cd commit f956e5c
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,33 @@

[![PyPI version](https://badge.fury.io/py/vpx-rtp-py.svg)](https://badge.fury.io/py/vpx-rtp-py)

python library for encoding/decoding video rtp streams using `libvpx`, loosly forked from `aiortc`.
a creatively named python library for encoding/decoding video rtp streams using `cffi` bindings to `libvpx`, loosely forked / slimmed down from [aiortc](https://github.com/aiortc/aiortc).

narrowly constructed for the use cases of [Tutor Intelligence](http://tutorintelligence.com/), but feel free to post an issue or PR if relevant to you.
narrowly constructed for the use cases of [Tutor Intelligence](http://tutorintelligence.com/), but feel free to post an issue or PR if relevant to you.

### install steps

be sure you have `libvpx` installed on your computer, otherwise `vpx-rtp-py` will not work (even if installed via `pip`). to do so:

```
# ubuntu
sudo apt install libvpx-dev
```

```
# mac
brew install libvpx
```

then install via pypi:

```
pip install vpx-rtp-py
```

### limitations

- does not really support RTCP or anything special/bidirectional (eg packet loss acknowledgement, retransmission packets)
- does not support SSL
- only supports `vp8` and `vp9` video encoding
- pypi pre-built wheels only support linux + x86_64 + python 3.10. if you want to add support for other platforms, feel free to update our `cd.yml` in a PR.

0 comments on commit f956e5c

Please sign in to comment.