obs-powershell

Get-OBSSceneItemId

Synopsis

Get-OBSSceneItemId : GetSceneItemId


Description

Searches a scene for a source, and returns its id.

Scenes and Groups

Get-OBSSceneItemId calls the OBS WebSocket with a request of type GetSceneItemId.



Parameters

SceneName

Name of the scene or group to search in

Type Required Position PipelineInput
[String] true 1 true (ByPropertyName)

SourceName

Name of the source to find

Type Required Position PipelineInput
[String] true 2 true (ByPropertyName)

SearchOffset

Number of matches to skip during search. >= 0 means first forward. -1 means last (top) item

Type Required Position PipelineInput
[Double] false 3 true (ByPropertyName)

PassThru

If set, will return the information that would otherwise be sent to OBS.

Type Required Position PipelineInput Aliases
[Switch] false named true (ByPropertyName) OutputRequest
OutputInput

NoResponse

If set, will not attempt to receive a response from OBS. This can increase performance, and also silently ignore critical errors

Type Required Position PipelineInput Aliases
[Switch] false named true (ByPropertyName) NoReceive
IgnoreResponse
IgnoreReceive
DoNotReceiveResponse

Syntax

Get-OBSSceneItemId [-SceneName] <String> [-SourceName] <String> [[-SearchOffset] <Double>] [-PassThru] [-NoResponse] [<CommonParameters>]