rob
/
moq-rs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
moq-rs/README.md

70 lines
3.0 KiB
Markdown
Raw Normal View History

Major moq-transport API simplification (#68) Exponentially easier to use moq-transport as there's no message handling required. This is a BREAKING CHANGE.
2023-09-15 19:06:28 +00:00
<p align="center">
Update README.md
2023-09-18 05:43:22 +00:00
<img height="128px" src="https://github.com/kixelated/moq-rs/blob/main/.github/logo.svg" alt="Media over QUIC">
Major moq-transport API simplification (#68) Exponentially easier to use moq-transport as there's no message handling required. This is a BREAKING CHANGE.
2023-09-15 19:06:28 +00:00
</p>
Split the web player into it's own repo. https://github.com/kixelated/moq-js
2023-05-24 20:29:18 +00:00
Media over QUIC (MoQ) is a live media delivery protocol utilizing QUIC streams.
Update README.md
2023-09-18 05:43:05 +00:00
See [quic.video](https://quic.video) for more information.
Update README.md
2023-08-25 23:36:06 +00:00
Update README.md
2023-09-18 05:43:05 +00:00
This repository contains a few crates:
Update README.md
2023-08-25 23:36:06 +00:00
Add support for multiple origins (#82) Adds `moq-api` to get/set the origin for each broadcast. Not used by default for local development.
2023-10-12 04:09:32 +00:00
- **moq-relay**: A relay server, accepting content from publishers and fanning it out to subscribers.
- **moq-pub**: A publish client, accepting media from stdin (ex. via ffmpeg) and sending it to a remote server.
- **moq-transport**: An async implementation of the underlying MoQ protocol.
- **moq-api**: A HTTP API server that stores the origin for each broadcast, backed by redis.
Initial public release.
2022-06-29 16:17:02 +00:00
Add support for multiple origins (#82) Adds `moq-api` to get/set the origin for each broadcast. Not used by default for local development.
2023-10-12 04:09:32 +00:00
There's currently no way to view media with `moq-rs`; you'll need to use [moq-js](https://github.com/kixelated/moq-js) for that.
Add a limitations section to the README.
2022-06-30 20:23:33 +00:00
Add support for multiple origins (#82) Adds `moq-api` to get/set the origin for each broadcast. Not used by default for local development.
2023-10-12 04:09:32 +00:00
## Development
Split the web player into it's own repo. https://github.com/kixelated/moq-js
2023-05-24 20:29:18 +00:00
Add support for multiple origins (#82) Adds `moq-api` to get/set the origin for each broadcast. Not used by default for local development.
2023-10-12 04:09:32 +00:00
See the [dev/README.md] helper scripts for local development.
Major moq-transport API simplification (#68) Exponentially easier to use moq-transport as there's no message handling required. This is a BREAKING CHANGE.
2023-09-15 19:06:28 +00:00
Serve the certificate fingerprint over HTTP (#20) It's a bloated solution, but it's required for local development until Chrome supports self-signed WebTransport CAs.
2023-05-25 00:20:44 +00:00
## Usage
Initial public release.
2022-06-29 16:17:02 +00:00
Major moq-transport API simplification (#68) Exponentially easier to use moq-transport as there's no message handling required. This is a BREAKING CHANGE.
2023-09-15 19:06:28 +00:00
### moq-relay
**moq-relay** is a server that forwards subscriptions from publishers to subscribers, caching and deduplicating along the way.
It's designed to be run in a datacenter, relaying media across multiple hops to deduplicate and improve QoS.
Add support for multiple origins (#82) Adds `moq-api` to get/set the origin for each broadcast. Not used by default for local development.
2023-10-12 04:09:32 +00:00
The relays register themselves via the [moq-api] endpoints, which is used to discover other relays and share broadcasts.
Major moq-transport API simplification (#68) Exponentially easier to use moq-transport as there's no message handling required. This is a BREAKING CHANGE.
2023-09-15 19:06:28 +00:00
Notable arguments:
Add support for multiple origins (#82) Adds `moq-api` to get/set the origin for each broadcast. Not used by default for local development.
2023-10-12 04:09:32 +00:00
- `--listen <ADDR>` Listen on this address [default: [::]:4443]
Major moq-transport API simplification (#68) Exponentially easier to use moq-transport as there's no message handling required. This is a BREAKING CHANGE.
2023-09-15 19:06:28 +00:00
- `--cert <CERT>` Use the certificate file at this path
- `--key <KEY>` Use the private key at this path
Add support for multiple origins (#82) Adds `moq-api` to get/set the origin for each broadcast. Not used by default for local development.
2023-10-12 04:09:32 +00:00
- `--fingerprint` Listen via HTTPS as well, serving the `/fingerprint` of the self-signed certificate. (dev only)
Major moq-transport API simplification (#68) Exponentially easier to use moq-transport as there's no message handling required. This is a BREAKING CHANGE.
2023-09-15 19:06:28 +00:00
This listens for WebTransport connections on `UDP https://localhost:4443` by default.
You need a client to connect to that address, to both publish and consume media.
### moq-pub
This is a client that publishes a fMP4 stream from stdin over MoQ.
This can be combined with ffmpeg (and other tools) to produce a live stream.
Notable arguments:
Add support for multiple origins (#82) Adds `moq-api` to get/set the origin for each broadcast. Not used by default for local development.
2023-10-12 04:09:32 +00:00
- `<URL>` connect to the given address, which must start with https:// for WebTransport.
**NOTE**: We're very particular about the fMP4 ingested. See [dev/pub] for the required ffmpeg flags.
Major moq-transport API simplification (#68) Exponentially easier to use moq-transport as there's no message handling required. This is a BREAKING CHANGE.
2023-09-15 19:06:28 +00:00
Add support for multiple origins (#82) Adds `moq-api` to get/set the origin for each broadcast. Not used by default for local development.
2023-10-12 04:09:32 +00:00
### moq-transport
Major moq-transport API simplification (#68) Exponentially easier to use moq-transport as there's no message handling required. This is a BREAKING CHANGE.
2023-09-15 19:06:28 +00:00
Add support for multiple origins (#82) Adds `moq-api` to get/set the origin for each broadcast. Not used by default for local development.
2023-10-12 04:09:32 +00:00
A media-agnostic library used by [moq-relay] and [moq-pub] to serve the underlying subscriptions.
It has caching/deduplication built-in, so your application is oblivious to the number of connections under the hood.
Somebody build a non-media application using this library and I'll link it here!
Major moq-transport API simplification (#68) Exponentially easier to use moq-transport as there's no message handling required. This is a BREAKING CHANGE.
2023-09-15 19:06:28 +00:00
Add support for multiple origins (#82) Adds `moq-api` to get/set the origin for each broadcast. Not used by default for local development.
2023-10-12 04:09:32 +00:00
See the published [crate](https://crates.io/crates/moq-transport) and [documentation](https://docs.rs/moq-transport/latest/moq_transport/).
Major moq-transport API simplification (#68) Exponentially easier to use moq-transport as there's no message handling required. This is a BREAKING CHANGE.
2023-09-15 19:06:28 +00:00
Add support for multiple origins (#82) Adds `moq-api` to get/set the origin for each broadcast. Not used by default for local development.
2023-10-12 04:09:32 +00:00
### moq-api
Major moq-transport API simplification (#68) Exponentially easier to use moq-transport as there's no message handling required. This is a BREAKING CHANGE.
2023-09-15 19:06:28 +00:00
Add support for multiple origins (#82) Adds `moq-api` to get/set the origin for each broadcast. Not used by default for local development.
2023-10-12 04:09:32 +00:00
This is a API server that exposes a REST API.
It's used by relays to inserts themselves as origins when publishing, and to find the origin when subscribing.
It's basically just a thin wrapper around redis.
Dual license (#40) License under either MIT or Apache 2.0 at licensees' choice. Offering the option of MIT allows for GPL compatibility, but we can also allow licensees to choose Apache 2.0 if they prefer. This is common practice for many Rust projects.
2023-07-05 21:55:40 +00:00
## License
Remove the file source, since it doesn't loop. (#47) ffmpeg -> moq-warp coming soon
2023-07-22 04:03:09 +00:00
Licensed under either:
Dual license (#40) License under either MIT or Apache 2.0 at licensees' choice. Offering the option of MIT allows for GPL compatibility, but we can also allow licensees to choose Apache 2.0 if they prefer. This is common practice for many Rust projects.
2023-07-05 21:55:40 +00:00
Remove the file source, since it doesn't loop. (#47) ffmpeg -> moq-warp coming soon
2023-07-22 04:03:09 +00:00
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)