Commands/Filters/Set-OBSScrollFilter.ps1
|
function Set-OBSScrollFilter { <# .SYNOPSIS Sets a scroll filter. .DESCRIPTION Adds or Changes a Scroll Filter on an OBS Input. This allows you to scroll horizontally or vertically. .EXAMPLE Show-OBS -Uri https://pssvg.start-automating.com/Examples/Stars.svg | Set-OBSScrollFilter -HorizontalSpeed 100 -VerticalSpeed 100 #> [CmdletBinding()] param( # The horizontal scroll speed. [Parameter(ValueFromPipelineByPropertyName)] [ComponentModel.DefaultBindingProperty("speed_x")] [Alias('SpeedX', 'Speed_X','HSpeed')] [double] $HorizontalSpeed, # The vertical scroll speed. [Parameter(ValueFromPipelineByPropertyName)] [ComponentModel.DefaultBindingProperty("speed_y")] [Alias('SpeedY', 'Speed_Y','VSpeed')] [double] $VerticalSpeed, # If set, will not loop [Parameter(ValueFromPipelineByPropertyName)] [ComponentModel.DefaultBindingProperty("loop")] [switch] $NoLoop, # If provided, will limit the width. [Parameter(ValueFromPipelineByPropertyName)] [ValidateRange(-500, 500)] [ComponentModel.DefaultBindingProperty("cx")] [Alias('LimitX', 'Limit_CX','WidthLimit')] [double] $LimitWidth, # If provided, will limit the height. [Parameter(ValueFromPipelineByPropertyName)] [ValidateRange(-500, 500)] [ComponentModel.DefaultBindingProperty("cy")] [Alias('LimitY', 'Limit_CY','HeightLimit')] [double] $LimitHeight, # If set, will remove a filter if one already exists. # If this is not provided and the filter already exists, the settings of the filter will be changed. [switch] $Force ) dynamicParam { $baseCommand = if (-not $script:AddOBSSourceFilter) { $script:AddOBSSourceFilter = $executionContext.SessionState.InvokeCommand.GetCommand('Add-OBSSourceFilter','Function') $script:AddOBSSourceFilter } else { $script:AddOBSSourceFilter } $IncludeParameter = @() $ExcludeParameter = 'FilterKind','FilterSettings' $DynamicParameters = [Management.Automation.RuntimeDefinedParameterDictionary]::new() :nextInputParameter foreach ($paramName in ([Management.Automation.CommandMetaData]$baseCommand).Parameters.Keys) { if ($ExcludeParameter) { foreach ($exclude in $ExcludeParameter) { if ($paramName -like $exclude) { continue nextInputParameter} } } if ($IncludeParameter) { $shouldInclude = foreach ($include in $IncludeParameter) { if ($paramName -like $include) { $true;break} } if (-not $shouldInclude) { continue nextInputParameter } } $DynamicParameters.Add($paramName, [Management.Automation.RuntimeDefinedParameter]::new( $baseCommand.Parameters[$paramName].Name, $baseCommand.Parameters[$paramName].ParameterType, $baseCommand.Parameters[$paramName].Attributes )) } $DynamicParameters } process { $myParameters = [Ordered]@{} + $PSBoundParameters if (-not $myParameters["FilterName"]) { $filterName = $myParameters["FilterName"] = "Scroll" } $myParameterData = [Ordered]@{} foreach ($parameter in $MyInvocation.MyCommand.Parameters.Values) { $bindToPropertyName = $null foreach ($attribute in $parameter.Attributes) { if ($attribute -is [ComponentModel.DefaultBindingPropertyAttribute]) { $bindToPropertyName = $attribute.Name break } } if (-not $bindToPropertyName) { continue } if ($myParameters.Contains($parameter.Name)) { $myParameterData[$bindToPropertyName] = $myParameters[$parameter.Name] if ($myParameters[$parameter.Name] -is [switch]) { $myParameterData[$bindToPropertyName] = $parameter.Name -as [bool] } } } if ($myParameterData["loop"]) { $myParameterData["loop"] = -not $myParameterData["loop"] } if ($myParameterData["cx"]) { $myParameterData["limit_cx"] = $true } if ($myParameterData["cy"]) { $myParameterData["limit_cy"] = $true } $addSplat = @{ filterName = $myParameters["FilterName"] SourceName = $myParameters["SourceName"] filterKind = "scroll_filter" filterSettings = $myParameterData } if ($MyParameters["PassThru"]) { $addSplat.Passthru = $MyParameters["PassThru"] if ($MyInvocation.InvocationName -like 'Add-*') { Add-OBSSourceFilter @addSplat } else { $addSplat.Remove('FilterKind') Set-OBSSourceFilterSettings @addSplat } return } # Add the input. $outputAddedResult = Add-OBSSourceFilter @addSplat *>&1 # If we got back an error if ($outputAddedResult -is [Management.Automation.ErrorRecord]) { # and that error was saying the source already exists, if ($outputAddedResult.TargetObject.d.requestStatus.code -eq 601) { # then check if we use the -Force. if ($Force) { # If we do, remove the input Remove-OBSSourceFilter -FilterName $addSplat.FilterName -SourceName $addSplat.SourceName # and re-add our result. $outputAddedResult = Add-OBSInput @addSplat *>&1 } else { # Otherwise, get the existing filter. $existingFilter = Get-OBSSourceFilter -SourceName $addSplat.SourceName -FilterName $addSplat.FilterName # then apply the settings $existingFilter.Set($addSplat.filterSettings) # and output them $existingFilter # (don't forget to null the result, so we don't show this error) $outputAddedResult = $null } } # If the output was still an error if ($outputAddedResult -is [Management.Automation.ErrorRecord]) { # use $psCmdlet.WriteError so that it shows the error correctly. $psCmdlet.WriteError($outputAddedResult) } } # Otherwise, if we had a result elseif ($outputAddedResult) { # Otherwise, get the input from the filters. Get-OBSSourceFilter -SourceName $addSplat.SourceName -FilterName $addSplat.FilterName } } } |