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

Update links in README.md

This commit is contained in:
kixelated 2023-10-12 13:13:45 +09:00 committed by GitHub
parent 04ff9d5a6a
commit 1cf8a7617c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -12,11 +12,11 @@ This repository contains a few crates:
- **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.
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.
There's currently no way to view media with this repo; you'll need to use [moq-js](https://github.com/kixelated/moq-js) for that.
## Development
See the [dev/README.md] helper scripts for local development.
Use the [dev helper scripts](dev/README.md) for local development.
## Usage
@ -24,11 +24,11 @@ See the [dev/README.md] helper scripts for local development.
**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.
The relays register themselves via the [moq-api] endpoints, which is used to discover other relays and share broadcasts.
The relays register themselves via the [moq-api](moq-api) endpoints, which is used to discover other relays and share broadcasts.
Notable arguments:
- `--listen <ADDR>` Listen on this address [default: [::]:4443]
- `--listen <ADDR>` Listen on this address, default: `[::]:4443`
- `--cert <CERT>` Use the certificate file at this path
- `--key <KEY>` Use the private key at this path
- `--fingerprint` Listen via HTTPS as well, serving the `/fingerprint` of the self-signed certificate. (dev only)
@ -43,15 +43,14 @@ This can be combined with ffmpeg (and other tools) to produce a live stream.
Notable arguments:
- `<URL>` connect to the given address, which must start with https:// for WebTransport.
- `<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.
**NOTE**: We're very particular about the fMP4 ingested. See [this script](dev/pub] for the required ffmpeg flags.
### moq-transport
A media-agnostic library used by [moq-relay] and [moq-pub] to serve the underlying subscriptions.
A media-agnostic library used by [moq-relay](moq-relay) and [moq-pub](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!
See the published [crate](https://crates.io/crates/moq-transport) and [documentation](https://docs.rs/moq-transport/latest/moq_transport/).
@ -59,7 +58,7 @@ See the published [crate](https://crates.io/crates/moq-transport) and [documenta
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.
It's basically just a thin wrapper around redis that is only needed to run multiple relays in a (simple) cluster.
## License