Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions doc/bin/obs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: Stream from OBS Studio to MoQ, or bring a broadcast into a scene
The plugin adds a **MoQ** streaming service and a **MoQ Source** to a stock
OBS Studio install.

- **Publish**: Settings > Stream, choose "MoQ", enter the relay URL (with `?jwt=` if needed) and broadcast path, Start Streaming.
- **Publish**: in the **MoQ** dock, enter the relay URL (with `?jwt=` if needed) and broadcast name, Go Live. OBS's own Start Streaming publishes over MoQ once obs-websocket sets the stream service, as [simulcast renditions](#simulcast-renditions) shows.
- **Subscribe**: add a "MoQ Source", enter the relay URL and broadcast path, and the stream appears in the scene.
- **Dock**: a **MoQ** dock with Go Live, encoding that uses the OBS Output settings or custom settings for this stream only, and live stats (protocol, RTT, bandwidth, loss), and the reason while a stream connects or reconnects.

Expand Down Expand Up @@ -44,9 +44,32 @@ shows the current video target beside the configured rate. An encoder shared
with a recording follows too, so record with a separate encoder to keep the
recording at the full rate.

## Simulcast renditions

Every video encoder on OBS's stream output is its own rendition of the
broadcast, with its size, codec, and (under CBR) configured bitrate in the
catalog, so `<moq-watch>` picks between them. OBS adds encoders from its WHIP
simulcast layer count, `Stream1` / `WHIPSimulcastTotalLayers` in the profile,
whatever the service: `N` layers add `N - 1` copies of the stream encoder,
layer `i` at `i/N` of the output size and bitrate. 3 layers on a 1080p
6000 kbps stream add 720p at 4000 kbps and 360p at 2000 kbps.

OBS's Settings window shows that count only for WHIP and cannot select the
MoQ service, so set both over obs-websocket:

1. `SetStreamServiceSettings` with `streamServiceType` `moq_service` and
`streamServiceSettings` `{"server": "<relay URL>", "key": "<broadcast path>"}`.
2. `SetProfileParameter` with `Stream1`, `WHIPSimulcastTotalLayers`, and a
count such as `"3"`. OBS applies it on restart or a profile switch.
3. `StartStream`.

Saving Settings > Stream afterwards replaces the MoQ service. The dock's Go
Live publishes one rendition. OBS's Enhanced Broadcasting (multitrack video)
always streams through its RTMP output, so it cannot drive MoQ.

## Source quality and moq-transcode

OBS publishes **one** rendition and does not encode a viewer ladder. When a
Without simulcast layers, OBS publishes **one** rendition. When a
relay or moq.pro runs [`moq-transcode`](/bin/cli#transcode), the ladder appears
beside the source as `{broadcast}/transcode.hang`. For a good ladder, name the
broadcast with a `.hang` suffix, use a canvas at least as tall as the top rung
Expand Down
1 change: 0 additions & 1 deletion quest/m1/simulcast-rung-disable.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,4 @@ its `moq_video_encode_options`.

- [JS rung disable](/quest/m2/probe/rung-disable-js.md) - the same rule in `js/publish`, probing with padding
- [Ladder controller](/quest/m3/ladder/controller.md) - the same rung disable for generated transcode ladders
- [OBS multitrack](/quest/m2/obs-multitrack.md) - OBS's native multitrack encoders as the renditions this disables
- [Viewer up-switch](/quest/m2/probe/viewer-upswitch.md) - the viewer side of moving between renditions as capacity changes
1 change: 0 additions & 1 deletion quest/m2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ lite-07; bitrate enforcement is not part of this release.

- [Pipelined requests](/quest/m2/pipeline-requests/README.md) - SUBSCRIBE and the first FETCH go out with the track-info request at every hop, so first data arrives a round trip sooner per hop
- [OBS native codecs](/quest/m2/obs-moq-video/README.md) - replace FFmpeg video and audio decoding with moq-video and moq-audio, deliver GPU frames, and use native audio/video encoders
- [OBS multitrack](/quest/m2/obs-multitrack.md) - the obs-moq output publishes OBS's native multitrack video encoders as simulcast renditions, configured like OBS multitrack and over obs-websocket
- [MoQ in obs-studio](/quest/m2/obs-studio/README.md) - a native MoQ output and service merged into obs-studio, once its maintainers agree; the plugin carries it until then
- [OBS source renditions](/quest/m2/obs-source-renditions.md) - the OBS source picks the best enabled decodable rendition, using a `preference` the bindings now carry, and resubscribes when a referenced publisher's epoch changes
- [CMake qlog option for OBS](/quest/m2/obs-qlog.md) - an OBS build can opt into qlog trace capture through moq-ffi's `qlog` feature
Expand Down
39 changes: 0 additions & 39 deletions quest/m2/obs-multitrack.md

This file was deleted.

1 change: 0 additions & 1 deletion quest/m2/obs-studio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,5 @@ Open, for when the port starts:

## Related

- [OBS multitrack](/quest/m2/obs-multitrack.md) - multitrack video renditions the native output should carry
- [First C++ package release](/quest/m2/release/cpp-release.md) - the published C++ package the port would build on
- [OBS native codecs](/quest/m2/obs-moq-video/README.md) - the plugin's codec work, which stays plugin-side