Get Scene Item Properties

Parameters

Connectionrequired

Select

Select the configured OBS Studio Connection to connect to

Select Any to trigger on any connection

Scenerequired

String

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

Sourcerequired

String

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

Variables

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

		Description	Example
`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	`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	`true`
`props.message-id`	`string`	The id of the message
`props.muted`	`boolean`	If the source is muted	`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	`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	`true`
`props.width`	`number`	Scene item width (base source width multiplied by the horizontal scaling factor)

		Description	Example
`__source`	`EventType`	The event which triggered the action. This will not always exist and requires C# to access	`TwitchChatMessage`
`actionId`	`string`	The unique ID of the action being executed	`2cd1495a-e50c-45d2-8bb5-ffe9c3dff243`
`actionName`	`string`	The name of the action being executed	`My Action`
`actionQueuedAt`	`DateTime`	The timestamp of when action was queued	`12/21/2023 9:25:21 AM`
`eventSource`	`EventSource`	The service of the event which triggered the action. This will not always exist and requires C# to access	`twitch`
`runningActionId`	`string`	The unique ID of this running action instance within the queue	`c83dd939-9f86-4435-b07c-b6e7e3eef134`
`triggerCategory`	`string`	The category of the trigger which executed the action	`Twitch/Chat`
`triggerId`	`string`	The unique id of the trigger with executed the action	`2cd1495a-e50c-45d2-8bb5-ffe9c3dff243`
`triggerName`	`string`	The name of the trigger which executed the action	`Chat Message`

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