diff --git a/Assets/obs-powershell.svg b/Assets/obs-powershell.svg index 3ed66016d..36436dd07 100644 --- a/Assets/obs-powershell.svg +++ b/Assets/obs-powershell.svg @@ -1,4 +1,4 @@ - + @@ -12,4 +12,4 @@ OBS PowerShell - \ No newline at end of file + diff --git a/CHANGELOG.md b/CHANGELOG.md index 69d916d4c..09aa4da6d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,12 @@ +## obs-powershell 0.1.6: + +* Adding OBS.SceneItem .Scale (Fixes #64) +* OBS.SceneItem .FitToScreen, adjusting .Scale (Fixes #63) +* Add-OBSMediaSource: Fixing -InputSettings / -SceneItemEnabled (Fixes #62) + +--- + + ## obs-powershell 0.1.5: * Adding OBS.SceneItem .Animate (Fixes #59) diff --git a/Commands/Sources/Add-OBSMediaSource.ps.ps1 b/Commands/Sources/Add-OBSMediaSource.ps.ps1 index e4ee06ab1..fb1197575 100644 --- a/Commands/Sources/Add-OBSMediaSource.ps.ps1 +++ b/Commands/Sources/Add-OBSMediaSource.ps.ps1 @@ -105,12 +105,40 @@ function Add-OBSMediaSource $FilePathItem = Get-Item -Path $FilePath $myParameterData['local_file'] = $FilePathItem.FullName -replace '/', '\' + + if ($myParameters['InputSettings']) { + $keys = + @(if ($myParameters['InputSettings'] -is [Collections.IDictionary]) { + $myParameters['InputSettings'].Keys + } else { + foreach ($prop in $myParameters['InputSettings'].PSObject.Properties) { + $prop.Name + } + }) + + foreach ($key in $keys) { + $myParameterData[$key] = $myParameters['InputSettings'].$key + } + + $myParameterData.remove('inputSettings') + } if (-not $Name) { $Name = $FilePathItem.Name } - $outputAddedResult = Add-OBSInput -sceneName $myParameters["Scene"] -inputKind "ffmpeg_source" -inputSettings $myParameterData -inputName $Name + $addSplat = [Ordered]@{ + sceneName = $myParameters["Scene"] + inputKind = "ffmpeg_source" + inputSettings = $myParameterData + inputName = $Name + } + + if ($myParameters.Contains('SceneItemEnabled')) { + $addSplat.SceneItemEnabled = $myParameters['SceneItemEnabled'] -as [bool] + } + + $outputAddedResult = Add-OBSInput @addSplat if ($outputAddedResult) { Get-OBSSceneItem -sceneName $myParameters["Scene"] | Where-Object SourceName -eq $name diff --git a/Commands/Sources/Add-OBSMediaSource.ps1 b/Commands/Sources/Add-OBSMediaSource.ps1 index 5c25c335b..0f826e52c 100644 --- a/Commands/Sources/Add-OBSMediaSource.ps1 +++ b/Commands/Sources/Add-OBSMediaSource.ps1 @@ -128,11 +128,34 @@ dynamicParam { } $FilePathItem = Get-Item -Path $FilePath $myParameterData['local_file'] = $FilePathItem.FullName -replace '/', '\' + if ($myParameters['InputSettings']) { + $keys = + @(if ($myParameters['InputSettings'] -is [Collections.IDictionary]) { + $myParameters['InputSettings'].Keys + } else { + foreach ($prop in $myParameters['InputSettings'].PSObject.Properties) { + $prop.Name + } + }) + foreach ($key in $keys) { + $myParameterData[$key] = $myParameters['InputSettings'].$key + } + $myParameterData.remove('inputSettings') + } if (-not $Name) { $Name = $FilePathItem.Name } - $outputAddedResult = Add-OBSInput -sceneName $myParameters["Scene"] -inputKind "ffmpeg_source" -inputSettings $myParameterData -inputName $Name + $addSplat = [Ordered]@{ + sceneName = $myParameters["Scene"] + inputKind = "ffmpeg_source" + inputSettings = $myParameterData + inputName = $Name + } + if ($myParameters.Contains('SceneItemEnabled')) { + $addSplat.SceneItemEnabled = $myParameters['SceneItemEnabled'] -as [bool] + } + $outputAddedResult = Add-OBSInput @addSplat if ($outputAddedResult) { Get-OBSSceneItem -sceneName $myParameters["Scene"] | Where-Object SourceName -eq $name diff --git a/Types/OBS.GetSceneItemList.Response/FitToScreen.ps1 b/Types/OBS.GetSceneItemList.Response/FitToScreen.ps1 index 64f8f26a3..2ca79e686 100644 --- a/Types/OBS.GetSceneItemList.Response/FitToScreen.ps1 +++ b/Types/OBS.GetSceneItemList.Response/FitToScreen.ps1 @@ -1,9 +1,13 @@ $videoSettings = Get-OBSVideoSettings -$this | Set-OBSSceneItemTransform -SceneItemTransform ([PSCustomObject][Ordered]@{ +$thisTransform = $this | Get-OBSSceneItemTransform + +$sceneItemTransform = ([Ordered]@{ alignment = 0 - height = $videoSettings.outputHeight + scaleX = ([double]$videoSettings.outputWidth / $thisTransform.sourceWidth ) positionX = [int]($videoSettings.outputWidth / 2) positionY = [int]($videoSettings.outputHeight / 2) - width = $videoSettings.outputWidth -}) \ No newline at end of file + scaleY = ([double]$videoSettings.outputHeight / $thisTransform.sourceHeight ) +}) + +$this | Set-OBSSceneItemTransform -SceneItemTransform $sceneItemTransform \ No newline at end of file diff --git a/Types/OBS.GetSceneItemList.Response/Scale.ps1 b/Types/OBS.GetSceneItemList.Response/Scale.ps1 new file mode 100644 index 000000000..cb4f15df4 --- /dev/null +++ b/Types/OBS.GetSceneItemList.Response/Scale.ps1 @@ -0,0 +1,38 @@ +param( +[double[]] +$ScaleX = 1, + +[double[]] +$ScaleY = 1, + +# The timespan the animation will take +[TimeSpan] +$TimeSpan = [timespan]::fromSeconds(1) +) + +if ($scaleX.Length -eq 1 -and $scaleY.Length -eq 1) { + $this | Set-OBSSceneItemTransform -SceneItemTransform @{ + scaleX = $ScaleX[0] + scaleY = $scaleY[0] + } + return +} + +$thisTransform = $this | Get-OBSSceneItemTransform + +$fromValue = [Ordered]@{ + scaleX = $thisTransform.scaleX + scaleY = $thisTransform.scaleY +} + +$durationPerStep = [TimeSpan]::FromMilliseconds($TimeSpan.TotalMilliseconds / $ScaleX.Length) + +for ($stepNumber = 0; $stepNumber -lt $ScaleX.Length; $stepNumber++) { + $toValue = [Ordered]@{ + scaleX = $ScaleX[$stepNumber] + scaleY = $ScaleY[$stepNumber] + } + $this.Animate($fromValue, $toValue, $durationPerStep) + $fromValue = $toValue +} + diff --git a/docs/Add-OBSBrowserSource.md b/docs/Add-OBSBrowserSource.md index ef170a24e..864210093 100644 --- a/docs/Add-OBSBrowserSource.md +++ b/docs/Add-OBSBrowserSource.md @@ -24,13 +24,12 @@ If the uri points to a local file, this will be preferred -> **Type**: ```[Uri]``` -> **Required**: false -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If none is provided, this will be the output width of the video settings. -> **Type**: ```[Int32]``` -> **Required**: false -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |2 |true (ByPropertyName)| @@ -60,13 +58,12 @@ If none is provided, this will be the output height of the video settings. -> **Type**: ```[Int32]``` -> **Required**: false -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |3 |true (ByPropertyName)| @@ -77,13 +74,12 @@ The css style used to render the browser page. -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 4 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |4 |true (ByPropertyName)| @@ -94,13 +90,12 @@ If set, the browser source will shutdown when it is hidden -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -111,13 +106,12 @@ If set, the browser source will restart when it is activated. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -128,13 +122,12 @@ If set, audio from the browser source will be rerouted into OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -145,13 +138,12 @@ If provided, the browser source will render at a custom frame rate. -> **Type**: ```[Int32]``` -> **Required**: false -> **Position**: 5 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |5 |true (ByPropertyName)| @@ -163,13 +155,12 @@ If no scene name is provided, the current program scene will be used. -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 6 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |6 |true (ByPropertyName)| @@ -181,13 +172,12 @@ If no name is provided, the last segment of the URI or file path will be the inp -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 7 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |7 |true (ByPropertyName)| diff --git a/docs/Add-OBSColorSource.md b/docs/Add-OBSColorSource.md index d53e600b5..8a3763081 100644 --- a/docs/Add-OBSColorSource.md +++ b/docs/Add-OBSColorSource.md @@ -24,13 +24,12 @@ If no scene name is provided, the current program scene will be used. -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |1 |true (ByPropertyName)| @@ -42,26 +41,24 @@ If no name is provided, "Display $($Monitor + 1)" will be the input source name. -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |2 |true (ByPropertyName)| --- #### **Color** -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| diff --git a/docs/Add-OBSDisplaySource.md b/docs/Add-OBSDisplaySource.md index 400c0007a..548e822e9 100644 --- a/docs/Add-OBSDisplaySource.md +++ b/docs/Add-OBSDisplaySource.md @@ -29,13 +29,12 @@ This the number of the monitor you would like to capture. -> **Type**: ```[Int32]``` -> **Required**: false -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |1 |true (ByPropertyName)| @@ -48,13 +47,12 @@ If explicitly set to false, the cursor will not be captured. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -66,13 +64,12 @@ If no scene name is provided, the current program scene will be used. -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |2 |true (ByPropertyName)| @@ -84,13 +81,12 @@ If no name is provided, "Display $($Monitor + 1)" will be the input source name. -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| diff --git a/docs/Add-OBSFFMpegSource.md b/docs/Add-OBSFFMpegSource.md index 8823c2466..180a18fee 100644 --- a/docs/Add-OBSFFMpegSource.md +++ b/docs/Add-OBSFFMpegSource.md @@ -29,13 +29,12 @@ The path to the media file. -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -48,13 +47,12 @@ To explicitly set it to false, use -CloseWhenInactive:$false -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -65,13 +63,12 @@ If set, the source will automatically restart. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -82,13 +79,12 @@ If set, will use hardware decoding, if available. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -102,13 +98,12 @@ To explicitly set to false, use -ClearMediaEnd:$false -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -119,13 +114,12 @@ Any FFMpeg demuxer options. -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |2 |true (ByPropertyName)| @@ -137,13 +131,12 @@ If no scene name is provided, the current program scene will be used. -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| @@ -155,13 +148,12 @@ If no name is provided, the last segment of the URI or file path will be the inp -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 4 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |4 |true (ByPropertyName)| diff --git a/docs/Add-OBSInput.md b/docs/Add-OBSInput.md index d4ce60a1c..19d6835d9 100644 --- a/docs/Add-OBSInput.md +++ b/docs/Add-OBSInput.md @@ -25,13 +25,12 @@ Name of the scene to add the input to as a scene item -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Name of the new input to created -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ The kind of input to be created -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |3 |true (ByPropertyName)| @@ -76,13 +73,12 @@ Settings object to initialize the input with -> **Type**: ```[PSObject]``` -> **Required**: false -> **Position**: 4 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|false |4 |true (ByPropertyName)| @@ -93,13 +89,12 @@ Whether to set the created scene item to enabled or disabled -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -110,13 +105,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Add-OBSMediaSource.md b/docs/Add-OBSMediaSource.md index 8823c2466..180a18fee 100644 --- a/docs/Add-OBSMediaSource.md +++ b/docs/Add-OBSMediaSource.md @@ -29,13 +29,12 @@ The path to the media file. -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -48,13 +47,12 @@ To explicitly set it to false, use -CloseWhenInactive:$false -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -65,13 +63,12 @@ If set, the source will automatically restart. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -82,13 +79,12 @@ If set, will use hardware decoding, if available. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -102,13 +98,12 @@ To explicitly set to false, use -ClearMediaEnd:$false -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -119,13 +114,12 @@ Any FFMpeg demuxer options. -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |2 |true (ByPropertyName)| @@ -137,13 +131,12 @@ If no scene name is provided, the current program scene will be used. -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| @@ -155,13 +148,12 @@ If no name is provided, the last segment of the URI or file path will be the inp -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 4 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |4 |true (ByPropertyName)| diff --git a/docs/Add-OBSMonitorSource.md b/docs/Add-OBSMonitorSource.md index 400c0007a..548e822e9 100644 --- a/docs/Add-OBSMonitorSource.md +++ b/docs/Add-OBSMonitorSource.md @@ -29,13 +29,12 @@ This the number of the monitor you would like to capture. -> **Type**: ```[Int32]``` -> **Required**: false -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |1 |true (ByPropertyName)| @@ -48,13 +47,12 @@ If explicitly set to false, the cursor will not be captured. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -66,13 +64,12 @@ If no scene name is provided, the current program scene will be used. -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |2 |true (ByPropertyName)| @@ -84,13 +81,12 @@ If no name is provided, "Display $($Monitor + 1)" will be the input source name. -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| diff --git a/docs/Add-OBSProfile.md b/docs/Add-OBSProfile.md index 40aab2677..1f7bbf161 100644 --- a/docs/Add-OBSProfile.md +++ b/docs/Add-OBSProfile.md @@ -25,13 +25,12 @@ Name for the new profile -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Add-OBSScene.md b/docs/Add-OBSScene.md index 0f95299cd..dd7d84581 100644 --- a/docs/Add-OBSScene.md +++ b/docs/Add-OBSScene.md @@ -25,13 +25,12 @@ Name for the new scene -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Add-OBSSceneCollection.md b/docs/Add-OBSSceneCollection.md index 9145e31e0..435e0d908 100644 --- a/docs/Add-OBSSceneCollection.md +++ b/docs/Add-OBSSceneCollection.md @@ -27,13 +27,12 @@ Name for the new scene collection -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Add-OBSSceneItem.md b/docs/Add-OBSSceneItem.md index 9d3d3b3b3..1f0e418bc 100644 --- a/docs/Add-OBSSceneItem.md +++ b/docs/Add-OBSSceneItem.md @@ -27,13 +27,12 @@ Name of the scene to create the new item in -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Name of the source to add to the scene -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ Enable state to apply to the scene item on creation -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -78,13 +75,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Add-OBSSceneSource.md b/docs/Add-OBSSceneSource.md index 9d3d3b3b3..1f0e418bc 100644 --- a/docs/Add-OBSSceneSource.md +++ b/docs/Add-OBSSceneSource.md @@ -27,13 +27,12 @@ Name of the scene to create the new item in -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Name of the source to add to the scene -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ Enable state to apply to the scene item on creation -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -78,13 +75,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Add-OBSSourceFilter.md b/docs/Add-OBSSourceFilter.md index c1a1484f5..981197010 100644 --- a/docs/Add-OBSSourceFilter.md +++ b/docs/Add-OBSSourceFilter.md @@ -25,13 +25,12 @@ Name of the source to add the filter to -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Name of the new filter to be created -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ The kind of filter to be created -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |3 |true (ByPropertyName)| @@ -76,13 +73,12 @@ Settings object to initialize the filter with -> **Type**: ```[PSObject]``` -> **Required**: false -> **Position**: 4 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|false |4 |true (ByPropertyName)| @@ -93,13 +89,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Assets/obs-powershell.svg b/docs/Assets/obs-powershell.svg index 3ed66016d..36436dd07 100644 --- a/docs/Assets/obs-powershell.svg +++ b/docs/Assets/obs-powershell.svg @@ -1,4 +1,4 @@ - + @@ -12,4 +12,4 @@ OBS PowerShell - \ No newline at end of file + diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 6d49ffec4..107fa5ad8 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,3 +1,12 @@ +## obs-powershell 0.1.6: + +* Adding OBS.SceneItem .Scale (Fixes #64) +* OBS.SceneItem .FitToScreen, adjusting .Scale (Fixes #63) +* Add-OBSMediaSource: Fixing -InputSettings / -SceneItemEnabled (Fixes #62) + +--- + + ## obs-powershell 0.1.5: * Adding OBS.SceneItem .Animate (Fixes #59) diff --git a/docs/Clear-OBSScene.md b/docs/Clear-OBSScene.md index e026679b8..3cda50719 100644 --- a/docs/Clear-OBSScene.md +++ b/docs/Clear-OBSScene.md @@ -27,13 +27,12 @@ Name of the scene. -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |1 |true (ByPropertyName)| diff --git a/docs/Connect-OBS.md b/docs/Connect-OBS.md index 2f549f604..e9e9315ba 100644 --- a/docs/Connect-OBS.md +++ b/docs/Connect-OBS.md @@ -31,13 +31,12 @@ The OBS websocket URL. If not provided, this will default to loopback on port 4 -> **Type**: ```[Uri]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| @@ -49,13 +48,12 @@ You can see the websocket password in Tools -> obs-websocket settings -> show co -> **Type**: ```[String]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| diff --git a/docs/Copy-OBSSceneItem.md b/docs/Copy-OBSSceneItem.md index 56dfcb298..198c94f5a 100644 --- a/docs/Copy-OBSSceneItem.md +++ b/docs/Copy-OBSSceneItem.md @@ -27,13 +27,12 @@ Name of the scene the item is in -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Numeric ID of the scene item -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ Name of the scene to create the duplicated item in -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| @@ -78,13 +75,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSCurrentPreviewScene.md b/docs/Get-OBSCurrentPreviewScene.md index 911548687..5c0a35671 100644 --- a/docs/Get-OBSCurrentPreviewScene.md +++ b/docs/Get-OBSCurrentPreviewScene.md @@ -34,13 +34,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSCurrentProgramScene.md b/docs/Get-OBSCurrentProgramScene.md index 798b0a391..713a67de5 100644 --- a/docs/Get-OBSCurrentProgramScene.md +++ b/docs/Get-OBSCurrentProgramScene.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSCurrentSceneTransition.md b/docs/Get-OBSCurrentSceneTransition.md index 52ebe6cd9..7f21f069f 100644 --- a/docs/Get-OBSCurrentSceneTransition.md +++ b/docs/Get-OBSCurrentSceneTransition.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSCurrentSceneTransitionCursor.md b/docs/Get-OBSCurrentSceneTransitionCursor.md index 19bedc0db..8e92a36ca 100644 --- a/docs/Get-OBSCurrentSceneTransitionCursor.md +++ b/docs/Get-OBSCurrentSceneTransitionCursor.md @@ -34,13 +34,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSGroup.md b/docs/Get-OBSGroup.md index 38f23ec2e..5e1d9342e 100644 --- a/docs/Get-OBSGroup.md +++ b/docs/Get-OBSGroup.md @@ -34,13 +34,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSGroupSceneItem.md b/docs/Get-OBSGroupSceneItem.md index 193014d0b..3feb518ec 100644 --- a/docs/Get-OBSGroupSceneItem.md +++ b/docs/Get-OBSGroupSceneItem.md @@ -29,13 +29,12 @@ Name of the group to get the items of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -46,13 +45,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSHotkey.md b/docs/Get-OBSHotkey.md index f78c46d4c..5b95c89c5 100644 --- a/docs/Get-OBSHotkey.md +++ b/docs/Get-OBSHotkey.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSInput.md b/docs/Get-OBSInput.md index 4085e8a99..8edc42cf3 100644 --- a/docs/Get-OBSInput.md +++ b/docs/Get-OBSInput.md @@ -25,13 +25,12 @@ Restrict the array to only inputs of the specified kind -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSInputAudioBalance.md b/docs/Get-OBSInputAudioBalance.md index cc85c3f73..f5028ff32 100644 --- a/docs/Get-OBSInputAudioBalance.md +++ b/docs/Get-OBSInputAudioBalance.md @@ -25,13 +25,12 @@ Name of the input to get the audio balance of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSInputAudioMonitorType.md b/docs/Get-OBSInputAudioMonitorType.md index 51b2295e1..435e91da7 100644 --- a/docs/Get-OBSInputAudioMonitorType.md +++ b/docs/Get-OBSInputAudioMonitorType.md @@ -31,13 +31,12 @@ Name of the input to get the audio monitor type of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -48,13 +47,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSInputAudioSyncOffset.md b/docs/Get-OBSInputAudioSyncOffset.md index 9df2d3d8e..600f0dd57 100644 --- a/docs/Get-OBSInputAudioSyncOffset.md +++ b/docs/Get-OBSInputAudioSyncOffset.md @@ -27,13 +27,12 @@ Name of the input to get the audio sync offset of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSInputAudioTracks.md b/docs/Get-OBSInputAudioTracks.md index b129141c9..8fd1ac761 100644 --- a/docs/Get-OBSInputAudioTracks.md +++ b/docs/Get-OBSInputAudioTracks.md @@ -25,13 +25,12 @@ Name of the input -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSInputDefaultSettings.md b/docs/Get-OBSInputDefaultSettings.md index 80660fdb0..201da19a8 100644 --- a/docs/Get-OBSInputDefaultSettings.md +++ b/docs/Get-OBSInputDefaultSettings.md @@ -25,13 +25,12 @@ Input kind to get the default settings for -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSInputKind.md b/docs/Get-OBSInputKind.md index 15c1b2ac8..07ae8871f 100644 --- a/docs/Get-OBSInputKind.md +++ b/docs/Get-OBSInputKind.md @@ -25,13 +25,12 @@ True == Return all kinds as unversioned, False == Return with version suffixes ( -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSInputMute.md b/docs/Get-OBSInputMute.md index ee6c32e4c..b38d544a0 100644 --- a/docs/Get-OBSInputMute.md +++ b/docs/Get-OBSInputMute.md @@ -25,13 +25,12 @@ Name of input to get the mute state of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSInputPropertiesListPropertyItems.md b/docs/Get-OBSInputPropertiesListPropertyItems.md index eb2c9415c..bfc1d317f 100644 --- a/docs/Get-OBSInputPropertiesListPropertyItems.md +++ b/docs/Get-OBSInputPropertiesListPropertyItems.md @@ -27,13 +27,12 @@ Name of the input -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Name of the list property to get the items of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSInputSettings.md b/docs/Get-OBSInputSettings.md index 5a2e0019c..9e89eafaa 100644 --- a/docs/Get-OBSInputSettings.md +++ b/docs/Get-OBSInputSettings.md @@ -27,13 +27,12 @@ Name of the input to get the settings of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSInputVolume.md b/docs/Get-OBSInputVolume.md index 980e4a9f6..7f8e21546 100644 --- a/docs/Get-OBSInputVolume.md +++ b/docs/Get-OBSInputVolume.md @@ -25,13 +25,12 @@ Name of the input to get the volume of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSLastReplayBufferReplay.md b/docs/Get-OBSLastReplayBufferReplay.md index b10638323..8b38b806f 100644 --- a/docs/Get-OBSLastReplayBufferReplay.md +++ b/docs/Get-OBSLastReplayBufferReplay.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSMediaInputStatus.md b/docs/Get-OBSMediaInputStatus.md index 70b904940..7a92a0c4e 100644 --- a/docs/Get-OBSMediaInputStatus.md +++ b/docs/Get-OBSMediaInputStatus.md @@ -36,13 +36,12 @@ Name of the media input -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -53,13 +52,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSMonitor.md b/docs/Get-OBSMonitor.md index a6f018338..d141930da 100644 --- a/docs/Get-OBSMonitor.md +++ b/docs/Get-OBSMonitor.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSOutput.md b/docs/Get-OBSOutput.md index 095b1b6f4..e659842b9 100644 --- a/docs/Get-OBSOutput.md +++ b/docs/Get-OBSOutput.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSOutputSettings.md b/docs/Get-OBSOutputSettings.md index a295856ac..1ff33ca54 100644 --- a/docs/Get-OBSOutputSettings.md +++ b/docs/Get-OBSOutputSettings.md @@ -25,13 +25,12 @@ Output name -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSOutputStatus.md b/docs/Get-OBSOutputStatus.md index 9ca2b75f0..e9fbcc3ef 100644 --- a/docs/Get-OBSOutputStatus.md +++ b/docs/Get-OBSOutputStatus.md @@ -25,13 +25,12 @@ Output name -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSPersistentData.md b/docs/Get-OBSPersistentData.md index 614c38e60..87736de3b 100644 --- a/docs/Get-OBSPersistentData.md +++ b/docs/Get-OBSPersistentData.md @@ -25,13 +25,12 @@ The data realm to select. `OBS_WEBSOCKET_DATA_REALM_GLOBAL` or `OBS_WEBSOCKET_DA -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ The name of the slot to retrieve data from -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSProfile.md b/docs/Get-OBSProfile.md index 5705676f0..351557acb 100644 --- a/docs/Get-OBSProfile.md +++ b/docs/Get-OBSProfile.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSProfileParameter.md b/docs/Get-OBSProfileParameter.md index ebaf6f434..3d870e882 100644 --- a/docs/Get-OBSProfileParameter.md +++ b/docs/Get-OBSProfileParameter.md @@ -25,13 +25,12 @@ Category of the parameter to get -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Name of the parameter to get -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSRecordDirectory.md b/docs/Get-OBSRecordDirectory.md index e3491a0be..1515008d3 100644 --- a/docs/Get-OBSRecordDirectory.md +++ b/docs/Get-OBSRecordDirectory.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSRecordStatus.md b/docs/Get-OBSRecordStatus.md index 214ae56df..c7265d386 100644 --- a/docs/Get-OBSRecordStatus.md +++ b/docs/Get-OBSRecordStatus.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSReplayBufferStatus.md b/docs/Get-OBSReplayBufferStatus.md index 8ef037192..6022662bd 100644 --- a/docs/Get-OBSReplayBufferStatus.md +++ b/docs/Get-OBSReplayBufferStatus.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSScene.md b/docs/Get-OBSScene.md index 9cc7ffe64..cf7af45a9 100644 --- a/docs/Get-OBSScene.md +++ b/docs/Get-OBSScene.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSSceneCollection.md b/docs/Get-OBSSceneCollection.md index 3221aeee0..5094b8ff8 100644 --- a/docs/Get-OBSSceneCollection.md +++ b/docs/Get-OBSSceneCollection.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSSceneItem.md b/docs/Get-OBSSceneItem.md index e162bde47..b2aabe93f 100644 --- a/docs/Get-OBSSceneItem.md +++ b/docs/Get-OBSSceneItem.md @@ -27,13 +27,12 @@ Name of the scene to get the items of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSSceneItemBlendMode.md b/docs/Get-OBSSceneItemBlendMode.md index ba78e4ece..7b489149e 100644 --- a/docs/Get-OBSSceneItemBlendMode.md +++ b/docs/Get-OBSSceneItemBlendMode.md @@ -37,13 +37,12 @@ Name of the scene the item is in -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -54,13 +53,12 @@ Numeric ID of the scene item -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |2 |true (ByPropertyName)| @@ -71,13 +69,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSSceneItemEnabled.md b/docs/Get-OBSSceneItemEnabled.md index 2026c76e9..f2cd08831 100644 --- a/docs/Get-OBSSceneItemEnabled.md +++ b/docs/Get-OBSSceneItemEnabled.md @@ -27,13 +27,12 @@ Name of the scene the item is in -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Numeric ID of the scene item -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSSceneItemId.md b/docs/Get-OBSSceneItemId.md index f38331bc7..6006b28cb 100644 --- a/docs/Get-OBSSceneItemId.md +++ b/docs/Get-OBSSceneItemId.md @@ -27,13 +27,12 @@ Name of the scene or group to search in -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Name of the source to find -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ Number of matches to skip during search. >= 0 means first forward. -1 means last -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |3 |true (ByPropertyName)| @@ -78,13 +75,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSSceneItemIndex.md b/docs/Get-OBSSceneItemIndex.md index 0dc04e692..f5d054720 100644 --- a/docs/Get-OBSSceneItemIndex.md +++ b/docs/Get-OBSSceneItemIndex.md @@ -29,13 +29,12 @@ Name of the scene the item is in -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -46,13 +45,12 @@ Numeric ID of the scene item -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |2 |true (ByPropertyName)| @@ -63,13 +61,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSSceneItemLocked.md b/docs/Get-OBSSceneItemLocked.md index 6bcc38620..8a41b5172 100644 --- a/docs/Get-OBSSceneItemLocked.md +++ b/docs/Get-OBSSceneItemLocked.md @@ -27,13 +27,12 @@ Name of the scene the item is in -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Numeric ID of the scene item -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSSceneItemTransform.md b/docs/Get-OBSSceneItemTransform.md index 808304ece..6d84861de 100644 --- a/docs/Get-OBSSceneItemTransform.md +++ b/docs/Get-OBSSceneItemTransform.md @@ -27,13 +27,12 @@ Name of the scene the item is in -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Numeric ID of the scene item -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSSceneSceneTransitionOverride.md b/docs/Get-OBSSceneSceneTransitionOverride.md index 3d7592297..5d13bea4e 100644 --- a/docs/Get-OBSSceneSceneTransitionOverride.md +++ b/docs/Get-OBSSceneSceneTransitionOverride.md @@ -25,13 +25,12 @@ Name of the scene -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSSceneTransition.md b/docs/Get-OBSSceneTransition.md index ce172ef99..5c1035bcc 100644 --- a/docs/Get-OBSSceneTransition.md +++ b/docs/Get-OBSSceneTransition.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSSourceActive.md b/docs/Get-OBSSourceActive.md index 7b1376767..54692114e 100644 --- a/docs/Get-OBSSourceActive.md +++ b/docs/Get-OBSSourceActive.md @@ -27,13 +27,12 @@ Name of the source to get the active state of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSSourceFilter.md b/docs/Get-OBSSourceFilter.md index efeed3aa5..4e5e69d21 100644 --- a/docs/Get-OBSSourceFilter.md +++ b/docs/Get-OBSSourceFilter.md @@ -25,13 +25,12 @@ Name of the source -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Name of the filter -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSSourceFilterDefaultSettings.md b/docs/Get-OBSSourceFilterDefaultSettings.md index ace561b4e..c9eb34a5a 100644 --- a/docs/Get-OBSSourceFilterDefaultSettings.md +++ b/docs/Get-OBSSourceFilterDefaultSettings.md @@ -25,13 +25,12 @@ Filter kind to get the default settings for -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSSourceFilterList.md b/docs/Get-OBSSourceFilterList.md index a6439fa18..29288e1c9 100644 --- a/docs/Get-OBSSourceFilterList.md +++ b/docs/Get-OBSSourceFilterList.md @@ -25,13 +25,12 @@ Name of the source -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSSourceScreenshot.md b/docs/Get-OBSSourceScreenshot.md index 51589467f..aca73d62f 100644 --- a/docs/Get-OBSSourceScreenshot.md +++ b/docs/Get-OBSSourceScreenshot.md @@ -30,13 +30,12 @@ Name of the source to take a screenshot of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -47,13 +46,12 @@ Image compression format to use. Use `GetVersion` to get compatible image format -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -64,13 +62,12 @@ Width to scale the screenshot to -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |3 |true (ByPropertyName)| @@ -81,13 +78,12 @@ Height to scale the screenshot to -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 4 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |4 |true (ByPropertyName)| @@ -98,13 +94,12 @@ Compression quality to use. 0 for high compression, 100 for uncompressed. -1 to -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 5 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |5 |true (ByPropertyName)| @@ -115,13 +110,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSSpecialInputs.md b/docs/Get-OBSSpecialInputs.md index be8707136..777cd77e0 100644 --- a/docs/Get-OBSSpecialInputs.md +++ b/docs/Get-OBSSpecialInputs.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSStats.md b/docs/Get-OBSStats.md index f5d005d53..bdfc86328 100644 --- a/docs/Get-OBSStats.md +++ b/docs/Get-OBSStats.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSStreamServiceSettings.md b/docs/Get-OBSStreamServiceSettings.md index 4eb35630c..d9779c0b8 100644 --- a/docs/Get-OBSStreamServiceSettings.md +++ b/docs/Get-OBSStreamServiceSettings.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSStreamStatus.md b/docs/Get-OBSStreamStatus.md index e86b72b65..e581a547b 100644 --- a/docs/Get-OBSStreamStatus.md +++ b/docs/Get-OBSStreamStatus.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSStudioModeEnabled.md b/docs/Get-OBSStudioModeEnabled.md index 40aa4a22c..7378dc1c1 100644 --- a/docs/Get-OBSStudioModeEnabled.md +++ b/docs/Get-OBSStudioModeEnabled.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSTransitionKind.md b/docs/Get-OBSTransitionKind.md index edf5ac7f9..2de809085 100644 --- a/docs/Get-OBSTransitionKind.md +++ b/docs/Get-OBSTransitionKind.md @@ -34,13 +34,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSVersion.md b/docs/Get-OBSVersion.md index a4bfd14b5..39473f321 100644 --- a/docs/Get-OBSVersion.md +++ b/docs/Get-OBSVersion.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSVideoSettings.md b/docs/Get-OBSVideoSettings.md index ce70dc151..98b885c7d 100644 --- a/docs/Get-OBSVideoSettings.md +++ b/docs/Get-OBSVideoSettings.md @@ -34,13 +34,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Get-OBSVirtualCamStatus.md b/docs/Get-OBSVirtualCamStatus.md index 1333ba0e0..6f55f25e4 100644 --- a/docs/Get-OBSVirtualCamStatus.md +++ b/docs/Get-OBSVirtualCamStatus.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Open-OBSInputFiltersDialog.md b/docs/Open-OBSInputFiltersDialog.md index 50cc69f5a..4e0d30352 100644 --- a/docs/Open-OBSInputFiltersDialog.md +++ b/docs/Open-OBSInputFiltersDialog.md @@ -25,13 +25,12 @@ Name of the input to open the dialog of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Open-OBSInputInteractDialog.md b/docs/Open-OBSInputInteractDialog.md index 287f67d91..b99ed4e91 100644 --- a/docs/Open-OBSInputInteractDialog.md +++ b/docs/Open-OBSInputInteractDialog.md @@ -25,13 +25,12 @@ Name of the input to open the dialog of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Open-OBSInputPropertiesDialog.md b/docs/Open-OBSInputPropertiesDialog.md index 16497565a..dbf88570a 100644 --- a/docs/Open-OBSInputPropertiesDialog.md +++ b/docs/Open-OBSInputPropertiesDialog.md @@ -25,13 +25,12 @@ Name of the input to open the dialog of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Open-OBSSourceProjector.md b/docs/Open-OBSSourceProjector.md index 1f6dbbf10..26b5acea9 100644 --- a/docs/Open-OBSSourceProjector.md +++ b/docs/Open-OBSSourceProjector.md @@ -27,13 +27,12 @@ Name of the source to open a projector for -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Monitor index, use `GetMonitorList` to obtain index -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutual -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| @@ -78,13 +75,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Open-OBSVideoMixProjector.md b/docs/Open-OBSVideoMixProjector.md index cfa557668..28f7c4e22 100644 --- a/docs/Open-OBSVideoMixProjector.md +++ b/docs/Open-OBSVideoMixProjector.md @@ -33,13 +33,12 @@ Type of mix to open -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -50,13 +49,12 @@ Monitor index, use `GetMonitorList` to obtain index -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |2 |true (ByPropertyName)| @@ -67,13 +65,12 @@ Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutual -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| @@ -84,13 +81,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Receive-OBS.md b/docs/Receive-OBS.md index 21a65f1a6..2eea2e09f 100644 --- a/docs/Receive-OBS.md +++ b/docs/Receive-OBS.md @@ -16,13 +16,12 @@ The message data that has been received -> **Type**: ```[Object]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByValue) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|--------------| +|`[Object]`|false |named |true (ByValue)| @@ -33,13 +32,12 @@ If set will wait for a response from the message and expand the results. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:false +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | @@ -50,13 +48,12 @@ If set, will responsd to known events, like 'hello', and resend other events as -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:false +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | @@ -67,13 +64,12 @@ The OBS websocket URL. If not provided, this will default to loopback on port 4 -> **Type**: ```[Uri]``` -> **Required**: true -> **Position**: named -> **PipelineInput**:false +|Type |Required|Position|PipelineInput| +|-------|--------|--------|-------------| +|`[Uri]`|true |named |false | @@ -85,13 +81,12 @@ You can see the websocket password in Tools -> obs-websocket settings -> show co -> **Type**: ```[String]``` -> **Required**: true -> **Position**: named -> **PipelineInput**:false +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|true |named |false | diff --git a/docs/Remove-OBSInput.md b/docs/Remove-OBSInput.md index 0645c491f..829083698 100644 --- a/docs/Remove-OBSInput.md +++ b/docs/Remove-OBSInput.md @@ -27,13 +27,12 @@ Name of the input to remove -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Remove-OBSProfile.md b/docs/Remove-OBSProfile.md index 786198860..5deed5907 100644 --- a/docs/Remove-OBSProfile.md +++ b/docs/Remove-OBSProfile.md @@ -25,13 +25,12 @@ Name of the profile to remove -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Remove-OBSScene.md b/docs/Remove-OBSScene.md index 7b16f30e5..30d31c1e8 100644 --- a/docs/Remove-OBSScene.md +++ b/docs/Remove-OBSScene.md @@ -25,13 +25,12 @@ Name of the scene to remove -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Remove-OBSSceneItem.md b/docs/Remove-OBSSceneItem.md index d7705ecf3..679f101ab 100644 --- a/docs/Remove-OBSSceneItem.md +++ b/docs/Remove-OBSSceneItem.md @@ -27,13 +27,12 @@ Name of the scene the item is in -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Numeric ID of the scene item -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Remove-OBSSourceFilter.md b/docs/Remove-OBSSourceFilter.md index 6c3a075e2..472b198b4 100644 --- a/docs/Remove-OBSSourceFilter.md +++ b/docs/Remove-OBSSourceFilter.md @@ -25,13 +25,12 @@ Name of the source the filter is on -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Name of the filter to remove -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Resume-OBSRecord.md b/docs/Resume-OBSRecord.md index 83a5b72c6..ff3c9dc9a 100644 --- a/docs/Resume-OBSRecord.md +++ b/docs/Resume-OBSRecord.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Save-OBSReplayBuffer.md b/docs/Save-OBSReplayBuffer.md index 9d55268df..d037ed8bf 100644 --- a/docs/Save-OBSReplayBuffer.md +++ b/docs/Save-OBSReplayBuffer.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Save-OBSSourceScreenshot.md b/docs/Save-OBSSourceScreenshot.md index 93a135c14..aa5a47819 100644 --- a/docs/Save-OBSSourceScreenshot.md +++ b/docs/Save-OBSSourceScreenshot.md @@ -30,13 +30,12 @@ Name of the source to take a screenshot of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -47,13 +46,12 @@ Image compression format to use. Use `GetVersion` to get compatible image format -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -64,13 +62,12 @@ Path to save the screenshot file to. Eg. `C:\Users\user\Desktop\screenshot.png` -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |3 |true (ByPropertyName)| @@ -81,13 +78,12 @@ Width to scale the screenshot to -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 4 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |4 |true (ByPropertyName)| @@ -98,13 +94,12 @@ Height to scale the screenshot to -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 5 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |5 |true (ByPropertyName)| @@ -115,13 +110,12 @@ Compression quality to use. 0 for high compression, 100 for uncompressed. -1 to -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 6 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |6 |true (ByPropertyName)| @@ -132,13 +126,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Send-OBS.md b/docs/Send-OBS.md index 740167c1a..f454e6b67 100644 --- a/docs/Send-OBS.md +++ b/docs/Send-OBS.md @@ -26,13 +26,12 @@ The data to send to the obs websocket. -> **Type**: ```[Object]``` -> **Required**: false -> **Position**: 1 -> **PipelineInput**:true (ByValue, ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|------------------------------| +|`[Object]`|false |1 |true (ByValue, ByPropertyName)| @@ -45,13 +44,12 @@ If -SerialFrame was provied, -StepTime will be the number of frames to wait. -> **Type**: ```[TimeSpan]``` -> **Required**: false -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[TimeSpan]`|false |2 |true (ByPropertyName)| @@ -62,13 +60,12 @@ If set, will process a batch of requests in parallel. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:false +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | @@ -79,13 +76,12 @@ If set, will process a batch of requests in parallel. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:false +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | diff --git a/docs/Send-OBSCallVendorRequest.md b/docs/Send-OBSCallVendorRequest.md index f6c920eeb..c8e7ffba1 100644 --- a/docs/Send-OBSCallVendorRequest.md +++ b/docs/Send-OBSCallVendorRequest.md @@ -28,13 +28,12 @@ Name of the vendor to use -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -45,13 +44,12 @@ The request type to call -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -62,13 +60,12 @@ Object containing appropriate request data -> **Type**: ```[PSObject]``` -> **Required**: false -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|false |3 |true (ByPropertyName)| @@ -79,13 +76,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Send-OBSCustomEvent.md b/docs/Send-OBSCustomEvent.md index d50eafb44..cdc22d9fd 100644 --- a/docs/Send-OBSCustomEvent.md +++ b/docs/Send-OBSCustomEvent.md @@ -25,13 +25,12 @@ Data payload to emit to all receivers -> **Type**: ```[PSObject]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Send-OBSOffsetMediaInputCursor.md b/docs/Send-OBSOffsetMediaInputCursor.md index ef3a5f83e..f0d375a55 100644 --- a/docs/Send-OBSOffsetMediaInputCursor.md +++ b/docs/Send-OBSOffsetMediaInputCursor.md @@ -27,13 +27,12 @@ Name of the media input -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Value to offset the current cursor position by -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Send-OBSPauseRecord.md b/docs/Send-OBSPauseRecord.md index 10580f6c4..9fc5b4958 100644 --- a/docs/Send-OBSPauseRecord.md +++ b/docs/Send-OBSPauseRecord.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Send-OBSPressInputPropertiesButton.md b/docs/Send-OBSPressInputPropertiesButton.md index 7f02d2631..a21b2bc2f 100644 --- a/docs/Send-OBSPressInputPropertiesButton.md +++ b/docs/Send-OBSPressInputPropertiesButton.md @@ -31,13 +31,12 @@ Name of the input -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -48,13 +47,12 @@ Name of the button property to press -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -65,13 +63,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Send-OBSSleep.md b/docs/Send-OBSSleep.md index a5752e59d..5eb832e4f 100644 --- a/docs/Send-OBSSleep.md +++ b/docs/Send-OBSSleep.md @@ -25,13 +25,12 @@ Number of milliseconds to sleep for (if `SERIAL_REALTIME` mode) -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Number of frames to sleep for (if `SERIAL_FRAME` mode) -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Send-OBSStreamCaption.md b/docs/Send-OBSStreamCaption.md index 2e7766781..de4d6f462 100644 --- a/docs/Send-OBSStreamCaption.md +++ b/docs/Send-OBSStreamCaption.md @@ -25,13 +25,12 @@ Caption text -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Send-OBSTriggerHotkeyByKeySequence.md b/docs/Send-OBSTriggerHotkeyByKeySequence.md index 1921130e4..6db555141 100644 --- a/docs/Send-OBSTriggerHotkeyByKeySequence.md +++ b/docs/Send-OBSTriggerHotkeyByKeySequence.md @@ -25,13 +25,12 @@ The OBS key ID to use. See https://github.com/obsproject/obs-studio/blob/master/ -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Object containing key modifiers to apply -> **Type**: ```[PSObject]``` -> **Required**: false -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|false |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ Press Shift -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -76,13 +73,12 @@ Press CTRL -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -93,13 +89,12 @@ Press ALT -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -110,13 +105,12 @@ Press CMD (Mac) -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -127,13 +121,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Send-OBSTriggerHotkeyByName.md b/docs/Send-OBSTriggerHotkeyByName.md index f22fa0b77..0ffcc6c0a 100644 --- a/docs/Send-OBSTriggerHotkeyByName.md +++ b/docs/Send-OBSTriggerHotkeyByName.md @@ -25,13 +25,12 @@ Name of the hotkey to trigger -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Send-OBSTriggerMediaInputAction.md b/docs/Send-OBSTriggerMediaInputAction.md index 1781ecfa8..522eed754 100644 --- a/docs/Send-OBSTriggerMediaInputAction.md +++ b/docs/Send-OBSTriggerMediaInputAction.md @@ -25,13 +25,12 @@ Name of the media input -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Identifier of the `ObsMediaInputAction` enum -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Send-OBSTriggerStudioModeTransition.md b/docs/Send-OBSTriggerStudioModeTransition.md index e4a763ea0..ceaa992af 100644 --- a/docs/Send-OBSTriggerStudioModeTransition.md +++ b/docs/Send-OBSTriggerStudioModeTransition.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSCurrentPreviewScene.md b/docs/Set-OBSCurrentPreviewScene.md index 8ff4b1457..afde18a21 100644 --- a/docs/Set-OBSCurrentPreviewScene.md +++ b/docs/Set-OBSCurrentPreviewScene.md @@ -27,13 +27,12 @@ Scene to set as the current preview scene -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSCurrentProfile.md b/docs/Set-OBSCurrentProfile.md index 369a37589..4be5fdaac 100644 --- a/docs/Set-OBSCurrentProfile.md +++ b/docs/Set-OBSCurrentProfile.md @@ -25,13 +25,12 @@ Name of the profile to switch to -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSCurrentProgramScene.md b/docs/Set-OBSCurrentProgramScene.md index f95f6e8d5..29ca01589 100644 --- a/docs/Set-OBSCurrentProgramScene.md +++ b/docs/Set-OBSCurrentProgramScene.md @@ -25,13 +25,12 @@ Scene to set as the current program scene -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSCurrentSceneCollection.md b/docs/Set-OBSCurrentSceneCollection.md index 21daad267..45f883d72 100644 --- a/docs/Set-OBSCurrentSceneCollection.md +++ b/docs/Set-OBSCurrentSceneCollection.md @@ -27,13 +27,12 @@ Name of the scene collection to switch to -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSCurrentSceneTransition.md b/docs/Set-OBSCurrentSceneTransition.md index 97638000e..666db466c 100644 --- a/docs/Set-OBSCurrentSceneTransition.md +++ b/docs/Set-OBSCurrentSceneTransition.md @@ -27,13 +27,12 @@ Name of the transition to make active -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSCurrentSceneTransitionDuration.md b/docs/Set-OBSCurrentSceneTransitionDuration.md index 2ed001b95..eb1dcc7a0 100644 --- a/docs/Set-OBSCurrentSceneTransitionDuration.md +++ b/docs/Set-OBSCurrentSceneTransitionDuration.md @@ -25,13 +25,12 @@ Duration in milliseconds -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSCurrentSceneTransitionSettings.md b/docs/Set-OBSCurrentSceneTransitionSettings.md index 47ecfddee..67ce02ed0 100644 --- a/docs/Set-OBSCurrentSceneTransitionSettings.md +++ b/docs/Set-OBSCurrentSceneTransitionSettings.md @@ -25,13 +25,12 @@ Settings object to apply to the transition. Can be `{}` -> **Type**: ```[PSObject]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Whether to overlay over the current settings or replace them -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -59,13 +57,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSInputAudioBalance.md b/docs/Set-OBSInputAudioBalance.md index 27c7c969c..9a3db84f0 100644 --- a/docs/Set-OBSInputAudioBalance.md +++ b/docs/Set-OBSInputAudioBalance.md @@ -25,13 +25,12 @@ Name of the input to set the audio balance of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ New audio balance value -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSInputAudioMonitorType.md b/docs/Set-OBSInputAudioMonitorType.md index 3a55e2a6c..476b16efb 100644 --- a/docs/Set-OBSInputAudioMonitorType.md +++ b/docs/Set-OBSInputAudioMonitorType.md @@ -25,13 +25,12 @@ Name of the input to set the audio monitor type of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Audio monitor type -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSInputAudioSyncOffset.md b/docs/Set-OBSInputAudioSyncOffset.md index cf76a4b70..db9c6ae29 100644 --- a/docs/Set-OBSInputAudioSyncOffset.md +++ b/docs/Set-OBSInputAudioSyncOffset.md @@ -25,13 +25,12 @@ Name of the input to set the audio sync offset of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ New audio sync offset in milliseconds -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSInputAudioTracks.md b/docs/Set-OBSInputAudioTracks.md index c5454b349..8c1f5ac1a 100644 --- a/docs/Set-OBSInputAudioTracks.md +++ b/docs/Set-OBSInputAudioTracks.md @@ -25,13 +25,12 @@ Name of the input -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Track settings to apply -> **Type**: ```[PSObject]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSInputMute.md b/docs/Set-OBSInputMute.md index 842ea9b2b..62f545503 100644 --- a/docs/Set-OBSInputMute.md +++ b/docs/Set-OBSInputMute.md @@ -25,13 +25,12 @@ Name of the input to set the mute state of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Whether to mute the input or not -> **Type**: ```[Switch]``` -> **Required**: true -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| @@ -59,13 +57,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSInputName.md b/docs/Set-OBSInputName.md index 3fba4ac06..a40887c1b 100644 --- a/docs/Set-OBSInputName.md +++ b/docs/Set-OBSInputName.md @@ -25,13 +25,12 @@ Current input name -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ New name for the input -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSInputSettings.md b/docs/Set-OBSInputSettings.md index 8b7d06f21..3cb1d7477 100644 --- a/docs/Set-OBSInputSettings.md +++ b/docs/Set-OBSInputSettings.md @@ -25,13 +25,12 @@ Name of the input to set the settings of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Object of settings to apply -> **Type**: ```[PSObject]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ True == apply the settings on top of existing ones, False == reset the input to -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -76,13 +73,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSInputVolume.md b/docs/Set-OBSInputVolume.md index 10c6cc847..f1a5752f3 100644 --- a/docs/Set-OBSInputVolume.md +++ b/docs/Set-OBSInputVolume.md @@ -25,13 +25,12 @@ Name of the input to set the volume of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Volume setting in mul -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ Volume setting in dB -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |3 |true (ByPropertyName)| @@ -76,13 +73,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSMediaInputCursor.md b/docs/Set-OBSMediaInputCursor.md index 71a8addc1..87dc2e375 100644 --- a/docs/Set-OBSMediaInputCursor.md +++ b/docs/Set-OBSMediaInputCursor.md @@ -27,13 +27,12 @@ Name of the media input -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ New cursor position to set -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSOutputSettings.md b/docs/Set-OBSOutputSettings.md index f3eb9155c..51d1d9f6d 100644 --- a/docs/Set-OBSOutputSettings.md +++ b/docs/Set-OBSOutputSettings.md @@ -25,13 +25,12 @@ Output name -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Output settings -> **Type**: ```[PSObject]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSPersistentData.md b/docs/Set-OBSPersistentData.md index e8d612f70..0a6df1ac5 100644 --- a/docs/Set-OBSPersistentData.md +++ b/docs/Set-OBSPersistentData.md @@ -25,13 +25,12 @@ The data realm to select. `OBS_WEBSOCKET_DATA_REALM_GLOBAL` or `OBS_WEBSOCKET_DA -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ The name of the slot to retrieve data from -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ The value to apply to the slot -> **Type**: ```[PSObject]``` -> **Required**: true -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|true |3 |true (ByPropertyName)| @@ -76,13 +73,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSProfileParameter.md b/docs/Set-OBSProfileParameter.md index 7e5fa4af8..661fa6df6 100644 --- a/docs/Set-OBSProfileParameter.md +++ b/docs/Set-OBSProfileParameter.md @@ -25,13 +25,12 @@ Category of the parameter to set -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Name of the parameter to set -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ Value of the parameter to set. Use `null` to delete -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |3 |true (ByPropertyName)| @@ -76,13 +73,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSSceneItemBlendMode.md b/docs/Set-OBSSceneItemBlendMode.md index 0c334a165..307cb3e70 100644 --- a/docs/Set-OBSSceneItemBlendMode.md +++ b/docs/Set-OBSSceneItemBlendMode.md @@ -27,13 +27,12 @@ Name of the scene the item is in -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Numeric ID of the scene item -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ New blend mode -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |3 |true (ByPropertyName)| @@ -78,13 +75,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSSceneItemEnabled.md b/docs/Set-OBSSceneItemEnabled.md index 4e6afaad7..66a5c7a82 100644 --- a/docs/Set-OBSSceneItemEnabled.md +++ b/docs/Set-OBSSceneItemEnabled.md @@ -27,13 +27,12 @@ Name of the scene the item is in -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Numeric ID of the scene item -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ New enable state of the scene item -> **Type**: ```[Switch]``` -> **Required**: true -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| @@ -78,13 +75,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSSceneItemIndex.md b/docs/Set-OBSSceneItemIndex.md index 76ffb5e99..58f0e3a3e 100644 --- a/docs/Set-OBSSceneItemIndex.md +++ b/docs/Set-OBSSceneItemIndex.md @@ -27,13 +27,12 @@ Name of the scene the item is in -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Numeric ID of the scene item -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ New index position of the scene item -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |3 |true (ByPropertyName)| @@ -78,13 +75,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSSceneItemLocked.md b/docs/Set-OBSSceneItemLocked.md index 3250bc960..061f39d1e 100644 --- a/docs/Set-OBSSceneItemLocked.md +++ b/docs/Set-OBSSceneItemLocked.md @@ -27,13 +27,12 @@ Name of the scene the item is in -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Numeric ID of the scene item -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ New lock state of the scene item -> **Type**: ```[Switch]``` -> **Required**: true -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| @@ -78,13 +75,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSSceneItemTransform.md b/docs/Set-OBSSceneItemTransform.md index 0fc0f5143..fd701d7f3 100644 --- a/docs/Set-OBSSceneItemTransform.md +++ b/docs/Set-OBSSceneItemTransform.md @@ -25,13 +25,12 @@ Name of the scene the item is in -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Numeric ID of the scene item -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ Object containing scene item transform info to update -> **Type**: ```[PSObject]``` -> **Required**: true -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|true |3 |true (ByPropertyName)| @@ -76,13 +73,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSSceneName.md b/docs/Set-OBSSceneName.md index 581e4ee42..86396fd97 100644 --- a/docs/Set-OBSSceneName.md +++ b/docs/Set-OBSSceneName.md @@ -25,13 +25,12 @@ Name of the scene to be renamed -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ New name for the scene -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSSceneSceneTransitionOverride.md b/docs/Set-OBSSceneSceneTransitionOverride.md index 94f6f3f47..9b489bac5 100644 --- a/docs/Set-OBSSceneSceneTransitionOverride.md +++ b/docs/Set-OBSSceneSceneTransitionOverride.md @@ -25,13 +25,12 @@ Name of the scene -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Name of the scene transition to use as override. Specify `null` to remove -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ Duration to use for any overridden transition. Specify `null` to remove -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |3 |true (ByPropertyName)| @@ -76,13 +73,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSSourceFilterEnabled.md b/docs/Set-OBSSourceFilterEnabled.md index 6481744cb..08dbe1c6e 100644 --- a/docs/Set-OBSSourceFilterEnabled.md +++ b/docs/Set-OBSSourceFilterEnabled.md @@ -25,13 +25,12 @@ Name of the source the filter is on -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Name of the filter -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ New enable state of the filter -> **Type**: ```[Switch]``` -> **Required**: true -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| @@ -76,13 +73,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSSourceFilterIndex.md b/docs/Set-OBSSourceFilterIndex.md index 85d85900b..9397611e3 100644 --- a/docs/Set-OBSSourceFilterIndex.md +++ b/docs/Set-OBSSourceFilterIndex.md @@ -25,13 +25,12 @@ Name of the source the filter is on -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Name of the filter -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ New index position of the filter -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |3 |true (ByPropertyName)| @@ -76,13 +73,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSSourceFilterName.md b/docs/Set-OBSSourceFilterName.md index 9f11a2609..403b0f13d 100644 --- a/docs/Set-OBSSourceFilterName.md +++ b/docs/Set-OBSSourceFilterName.md @@ -25,13 +25,12 @@ Name of the source the filter is on -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Current name of the filter -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ New name for the filter -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |3 |true (ByPropertyName)| @@ -76,13 +73,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSSourceFilterSettings.md b/docs/Set-OBSSourceFilterSettings.md index 2a58f4fe1..a99b113b6 100644 --- a/docs/Set-OBSSourceFilterSettings.md +++ b/docs/Set-OBSSourceFilterSettings.md @@ -25,13 +25,12 @@ Name of the source the filter is on -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ Name of the filter to set the settings of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| @@ -59,13 +57,12 @@ Object of settings to apply -> **Type**: ```[PSObject]``` -> **Required**: true -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|true |3 |true (ByPropertyName)| @@ -76,13 +73,12 @@ True == apply the settings on top of existing ones, False == reset the input to -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -93,13 +89,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSStreamServiceSettings.md b/docs/Set-OBSStreamServiceSettings.md index 4310027b9..f20d3a047 100644 --- a/docs/Set-OBSStreamServiceSettings.md +++ b/docs/Set-OBSStreamServiceSettings.md @@ -27,13 +27,12 @@ Type of stream service to apply. Example: `rtmp_common` or `rtmp_custom` -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Settings to apply to the service -> **Type**: ```[PSObject]``` -> **Required**: true -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|true |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSStudioModeEnabled.md b/docs/Set-OBSStudioModeEnabled.md index 67bdabaca..872f1d1cb 100644 --- a/docs/Set-OBSStudioModeEnabled.md +++ b/docs/Set-OBSStudioModeEnabled.md @@ -25,13 +25,12 @@ True == Enabled, False == Disabled -> **Type**: ```[Switch]``` -> **Required**: true -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSTBarPosition.md b/docs/Set-OBSTBarPosition.md index 14ac97727..d2c8f62fb 100644 --- a/docs/Set-OBSTBarPosition.md +++ b/docs/Set-OBSTBarPosition.md @@ -27,13 +27,12 @@ New position -> **Type**: ```[Double]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|true |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Whether to release the TBar. Only set `false` if you know that you will be sendi -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| @@ -61,13 +59,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Set-OBSVideoSettings.md b/docs/Set-OBSVideoSettings.md index 60e6f3a13..0b127e093 100644 --- a/docs/Set-OBSVideoSettings.md +++ b/docs/Set-OBSVideoSettings.md @@ -27,13 +27,12 @@ Numerator of the fractional FPS value -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |1 |true (ByPropertyName)| @@ -44,13 +43,12 @@ Denominator of the fractional FPS value -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |2 |true (ByPropertyName)| @@ -61,13 +59,12 @@ Width of the base (canvas) resolution in pixels -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 3 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |3 |true (ByPropertyName)| @@ -78,13 +75,12 @@ Height of the base (canvas) resolution in pixels -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 4 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |4 |true (ByPropertyName)| @@ -95,13 +91,12 @@ Width of the output resolution in pixels -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 5 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |5 |true (ByPropertyName)| @@ -112,13 +107,12 @@ Height of the output resolution in pixels -> **Type**: ```[Double]``` -> **Required**: false -> **Position**: 6 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |6 |true (ByPropertyName)| @@ -129,13 +123,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Start-OBSOutput.md b/docs/Start-OBSOutput.md index 101d78063..a6d04ac70 100644 --- a/docs/Start-OBSOutput.md +++ b/docs/Start-OBSOutput.md @@ -25,13 +25,12 @@ Output name -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Start-OBSRecord.md b/docs/Start-OBSRecord.md index e9d86978c..3ca6499cb 100644 --- a/docs/Start-OBSRecord.md +++ b/docs/Start-OBSRecord.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Start-OBSReplayBuffer.md b/docs/Start-OBSReplayBuffer.md index 0640965fb..bae0d542e 100644 --- a/docs/Start-OBSReplayBuffer.md +++ b/docs/Start-OBSReplayBuffer.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Start-OBSStream.md b/docs/Start-OBSStream.md index 2b26be52e..cb61084a7 100644 --- a/docs/Start-OBSStream.md +++ b/docs/Start-OBSStream.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Start-OBSVirtualCam.md b/docs/Start-OBSVirtualCam.md index ece3c9019..b8229f7b4 100644 --- a/docs/Start-OBSVirtualCam.md +++ b/docs/Start-OBSVirtualCam.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Stop-OBSOutput.md b/docs/Stop-OBSOutput.md index 4a8863d1a..ade63d64a 100644 --- a/docs/Stop-OBSOutput.md +++ b/docs/Stop-OBSOutput.md @@ -25,13 +25,12 @@ Output name -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Stop-OBSRecord.md b/docs/Stop-OBSRecord.md index 24a055482..8246b8760 100644 --- a/docs/Stop-OBSRecord.md +++ b/docs/Stop-OBSRecord.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Stop-OBSReplayBuffer.md b/docs/Stop-OBSReplayBuffer.md index 35979a211..a29f48f8f 100644 --- a/docs/Stop-OBSReplayBuffer.md +++ b/docs/Stop-OBSReplayBuffer.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Stop-OBSStream.md b/docs/Stop-OBSStream.md index 53e603bec..5ea829192 100644 --- a/docs/Stop-OBSStream.md +++ b/docs/Stop-OBSStream.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Stop-OBSVirtualCam.md b/docs/Stop-OBSVirtualCam.md index 320e5264e..093411fb5 100644 --- a/docs/Stop-OBSVirtualCam.md +++ b/docs/Stop-OBSVirtualCam.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Switch-OBSInputMute.md b/docs/Switch-OBSInputMute.md index 4001954c3..7b18f66cc 100644 --- a/docs/Switch-OBSInputMute.md +++ b/docs/Switch-OBSInputMute.md @@ -25,13 +25,12 @@ Name of the input to toggle the mute state of -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Switch-OBSOutput.md b/docs/Switch-OBSOutput.md index 18e47942d..a23ec4eba 100644 --- a/docs/Switch-OBSOutput.md +++ b/docs/Switch-OBSOutput.md @@ -25,13 +25,12 @@ Output name -> **Type**: ```[String]``` -> **Required**: true -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| @@ -42,13 +41,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Switch-OBSRecord.md b/docs/Switch-OBSRecord.md index c3424dbc1..58e9e9ce1 100644 --- a/docs/Switch-OBSRecord.md +++ b/docs/Switch-OBSRecord.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Switch-OBSRecordPause.md b/docs/Switch-OBSRecordPause.md index 0410f4f80..1b6c79462 100644 --- a/docs/Switch-OBSRecordPause.md +++ b/docs/Switch-OBSRecordPause.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Switch-OBSReplayBuffer.md b/docs/Switch-OBSReplayBuffer.md index 09b43a88b..2703edbc1 100644 --- a/docs/Switch-OBSReplayBuffer.md +++ b/docs/Switch-OBSReplayBuffer.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Switch-OBSStream.md b/docs/Switch-OBSStream.md index a18969edc..388bd2476 100644 --- a/docs/Switch-OBSStream.md +++ b/docs/Switch-OBSStream.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Switch-OBSVirtualCam.md b/docs/Switch-OBSVirtualCam.md index d1fdb259b..9c065ae07 100644 --- a/docs/Switch-OBSVirtualCam.md +++ b/docs/Switch-OBSVirtualCam.md @@ -32,13 +32,12 @@ If set, will return the information that would otherwise be sent to OBS. -> **Type**: ```[Switch]``` -> **Required**: false -> **Position**: named -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| diff --git a/docs/Watch-OBS.md b/docs/Watch-OBS.md index 08871055c..609764dc5 100644 --- a/docs/Watch-OBS.md +++ b/docs/Watch-OBS.md @@ -38,13 +38,12 @@ The OBS websocket URL. If not provided, this will default to loopback on port 4 -> **Type**: ```[Uri]``` -> **Required**: false -> **Position**: 1 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |1 |true (ByPropertyName)| @@ -56,13 +55,12 @@ You can see the websocket password in Tools -> obs-websocket settings -> show co -> **Type**: ```[String]``` -> **Required**: false -> **Position**: 2 -> **PipelineInput**:true (ByPropertyName) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |2 |true (ByPropertyName)| diff --git a/obs-powershell.ps.psd1 b/obs-powershell.ps.psd1 index 067844332..ed8e83cbd 100644 --- a/obs-powershell.ps.psd1 +++ b/obs-powershell.ps.psd1 @@ -1,5 +1,5 @@ @{ - ModuleVersion = '0.1.5' + ModuleVersion = '0.1.6' RootModule = 'obs-powershell.psm1' Description = 'Script OBS with PowerShell' Guid = '1417123e-a932-439f-9b68-a7313cf1e170' @@ -16,6 +16,14 @@ ProjectURI = 'https://github.com/StartAutomating/obs-powershell' LicenseURI = 'https://github.com/StartAutomating/obs-powershell/blob/main/LICENSE' ReleaseNotes = @' +## obs-powershell 0.1.6: + +* Adding OBS.SceneItem .Scale (Fixes #64) +* OBS.SceneItem .FitToScreen, adjusting .Scale (Fixes #63) +* Add-OBSMediaSource: Fixing -InputSettings / -SceneItemEnabled (Fixes #62) + +--- + ## obs-powershell 0.1.5: * Adding OBS.SceneItem .Animate (Fixes #59) diff --git a/obs-powershell.psd1 b/obs-powershell.psd1 index 10e589fa5..c075e1ae6 100644 --- a/obs-powershell.psd1 +++ b/obs-powershell.psd1 @@ -1,5 +1,5 @@ @{ - ModuleVersion = '0.1.5' + ModuleVersion = '0.1.6' RootModule = 'obs-powershell.psm1' Description = 'Script OBS with PowerShell' Guid = '1417123e-a932-439f-9b68-a7313cf1e170' @@ -16,6 +16,14 @@ ProjectURI = 'https://github.com/StartAutomating/obs-powershell' LicenseURI = 'https://github.com/StartAutomating/obs-powershell/blob/main/LICENSE' ReleaseNotes = @' +## obs-powershell 0.1.6: + +* Adding OBS.SceneItem .Scale (Fixes #64) +* OBS.SceneItem .FitToScreen, adjusting .Scale (Fixes #63) +* Add-OBSMediaSource: Fixing -InputSettings / -SceneItemEnabled (Fixes #62) + +--- + ## obs-powershell 0.1.5: * Adding OBS.SceneItem .Animate (Fixes #59) @@ -97,6 +105,10 @@ Initial Release of obs-powershell 'Receive-OBS', 'Send-OBS', 'Watch-OBS', +'Add-OBSBrowserSource', +'Add-OBSColorSource', +'Add-OBSDisplaySource', +'Add-OBSMediaSource', 'Add-OBSInput', 'Add-OBSProfile', 'Add-OBSScene', @@ -233,10 +245,6 @@ Initial Release of obs-powershell 'Switch-OBSRecordPause', 'Switch-OBSReplayBuffer', 'Switch-OBSStream', -'Switch-OBSVirtualCam', -'Add-OBSBrowserSource', -'Add-OBSColorSource', -'Add-OBSDisplaySource', -'Add-OBSMediaSource' +'Switch-OBSVirtualCam' } diff --git a/obs-powershell.types.ps1xml b/obs-powershell.types.ps1xml index 6f416240e..cbd2e3190 100644 --- a/obs-powershell.types.ps1xml +++ b/obs-powershell.types.ps1xml @@ -183,13 +183,17 @@ $this | Set-OBSSceneItemTransform -SceneItemTransform $cropTable @@ -218,6 +222,50 @@ $this | Set-OBSSceneItemTransform -SceneItemTransform @{ } + + Scale + + Unlock