Get Scene Item Properties

Preview

Parameters

Connectionrequired

Select

Select the configured OBS Studio Connection to connect to

Any - trigger on events from any OBS connection
Default - trigger on events from the default OBS connection

Scenerequired

Text

Select the scene from this dropdown list, you can also manually enter a scene name.

Sourcerequired

Text

Select the source from this dropdown list, you can also manually enter a source name.

Variables

The following variables will be populated after executing this sub-action:

		Description
`props._json`	`string`	Everything above in a json format
`props.bounds.alignment`	`string`	The alignment of the bounding box
`props.bounds.type`	`string`	The type of bounding box Example: `OBS_BOUNDS_STRETCH, OBS_BOUNDS_SCALE_INNER, OBS_BOUNDS_SCALE_OUTER, OBS_BOUNDS_SCALE_TO_WIDTH, OBS_BOUNDS_SCALE_TO_HEIGHT, OBS_BOUNDS_MAX_ONLY or OBS_BOUNDS_NONE`
`props.bounds.x`	`number`	The width of the bounding box
`props.bounds.y`	`number`	The height of the bounding box
`props.crop.bottom`	`number`	The number of pixels cropped off the bottom of the source before scaling
`props.crop.left`	`number`	The number of pixels cropped off the left of the source before scaling
`props.crop.right`	`number`	The number of pixels cropped off the right of the source before scaling
`props.crop.top`	`number`	The number of pixels cropped off the top of the source before scaling
`props.groupChildren[#].<one of these above>`	`any`	List of children (if this item is a group)
`props.height`	`number`	Scene item height (base source height multiplied by the vertical scaling factor)
`props.itemId`	`string`	The scene Item id
`props.locked`	`boolean`	If the source's transform is locked Example: `true`
`props.message-id`	`string`	The id of the message
`props.muted`	`boolean`	If the source is muted Example: `true`
`props.name`	`string`	Scene Item name
`props.position.alignment`	`string`	The point on the source that the item is manipulated from. The sum of 1=Left or 2=Right, and 4=Top or 8=Bottom, or omit to centre on that axis
`props.position.x`	`number`	The x position of the source from the left
`props.position.y`	`number`	The y position of the source from the top
`props.rotation`	`number`	The clockwise rotation of the item in degrees around the point of alignment
`props.scale.filter`	`string`	The scale filter of the source Example: `OBS_SCALE_DISABLE, OBS_SCALE_POINT, OBS_SCALE_BICUBIC, OBS_SCALE_BILINEAR, OBS_SCALE_LANCZOS or OBS_SCALE_AREA`
`props.scale.x`	`number`	The x-scale factor of the source
`props.scale.y`	`number`	The y-scale factor of the source
`props.sourceHeight`	`number`	Base source (without scaling) of the source
`props.sourceWidth`	`number`	Base width (without scaling) of the source
`props.status`	`string`	The status of the sub-action
`props.visible`	`boolean`	If the source is visible Example: `true`
`props.width`	`number`	Scene item width (base source width multiplied by the horizontal scaling factor)

C# Usage

public string ObsGetSceneItemProperties(string scene, string source, int connection = 0)

Set Replay Buffer State

Change your replay buffer status

Hide Scene's Sources

Hide ALL sources within the given Scene