Scenes

On this page
Edit

Scene Switch #

Switches to the selected scene with normal transition.

Box Name Type Description
OBS Dropdown OBS to send this command to (if using multiple OBS)
Scene String Scene name you want to switch to. Select from the menu or type manually.

Edit

Change Scene Transition #

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

Box Name Type Description
OBS Dropdown OBS to send this command to (if using multiple OBS)
Scene String Transition scene name
Transition Name String Name of the transition
Duration Int Duration of the transition in milliseconds

Edit

Remove Scene Transition #

Remove temporary changed transition of a scene (from executing Change Scene Transition command).

Box Name Type Description
OBS Dropdown OBS to send this command to (if using multiple OBS)
Scene String Scene name that has a temporary transition added to it

Edit

Set Transition #

Set the duration of the currently selected transition if supported.

Box Name Type Description
OBS Dropdown OBS to send this command to (if using multiple OBS)
Duration Number Desired duration of the transition (in milliseconds).

Edit

Set Transition Settings #

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 Fetch OBS Data command with the following JSON: {"request-type":"GetTransitionSettings","transitionName":"YOURTRANSITIONNAME","message-id":"6666"}

Box Name Type Description
OBS Dropdown OBS to send this command to (if using multiple OBS)
Transition String Name of the transition to modify
Settings JSON JSON string containing the transition settings

Edit

Set Transition Duration #

Changes the duration of a specified transition.

Box Name Type Description
OBS Dropdown OBS to send this command to (if using multiple OBS)
Transition String Name of the transition
Duration Number New duration in milliseconds

Edit

Create Scene #

Creates a new scene in OBS.

Box Name Type Description
OBS Dropdown OBS to send this command to (if using multiple OBS)
Scene Name String Unique name of the scene to create.