Skip to main content

FileRef

A reference to an uploaded file, returned by uploadFile(). Pass into sendCommand() to attach files to a command.
Definition
See File Uploads for usage examples.

ReactorStatus

The connection state of a Reactor instance.
Definition

ReactorState

Definition

ConnectOptions

Options passed to connect(), reconnect(), and the React provider’s connectOptions prop.
Definition
  • maxAttempts caps how many times the SDK polls the server for its SDP answer (its reply in the WebRTC connection handshake) before the connect fails.
  • autoResumeTracks (default true) subscribes to every output (recvonly) track as soon as the connection is established, so output reaches your client on connect. The model emits frames the whole time the session runs; this only controls whether your client receives them. Set it to false to start unsubscribed and subscribe per track with resumeTrack().
  • sessionId attaches to a session that already exists, for example one created by your backend, instead of creating a new one. The token passed to connect() must be valid for the account that owns the session. Only the session’s creator can terminate it. A client that adopts the session leaves it running when it disconnects. See Sessions.
  • connectionId joins the session using a specific WebRTC connection id already registered for it, for example one your backend created and handed to this client. When omitted, the SDK registers a fresh connection and the server mints the id. connect() rejects if the id is unknown or already closed.

ReactorError

Definition

Error codes

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
Track names are defined by the model and handled automatically by the SDK.

Capabilities

The model’s capabilities, received after session creation.
Definition
Access via 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
A 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

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