connect(handlers?): Promise<MediaStream> | Connect to a streaming session (returns MediaStream when ready) |
createClientCredentials(): Promise<ClientCredentials> | Mint short-lived credentials for client-side connections (v1.3.0+) |
connectWithCredentials(credentials, handlers?): Promise<MediaStream> | Connect with pre-minted credentials (no API key required) (v1.3.0+) |
disconnect(): void | Disconnect and clean up resources |
startStream(options?): Promise<string> | Start an interactive stream. Supports ‘broadcast: true’ to enable shared playback. |
interact(options): Promise<string> | Send a prompt to update the video |
endStream(): Promise<void> | End the current stream session |
attachToVideo(element): HTMLVideoElement | Attach stream to a video element |
getRecording(streamId): Promise<Recording> | Get recording URLs for a stream |
listStreamRecordings(options?): Promise<StreamRecordingsListResponse> | List user’s stream recordings |
simulate(options): Promise<SimulationJob> | Create an async simulation job |
getSimulateStatus(id): Promise<SimulationJobDetail> | Get simulation job status |
listSimulations(options?): Promise<SimulationJobsList> | List simulation jobs |
cancelSimulation(id): Promise<void> | Cancel a simulation job |
connectToStream(webrtcUrl: string, spectatorToken: string, options?: { signal?: AbortSignal }): Promise<SpectatorConnection> | Connect as a spectator to an existing broadcast stream (WebRTC/WHEP). |
