Documentation Index
Fetch the complete documentation index at: https://docs.reactor.inc/llms.txt
Use this file to discover all available pages before exploring further.
FileRef
A reference to an uploaded file, returned by uploadFile(). Pass into sendCommand() to attach files to a command.
Definition
ReactorStatus
The connection state of a Reactor instance.
Definition
ReactorState
Definition
ReactorError
Definition
Error codes
| Code | Component | Recoverable | Description |
|---|---|---|---|
CONNECTION_FAILED | api | Yes | Failed to establish a connection |
GPU_CONNECTION_ERROR | gpu | Yes | Connection to GPU dropped |
MESSAGE_SEND_FAILED | gpu | Yes | Failed to send a message |
TRACK_PUBLISH_FAILED | gpu | Yes | Failed to publish a media track |
RECONNECTION_FAILED | gpu | Yes | Failed to reconnect to existing session |
TrackCapability
Describes a media track declared in the model’s capabilities. Track capabilities are provided by the server after session creation. You do not need to declare tracks on the client.
Definition
Capabilities
The model’s capabilities, received after session creation.
Definition
reactor.getCapabilities() or the capabilitiesReceived event.
Clip
A captured clip returned by requestClip() and requestRecording(). Pass it to ClipPlayer, ClipDownloadButton, or useClipDownload to play or save it.
Definition
Clip is temporary. The URL it carries expires after 24 hours, so save the bytes locally if you need them later. See Recordings for usage.
RecordingError
Thrown by the recording APIs when a clip request, playback, or download fails.
Definition
Error codes
| Code | Description |
|---|---|
RECORDER_DISABLED | The model does not have recording enabled, or recording crashed on the server. |
INVALID_DURATION | requestClip was called with a non-positive or non-finite duration. |
DISCONNECTED | The session disconnected before the server answered, or the request was issued while disconnected. |
REQUEST_TIMEOUT | The server did not acknowledge the request in time. |
CLIP_GONE | The clip is no longer available (it has aged out, or the session is unknown). |
CLIP_NOT_READY | The clip was still being finalised past the expected grace window. |
PLAYLIST_FETCH_FAILED | Network error while fetching the clip. |
CHUNK_FETCH_FAILED | One of the clip’s segments failed to download. |
INVALID_PLAYLIST | The clip metadata was malformed. |
DOWNLOAD_UNSUPPORTED | downloadClipAsFile() was called outside a browser with a non-null filename. Pass filename: null to receive the Blob instead. |
INTERNAL_ERROR | Catch-all for unexpected SDK or server failures. |
ClipDownloadState
State of an in-progress download, returned by useClipDownload.
Definition
total is 0 until the SDK knows how many segments to fetch. message is suitable for inline display.
ConnectionStats
WebRTC connection statistics returned by useStats() and the statsUpdate event.
Definition