iroh-live Reference Documentation
Status: Early tech preview. APIs are unstable. Based on source code analysis of the iroh-live workspace.
Files
| File | Topic |
|---|---|
| 01-overview-and-architecture | Workspace structure, crate layers, design principles, data flow, dependencies |
| 02-core-api | Live, LiveTicket, Call, Subscription, DisconnectReason, util module |
| 03-iroh-moq-transport | Moq, MoqSession, MoqProtocolHandler, actor internals, session lifecycle, error types |
| 04-rooms | Room, RoomHandle, RoomTicket, RoomEvent, gossip KV coordination, actor architecture |
| 05-relay | iroh-live-relay: browser bridging, pull model, RelayConfig, PullState, web viewer |
| 06-moq-media-pipelines | LocalBroadcast, RemoteBroadcast, VideoTrack, AudioTrack, transport abstraction, codec support |
| 07-network-signals-and-adaptive-bitrate | NetworkSignals, adaptation algorithm, AdaptiveConfig, Decision, probe lifecycle |
| 08-p2p-and-relay | iroh P2P connectivity, relay architecture, pull model, ticket format, connection access |
Quick Navigation
"How do I..."
- Publish a stream? → 02-core-api (
Live::publish) + 06-moq-media-pipelines (LocalBroadcast) - Subscribe to a stream? → 02-core-api (
Live::subscribe) + 06-moq-media-pipelines (RemoteBroadcast) - Make a 1:1 call? → 02-core-api (
Call::dial/Call::accept) - Create a multi-party room? → 04-rooms (
Room::new,RoomTicket) - Bridge to browsers? → 05-relay (
iroh-live-relay) - Adapt quality to network conditions? → 07-network-signals-and-adaptive-bitrate
- Understand the MoQ transport? → 03-iroh-moq-transport
- Understand the media pipeline? → 06-moq-media-pipelines
Key Source Files
| Component | Path |
|---|---|
| iroh-live crate | iroh-live/src/{lib, live, call, subscription, ticket, types, util, rooms}.rs |
| iroh-moq crate | iroh-moq/src/lib.rs |
| iroh-live-relay | iroh-live-relay/src/{lib, main, pull}.rs |
| moq-media publish | moq-media/src/publish.rs |
| moq-media subscribe | moq-media/src/subscribe.rs |
| moq-media adaptive | moq-media/src/adaptive.rs |
| moq-media transport | moq-media/src/transport.rs |
| moq-media network signals | moq-media/src/net.rs |