# reactor-effect

> reactor-effect is an independent Effect (effect-ts v4) SDK for Reactor's real-time video models. Packages: reactor-effect-client (portable core: sessions, tokens, the H3 provider, Playout, ReactorTest), reactor-effect-browser (RTCPeerConnection host), reactor-effect-native (libwebrtc Node-API host with decoded frames).

reactor-effect is an independent, Apache-2.0 project, not affiliated with Reactor; "official documentation" below means this site. Every package pins Effect 4.0.0-rc.117 exactly. Import modules by subpath (reactor-effect-client/Playout) or as namespaces from the root. ReactorTest runs the same application offline on the Effect clock, with no API key.

## Pages

- [Quickstart](https://mannyc2.github.io/reactor-effect-client/start/quickstart/): one H3 clip offline with no key, then live
- [Installation](https://mannyc2.github.io/reactor-effect-client/start/installation/): packages per host, the exact Effect pin and the platform override
- [Going live](https://mannyc2.github.io/reactor-effect-client/start/going-live/): API key, session tokens, caps and what a session costs
- [Sessions and tokens](https://mannyc2.github.io/reactor-effect-client/concepts/sessions/): Reactor, Session, CoordinatorClient, reconnects and close reports
- [The H3 provider](https://mannyc2.github.io/reactor-effect-client/concepts/h3/): requests, references, the queue and each clip's operation facts
- [Playout](https://mannyc2.github.io/reactor-effect-client/concepts/playout/): lanes, filler, windows, edits, placement and renewal across sessions
- [Sources](https://mannyc2.github.io/reactor-effect-client/concepts/sources/): H3Source and LocalSource
- [Media](https://mannyc2.github.io/reactor-effect-client/concepts/media/): decoded frames, PCM and browser tracks
- [Errors and dispatch evidence](https://mannyc2.github.io/reactor-effect-client/concepts/errors/): tagged reasons and not-submitted / replied / unknown outcomes
- [Test offline with ReactorTest](https://mannyc2.github.io/reactor-effect-client/guides/testing-offline/): the simulated Reactor on TestClock, with faults
- [Run a 24/7 channel](https://mannyc2.github.io/reactor-effect-client/guides/channel/): one playout broadcast to many viewers
- [Sessions in the browser](https://mannyc2.github.io/reactor-effect-client/guides/browser/): BrowserPeer with a token server
- [Frames in Node and Bun](https://mannyc2.github.io/reactor-effect-client/guides/native/): the libwebrtc addon, in process or isolated
- [Cost control](https://mannyc2.github.io/reactor-effect-client/guides/cost-control/): caps, confirmed termination and budgets
- [Modules](https://mannyc2.github.io/reactor-effect-client/reference/modules/): every public module and its exports
- [Hosted evidence](https://mannyc2.github.io/reactor-effect-client/reference/hosted-evidence/): every paid run behind the hosted claims

## Documentation Sets

- [Abridged documentation](https://mannyc2.github.io/reactor-effect-client/llms-small.txt): a compact version of the documentation for reactor-effect, with non-essential content removed
- [Complete documentation](https://mannyc2.github.io/reactor-effect-client/llms-full.txt): the full documentation for reactor-effect

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation

## Optional

- [Reactor's own documentation](https://docs.reactor.inc/llms.txt): models, commands, pricing and limits
- [Source and examples](https://github.com/mannyc2/reactor-effect-client)