Scenes

Activate a scene

Switch the active scene in the project. The previously active scene is deactivated.

Auto-sync behavior:

  • If auto-sync is enabled and a live stream is running, the scene change is pushed to the stream immediately (synced: true).
  • If auto-sync is disabled (or not set), the scene is activated only in the project (synced: false). The live stream continues showing the previous scene until you call the sync endpoint.

Check the synced field in the response to know whether the change reached the live stream.

post/projects/{id}/scenes/{sceneId}/activate

Request

  • Base URL: https://api.livereacting.com/v1/external
  • URL: https://api.livereacting.com/v1/external/projects/{id}/scenes/{sceneId}/activate
  • Auth: HTTP bearer

Path parameters

idstring required

Project ID

sceneIdstring required

Scene ID to activate

Response

Scene activated successfully

activeSceneIdstring

ID of the now-active scene

syncedboolean

Whether the scene change was synced to the live stream. true — auto-sync is enabled and the live stream now shows this scene. false — the scene is active in the project only. This happens when auto-sync is disabled, not set, or no live stream is running. Call the sync endpoint to push changes to the live stream.

Changes

No recorded changes to this operation across all 1 revision of this API.