Commands/Requests/Get-OBSSceneItemId.ps1
|
function 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. .Link https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemid #> [Reflection.AssemblyMetadata('OBS.WebSocket.RequestType', 'GetSceneItemId')] [Reflection.AssemblyMetadata('OBS.WebSocket.ExpectingResponse', $true)] param( <# Name of the scene or group to search in #> [Parameter(Mandatory,ValueFromPipelineByPropertyName)] [ComponentModel.DefaultBindingProperty('sceneName')] [string] $sceneName, <# Name of the source to find #> [Parameter(Mandatory,ValueFromPipelineByPropertyName)] [ComponentModel.DefaultBindingProperty('sourceName')] [string] $sourceName, <# Number of matches to skip during search. >= 0 means first forward. -1 means last (top) item #> [Parameter(ValueFromPipelineByPropertyName)] [ComponentModel.DefaultBindingProperty('searchOffset')] [ValidateRange(-1,[int]::MaxValue)] [double] $searchOffset, # If set, will return the information that would otherwise be sent to OBS. [Parameter(ValueFromPipelineByPropertyName)] [Alias('OutputRequest','OutputInput')] [switch] $PassThru ) process { # Create a copy of the parameters (that are part of the payload) $paramCopy = [Ordered]@{} # get a reference to this command $myCmd = $MyInvocation.MyCommand # Keep track of how many requests we have done of a given type # (this makes creating RequestIDs easy) if (-not $script:ObsRequestsCounts) { $script:ObsRequestsCounts = @{} } # Set my requestType to blank $myRequestType = '' # and indicate we are not expecting a response $responseExpected = $false # Then walk over this commands' attributes, foreach ($attr in $myCmd.ScriptBlock.Attributes) { if ($attr -is [Reflection.AssemblyMetadataAttribute]) { if ($attr.Key -eq 'OBS.WebSocket.RequestType') { $myRequestType = $attr.Value # set the requestType, } elseif ($attr.Key -eq 'OBS.WebSocket.ExpectingResponse') { # and determine if we are expecting a response. $responseExpected = if ($attr.Value -eq 'false') { $false } else { $true } } } } # Walk over each parameter :nextParam foreach ($keyValue in $PSBoundParameters.GetEnumerator()) { # and walk over each of it's attributes to see if it part of the payload foreach ($attr in $myCmd.Parameters[$keyValue.Key].Attributes) { # If the parameter is bound to part of the payload if ($attr -is [ComponentModel.DefaultBindingPropertyAttribute]) { # copy it into our payload dicitionary. $paramCopy[$attr.Name] = $keyValue.Value # (don't forget to turn switches into booleans) if ($paramCopy[$attr.Name] -is [switch]) { $paramCopy[$attr.Name] = [bool]$paramCopy[$attr.Name] } continue nextParam } } } # If we don't have a request counter for this request type if (-not $script:ObsRequestsCounts[$myRequestType]) { # initialize it to zero. $script:ObsRequestsCounts[$myRequestType] = 0 } # Increment the counter for requests of this type $script:ObsRequestsCounts[$myRequestType]++ # and make a request ID from that. $myRequestId = "$myRequestType.$($script:ObsRequestsCounts[$myRequestType])" # Construct the payload object $requestPayload = [Ordered]@{ # It must include a request ID requestId = "$myRequestType.$($script:ObsRequestsCounts[$myRequestType])" # request type requestType = $myRequestType # and optional data requestData = $paramCopy } if ($PassThru) { [PSCustomObject]$requestPayload } else { [PSCustomObject]$requestPayload | Send-OBS } } } |