OBS Item Properties

Edit

Pull Source Value #

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

Pull Type Description Possible values
X/Y position returns X or Y position of the source for example 500
X/Y scale returns scale of the source that affects its width (X) and height (Y) 1 = 100% scale
Rotation returns the degree of rotation of the source 0-360
Volume returns the volume percentage of the source 0-100
Muted returns boolean value whether the source is muted or not 0 for unmuted and 1 for muted
Visible returns boolean value whether the source is visible or not 0 for not visible and 1 for visible
Box Name Type Description
Scene String Scene name containing the source
Source String Source name to pull the value
Variable String Variable name to save the pulled value into
Pull Dropdown menu Type of the value you wish to pull


Edit

Source Change Visibility #

Changes the visibility of a source.

Box Name Type Description
scene-name String (optional) Scene name containing the source. Leave blank for current active scene.
item String Source name
visible boolean True for visible, False for not visible or Toggle to invert current visibility status
Toggle should be used only if it’s a single button command.


Edit

Source Change Position #

Changes the position of a source.

Box Name Type Description
scene-name String (optional) Scene name containing the source. Leave blank for current active scene.
item String Source name
Field: X Real (optional) X position to set the source to. Can leave blank to not modify it.
Field: Y Real (optional) Y position to set the source to. Can leave blank to not modify it.


Edit

Source Change Scale #

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).

Box Name Type Description
scene-name String (optional) Scene name containing the source. Leave blank for current active scene.
item String Source name to change size.
X Scale Real (optional) X Scaling to set the source to. Leave blank to not modify it. 1.0 is 100%.
Y Scale Real (optional) Y Scaling to set the source at. Leave blank to not modify it. 1.0 is 100%.


Edit

Source Change Rotation #

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

Box Name Type Description
scene-name String (optional) Scene name containing the source. Leave blank for current active scene.
item String Source name to change rotation.
rotation Real Rotation angle to change the source to. 0 is normal, 180 is upside down, 360 is back normal


Edit

Source Change Volume #

Changes the volume of a source.

Box Name Type Description
source String (optional) Scene name containing the source. Leave blank for current active scene.
volume % Real Percentage to set the volume to, between 0 and 100.


Edit

Source Motion: Position #

Moves a source from point A to point B over a given duration.
If you want to move a source from its current position, you can use the command Math: Pull Source Value to find the current source’s X and Y position and incorporate it into this command.

Box Name Type Description
scene String Scene name containing the source
source String Source name to move
Start X Real Starting X position
Start Y Real Starting Y position
Final X Real Final X position
Final Y Real Final Y position
Dur.(MS) Int Duration of the transition in milliseconds
Smooth dropdown Type of transition.
None = Normal, Out = Starts out fast and ends slow, In = Starts out slow and ends fast,
In/Out= Starts out slow, gets faster and then slows down at the end again.


Edit

Source Motion: Position Curve #

Moves a Source from point A to point B over a given duration and curves it in a circle pattern.
You can make a source complete a half circle or have a slight curve in its transition.
If you want to move a source from its current position, you can use the command Math: Pull Source Value to find current source’s X and Y position and incorporate it into this command.

Box Name Type Description
scene String Scene name containing the source
source String Source name to move
Start X Real Starting X position
Start Y Real Starting Y position
Final X Real Final X position
Final Y Real Final Y position
Curve % Real The amplitude of the curve. Can be negative or over 100.
100% = perfect half circle, 0% = straight line with a slower start and slower finish.
-200% elongated half circle on the opposite side.
Dur.(MS) Int Duration of the transition in milliseconds
Smooth dropdown Type of transition.
None = Normal, Out = Starts out fast and ends slow, In = Starts out slow and ends fast,
In/Out= Starts out slow, gets faster and then slows down at the end again.


Edit

Source Motion: Scale #

Resizes a source from Size A to size B over a given duration.
Due to the way the OBS source resizing work, the result might look a bit snappy sometimes.
The way the source is resized is based on what the source’s point of origin is set to in OBS.
You can use negative values for a horizontal (mirror) or vertical source flip.
You can use Math: Pull Source Value command to find current source’s X and Y size and incorporate it into this command.

Box Name Type Description
scene String Scene name containing the source
source String Source name to scale
Start Xscale Real Starting X size
Start Yscale Real Starting Y size
Final Xscale Real Final X size
Final Yscale Real Final Y size
Dur.(MS) Int Duration of the transition in milliseconds
Smooth dropdown Type of transition.
None = Normal, Out = Starts out fast and ends slow, In = Starts out slow and ends fast,
In/Out= Starts out slow, gets faster and then slows down at the end again.


Edit

Source Motion: Rotation #

Changes the rotation of a source over a set duration.
The center point of the rotation is based on the Positional Alignment option (right click on the source in OBS-Transform-Edit Transform).
You can use Math: Pull Source Value command to get the current rotation of a source and incorporate it in this command.

Box Name Type Description  
scene String Scene name including the source.  
item String Source name to change the rotation.  
Start Rotation Real Starting Rotation. 0-360  
Final Rotation Real Final Rotation. 0-360  
Dur.(MS) Int   Duration of the transition in milliseconds
Smooth dropdown Type of transition.
None = Normal, Out = Starts out fast and ends slow, In = Starts out slow and ends fast,
In/Out= Starts out slow, gets faster and then slows down at the end again.
 


Edit

Source Motion: Volume #

Changes the volume of a given source from volume A to B over a duration.
You can use Math: Pull Source Value command to get the current volume of a source and incorporate it in this command.

Box Name Type Description
source String Source name to change the volume
Start Volume% Real Starting volume percentage. 0-100 range.
Final Volume% Real Final volume percentage. 0-100 range.
Dur.(MS) Int Transition duration in milliseconds


Edit

Source Motion: Alpha Filter #

Changes the transparency of a source over a set duration.
Requires a Color Correction filter to be added to your source.
This way you can gradually fade out a source before turning its visibility completely off and gradually fade in a source after turning its visibility on.

Box Name Type Description
source String Source name to change the transparency of.  
filterName String Filter name. Must be a Color Correction filter.
Start Alpha% Real Starting transparency percentage. 0-100 or 0-1 depending on the filter’s version.
Final Alpha% Real Final transparency percentage. 0-100 or 0-1 depending on the filter’s version.
Dur.(MS) Int Transition duration in milliseconds


Edit

Source Mute #

Mutes the sound of a source.

Box Name Type Description
Source String Source name to be muted. Can be a scene name as well.
mute boolean True for mute source, false for unmute source


Edit

Source Toggle Mute #

Inverts the mute status of a specified source.

Box Name Type Description
Source String Source name to be muted or unmuted. Can be a scene name as well.