Sources

Pulls the last known value of a source. Will return 0 if the source doesn’t exist.
Very useful command to use together with Motion commands. For example, you can pull the current X and Y position of a source and then use Motion: Source Position to smoothly move it across the screen.

Changes the visibility of a source.

OBS WebSocket 5 Request: SetSceneItemEnabled

Toggles the visibility of a source. If the source is visible it’s turn off and vice versa.

OBS WebSocket 5 Request: SetSceneItemEnabled

SAMMI reads the current visibility state from its internal cache and then calls SetSceneItemEnabled with the inverted value.

Toggle source visibility

Toggle source visibility

Import JSON button

Changes the position of a source.

OBS WebSocket 5 Request: SetSceneItemTransform

Position 0, 0 is the top-left corner of the canvas. Coordinates are in pixels based on the canvas size (e.g. 1920×1080).

Changes the size of a source.
Use negative values for a horizontal (mirror) or vertical source flip.
The way the source resized is based on source’s positional alignment in OBS (source-Transform-Edit Transform).

OBS WebSocket 5 Request: SetSceneItemTransform

Changes the rotation of a source.
The center point of the rotation is based on the Positional Alignment option (source-Transform-Edit Transform).

OBS WebSocket 5 Request: SetSceneItemTransform

Changes the volume of a source.

OBS WebSocket 5 Request: SetInputVolume

Only one of inputVolumeMul or inputVolumeDb is sent per request depending on the Use dB checkbox.

Changes the positional alignment of a source.

OBS WebSocket 5 Request: SetSceneItemTransform

Changes the crop settings of a source.

OBS WebSocket 5 Request: SetSceneItemTransform

Changes the text of a Text GDI+ source.
If you wish to change the text to a value saved in a variable, you need to wrap it: /$variable$/.

OBS WebSocket 5 Request: SetInputSettings

Sends SetInputSettings with inputSettings: { "text": "your text here" }.

Changes the text of a Freetype 2 text source.
If you wish to change the text to a value saved in a variable, you need to wrap it: /$variable$/.

OBS WebSocket 5 Request: SetInputSettings

Sends SetInputSettings with inputSettings: { "text": "your text here" }.

Changes settings of a source. Not to be confused with item transform settings.
Easy way to see your current source’s settings is to use the Check Settings button - after filling out the Source Name box, you will get a pop-up showing the source’s settings, excluding any still at default values.

Use JSON string validator if you want to make sure your formatting is correct.

OBS WebSocket 5 Request: SetInputSettings

The setting keys depend on the source type. Use the Check Settings button in SAMMI or Send OBS Request with GetInputSettings to see available keys for your source.

Mutes the sound of a source.

OBS WebSocket 5 Request: SetInputMute

Inverts the mute status of a specified source. If the source was muted, it will be now unmuted and if the source was unmuted, it will be now muted.

OBS WebSocket 5 Request: ToggleInputMute

Changes the monitoring type of an audio source.
Same option as in OBS-Audio Mixer-Cogwheel-Advanced Audio Properties.

OBS WebSocket 5 Request: SetInputAudioMonitorType

Creates a new source and adds it to a scene.
You can pass a JSON string containing the new source’s settings as well.
The source will be added at the top of the list. To reorder it, use a Send OBS Request command.

OBS WebSocket 5 Request: CreateInput

Common inputKind values: browser_source, image_source, ffmpeg_source, vlc_source, text_gdiplus_v2, text_ft2_source_v2, color_source_v3, wasapi_input_capture, wasapi_output_capture, monitor_capture, window_capture, game_capture, dshow_input.

Deletes a source.

OBS WebSocket 5 Request: RemoveSceneItem

Duplicates a source, copying all transform and crop info.

OBS WebSocket 5 Request: DuplicateSceneItem

Changes the blend mode of a source.

OBS WebSocket 5 Request: SetSceneItemBlendMode

Saves a screenshot of an OBS source or scene to a local PNG file.

OBS WebSocket 5 Request: SaveSourceScreenshot

Gets the current settings of an OBS source and saves them as an object.

Example:

After saving the object, use Object Get Variable or JSON: Get Value after stringifying the object to read a specific setting.

OBS WebSocket 5 Request: GetInputSettings

Example saved objects by source type:

Gets OBS source names and saves them as an array. If a scene is selected, only sources in that scene are returned. If the scene field is empty, all known sources are returned.

Examples:

Use an empty scene name when you want every known source, or select a scene when you only want the sources currently listed in that scene.

Gets transform data for an OBS source in a scene and saves it as an object.

Example:

Typical values can include:

The exact keys depend on what OBS returns for the selected source and OBS WebSocket version.

OBS WebSocket 5 Request: GetSceneItemTransform

Example saved object:

{
  "positionX": 960,
  "positionY": 540,
  "width": 1920,
  "height": 1080,
  "scaleX": 1.0,
  "scaleY": 1.0,
  "rotation": 0,
  "cropLeft": 0,
  "cropTop": 0,
  "cropRight": 0,
  "cropBottom": 0,
  "sourceWidth": 1920,
  "sourceHeight": 1080
}