All symbols

The application and media symbols below are importable from the top-level package:

from reactor_runtime import ReactorApp, InputState, Output, Video, event

Those names are also available under reactor_runtime.interface, but the top-level package is the path to use. Distributed workers use a separate import, shown below.

The app

Symbol	Description
`ReactorApp`	The class you subclass to define a model
`StepOutcome`	What `generate()` did on one step
`ApplicationError`	Raise from `process_input()` to skip a step

State

Symbol	Description
`InputState`	Base for the state a client can set
`InputField()`	Declare a field’s default and constraints
`FieldInfo`	The resolved constraints of one field

Commands

Symbol	Description
`@event`	Mark a method as the handler for a named command
`Command`	Base for the generated command payload
`CommandError`	Answer a caller with a failure
`UploadedFile`	A file a client sent, as bytes
`@file_uploaded`	Receive a file sent outside any command

Messages

Symbol	Description
`ModelMessage`	Base for a typed message to clients
`MessageField()`	Declare a default and a description

Sessions and clients

Symbol	Description
`@session_started`	Runs once when a session begins
`@session_ended`	Runs once when a session ends
`@connected`	Runs each time a client connects
`@disconnected`	Runs each time a client disconnects
`ClientInfo`	One client’s identity, and messaging it alone

Outbound media

Symbol	Description
`Output`	Base for the tracks your model sends
`Video`	Declares a video track
`Audio`	Declares an audio track
`Track`	The base both `Video` and `Audio` extend
`TrackPayload`	Frames plus the metadata to send with them
`Metadata`	What a frame’s metadata can be
`OutputStream`	`self.output`, the handle onto playout

Inbound media

Symbol	Description
`MediaInput`	Base for the tracks your model receives
`InputFrame`	One frame that arrived from a client
`InputBuffer`	One inbound track’s frames
`ReadMode`	Newest frames, or oldest
`BufferClosed`	Raised once a closed track is drained

Distributed workers

These names are available from reactor_runtime.distributed:

from reactor_runtime.distributed import DistributedRunner, DistributedWorker

Symbol	Description
`DistributedRunner`	Start workers and drive them with one call
`DistributedWorker`	Base class for a model worker
`WorkerCrashed`	A worker exited without answering
`WorkerTimeout`	Workers did not all answer before the deadline
`RankDesync`	Ranks disagreed on success or exception type
`SharedSlotAllocationFailed`	A shared-memory block could not be allocated

Helpers

Symbol	Description
`get_weights_path()`	The directory the model’s weights live under
`get_logger()`	A logger that carries the session id

Renamed

These still import, with a deprecation warning.

Old name	Use instead
`ReactorModel`	`ReactorApp`
`ReactorPipeline`	`ReactorApp`
`Input`	`MediaInput`
`Idle`	`ApplicationError`

Get Started

CLI & Platform

Build a Model

Media & Transport

Releases

The app

State

Commands

Messages

Sessions and clients

Outbound media

Inbound media

Distributed workers

Helpers

Renamed

​The app

​State

​Commands

​Messages

​Sessions and clients

​Outbound media

​Inbound media

​Distributed workers

​Helpers

​Renamed

The app

State

Commands

Messages

Sessions and clients

Outbound media

Inbound media

Distributed workers

Helpers

Renamed