Skip to content

Commit

Permalink
README: Update supported formats table (#44)
Browse files Browse the repository at this point in the history
I thought this table could be a bit more useful as a quickstart reference for input/output options!
  • Loading branch information
zachallaun authored Sep 30, 2024
1 parent f5f6bec commit b6ee0a4
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,16 @@ For more examples, see [examples.livemd](examples.livemd).

## Supported formats & protocols

| format | direction |
|---|---|
| MP4 | input, output |
| WebRTC | input, output |
| RTMP | input |
| RTSP | input |
| HLS | output |
| Elixir Stream | input, output |
| format | input | output |
|---|---|---|
| MP4 | `"*.mp4"` | `"*.mp4"` |
| WebRTC | `{:webrtc, signaling}` | `{:webrtc, signaling}` |
| RTMP | `"rtmp://*"` | _not supported_ |
| RTSP | `"rtsp://*"` | _not supported_ |
| HLS | _not supported_ | `"*.m3u8"` |
| `Enumerable.t()` | `{:stream, opts}` | `{:stream, opts}` |

For the full list of input and output options, see [`Boombox.run/2`](https://hexdocs.pm/boombox/Boombox.html#run/2)

## Installation

Expand Down

0 comments on commit b6ee0a4

Please sign in to comment.