Scenes

Switches to the selected scene with normal transition.

OBS WebSocket 5 Request: SetCurrentProgramScene

Temporarily changes the transition of a scene. Lasts until you use Remove Scene Transition command.

OBS WebSocket 5 Request: SetSceneSceneTransitionOverride

Removes temporarily changed transition of a scene (from executing Change Scene Transition command).

OBS WebSocket 5 Request: SetSceneSceneTransitionOverride

Sends SetSceneSceneTransitionOverride with an empty transitionName to remove the override and restore the global transition for the specified scene.

Change the current transition.

OBS WebSocket 5 Request: SetCurrentSceneTransition

Changes the current settings of a transition. Same as going to your OBS and clicking on ‘Properties’ in your Scene Transitions.
Example: {"transition_match": "Fade","switch_percentage": 30,"easing_match": 2,"position_in": 10}

You can retrieve your current transition settings by executing a Send OBS Request command with the following JSON (OBSws 5):

{
  "op": 6,
  "d": {
    "requestType": "GetCurrentSceneTransition"
  }
}

OBS WebSocket 5 Request: SetCurrentSceneTransitionSettings

The available keys in transitionSettings depend on the selected transition type. Use Send OBS Request with GetCurrentSceneTransition to view current settings.

Changes the duration of a specified transition.

OBS WebSocket 5 Request: SetCurrentSceneTransitionDuration

Creates a new scene in OBS.

OBS WebSocket 5 Request: CreateScene

Gets the current OBS scene list and saves the scene names as an array.

Example:

You can combine this command with Array Get Size, Array Get Value, or Repeat to loop through all OBS scenes.

OBS WebSocket 5 Request: GetSceneList

SAMMI extracts the sceneName from each scene object and returns them as a plain string array.

Gets the name of the current Preview scene in OBS Studio Mode and saves it as a string variable.

Studio Mode must be enabled in OBS (View → Studio Mode) for this command to return a meaningful value. Use this to check what is currently staged in the Preview before triggering a transition.

Saved Value:

OBS WebSocket 5 Request: GetCurrentPreviewScene

No request fields.

Example SAMMI Response:

Gameplay

Sets the OBS Studio Mode Preview scene without affecting the active Program output.

Studio Mode must be enabled in OBS (View → Studio Mode). This command loads a scene into the Preview panel without changing what viewers currently see on stream. Use Activate Studio Mode Scene afterwards to trigger the transition and move the Preview to Program.

OBS WebSocket 5 Request: SetCurrentPreviewScene

Triggers the Studio Mode transition in OBS — moves the current Preview scene to the Program output.

Studio Mode must be enabled in OBS (View → Studio Mode). This is equivalent to pressing the Transition button in OBS Studio Mode — whatever scene is currently in the Preview will become the new Program output. The transition type and duration configured in OBS are used.

Use Set Studio Mode Scene first to control which scene gets transitioned, then call this command to execute the switch.

OBS WebSocket 5 Request: TriggerStudioModeTransition

No request fields — executes the transition immediately using the active OBS transition settings.