Scenes

On this page

Edit

Switch Scene #

Switches to the selected scene with normal transition.

Use premade global.Main.current_scene or global.Main.previous_scene variables to switch to your current or previous scene.

Box Name	Type	Description
OBS	Dropdown	OBS to send this command to (if using multiple OBS)
Scene Name	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 Name	String	Transition scene name. Select from dropdown or input manually.
Transition Name	String	Name of the transition
Duration (ms)	Int	Duration of the transition in milliseconds

Edit

Remove Scene Transition #

Removes temporarily 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 Name	String	Scene name that has a temporary transition added to it. Select from dropdown or input manually.

Edit

Set Transition #

Change the current transition.

Box Name	Type	Description
OBS	Dropdown	OBS to send this command to (if using multiple OBS)
Transition	String	Desired transition name to change to

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 Send OBS Request command with the following JSON (OBSws 5):

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

Box Name	Type	Description
OBS	Dropdown	OBS to send this command to (if using multiple OBS)
Transition Name	String	Name of the transition to modify
Settings (JSON)	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 (ms)	Number	New duration in milliseconds

Edit

Create Scene #

Creates a new scene in OBS.

If using OBS 27 or older, you must restart OBS before creating a scene with the same name as the scene you just deleted.

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.