Skip to main content

What is a streamed session?

A streamed session runs the model continuously and plays its output to your app in real time, as live video and audio. It is the default of the two session types, and the one you get unless you ask for a stepped session. Every model runs as a loop of steps. In a streamed session the model drives that loop on its own: once the session is ready, it runs step after step, and each step’s frames go out on the model’s output tracks as soon as they are produced. Your app does not request frames. It steers the model while it runs.

When to use it

Use a streamed session for anything a person watches or plays live:
  • Interactive video and worlds. A user steers the model with controls, prompts, or a camera, and sees the result immediately.
  • Live transformation. Your app streams a camera or screen into the model and shows what comes back.
  • Viewers and multiplayer. Several connections watch, and steer, one running model.
If you need to know exactly which input produced which output, or want frames as arrays rather than a video stream, use a stepped session instead.

How it works

The model does not wait for your app. A command changes what the model generates from the next step on, not a particular frame. If you need to change the prompt or controls between two specific steps, use a stepped session.

Starting a streamed session

You don’t need to ask for a streamed session: every session is streamed unless your app asks for a stepped one. Connect as usual, and media starts flowing once the connection reaches ready.
See the Quickstart for a full example that renders the model’s video and sends a command.

Next steps

Tracks

Receive the model’s live media and publish your own.

Commands & Messages

Steer the model while it runs and handle what it sends back.

Recordings

Save clips of a live session.

Stepped sessions

Run one step per request instead of a live stream.