From b9ce1c77cc684ade16c3c26f13e132cfe1dc768d Mon Sep 17 00:00:00 2001 From: James Brundage <@github.com> Date: Wed, 8 Mar 2023 19:03:10 -0800 Subject: [PATCH 001/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- Commands/Sources/Add-OBSBrowserSource.ps.ps1 | 16 +++++++++++++++- Commands/Sources/Add-OBSColorSource.ps.ps1 | 16 +++++++++++++++- Commands/Sources/Add-OBSDisplaySource.ps.ps1 | 17 ++++++++++++++++- Commands/Sources/Add-OBSMediaSource.ps.ps1 | 16 +++++++++++++++- 4 files changed, 61 insertions(+), 4 deletions(-) diff --git a/Commands/Sources/Add-OBSBrowserSource.ps.ps1 b/Commands/Sources/Add-OBSBrowserSource.ps.ps1 index cef14b54c..8927c8d48 100644 --- a/Commands/Sources/Add-OBSBrowserSource.ps.ps1 +++ b/Commands/Sources/Add-OBSBrowserSource.ps.ps1 @@ -75,7 +75,13 @@ function Add-OBSBrowserSource # If no name is provided, the last segment of the URI or file path will be the input name. [Parameter(ValueFromPipelineByPropertyName)] [string] - $Name + $Name, + + # If set, will check if the source exists in the scene before creating it and removing any existing sources found. + # If not set, you will get an error if a source with the same name exists. + [Parameter(ValueFromPipelineByPropertyName)] + [switch] + $Force ) process { @@ -144,6 +150,14 @@ function Add-OBSBrowserSource } } + # If -Force is provided + if ($Force) { + # Clear any items from that scene + Get-OBSSceneItem -sceneName $myParameters["Scene"] | + Where-Object SourceName -eq $name | + Remove-OBSInput -InputName { $_.SourceName } + } + $outputAddedResult = Add-OBSInput -sceneName $myParameters["Scene"] -inputKind "browser_source" -inputSettings $myParameterData -inputName $Name diff --git a/Commands/Sources/Add-OBSColorSource.ps.ps1 b/Commands/Sources/Add-OBSColorSource.ps.ps1 index 698a190e5..225da043e 100644 --- a/Commands/Sources/Add-OBSColorSource.ps.ps1 +++ b/Commands/Sources/Add-OBSColorSource.ps.ps1 @@ -30,7 +30,13 @@ function Add-OBSColorSource [ValidatePattern('\#(?>[0-9a-f]{8}|[0-9a-f]{6}|[0-9a-f]{4}|[0-9a-f]{3})')] [Parameter(ValueFromPipelineByPropertyName)] [string] - $Color + $Color, + + # If set, will check if the source exists in the scene before creating it and removing any existing sources found. + # If not set, you will get an error if a source with the same name exists. + [Parameter(ValueFromPipelineByPropertyName)] + [switch] + $Force ) process { @@ -99,6 +105,14 @@ function Add-OBSColorSource inputSettings = $myParameterData } + # If -Force is provided + if ($Force) { + # Clear any items from that scene + Get-OBSSceneItem -sceneName $myParameters["Scene"] | + Where-Object SourceName -eq $myParameters["Name"] | + Remove-OBSInput -InputName { $_.SourceName } + } + $outputAddedResult = Add-OBSInput @addObsInputParams if ($outputAddedResult) { Get-OBSSceneItem -sceneName $myParameters["Scene"] | diff --git a/Commands/Sources/Add-OBSDisplaySource.ps.ps1 b/Commands/Sources/Add-OBSDisplaySource.ps.ps1 index 5b15d4b18..f65a4ab6c 100644 --- a/Commands/Sources/Add-OBSDisplaySource.ps.ps1 +++ b/Commands/Sources/Add-OBSDisplaySource.ps.ps1 @@ -41,7 +41,13 @@ function Add-OBSDisplaySource [Parameter(ValueFromPipelineByPropertyName)] [Alias('InputName')] [string] - $Name + $Name, + + # If set, will check if the source exists in the scene before creating it and removing any existing sources found. + # If not set, you will get an error if a source with the same name exists. + [Parameter(ValueFromPipelineByPropertyName)] + [switch] + $Force ) process { @@ -86,6 +92,15 @@ function Add-OBSDisplaySource inputSettings = $myParameterData } + # If -Force is provided + if ($Force) { + # Clear any items from that scene + Get-OBSSceneItem -sceneName $myParameters["Scene"] | + Where-Object SourceName -eq $myParameters["Name"] | + Remove-OBSInput -InputName { $_.SourceName } + } + + $outputAddedResult = Add-OBSInput @addObsInputParams if ($outputAddedResult) { Get-OBSSceneItem -sceneName $myParameters["Scene"] | diff --git a/Commands/Sources/Add-OBSMediaSource.ps.ps1 b/Commands/Sources/Add-OBSMediaSource.ps.ps1 index fb1197575..d0637f40c 100644 --- a/Commands/Sources/Add-OBSMediaSource.ps.ps1 +++ b/Commands/Sources/Add-OBSMediaSource.ps.ps1 @@ -68,7 +68,13 @@ function Add-OBSMediaSource # If no name is provided, the last segment of the URI or file path will be the input name. [Parameter(ValueFromPipelineByPropertyName)] [string] - $Name + $Name, + + # If set, will check if the source exists in the scene before creating it and removing any existing sources found. + # If not set, you will get an error if a source with the same name exists. + [Parameter(ValueFromPipelineByPropertyName)] + [switch] + $Force ) process { @@ -138,6 +144,14 @@ function Add-OBSMediaSource $addSplat.SceneItemEnabled = $myParameters['SceneItemEnabled'] -as [bool] } + # If -Force is provided + if ($Force) { + # Clear any items from that scene + Get-OBSSceneItem -sceneName $myParameters["Scene"] | + Where-Object SourceName -eq $myParameters["Name"] | + Remove-OBSInput -InputName { $_.SourceName } + } + $outputAddedResult = Add-OBSInput @addSplat if ($outputAddedResult) { Get-OBSSceneItem -sceneName $myParameters["Scene"] | From 6d6f23f4cc9e9192aa858460ca923e8d1b727225 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:22 +0000 Subject: [PATCH 002/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- Commands/Sources/Add-OBSBrowserSource.ps1 | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/Commands/Sources/Add-OBSBrowserSource.ps1 b/Commands/Sources/Add-OBSBrowserSource.ps1 index e23e3824f..9758c95c0 100644 --- a/Commands/Sources/Add-OBSBrowserSource.ps1 +++ b/Commands/Sources/Add-OBSBrowserSource.ps1 @@ -64,7 +64,12 @@ function Add-OBSBrowserSource { # If no name is provided, the last segment of the URI or file path will be the input name. [Parameter(ValueFromPipelineByPropertyName)] [string] - $Name + $Name, +# If set, will check if the source exists in the scene before creating it and removing any existing sources found. + # If not set, you will get an error if a source with the same name exists. + [Parameter(ValueFromPipelineByPropertyName)] + [switch] + $Force ) dynamicParam { $baseCommand = @@ -160,6 +165,13 @@ dynamicParam { $uri } } + # If -Force is provided + if ($Force) { + # Clear any items from that scene + Get-OBSSceneItem -sceneName $myParameters["Scene"] | + Where-Object SourceName -eq $name | + Remove-OBSInput -InputName { $_.SourceName } + } $outputAddedResult = Add-OBSInput -sceneName $myParameters["Scene"] -inputKind "browser_source" -inputSettings $myParameterData -inputName $Name if ($outputAddedResult) { From b0e4e39504dbd4c4334ad709df47b02b48150afa Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:22 +0000 Subject: [PATCH 003/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- Commands/Sources/Add-OBSColorSource.ps1 | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/Commands/Sources/Add-OBSColorSource.ps1 b/Commands/Sources/Add-OBSColorSource.ps1 index 01e102079..a0af3be5a 100644 --- a/Commands/Sources/Add-OBSColorSource.ps1 +++ b/Commands/Sources/Add-OBSColorSource.ps1 @@ -27,7 +27,12 @@ function Add-OBSColorSource { [ValidatePattern('\#(?>[0-9a-f]{8}|[0-9a-f]{6}|[0-9a-f]{4}|[0-9a-f]{3})')] [Parameter(ValueFromPipelineByPropertyName)] [string] - $Color + $Color, +# If set, will check if the source exists in the scene before creating it and removing any existing sources found. + # If not set, you will get an error if a source with the same name exists. + [Parameter(ValueFromPipelineByPropertyName)] + [switch] + $Force ) dynamicParam { $baseCommand = @@ -124,6 +129,13 @@ dynamicParam { inputKind = "color_source_v3" inputSettings = $myParameterData } + # If -Force is provided + if ($Force) { + # Clear any items from that scene + Get-OBSSceneItem -sceneName $myParameters["Scene"] | + Where-Object SourceName -eq $myParameters["Name"] | + Remove-OBSInput -InputName { $_.SourceName } + } $outputAddedResult = Add-OBSInput @addObsInputParams if ($outputAddedResult) { Get-OBSSceneItem -sceneName $myParameters["Scene"] | From 3ad4da20f81b5bc4016ebb13ebb0f442b34ffbc2 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:22 +0000 Subject: [PATCH 004/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- Commands/Sources/Add-OBSDisplaySource.ps1 | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/Commands/Sources/Add-OBSDisplaySource.ps1 b/Commands/Sources/Add-OBSDisplaySource.ps1 index 5639b01c2..e276d4fdf 100644 --- a/Commands/Sources/Add-OBSDisplaySource.ps1 +++ b/Commands/Sources/Add-OBSDisplaySource.ps1 @@ -39,7 +39,12 @@ function Add-OBSDisplaySource { [Parameter(ValueFromPipelineByPropertyName)] [Alias('InputName')] [string] - $Name + $Name, +# If set, will check if the source exists in the scene before creating it and removing any existing sources found. + # If not set, you will get an error if a source with the same name exists. + [Parameter(ValueFromPipelineByPropertyName)] + [switch] + $Force ) dynamicParam { $baseCommand = @@ -111,6 +116,14 @@ dynamicParam { inputKind = "monitor_capture" inputSettings = $myParameterData } + # If -Force is provided + if ($Force) { + # Clear any items from that scene + Get-OBSSceneItem -sceneName $myParameters["Scene"] | + Where-Object SourceName -eq $myParameters["Name"] | + Remove-OBSInput -InputName { $_.SourceName } + } + $outputAddedResult = Add-OBSInput @addObsInputParams if ($outputAddedResult) { Get-OBSSceneItem -sceneName $myParameters["Scene"] | From 2156cab37b0f6601f6f48934741bb923e12fad40 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:22 +0000 Subject: [PATCH 005/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- Commands/Sources/Add-OBSMediaSource.ps1 | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/Commands/Sources/Add-OBSMediaSource.ps1 b/Commands/Sources/Add-OBSMediaSource.ps1 index 0f826e52c..addbc8837 100644 --- a/Commands/Sources/Add-OBSMediaSource.ps1 +++ b/Commands/Sources/Add-OBSMediaSource.ps1 @@ -62,7 +62,12 @@ function Add-OBSMediaSource { # If no name is provided, the last segment of the URI or file path will be the input name. [Parameter(ValueFromPipelineByPropertyName)] [string] - $Name + $Name, +# If set, will check if the source exists in the scene before creating it and removing any existing sources found. + # If not set, you will get an error if a source with the same name exists. + [Parameter(ValueFromPipelineByPropertyName)] + [switch] + $Force ) dynamicParam { $baseCommand = @@ -155,6 +160,13 @@ dynamicParam { if ($myParameters.Contains('SceneItemEnabled')) { $addSplat.SceneItemEnabled = $myParameters['SceneItemEnabled'] -as [bool] } + # If -Force is provided + if ($Force) { + # Clear any items from that scene + Get-OBSSceneItem -sceneName $myParameters["Scene"] | + Where-Object SourceName -eq $myParameters["Name"] | + Remove-OBSInput -InputName { $_.SourceName } + } $outputAddedResult = Add-OBSInput @addSplat if ($outputAddedResult) { Get-OBSSceneItem -sceneName $myParameters["Scene"] | From 2f74811f44c64bac943857badb8e30685be5f583 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:36 +0000 Subject: [PATCH 006/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Add-OBSBrowserSource.md | 60 ++++++++++++++++++++++++++---------- 1 file changed, 43 insertions(+), 17 deletions(-) diff --git a/docs/Add-OBSBrowserSource.md b/docs/Add-OBSBrowserSource.md index 864210093..e2785a514 100644 --- a/docs/Add-OBSBrowserSource.md +++ b/docs/Add-OBSBrowserSource.md @@ -1,21 +1,37 @@ Add-OBSBrowserSource -------------------- + + + + ### Synopsis Adds a browser source + + --- + + ### Description Adds a browser source to OBS. + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Add-OBSBrowserSource ``` + + --- + + ### Parameters #### **Uri** @@ -27,13 +43,12 @@ If the uri points to a local file, this will be preferred -|Type |Required|Position|PipelineInput | -|-------|--------|--------|---------------------| -|`[Uri]`|false |1 |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|-------|--------|--------|---------------------|-----------------------------------------------| +|`[Uri]`|false |1 |true (ByPropertyName)|Url
Href
Path
FilePath
FullName| ---- #### **Width** The width of the browser source. @@ -50,7 +65,6 @@ If none is provided, this will be the output width of the video settings. ---- #### **Height** The width of the browser source. @@ -67,7 +81,6 @@ If none is provided, this will be the output height of the video settings. ---- #### **CSS** The css style used to render the browser page. @@ -83,7 +96,6 @@ The css style used to render the browser page. ---- #### **ShutdownWhenHidden** If set, the browser source will shutdown when it is hidden @@ -99,7 +111,6 @@ If set, the browser source will shutdown when it is hidden ---- #### **RestartWhenActived** If set, the browser source will restart when it is activated. @@ -115,7 +126,6 @@ If set, the browser source will restart when it is activated. ---- #### **RerouteAudio** If set, audio from the browser source will be rerouted into OBS. @@ -131,7 +141,6 @@ If set, audio from the browser source will be rerouted into OBS. ---- #### **FramesPerSecond** If provided, the browser source will render at a custom frame rate. @@ -141,13 +150,12 @@ If provided, the browser source will render at a custom frame rate. -|Type |Required|Position|PipelineInput | -|---------|--------|--------|---------------------| -|`[Int32]`|false |5 |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases| +|---------|--------|--------|---------------------|-------| +|`[Int32]`|false |5 |true (ByPropertyName)|FPS | ---- #### **Scene** The name of the scene. @@ -164,7 +172,6 @@ If no scene name is provided, the current program scene will be used. ---- #### **Name** The name of the input. @@ -181,9 +188,28 @@ If no name is provided, the last segment of the URI or file path will be the inp +#### **Force** + +If set, will check if the source exists in the scene before creating it and removing any existing sources found. +If not set, you will get an error if a source with the same name exists. + + + + + + +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| + + + + + --- + + ### Syntax ```PowerShell -Add-OBSBrowserSource [[-Uri] ] [[-Width] ] [[-Height] ] [[-CSS] ] [-ShutdownWhenHidden] [-RestartWhenActived] [-RerouteAudio] [[-FramesPerSecond] ] [[-Scene] ] [[-Name] ] [] +Add-OBSBrowserSource [[-Uri] ] [[-Width] ] [[-Height] ] [[-CSS] ] [-ShutdownWhenHidden] [-RestartWhenActived] [-RerouteAudio] [[-FramesPerSecond] ] [[-Scene] ] [[-Name] ] [-Force] [] ``` ---- From e973dc0fb3fa5e57586620b96cf7e23cccd5340c Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:37 +0000 Subject: [PATCH 007/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Add-OBSColorSource.md | 53 +++++++++++++++++++++++++++++++------- 1 file changed, 43 insertions(+), 10 deletions(-) diff --git a/docs/Add-OBSColorSource.md b/docs/Add-OBSColorSource.md index 8a3763081..d65afe8b2 100644 --- a/docs/Add-OBSColorSource.md +++ b/docs/Add-OBSColorSource.md @@ -1,21 +1,37 @@ Add-OBSColorSource ------------------ + + + + ### Synopsis Adds a color source + + --- + + ### Description Adds a color source to OBS. This displays a single 32-bit color (RGBA). + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Add-OBSColorSource ``` + + --- + + ### Parameters #### **Scene** @@ -27,13 +43,12 @@ If no scene name is provided, the current program scene will be used. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[String]`|false |1 |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[String]`|false |1 |true (ByPropertyName)|SceneName| ---- #### **Name** The name of the input. @@ -44,13 +59,12 @@ If no name is provided, "Display $($Monitor + 1)" will be the input source name. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[String]`|false |2 |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[String]`|false |2 |true (ByPropertyName)|InputName| ---- #### **Color** @@ -62,9 +76,28 @@ If no name is provided, "Display $($Monitor + 1)" will be the input source name. +#### **Force** + +If set, will check if the source exists in the scene before creating it and removing any existing sources found. +If not set, you will get an error if a source with the same name exists. + + + + + + +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| + + + + + --- + + ### Syntax ```PowerShell -Add-OBSColorSource [[-Scene] ] [[-Name] ] [[-Color] ] [] +Add-OBSColorSource [[-Scene] ] [[-Name] ] [[-Color] ] [-Force] [] ``` ---- From 8d4e4ff2c0a3ca68c9027e9eeb7ab843f86989ad Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:37 +0000 Subject: [PATCH 008/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Add-OBSDisplaySource.md | 56 ++++++++++++++++++++++++++++-------- 1 file changed, 44 insertions(+), 12 deletions(-) diff --git a/docs/Add-OBSDisplaySource.md b/docs/Add-OBSDisplaySource.md index 548e822e9..2eaee3785 100644 --- a/docs/Add-OBSDisplaySource.md +++ b/docs/Add-OBSDisplaySource.md @@ -1,14 +1,26 @@ Add-OBSDisplaySource -------------------- + + + + ### Synopsis Adds a display source + + --- + + ### Description Adds a display source to OBS. This captures the contents of the display. + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell @@ -20,7 +32,11 @@ Add-OBSMonitorSource # Adds a display source of the primary monitor Add-OBSMonitorSource -Display 2 # Adds a display source of the second monitor ``` + + --- + + ### Parameters #### **Monitor** @@ -32,13 +48,12 @@ This the number of the monitor you would like to capture. -|Type |Required|Position|PipelineInput | -|---------|--------|--------|---------------------| -|`[Int32]`|false |1 |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|---------|--------|--------|---------------------|-------------------------------------------| +|`[Int32]`|false |1 |true (ByPropertyName)|MonitorNumber
Display
DisplayNumber| ---- #### **CaptureCursor** If set, will capture the cursor. @@ -56,7 +71,6 @@ If explicitly set to false, the cursor will not be captured. ---- #### **Scene** The name of the scene. @@ -67,13 +81,12 @@ If no scene name is provided, the current program scene will be used. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[String]`|false |2 |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[String]`|false |2 |true (ByPropertyName)|SceneName| ---- #### **Name** The name of the input. @@ -84,15 +97,34 @@ If no name is provided, "Display $($Monitor + 1)" will be the input source name. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[String]`|false |3 |true (ByPropertyName)|InputName| + + + +#### **Force** + +If set, will check if the source exists in the scene before creating it and removing any existing sources found. +If not set, you will get an error if a source with the same name exists. + + + + + + |Type |Required|Position|PipelineInput | |----------|--------|--------|---------------------| -|`[String]`|false |3 |true (ByPropertyName)| +|`[Switch]`|false |named |true (ByPropertyName)| + + --- + + ### Syntax ```PowerShell -Add-OBSDisplaySource [[-Monitor] ] [-CaptureCursor] [[-Scene] ] [[-Name] ] [] +Add-OBSDisplaySource [[-Monitor] ] [-CaptureCursor] [[-Scene] ] [[-Name] ] [-Force] [] ``` ---- From 36c0223409e25a383e91439efcf70a932bd00a94 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:37 +0000 Subject: [PATCH 009/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Add-OBSInput.md | 32 +++++++++++++++++++++++--------- 1 file changed, 23 insertions(+), 9 deletions(-) diff --git a/docs/Add-OBSInput.md b/docs/Add-OBSInput.md index 19d6835d9..4b26f9533 100644 --- a/docs/Add-OBSInput.md +++ b/docs/Add-OBSInput.md @@ -1,9 +1,17 @@ Add-OBSInput ------------ + + + + ### Synopsis Add-OBSInput : CreateInput + + --- + + ### Description Creates a new input, adding it as a scene item to the specified scene. @@ -11,13 +19,21 @@ Creates a new input, adding it as a scene item to the specified scene. Add-OBSInput calls the OBS WebSocket with a request of type CreateInput. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#createinput](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#createinput) + + --- + + ### Parameters #### **SceneName** @@ -34,7 +50,6 @@ Name of the scene to add the input to as a scene item ---- #### **InputName** Name of the new input to created @@ -50,7 +65,6 @@ Name of the new input to created ---- #### **InputKind** The kind of input to be created @@ -66,7 +80,6 @@ The kind of input to be created ---- #### **InputSettings** Settings object to initialize the input with @@ -82,7 +95,6 @@ Settings object to initialize the input with ---- #### **SceneItemEnabled** Whether to set the created scene item to enabled or disabled @@ -98,7 +110,6 @@ Whether to set the created scene item to enabled or disabled ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -108,15 +119,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Add-OBSInput [-SceneName] [-InputName] [-InputKind] [[-InputSettings] ] [-SceneItemEnabled] [-PassThru] [] ``` ---- From e432782ca4a403c10a52a7701072907d2c98e706 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:37 +0000 Subject: [PATCH 010/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Add-OBSMediaSource.md | 80 ++++++++++++++++++++++++++------------ 1 file changed, 56 insertions(+), 24 deletions(-) diff --git a/docs/Add-OBSMediaSource.md b/docs/Add-OBSMediaSource.md index 180a18fee..20c7b5eea 100644 --- a/docs/Add-OBSMediaSource.md +++ b/docs/Add-OBSMediaSource.md @@ -1,27 +1,47 @@ Add-OBSMediaSource ------------------ + + + + ### Synopsis Adds a media source + + --- + + ### Description Adds a media source to OBS. + + --- + + ### Related Links * [Add-OBSInput](Add-OBSInput.md) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Add-OBSMediaSource -FilePath My.mp4 ``` + + --- + + ### Parameters #### **FilePath** @@ -32,13 +52,12 @@ The path to the media file. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[String]`|true |1 |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------------------------------| +|`[String]`|true |1 |true (ByPropertyName)|FullName
LocalFile
local_file| ---- #### **CloseWhenInactive** If set, the source will close when it is inactive. @@ -56,7 +75,6 @@ To explicitly set it to false, use -CloseWhenInactive:$false ---- #### **Loop** If set, the source will automatically restart. @@ -66,13 +84,12 @@ If set, the source will automatically restart. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|false |named |true (ByPropertyName)|Looping| ---- #### **UseHardwareDecoding** If set, will use hardware decoding, if available. @@ -82,13 +99,12 @@ If set, will use hardware decoding, if available. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|HardwareDecoding
hw_decode| ---- #### **ClearOnMediaEnd** If set, will clear the output on the end of the media. @@ -101,13 +117,12 @@ To explicitly set to false, use -ClearMediaEnd:$false -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|ClearOnEnd
NoFreezeFrameOnEnd| ---- #### **FFMpegOption** Any FFMpeg demuxer options. @@ -117,13 +132,12 @@ Any FFMpeg demuxer options. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[String]`|false |2 |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------------------------------| +|`[String]`|false |2 |true (ByPropertyName)|FFMpegOptions
FFMpeg_Options| ---- #### **Scene** The name of the scene. @@ -140,7 +154,6 @@ If no scene name is provided, the current program scene will be used. ---- #### **Name** The name of the input. @@ -157,9 +170,28 @@ If no name is provided, the last segment of the URI or file path will be the inp +#### **Force** + +If set, will check if the source exists in the scene before creating it and removing any existing sources found. +If not set, you will get an error if a source with the same name exists. + + + + + + +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| + + + + + --- + + ### Syntax ```PowerShell -Add-OBSMediaSource [-FilePath] [-CloseWhenInactive] [-Loop] [-UseHardwareDecoding] [-ClearOnMediaEnd] [[-FFMpegOption] ] [[-Scene] ] [[-Name] ] [] +Add-OBSMediaSource [-FilePath] [-CloseWhenInactive] [-Loop] [-UseHardwareDecoding] [-ClearOnMediaEnd] [[-FFMpegOption] ] [[-Scene] ] [[-Name] ] [-Force] [] ``` ---- From aa51659ee580cf8b5da8aa4645300125c93cc1ec Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:37 +0000 Subject: [PATCH 011/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Add-OBSProfile.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Add-OBSProfile.md b/docs/Add-OBSProfile.md index 1f7bbf161..09b1aff46 100644 --- a/docs/Add-OBSProfile.md +++ b/docs/Add-OBSProfile.md @@ -1,9 +1,17 @@ Add-OBSProfile -------------- + + + + ### Synopsis Add-OBSProfile : CreateProfile + + --- + + ### Description Creates a new profile, switching to it in the process @@ -11,13 +19,21 @@ Creates a new profile, switching to it in the process Add-OBSProfile calls the OBS WebSocket with a request of type CreateProfile. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#createprofile](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#createprofile) + + --- + + ### Parameters #### **ProfileName** @@ -34,7 +50,6 @@ Name for the new profile ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Add-OBSProfile [-ProfileName] [-PassThru] [] ``` ---- From e5c4291a05e25bfca5a13b48994112987265d73f Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:37 +0000 Subject: [PATCH 012/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Add-OBSScene.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Add-OBSScene.md b/docs/Add-OBSScene.md index dd7d84581..a6573862a 100644 --- a/docs/Add-OBSScene.md +++ b/docs/Add-OBSScene.md @@ -1,9 +1,17 @@ Add-OBSScene ------------ + + + + ### Synopsis Add-OBSScene : CreateScene + + --- + + ### Description Creates a new scene in OBS. @@ -11,13 +19,21 @@ Creates a new scene in OBS. Add-OBSScene calls the OBS WebSocket with a request of type CreateScene. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#createscene](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#createscene) + + --- + + ### Parameters #### **SceneName** @@ -34,7 +50,6 @@ Name for the new scene ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Add-OBSScene [-SceneName] [-PassThru] [] ``` ---- From e33cd416ce9da4d9790379292b6e1a1d371284b3 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:37 +0000 Subject: [PATCH 013/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Add-OBSSceneCollection.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Add-OBSSceneCollection.md b/docs/Add-OBSSceneCollection.md index 435e0d908..4ac85cc5e 100644 --- a/docs/Add-OBSSceneCollection.md +++ b/docs/Add-OBSSceneCollection.md @@ -1,9 +1,17 @@ Add-OBSSceneCollection ---------------------- + + + + ### Synopsis Add-OBSSceneCollection : CreateSceneCollection + + --- + + ### Description Creates a new scene collection, switching to it in the process. @@ -13,13 +21,21 @@ Note: This will block until the collection has finished changing. Add-OBSSceneCollection calls the OBS WebSocket with a request of type CreateSceneCollection. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#createscenecollection](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#createscenecollection) + + --- + + ### Parameters #### **SceneCollectionName** @@ -36,7 +52,6 @@ Name for the new scene collection ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -46,15 +61,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Add-OBSSceneCollection [-SceneCollectionName] [-PassThru] [] ``` ---- From a5d0b5704a85360936b91b71f686ca4d1fa6e7e9 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:38 +0000 Subject: [PATCH 014/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Add-OBSSceneItem.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Add-OBSSceneItem.md b/docs/Add-OBSSceneItem.md index 1f0e418bc..719e056c2 100644 --- a/docs/Add-OBSSceneItem.md +++ b/docs/Add-OBSSceneItem.md @@ -1,9 +1,17 @@ Add-OBSSceneItem ---------------- + + + + ### Synopsis Add-OBSSceneItem : CreateSceneItem + + --- + + ### Description Creates a new scene item using a source. @@ -13,13 +21,21 @@ Scenes only Add-OBSSceneItem calls the OBS WebSocket with a request of type CreateSceneItem. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#createsceneitem](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#createsceneitem) + + --- + + ### Parameters #### **SceneName** @@ -36,7 +52,6 @@ Name of the scene to create the new item in ---- #### **SourceName** Name of the source to add to the scene @@ -52,7 +67,6 @@ Name of the source to add to the scene ---- #### **SceneItemEnabled** Enable state to apply to the scene item on creation @@ -68,7 +82,6 @@ Enable state to apply to the scene item on creation ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -78,15 +91,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Add-OBSSceneItem [-SceneName] [-SourceName] [-SceneItemEnabled] [-PassThru] [] ``` ---- From 05fb8c9765bc4df239f993bed1e99f74e54228a4 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:38 +0000 Subject: [PATCH 015/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Add-OBSSourceFilter.md | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/docs/Add-OBSSourceFilter.md b/docs/Add-OBSSourceFilter.md index 981197010..492b6077e 100644 --- a/docs/Add-OBSSourceFilter.md +++ b/docs/Add-OBSSourceFilter.md @@ -1,9 +1,17 @@ Add-OBSSourceFilter ------------------- + + + + ### Synopsis Add-OBSSourceFilter : CreateSourceFilter + + --- + + ### Description Creates a new filter, adding it to the specified source. @@ -11,13 +19,21 @@ Creates a new filter, adding it to the specified source. Add-OBSSourceFilter calls the OBS WebSocket with a request of type CreateSourceFilter. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#createsourcefilter](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#createsourcefilter) + + --- + + ### Parameters #### **SourceName** @@ -34,7 +50,6 @@ Name of the source to add the filter to ---- #### **FilterName** Name of the new filter to be created @@ -50,7 +65,6 @@ Name of the new filter to be created ---- #### **FilterKind** The kind of filter to be created @@ -66,7 +80,6 @@ The kind of filter to be created ---- #### **FilterSettings** Settings object to initialize the filter with @@ -82,7 +95,6 @@ Settings object to initialize the filter with ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -92,15 +104,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Add-OBSSourceFilter [-SourceName] [-FilterName] [-FilterKind] [[-FilterSettings] ] [-PassThru] [] ``` ---- From 015001d323576fa8482f59344ae640f10bc0e4fa Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:38 +0000 Subject: [PATCH 016/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Clear-OBSScene.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Clear-OBSScene.md b/docs/Clear-OBSScene.md index 3cda50719..8603a8ce1 100644 --- a/docs/Clear-OBSScene.md +++ b/docs/Clear-OBSScene.md @@ -1,9 +1,17 @@ Clear-OBSScene -------------- + + + + ### Synopsis Clears a Scene in OBS + + --- + + ### Description Clears a Scene in OBS. @@ -12,14 +20,22 @@ All inputs will be removed from the scene. This cannot be undone, so you will be prompted for confirmation. + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Clear-OBSScene -SceneName Scene ``` + + --- + + ### Parameters #### **SceneName** @@ -36,22 +52,24 @@ Name of the scene. ---- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. + + --- + + ### Syntax ```PowerShell Clear-OBSScene [[-SceneName] ] [-WhatIf] [-Confirm] [] ``` ---- From fcfef83f8b3ae5149270c7923b0381acda8c8513 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:38 +0000 Subject: [PATCH 017/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Connect-OBS.md | 32 +++++++++++++++++++++++++++----- 1 file changed, 27 insertions(+), 5 deletions(-) diff --git a/docs/Connect-OBS.md b/docs/Connect-OBS.md index e9e9315ba..b2bafff2f 100644 --- a/docs/Connect-OBS.md +++ b/docs/Connect-OBS.md @@ -1,29 +1,49 @@ Connect-OBS ----------- + + + + ### Synopsis Connects to Open Broadcast Studio + + --- + + ### Description Connects to the obs-websocket. This must occur at least once to use obs-powershell. + + --- + + ### Related Links * [Disconnect-OBS](Disconnect-OBS.md) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Connect-OBS ``` + + --- + + ### Parameters #### **WebSocketUri** @@ -40,7 +60,6 @@ The OBS websocket URL. If not provided, this will default to loopback on port 4 ---- #### **WebSocketToken** A randomly generated password used to connect to OBS. @@ -51,13 +70,17 @@ You can see the websocket password in Tools -> obs-websocket settings -> show co -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[String]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------| +|`[String]`|false |named |true (ByPropertyName)|WebSocketPassword| + + --- + + ### Syntax ```PowerShell Connect-OBS [] @@ -65,4 +88,3 @@ Connect-OBS [] ```PowerShell Connect-OBS [-WebSocketUri ] [-WebSocketToken ] [] ``` ---- From 14885d13dffeb4e02fae77eec5fe1298e623f2bc Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:38 +0000 Subject: [PATCH 018/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Copy-OBSSceneItem.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Copy-OBSSceneItem.md b/docs/Copy-OBSSceneItem.md index 198c94f5a..385b780dc 100644 --- a/docs/Copy-OBSSceneItem.md +++ b/docs/Copy-OBSSceneItem.md @@ -1,9 +1,17 @@ Copy-OBSSceneItem ----------------- + + + + ### Synopsis Copy-OBSSceneItem : DuplicateSceneItem + + --- + + ### Description Duplicates a scene item, copying all transform and crop info. @@ -13,13 +21,21 @@ Scenes only Copy-OBSSceneItem calls the OBS WebSocket with a request of type DuplicateSceneItem. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#duplicatesceneitem](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#duplicatesceneitem) + + --- + + ### Parameters #### **SceneName** @@ -36,7 +52,6 @@ Name of the scene the item is in ---- #### **SceneItemId** Numeric ID of the scene item @@ -52,7 +67,6 @@ Numeric ID of the scene item ---- #### **DestinationSceneName** Name of the scene to create the duplicated item in @@ -68,7 +82,6 @@ Name of the scene to create the duplicated item in ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -78,15 +91,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Copy-OBSSceneItem [-SceneName] [-SceneItemId] [[-DestinationSceneName] ] [-PassThru] [] ``` ---- From 94a3ef496f35f65718e5f02abfd9e5156d889976 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:38 +0000 Subject: [PATCH 019/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Disconnect-OBS.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/Disconnect-OBS.md b/docs/Disconnect-OBS.md index d9451010d..44b115306 100644 --- a/docs/Disconnect-OBS.md +++ b/docs/Disconnect-OBS.md @@ -1,31 +1,50 @@ Disconnect-OBS -------------- + + + + ### Synopsis Disconnects OBS + + --- + + ### Description Disconnects Websockets from OBS. All websockets will be disconnected. + + --- + + ### Related Links * [Connect-OBS](Connect-OBS.md) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Disconnect-OBS ``` + + --- + + ### Syntax ```PowerShell Disconnect-OBS [] ``` ---- From 902fd401ed9e3ef8f16772dcc6f6cb5038b9e083 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:38 +0000 Subject: [PATCH 020/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSCurrentPreviewScene.md | 31 ++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSCurrentPreviewScene.md b/docs/Get-OBSCurrentPreviewScene.md index 5c0a35671..0cf264597 100644 --- a/docs/Get-OBSCurrentPreviewScene.md +++ b/docs/Get-OBSCurrentPreviewScene.md @@ -1,9 +1,17 @@ Get-OBSCurrentPreviewScene -------------------------- + + + + ### Synopsis Get-OBSCurrentPreviewScene : GetCurrentPreviewScene + + --- + + ### Description Gets the current preview scene. @@ -13,20 +21,32 @@ Only available when studio mode is enabled. Get-OBSCurrentPreviewScene calls the OBS WebSocket with a request of type GetCurrentPreviewScene. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getcurrentpreviewscene](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getcurrentpreviewscene) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSCurrentPreviewScene ``` + + --- + + ### Parameters #### **PassThru** @@ -37,15 +57,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSCurrentPreviewScene [-PassThru] [] ``` ---- From 29411f6300ce3faa0ab836aec8eb1ff3f56d0191 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:38 +0000 Subject: [PATCH 021/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSCurrentProgramScene.md | 31 ++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSCurrentProgramScene.md b/docs/Get-OBSCurrentProgramScene.md index 713a67de5..b9610069b 100644 --- a/docs/Get-OBSCurrentProgramScene.md +++ b/docs/Get-OBSCurrentProgramScene.md @@ -1,9 +1,17 @@ Get-OBSCurrentProgramScene -------------------------- + + + + ### Synopsis Get-OBSCurrentProgramScene : GetCurrentProgramScene + + --- + + ### Description Gets the current program scene. @@ -11,20 +19,32 @@ Gets the current program scene. Get-OBSCurrentProgramScene calls the OBS WebSocket with a request of type GetCurrentProgramScene. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getcurrentprogramscene](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getcurrentprogramscene) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSCurrentProgramScene ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSCurrentProgramScene [-PassThru] [] ``` ---- From 1cc18d965841baffa2fbedf8cee0278763232598 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:39 +0000 Subject: [PATCH 022/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSCurrentSceneTransition.md | 31 +++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSCurrentSceneTransition.md b/docs/Get-OBSCurrentSceneTransition.md index 7f21f069f..2362e4713 100644 --- a/docs/Get-OBSCurrentSceneTransition.md +++ b/docs/Get-OBSCurrentSceneTransition.md @@ -1,9 +1,17 @@ Get-OBSCurrentSceneTransition ----------------------------- + + + + ### Synopsis Get-OBSCurrentSceneTransition : GetCurrentSceneTransition + + --- + + ### Description Gets information about the current scene transition. @@ -11,20 +19,32 @@ Gets information about the current scene transition. Get-OBSCurrentSceneTransition calls the OBS WebSocket with a request of type GetCurrentSceneTransition. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getcurrentscenetransition](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getcurrentscenetransition) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSCurrentSceneTransition ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSCurrentSceneTransition [-PassThru] [] ``` ---- From 4c7b95d8f4fa7e7fb5840a3dcdf61bf36dde9726 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:39 +0000 Subject: [PATCH 023/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSCurrentSceneTransitionCursor.md | 31 ++++++++++++++++++--- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSCurrentSceneTransitionCursor.md b/docs/Get-OBSCurrentSceneTransitionCursor.md index 8e92a36ca..a1036b342 100644 --- a/docs/Get-OBSCurrentSceneTransitionCursor.md +++ b/docs/Get-OBSCurrentSceneTransitionCursor.md @@ -1,9 +1,17 @@ Get-OBSCurrentSceneTransitionCursor ----------------------------------- + + + + ### Synopsis Get-OBSCurrentSceneTransitionCursor : GetCurrentSceneTransitionCursor + + --- + + ### Description Gets the cursor position of the current scene transition. @@ -13,20 +21,32 @@ Note: `transitionCursor` will return 1.0 when the transition is inactive. Get-OBSCurrentSceneTransitionCursor calls the OBS WebSocket with a request of type GetCurrentSceneTransitionCursor. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getcurrentscenetransitioncursor](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getcurrentscenetransitioncursor) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSCurrentSceneTransitionCursor ``` + + --- + + ### Parameters #### **PassThru** @@ -37,15 +57,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSCurrentSceneTransitionCursor [-PassThru] [] ``` ---- From 5d24532819e49389207c6f43ccdd260345b1b9c2 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:39 +0000 Subject: [PATCH 024/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSGroup.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSGroup.md b/docs/Get-OBSGroup.md index 5e1d9342e..6d0d9d589 100644 --- a/docs/Get-OBSGroup.md +++ b/docs/Get-OBSGroup.md @@ -1,9 +1,17 @@ Get-OBSGroup ------------ + + + + ### Synopsis Get-OBSGroup : GetGroupList + + --- + + ### Description Gets an array of all groups in OBS. @@ -13,20 +21,32 @@ Groups in OBS are actually scenes, but renamed and modified. In obs-websocket, w Get-OBSGroup calls the OBS WebSocket with a request of type GetGroupList. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getgrouplist](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getgrouplist) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSGroup ``` + + --- + + ### Parameters #### **PassThru** @@ -37,15 +57,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSGroup [-PassThru] [] ``` ---- From ef7980699aec2de21879a605b785a8b0ee9c8e7c Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:39 +0000 Subject: [PATCH 025/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSGroupSceneItem.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSGroupSceneItem.md b/docs/Get-OBSGroupSceneItem.md index 3feb518ec..ea6e148df 100644 --- a/docs/Get-OBSGroupSceneItem.md +++ b/docs/Get-OBSGroupSceneItem.md @@ -1,9 +1,17 @@ Get-OBSGroupSceneItem --------------------- + + + + ### Synopsis Get-OBSGroupSceneItem : GetGroupSceneItemList + + --- + + ### Description Basically GetSceneItemList, but for groups. @@ -15,13 +23,21 @@ Groups only Get-OBSGroupSceneItem calls the OBS WebSocket with a request of type GetGroupSceneItemList. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getgroupsceneitemlist](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getgroupsceneitemlist) + + --- + + ### Parameters #### **SceneName** @@ -38,7 +54,6 @@ Name of the group to get the items of ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -48,15 +63,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSGroupSceneItem [-SceneName] [-PassThru] [] ``` ---- From 76b9cae818a12fff27cbff92b3d23deee0364449 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:39 +0000 Subject: [PATCH 026/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSHotkey.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSHotkey.md b/docs/Get-OBSHotkey.md index 5b95c89c5..177571fc3 100644 --- a/docs/Get-OBSHotkey.md +++ b/docs/Get-OBSHotkey.md @@ -1,9 +1,17 @@ Get-OBSHotkey ------------- + + + + ### Synopsis Get-OBSHotkey : GetHotkeyList + + --- + + ### Description Gets an array of all hotkey names in OBS @@ -11,20 +19,32 @@ Gets an array of all hotkey names in OBS Get-OBSHotkey calls the OBS WebSocket with a request of type GetHotkeyList. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#gethotkeylist](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#gethotkeylist) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSHotkey ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSHotkey [-PassThru] [] ``` ---- From e0936573266b72474edd755b6dbc030f81d6a0af Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:39 +0000 Subject: [PATCH 027/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSInput.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSInput.md b/docs/Get-OBSInput.md index 8edc42cf3..3f36f4fa5 100644 --- a/docs/Get-OBSInput.md +++ b/docs/Get-OBSInput.md @@ -1,9 +1,17 @@ Get-OBSInput ------------ + + + + ### Synopsis Get-OBSInput : GetInputList + + --- + + ### Description Gets an array of all inputs in OBS. @@ -11,13 +19,21 @@ Gets an array of all inputs in OBS. Get-OBSInput calls the OBS WebSocket with a request of type GetInputList. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputlist](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputlist) + + --- + + ### Parameters #### **InputKind** @@ -34,7 +50,6 @@ Restrict the array to only inputs of the specified kind ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSInput [[-InputKind] ] [-PassThru] [] ``` ---- From 15e0b9854ebbfc510c42f2045bd99cf383f696c7 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:39 +0000 Subject: [PATCH 028/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSInputAudioBalance.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSInputAudioBalance.md b/docs/Get-OBSInputAudioBalance.md index f5028ff32..e53171004 100644 --- a/docs/Get-OBSInputAudioBalance.md +++ b/docs/Get-OBSInputAudioBalance.md @@ -1,9 +1,17 @@ Get-OBSInputAudioBalance ------------------------ + + + + ### Synopsis Get-OBSInputAudioBalance : GetInputAudioBalance + + --- + + ### Description Gets the audio balance of an input. @@ -11,13 +19,21 @@ Gets the audio balance of an input. Get-OBSInputAudioBalance calls the OBS WebSocket with a request of type GetInputAudioBalance. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputaudiobalance](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputaudiobalance) + + --- + + ### Parameters #### **InputName** @@ -34,7 +50,6 @@ Name of the input to get the audio balance of ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSInputAudioBalance [-InputName] [-PassThru] [] ``` ---- From a526cba9116ba21e1b45415b9ffc9b8edf013368 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:39 +0000 Subject: [PATCH 029/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSInputAudioMonitorType.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSInputAudioMonitorType.md b/docs/Get-OBSInputAudioMonitorType.md index 435e91da7..4d9666978 100644 --- a/docs/Get-OBSInputAudioMonitorType.md +++ b/docs/Get-OBSInputAudioMonitorType.md @@ -1,9 +1,17 @@ Get-OBSInputAudioMonitorType ---------------------------- + + + + ### Synopsis Get-OBSInputAudioMonitorType : GetInputAudioMonitorType + + --- + + ### Description Gets the audio monitor type of an input. @@ -17,13 +25,21 @@ The available audio monitor types are: Get-OBSInputAudioMonitorType calls the OBS WebSocket with a request of type GetInputAudioMonitorType. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputaudiomonitortype](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputaudiomonitortype) + + --- + + ### Parameters #### **InputName** @@ -40,7 +56,6 @@ Name of the input to get the audio monitor type of ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -50,15 +65,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSInputAudioMonitorType [-InputName] [-PassThru] [] ``` ---- From 96110873f30fda8e1bc21d42fe035ba5fbfe467e Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:39 +0000 Subject: [PATCH 030/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSInputAudioSyncOffset.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSInputAudioSyncOffset.md b/docs/Get-OBSInputAudioSyncOffset.md index 600f0dd57..08d126b41 100644 --- a/docs/Get-OBSInputAudioSyncOffset.md +++ b/docs/Get-OBSInputAudioSyncOffset.md @@ -1,9 +1,17 @@ Get-OBSInputAudioSyncOffset --------------------------- + + + + ### Synopsis Get-OBSInputAudioSyncOffset : GetInputAudioSyncOffset + + --- + + ### Description Gets the audio sync offset of an input. @@ -13,13 +21,21 @@ Note: The audio sync offset can be negative too! Get-OBSInputAudioSyncOffset calls the OBS WebSocket with a request of type GetInputAudioSyncOffset. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputaudiosyncoffset](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputaudiosyncoffset) + + --- + + ### Parameters #### **InputName** @@ -36,7 +52,6 @@ Name of the input to get the audio sync offset of ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -46,15 +61,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSInputAudioSyncOffset [-InputName] [-PassThru] [] ``` ---- From 778c4a6c0c22b758c246c27941687827ff2e4cdd Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:40 +0000 Subject: [PATCH 031/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSInputAudioTracks.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSInputAudioTracks.md b/docs/Get-OBSInputAudioTracks.md index 8fd1ac761..4c379b962 100644 --- a/docs/Get-OBSInputAudioTracks.md +++ b/docs/Get-OBSInputAudioTracks.md @@ -1,9 +1,17 @@ Get-OBSInputAudioTracks ----------------------- + + + + ### Synopsis Get-OBSInputAudioTracks : GetInputAudioTracks + + --- + + ### Description Gets the enable state of all audio tracks of an input. @@ -11,13 +19,21 @@ Gets the enable state of all audio tracks of an input. Get-OBSInputAudioTracks calls the OBS WebSocket with a request of type GetInputAudioTracks. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputaudiotracks](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputaudiotracks) + + --- + + ### Parameters #### **InputName** @@ -34,7 +50,6 @@ Name of the input ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSInputAudioTracks [-InputName] [-PassThru] [] ``` ---- From 139ebe82172e2311af56865220643178ff38a815 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:40 +0000 Subject: [PATCH 032/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSInputDefaultSettings.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSInputDefaultSettings.md b/docs/Get-OBSInputDefaultSettings.md index 201da19a8..b21f537c7 100644 --- a/docs/Get-OBSInputDefaultSettings.md +++ b/docs/Get-OBSInputDefaultSettings.md @@ -1,9 +1,17 @@ Get-OBSInputDefaultSettings --------------------------- + + + + ### Synopsis Get-OBSInputDefaultSettings : GetInputDefaultSettings + + --- + + ### Description Gets the default settings for an input kind. @@ -11,13 +19,21 @@ Gets the default settings for an input kind. Get-OBSInputDefaultSettings calls the OBS WebSocket with a request of type GetInputDefaultSettings. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputdefaultsettings](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputdefaultsettings) + + --- + + ### Parameters #### **InputKind** @@ -34,7 +50,6 @@ Input kind to get the default settings for ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSInputDefaultSettings [-InputKind] [-PassThru] [] ``` ---- From 067f18c37dd6b51c563c351f99fb5fc64592747b Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:40 +0000 Subject: [PATCH 033/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSInputKind.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSInputKind.md b/docs/Get-OBSInputKind.md index 07ae8871f..81f52274d 100644 --- a/docs/Get-OBSInputKind.md +++ b/docs/Get-OBSInputKind.md @@ -1,9 +1,17 @@ Get-OBSInputKind ---------------- + + + + ### Synopsis Get-OBSInputKind : GetInputKindList + + --- + + ### Description Gets an array of all available input kinds in OBS. @@ -11,13 +19,21 @@ Gets an array of all available input kinds in OBS. Get-OBSInputKind calls the OBS WebSocket with a request of type GetInputKindList. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputkindlist](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputkindlist) + + --- + + ### Parameters #### **Unversioned** @@ -34,7 +50,6 @@ True == Return all kinds as unversioned, False == Return with version suffixes ( ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSInputKind [-Unversioned] [-PassThru] [] ``` ---- From be453926680ea118e46dcad60992459ea010c7c4 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:40 +0000 Subject: [PATCH 034/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSInputMute.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSInputMute.md b/docs/Get-OBSInputMute.md index b38d544a0..7a7883532 100644 --- a/docs/Get-OBSInputMute.md +++ b/docs/Get-OBSInputMute.md @@ -1,9 +1,17 @@ Get-OBSInputMute ---------------- + + + + ### Synopsis Get-OBSInputMute : GetInputMute + + --- + + ### Description Gets the audio mute state of an input. @@ -11,13 +19,21 @@ Gets the audio mute state of an input. Get-OBSInputMute calls the OBS WebSocket with a request of type GetInputMute. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputmute](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputmute) + + --- + + ### Parameters #### **InputName** @@ -34,7 +50,6 @@ Name of input to get the mute state of ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSInputMute [-InputName] [-PassThru] [] ``` ---- From 946edd0fffb9617f92e746a44f8a6fa1f66341e9 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:40 +0000 Subject: [PATCH 035/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- ...Get-OBSInputPropertiesListPropertyItems.md | 29 +++++++++++++++---- 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Get-OBSInputPropertiesListPropertyItems.md b/docs/Get-OBSInputPropertiesListPropertyItems.md index bfc1d317f..ec0635862 100644 --- a/docs/Get-OBSInputPropertiesListPropertyItems.md +++ b/docs/Get-OBSInputPropertiesListPropertyItems.md @@ -1,9 +1,17 @@ Get-OBSInputPropertiesListPropertyItems --------------------------------------- + + + + ### Synopsis Get-OBSInputPropertiesListPropertyItems : GetInputPropertiesListPropertyItems + + --- + + ### Description Gets the items of a list property from an input's properties. @@ -13,13 +21,21 @@ Note: Use this in cases where an input provides a dynamic, selectable list of it Get-OBSInputPropertiesListPropertyItems calls the OBS WebSocket with a request of type GetInputPropertiesListPropertyItems. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputpropertieslistpropertyitems](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputpropertieslistpropertyitems) + + --- + + ### Parameters #### **InputName** @@ -36,7 +52,6 @@ Name of the input ---- #### **PropertyName** Name of the list property to get the items of @@ -52,7 +67,6 @@ Name of the list property to get the items of ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -62,15 +76,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSInputPropertiesListPropertyItems [-InputName] [-PropertyName] [-PassThru] [] ``` ---- From dbdc01ab5515e68e7581bf6a16dbed83917f1237 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:40 +0000 Subject: [PATCH 036/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSInputSettings.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSInputSettings.md b/docs/Get-OBSInputSettings.md index 9e89eafaa..46bcddf0c 100644 --- a/docs/Get-OBSInputSettings.md +++ b/docs/Get-OBSInputSettings.md @@ -1,9 +1,17 @@ Get-OBSInputSettings -------------------- + + + + ### Synopsis Get-OBSInputSettings : GetInputSettings + + --- + + ### Description Gets the settings of an input. @@ -13,13 +21,21 @@ Note: Does not include defaults. To create the entire settings object, overlay ` Get-OBSInputSettings calls the OBS WebSocket with a request of type GetInputSettings. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputsettings](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputsettings) + + --- + + ### Parameters #### **InputName** @@ -36,7 +52,6 @@ Name of the input to get the settings of ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -46,15 +61,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSInputSettings [-InputName] [-PassThru] [] ``` ---- From 72fbaa9c2ec8c7b08ed30df3e55e92136764f45c Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:40 +0000 Subject: [PATCH 037/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSInputVolume.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSInputVolume.md b/docs/Get-OBSInputVolume.md index 7f8e21546..1e8e8bf21 100644 --- a/docs/Get-OBSInputVolume.md +++ b/docs/Get-OBSInputVolume.md @@ -1,9 +1,17 @@ Get-OBSInputVolume ------------------ + + + + ### Synopsis Get-OBSInputVolume : GetInputVolume + + --- + + ### Description Gets the current volume setting of an input. @@ -11,13 +19,21 @@ Gets the current volume setting of an input. Get-OBSInputVolume calls the OBS WebSocket with a request of type GetInputVolume. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputvolume](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getinputvolume) + + --- + + ### Parameters #### **InputName** @@ -34,7 +50,6 @@ Name of the input to get the volume of ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSInputVolume [-InputName] [-PassThru] [] ``` ---- From 73ac13f3b1767d04dc4a8523a08cad4064e15bdd Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:40 +0000 Subject: [PATCH 038/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSLastReplayBufferReplay.md | 31 +++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSLastReplayBufferReplay.md b/docs/Get-OBSLastReplayBufferReplay.md index 8b38b806f..c68c6eb3d 100644 --- a/docs/Get-OBSLastReplayBufferReplay.md +++ b/docs/Get-OBSLastReplayBufferReplay.md @@ -1,9 +1,17 @@ Get-OBSLastReplayBufferReplay ----------------------------- + + + + ### Synopsis Get-OBSLastReplayBufferReplay : GetLastReplayBufferReplay + + --- + + ### Description Gets the filename of the last replay buffer save file. @@ -11,20 +19,32 @@ Gets the filename of the last replay buffer save file. Get-OBSLastReplayBufferReplay calls the OBS WebSocket with a request of type GetLastReplayBufferReplay. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getlastreplaybufferreplay](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getlastreplaybufferreplay) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSLastReplayBufferReplay ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSLastReplayBufferReplay [-PassThru] [] ``` ---- From 1c1750d126dc696fcb82e4c6b6d0a03bc43a05a3 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:40 +0000 Subject: [PATCH 039/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSMediaInputStatus.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSMediaInputStatus.md b/docs/Get-OBSMediaInputStatus.md index 7a92a0c4e..88c40352a 100644 --- a/docs/Get-OBSMediaInputStatus.md +++ b/docs/Get-OBSMediaInputStatus.md @@ -1,9 +1,17 @@ Get-OBSMediaInputStatus ----------------------- + + + + ### Synopsis Get-OBSMediaInputStatus : GetMediaInputStatus + + --- + + ### Description Gets the status of a media input. @@ -22,13 +30,21 @@ Media States: Get-OBSMediaInputStatus calls the OBS WebSocket with a request of type GetMediaInputStatus. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getmediainputstatus](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getmediainputstatus) + + --- + + ### Parameters #### **InputName** @@ -45,7 +61,6 @@ Name of the media input ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -55,15 +70,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSMediaInputStatus [-InputName] [-PassThru] [] ``` ---- From ed2f3e3d0c329012dae278a0d3a859578e3130a0 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:41 +0000 Subject: [PATCH 040/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSMonitor.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSMonitor.md b/docs/Get-OBSMonitor.md index d141930da..eec52fd2b 100644 --- a/docs/Get-OBSMonitor.md +++ b/docs/Get-OBSMonitor.md @@ -1,9 +1,17 @@ Get-OBSMonitor -------------- + + + + ### Synopsis Get-OBSMonitor : GetMonitorList + + --- + + ### Description Gets a list of connected monitors and information about them. @@ -11,20 +19,32 @@ Gets a list of connected monitors and information about them. Get-OBSMonitor calls the OBS WebSocket with a request of type GetMonitorList. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getmonitorlist](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getmonitorlist) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSMonitor ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSMonitor [-PassThru] [] ``` ---- From 17b02015ff2dcd50019150f42c042dcf953a2239 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:41 +0000 Subject: [PATCH 041/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSOutput.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSOutput.md b/docs/Get-OBSOutput.md index e659842b9..b4fe1ce7e 100644 --- a/docs/Get-OBSOutput.md +++ b/docs/Get-OBSOutput.md @@ -1,9 +1,17 @@ Get-OBSOutput ------------- + + + + ### Synopsis Get-OBSOutput : GetOutputList + + --- + + ### Description Gets the list of available outputs. @@ -11,20 +19,32 @@ Gets the list of available outputs. Get-OBSOutput calls the OBS WebSocket with a request of type GetOutputList. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getoutputlist](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getoutputlist) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSOutput ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSOutput [-PassThru] [] ``` ---- From aa3098c0b37252032b629983320b30e8d45a6059 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:41 +0000 Subject: [PATCH 042/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSOutputSettings.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSOutputSettings.md b/docs/Get-OBSOutputSettings.md index 1ff33ca54..30b48c7f7 100644 --- a/docs/Get-OBSOutputSettings.md +++ b/docs/Get-OBSOutputSettings.md @@ -1,9 +1,17 @@ Get-OBSOutputSettings --------------------- + + + + ### Synopsis Get-OBSOutputSettings : GetOutputSettings + + --- + + ### Description Gets the settings of an output. @@ -11,13 +19,21 @@ Gets the settings of an output. Get-OBSOutputSettings calls the OBS WebSocket with a request of type GetOutputSettings. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getoutputsettings](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getoutputsettings) + + --- + + ### Parameters #### **OutputName** @@ -34,7 +50,6 @@ Output name ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSOutputSettings [-OutputName] [-PassThru] [] ``` ---- From 7a09152d560e391764e30edc4492fd246df9beeb Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:41 +0000 Subject: [PATCH 043/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSOutputStatus.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSOutputStatus.md b/docs/Get-OBSOutputStatus.md index e9fbcc3ef..39f0fd827 100644 --- a/docs/Get-OBSOutputStatus.md +++ b/docs/Get-OBSOutputStatus.md @@ -1,9 +1,17 @@ Get-OBSOutputStatus ------------------- + + + + ### Synopsis Get-OBSOutputStatus : GetOutputStatus + + --- + + ### Description Gets the status of an output. @@ -11,13 +19,21 @@ Gets the status of an output. Get-OBSOutputStatus calls the OBS WebSocket with a request of type GetOutputStatus. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getoutputstatus](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getoutputstatus) + + --- + + ### Parameters #### **OutputName** @@ -34,7 +50,6 @@ Output name ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSOutputStatus [-OutputName] [-PassThru] [] ``` ---- From ee2d2b21e36512f22e2fc114cba3c4552fa79804 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:41 +0000 Subject: [PATCH 044/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSPersistentData.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Get-OBSPersistentData.md b/docs/Get-OBSPersistentData.md index 87736de3b..e2869c6d6 100644 --- a/docs/Get-OBSPersistentData.md +++ b/docs/Get-OBSPersistentData.md @@ -1,9 +1,17 @@ Get-OBSPersistentData --------------------- + + + + ### Synopsis Get-OBSPersistentData : GetPersistentData + + --- + + ### Description Gets the value of a "slot" from the selected persistent data realm. @@ -11,13 +19,21 @@ Gets the value of a "slot" from the selected persistent data realm. Get-OBSPersistentData calls the OBS WebSocket with a request of type GetPersistentData. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getpersistentdata](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getpersistentdata) + + --- + + ### Parameters #### **Realm** @@ -34,7 +50,6 @@ The data realm to select. `OBS_WEBSOCKET_DATA_REALM_GLOBAL` or `OBS_WEBSOCKET_DA ---- #### **SlotName** The name of the slot to retrieve data from @@ -50,7 +65,6 @@ The name of the slot to retrieve data from ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -60,15 +74,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSPersistentData [-Realm] [-SlotName] [-PassThru] [] ``` ---- From 9039b67e46076de609a0f8bc4ff6a31d2dc6db26 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:41 +0000 Subject: [PATCH 045/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSProfile.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSProfile.md b/docs/Get-OBSProfile.md index 351557acb..464946a76 100644 --- a/docs/Get-OBSProfile.md +++ b/docs/Get-OBSProfile.md @@ -1,9 +1,17 @@ Get-OBSProfile -------------- + + + + ### Synopsis Get-OBSProfile : GetProfileList + + --- + + ### Description Gets an array of all profiles @@ -11,20 +19,32 @@ Gets an array of all profiles Get-OBSProfile calls the OBS WebSocket with a request of type GetProfileList. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getprofilelist](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getprofilelist) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSProfile ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSProfile [-PassThru] [] ``` ---- From 0103d26f51bf5434f5cf57aac1d1233c183b7602 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:41 +0000 Subject: [PATCH 046/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSProfileParameter.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Get-OBSProfileParameter.md b/docs/Get-OBSProfileParameter.md index 3d870e882..1cfbc322a 100644 --- a/docs/Get-OBSProfileParameter.md +++ b/docs/Get-OBSProfileParameter.md @@ -1,9 +1,17 @@ Get-OBSProfileParameter ----------------------- + + + + ### Synopsis Get-OBSProfileParameter : GetProfileParameter + + --- + + ### Description Gets a parameter from the current profile's configuration. @@ -11,13 +19,21 @@ Gets a parameter from the current profile's configuration. Get-OBSProfileParameter calls the OBS WebSocket with a request of type GetProfileParameter. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getprofileparameter](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getprofileparameter) + + --- + + ### Parameters #### **ParameterCategory** @@ -34,7 +50,6 @@ Category of the parameter to get ---- #### **ParameterName** Name of the parameter to get @@ -50,7 +65,6 @@ Name of the parameter to get ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -60,15 +74,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSProfileParameter [-ParameterCategory] [-ParameterName] [-PassThru] [] ``` ---- From 47daf9bc80f24f7f5638f4c996518f28efdf494d Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:41 +0000 Subject: [PATCH 047/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSRecordDirectory.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSRecordDirectory.md b/docs/Get-OBSRecordDirectory.md index 1515008d3..79cea0997 100644 --- a/docs/Get-OBSRecordDirectory.md +++ b/docs/Get-OBSRecordDirectory.md @@ -1,9 +1,17 @@ Get-OBSRecordDirectory ---------------------- + + + + ### Synopsis Get-OBSRecordDirectory : GetRecordDirectory + + --- + + ### Description Gets the current directory that the record output is set to. @@ -11,20 +19,32 @@ Gets the current directory that the record output is set to. Get-OBSRecordDirectory calls the OBS WebSocket with a request of type GetRecordDirectory. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getrecorddirectory](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getrecorddirectory) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSRecordDirectory ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSRecordDirectory [-PassThru] [] ``` ---- From f078dcbf91cdda5cce0a4ee949ff0b9ae521070a Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:41 +0000 Subject: [PATCH 048/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSRecordStatus.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSRecordStatus.md b/docs/Get-OBSRecordStatus.md index c7265d386..c4d3bf485 100644 --- a/docs/Get-OBSRecordStatus.md +++ b/docs/Get-OBSRecordStatus.md @@ -1,9 +1,17 @@ Get-OBSRecordStatus ------------------- + + + + ### Synopsis Get-OBSRecordStatus : GetRecordStatus + + --- + + ### Description Gets the status of the record output. @@ -11,20 +19,32 @@ Gets the status of the record output. Get-OBSRecordStatus calls the OBS WebSocket with a request of type GetRecordStatus. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getrecordstatus](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getrecordstatus) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSRecordStatus ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSRecordStatus [-PassThru] [] ``` ---- From 0b80f97278384d16c9e63badccc2126eed779689 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:42 +0000 Subject: [PATCH 049/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSReplayBufferStatus.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSReplayBufferStatus.md b/docs/Get-OBSReplayBufferStatus.md index 6022662bd..b33c0a261 100644 --- a/docs/Get-OBSReplayBufferStatus.md +++ b/docs/Get-OBSReplayBufferStatus.md @@ -1,9 +1,17 @@ Get-OBSReplayBufferStatus ------------------------- + + + + ### Synopsis Get-OBSReplayBufferStatus : GetReplayBufferStatus + + --- + + ### Description Gets the status of the replay buffer output. @@ -11,20 +19,32 @@ Gets the status of the replay buffer output. Get-OBSReplayBufferStatus calls the OBS WebSocket with a request of type GetReplayBufferStatus. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getreplaybufferstatus](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getreplaybufferstatus) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSReplayBufferStatus ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSReplayBufferStatus [-PassThru] [] ``` ---- From 4fb766bc6eb33e369613d790790dd4f44af1d2bb Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:42 +0000 Subject: [PATCH 050/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSScene.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSScene.md b/docs/Get-OBSScene.md index cf7af45a9..479c00a86 100644 --- a/docs/Get-OBSScene.md +++ b/docs/Get-OBSScene.md @@ -1,9 +1,17 @@ Get-OBSScene ------------ + + + + ### Synopsis Get-OBSScene : GetSceneList + + --- + + ### Description Gets an array of all scenes in OBS. @@ -11,20 +19,32 @@ Gets an array of all scenes in OBS. Get-OBSScene calls the OBS WebSocket with a request of type GetSceneList. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getscenelist](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getscenelist) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSScene ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSScene [-PassThru] [] ``` ---- From 0fbc50456902d76fbdfa92dcb3b7cb6305c02d9b Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:42 +0000 Subject: [PATCH 051/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSSceneCollection.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSSceneCollection.md b/docs/Get-OBSSceneCollection.md index 5094b8ff8..b42b04c60 100644 --- a/docs/Get-OBSSceneCollection.md +++ b/docs/Get-OBSSceneCollection.md @@ -1,9 +1,17 @@ Get-OBSSceneCollection ---------------------- + + + + ### Synopsis Get-OBSSceneCollection : GetSceneCollectionList + + --- + + ### Description Gets an array of all scene collections @@ -11,20 +19,32 @@ Gets an array of all scene collections Get-OBSSceneCollection calls the OBS WebSocket with a request of type GetSceneCollectionList. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getscenecollectionlist](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getscenecollectionlist) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSSceneCollection ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSSceneCollection [-PassThru] [] ``` ---- From 02d431d6c410e4f074e88fb5ff478a6083d742f7 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:42 +0000 Subject: [PATCH 052/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSSceneItem.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSSceneItem.md b/docs/Get-OBSSceneItem.md index b2aabe93f..39803de09 100644 --- a/docs/Get-OBSSceneItem.md +++ b/docs/Get-OBSSceneItem.md @@ -1,9 +1,17 @@ Get-OBSSceneItem ---------------- + + + + ### Synopsis Get-OBSSceneItem : GetSceneItemList + + --- + + ### Description Gets a list of all scene items in a scene. @@ -13,13 +21,21 @@ Scenes only Get-OBSSceneItem calls the OBS WebSocket with a request of type GetSceneItemList. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemlist](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemlist) + + --- + + ### Parameters #### **SceneName** @@ -36,7 +52,6 @@ Name of the scene to get the items of ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -46,15 +61,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSSceneItem [-SceneName] [-PassThru] [] ``` ---- From 6e54ea45de116c131a0ad27ffebe3cdc1d3cc08a Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:42 +0000 Subject: [PATCH 053/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSSceneItemBlendMode.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Get-OBSSceneItemBlendMode.md b/docs/Get-OBSSceneItemBlendMode.md index 7b489149e..4d78d530a 100644 --- a/docs/Get-OBSSceneItemBlendMode.md +++ b/docs/Get-OBSSceneItemBlendMode.md @@ -1,9 +1,17 @@ Get-OBSSceneItemBlendMode ------------------------- + + + + ### Synopsis Get-OBSSceneItemBlendMode : GetSceneItemBlendMode + + --- + + ### Description Gets the blend mode of a scene item. @@ -23,13 +31,21 @@ Scenes and Groups Get-OBSSceneItemBlendMode calls the OBS WebSocket with a request of type GetSceneItemBlendMode. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemblendmode](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemblendmode) + + --- + + ### Parameters #### **SceneName** @@ -46,7 +62,6 @@ Name of the scene the item is in ---- #### **SceneItemId** Numeric ID of the scene item @@ -62,7 +77,6 @@ Numeric ID of the scene item ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -72,15 +86,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSSceneItemBlendMode [-SceneName] [-SceneItemId] [-PassThru] [] ``` ---- From 1d574ba31745a9911e99130124be828a8fb027b3 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:42 +0000 Subject: [PATCH 054/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSSceneItemEnabled.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Get-OBSSceneItemEnabled.md b/docs/Get-OBSSceneItemEnabled.md index f2cd08831..6323de2c5 100644 --- a/docs/Get-OBSSceneItemEnabled.md +++ b/docs/Get-OBSSceneItemEnabled.md @@ -1,9 +1,17 @@ Get-OBSSceneItemEnabled ----------------------- + + + + ### Synopsis Get-OBSSceneItemEnabled : GetSceneItemEnabled + + --- + + ### Description Gets the enable state of a scene item. @@ -13,13 +21,21 @@ Scenes and Groups Get-OBSSceneItemEnabled calls the OBS WebSocket with a request of type GetSceneItemEnabled. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemenabled](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemenabled) + + --- + + ### Parameters #### **SceneName** @@ -36,7 +52,6 @@ Name of the scene the item is in ---- #### **SceneItemId** Numeric ID of the scene item @@ -52,7 +67,6 @@ Numeric ID of the scene item ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -62,15 +76,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSSceneItemEnabled [-SceneName] [-SceneItemId] [-PassThru] [] ``` ---- From 0e316bdb1b69e5567beb972f7bc95c808c59debf Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:42 +0000 Subject: [PATCH 055/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSSceneItemId.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Get-OBSSceneItemId.md b/docs/Get-OBSSceneItemId.md index 6006b28cb..625dc06e0 100644 --- a/docs/Get-OBSSceneItemId.md +++ b/docs/Get-OBSSceneItemId.md @@ -1,9 +1,17 @@ Get-OBSSceneItemId ------------------ + + + + ### Synopsis Get-OBSSceneItemId : GetSceneItemId + + --- + + ### Description Searches a scene for a source, and returns its id. @@ -13,13 +21,21 @@ Scenes and Groups Get-OBSSceneItemId calls the OBS WebSocket with a request of type GetSceneItemId. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemid](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemid) + + --- + + ### Parameters #### **SceneName** @@ -36,7 +52,6 @@ Name of the scene or group to search in ---- #### **SourceName** Name of the source to find @@ -52,7 +67,6 @@ Name of the source to find ---- #### **SearchOffset** Number of matches to skip during search. >= 0 means first forward. -1 means last (top) item @@ -68,7 +82,6 @@ Number of matches to skip during search. >= 0 means first forward. -1 means last ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -78,15 +91,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSSceneItemId [-SceneName] [-SourceName] [[-SearchOffset] ] [-PassThru] [] ``` ---- From 95870aa21e7615b8939a823ddae68e130f6c0c47 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:42 +0000 Subject: [PATCH 056/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSSceneItemIndex.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Get-OBSSceneItemIndex.md b/docs/Get-OBSSceneItemIndex.md index f5d054720..99ed072cb 100644 --- a/docs/Get-OBSSceneItemIndex.md +++ b/docs/Get-OBSSceneItemIndex.md @@ -1,9 +1,17 @@ Get-OBSSceneItemIndex --------------------- + + + + ### Synopsis Get-OBSSceneItemIndex : GetSceneItemIndex + + --- + + ### Description Gets the index position of a scene item in a scene. @@ -15,13 +23,21 @@ Scenes and Groups Get-OBSSceneItemIndex calls the OBS WebSocket with a request of type GetSceneItemIndex. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemindex](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemindex) + + --- + + ### Parameters #### **SceneName** @@ -38,7 +54,6 @@ Name of the scene the item is in ---- #### **SceneItemId** Numeric ID of the scene item @@ -54,7 +69,6 @@ Numeric ID of the scene item ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -64,15 +78,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSSceneItemIndex [-SceneName] [-SceneItemId] [-PassThru] [] ``` ---- From 3f0b9a7aec5b628e4683a85528f4925c755ddb14 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:42 +0000 Subject: [PATCH 057/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSSceneItemLocked.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Get-OBSSceneItemLocked.md b/docs/Get-OBSSceneItemLocked.md index 8a41b5172..73704856e 100644 --- a/docs/Get-OBSSceneItemLocked.md +++ b/docs/Get-OBSSceneItemLocked.md @@ -1,9 +1,17 @@ Get-OBSSceneItemLocked ---------------------- + + + + ### Synopsis Get-OBSSceneItemLocked : GetSceneItemLocked + + --- + + ### Description Gets the lock state of a scene item. @@ -13,13 +21,21 @@ Scenes and Groups Get-OBSSceneItemLocked calls the OBS WebSocket with a request of type GetSceneItemLocked. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemlocked](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemlocked) + + --- + + ### Parameters #### **SceneName** @@ -36,7 +52,6 @@ Name of the scene the item is in ---- #### **SceneItemId** Numeric ID of the scene item @@ -52,7 +67,6 @@ Numeric ID of the scene item ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -62,15 +76,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSSceneItemLocked [-SceneName] [-SceneItemId] [-PassThru] [] ``` ---- From 85412561a0d74537a69a015674232b7cde1eeb3d Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:43 +0000 Subject: [PATCH 058/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSSceneItemTransform.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Get-OBSSceneItemTransform.md b/docs/Get-OBSSceneItemTransform.md index 6d84861de..128282094 100644 --- a/docs/Get-OBSSceneItemTransform.md +++ b/docs/Get-OBSSceneItemTransform.md @@ -1,9 +1,17 @@ Get-OBSSceneItemTransform ------------------------- + + + + ### Synopsis Get-OBSSceneItemTransform : GetSceneItemTransform + + --- + + ### Description Gets the transform and crop info of a scene item. @@ -13,13 +21,21 @@ Scenes and Groups Get-OBSSceneItemTransform calls the OBS WebSocket with a request of type GetSceneItemTransform. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemtransform](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsceneitemtransform) + + --- + + ### Parameters #### **SceneName** @@ -36,7 +52,6 @@ Name of the scene the item is in ---- #### **SceneItemId** Numeric ID of the scene item @@ -52,7 +67,6 @@ Numeric ID of the scene item ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -62,15 +76,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSSceneItemTransform [-SceneName] [-SceneItemId] [-PassThru] [] ``` ---- From a53a9b7a53ba3f2a097d8d21ebdb7183cb05ae9c Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:43 +0000 Subject: [PATCH 059/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSSceneSceneTransitionOverride.md | 28 +++++++++++++++++---- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSSceneSceneTransitionOverride.md b/docs/Get-OBSSceneSceneTransitionOverride.md index 5d13bea4e..10e540dc3 100644 --- a/docs/Get-OBSSceneSceneTransitionOverride.md +++ b/docs/Get-OBSSceneSceneTransitionOverride.md @@ -1,9 +1,17 @@ Get-OBSSceneSceneTransitionOverride ----------------------------------- + + + + ### Synopsis Get-OBSSceneSceneTransitionOverride : GetSceneSceneTransitionOverride + + --- + + ### Description Gets the scene transition overridden for a scene. @@ -11,13 +19,21 @@ Gets the scene transition overridden for a scene. Get-OBSSceneSceneTransitionOverride calls the OBS WebSocket with a request of type GetSceneSceneTransitionOverride. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getscenescenetransitionoverride](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getscenescenetransitionoverride) + + --- + + ### Parameters #### **SceneName** @@ -34,7 +50,6 @@ Name of the scene ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSSceneSceneTransitionOverride [-SceneName] [-PassThru] [] ``` ---- From 753a3974c21d65fc581647a42156e736b912d2b8 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:43 +0000 Subject: [PATCH 060/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSSceneTransition.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSSceneTransition.md b/docs/Get-OBSSceneTransition.md index 5c1035bcc..e79309ee7 100644 --- a/docs/Get-OBSSceneTransition.md +++ b/docs/Get-OBSSceneTransition.md @@ -1,9 +1,17 @@ Get-OBSSceneTransition ---------------------- + + + + ### Synopsis Get-OBSSceneTransition : GetSceneTransitionList + + --- + + ### Description Gets an array of all scene transitions in OBS. @@ -11,20 +19,32 @@ Gets an array of all scene transitions in OBS. Get-OBSSceneTransition calls the OBS WebSocket with a request of type GetSceneTransitionList. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getscenetransitionlist](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getscenetransitionlist) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSSceneTransition ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSSceneTransition [-PassThru] [] ``` ---- From 781f2dd5782f1acd46d86eafe90a7a5e8fc2f01f Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:43 +0000 Subject: [PATCH 061/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSSourceActive.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSSourceActive.md b/docs/Get-OBSSourceActive.md index 54692114e..3af20cdd6 100644 --- a/docs/Get-OBSSourceActive.md +++ b/docs/Get-OBSSourceActive.md @@ -1,9 +1,17 @@ Get-OBSSourceActive ------------------- + + + + ### Synopsis Get-OBSSourceActive : GetSourceActive + + --- + + ### Description Gets the active and show state of a source. @@ -13,13 +21,21 @@ Gets the active and show state of a source. Get-OBSSourceActive calls the OBS WebSocket with a request of type GetSourceActive. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsourceactive](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsourceactive) + + --- + + ### Parameters #### **SourceName** @@ -36,7 +52,6 @@ Name of the source to get the active state of ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -46,15 +61,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSSourceActive [-SourceName] [-PassThru] [] ``` ---- From 5e8bc3d0271c133cc8cc55020871953960263330 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:43 +0000 Subject: [PATCH 062/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSSourceFilter.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Get-OBSSourceFilter.md b/docs/Get-OBSSourceFilter.md index 4e5e69d21..58bcb056c 100644 --- a/docs/Get-OBSSourceFilter.md +++ b/docs/Get-OBSSourceFilter.md @@ -1,9 +1,17 @@ Get-OBSSourceFilter ------------------- + + + + ### Synopsis Get-OBSSourceFilter : GetSourceFilter + + --- + + ### Description Gets the info for a specific source filter. @@ -11,13 +19,21 @@ Gets the info for a specific source filter. Get-OBSSourceFilter calls the OBS WebSocket with a request of type GetSourceFilter. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsourcefilter](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsourcefilter) + + --- + + ### Parameters #### **SourceName** @@ -34,7 +50,6 @@ Name of the source ---- #### **FilterName** Name of the filter @@ -50,7 +65,6 @@ Name of the filter ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -60,15 +74,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSSourceFilter [-SourceName] [-FilterName] [-PassThru] [] ``` ---- From 61d07dc51131fa83c860bc60ab729cdfb7672ae5 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:43 +0000 Subject: [PATCH 063/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSSourceFilterDefaultSettings.md | 28 ++++++++++++++++++---- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSSourceFilterDefaultSettings.md b/docs/Get-OBSSourceFilterDefaultSettings.md index c9eb34a5a..a9d282103 100644 --- a/docs/Get-OBSSourceFilterDefaultSettings.md +++ b/docs/Get-OBSSourceFilterDefaultSettings.md @@ -1,9 +1,17 @@ Get-OBSSourceFilterDefaultSettings ---------------------------------- + + + + ### Synopsis Get-OBSSourceFilterDefaultSettings : GetSourceFilterDefaultSettings + + --- + + ### Description Gets the default settings for a filter kind. @@ -11,13 +19,21 @@ Gets the default settings for a filter kind. Get-OBSSourceFilterDefaultSettings calls the OBS WebSocket with a request of type GetSourceFilterDefaultSettings. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsourcefilterdefaultsettings](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsourcefilterdefaultsettings) + + --- + + ### Parameters #### **FilterKind** @@ -34,7 +50,6 @@ Filter kind to get the default settings for ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSSourceFilterDefaultSettings [-FilterKind] [-PassThru] [] ``` ---- From 417729f1bdcc664ad0ffaa31c3354b9435274716 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:43 +0000 Subject: [PATCH 064/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSSourceFilterList.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Get-OBSSourceFilterList.md b/docs/Get-OBSSourceFilterList.md index 29288e1c9..d14e9f9ae 100644 --- a/docs/Get-OBSSourceFilterList.md +++ b/docs/Get-OBSSourceFilterList.md @@ -1,9 +1,17 @@ Get-OBSSourceFilterList ----------------------- + + + + ### Synopsis Get-OBSSourceFilterList : GetSourceFilterList + + --- + + ### Description Gets an array of all of a source's filters. @@ -11,13 +19,21 @@ Gets an array of all of a source's filters. Get-OBSSourceFilterList calls the OBS WebSocket with a request of type GetSourceFilterList. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsourcefilterlist](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsourcefilterlist) + + --- + + ### Parameters #### **SourceName** @@ -34,7 +50,6 @@ Name of the source ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSSourceFilterList [-SourceName] [-PassThru] [] ``` ---- From 78ac9c144e47c494007987806df8f3678cccaf7f Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:43 +0000 Subject: [PATCH 065/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSSourceScreenshot.md | 32 +++++++++++++++++++++++--------- 1 file changed, 23 insertions(+), 9 deletions(-) diff --git a/docs/Get-OBSSourceScreenshot.md b/docs/Get-OBSSourceScreenshot.md index aca73d62f..f31535f44 100644 --- a/docs/Get-OBSSourceScreenshot.md +++ b/docs/Get-OBSSourceScreenshot.md @@ -1,9 +1,17 @@ Get-OBSSourceScreenshot ----------------------- + + + + ### Synopsis Get-OBSSourceScreenshot : GetSourceScreenshot + + --- + + ### Description Gets a Base64-encoded screenshot of a source. @@ -16,13 +24,21 @@ If `imageWidth` and `imageHeight` are not specified, the compressed image will u Get-OBSSourceScreenshot calls the OBS WebSocket with a request of type GetSourceScreenshot. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsourcescreenshot](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsourcescreenshot) + + --- + + ### Parameters #### **SourceName** @@ -39,7 +55,6 @@ Name of the source to take a screenshot of ---- #### **ImageFormat** Image compression format to use. Use `GetVersion` to get compatible image formats @@ -55,7 +70,6 @@ Image compression format to use. Use `GetVersion` to get compatible image format ---- #### **ImageWidth** Width to scale the screenshot to @@ -71,7 +85,6 @@ Width to scale the screenshot to ---- #### **ImageHeight** Height to scale the screenshot to @@ -87,7 +100,6 @@ Height to scale the screenshot to ---- #### **ImageCompressionQuality** Compression quality to use. 0 for high compression, 100 for uncompressed. -1 to use "default" (whatever that means, idk) @@ -103,7 +115,6 @@ Compression quality to use. 0 for high compression, 100 for uncompressed. -1 to ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -113,15 +124,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSSourceScreenshot [-SourceName] [-ImageFormat] [[-ImageWidth] ] [[-ImageHeight] ] [[-ImageCompressionQuality] ] [-PassThru] [] ``` ---- From c0257a39523ae4330123422e98137819d7858e39 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:43 +0000 Subject: [PATCH 066/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSSpecialInputs.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSSpecialInputs.md b/docs/Get-OBSSpecialInputs.md index 777cd77e0..d8654d66b 100644 --- a/docs/Get-OBSSpecialInputs.md +++ b/docs/Get-OBSSpecialInputs.md @@ -1,9 +1,17 @@ Get-OBSSpecialInputs -------------------- + + + + ### Synopsis Get-OBSSpecialInputs : GetSpecialInputs + + --- + + ### Description Gets the names of all special inputs. @@ -11,20 +19,32 @@ Gets the names of all special inputs. Get-OBSSpecialInputs calls the OBS WebSocket with a request of type GetSpecialInputs. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getspecialinputs](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getspecialinputs) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSSpecialInputs ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSSpecialInputs [-PassThru] [] ``` ---- From 8d12e300c9f6021f277f8dd93ac73aae1c7d5a61 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:43 +0000 Subject: [PATCH 067/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSStats.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSStats.md b/docs/Get-OBSStats.md index bdfc86328..ded31aee4 100644 --- a/docs/Get-OBSStats.md +++ b/docs/Get-OBSStats.md @@ -1,9 +1,17 @@ Get-OBSStats ------------ + + + + ### Synopsis Get-OBSStats : GetStats + + --- + + ### Description Gets statistics about OBS, obs-websocket, and the current session. @@ -11,20 +19,32 @@ Gets statistics about OBS, obs-websocket, and the current session. Get-OBSStats calls the OBS WebSocket with a request of type GetStats. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getstats](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getstats) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSStats ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSStats [-PassThru] [] ``` ---- From bc3cd7eecd6247d475290ef89093873b1743a97a Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:44 +0000 Subject: [PATCH 068/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSStreamServiceSettings.md | 31 ++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSStreamServiceSettings.md b/docs/Get-OBSStreamServiceSettings.md index d9779c0b8..edadb5f6c 100644 --- a/docs/Get-OBSStreamServiceSettings.md +++ b/docs/Get-OBSStreamServiceSettings.md @@ -1,9 +1,17 @@ Get-OBSStreamServiceSettings ---------------------------- + + + + ### Synopsis Get-OBSStreamServiceSettings : GetStreamServiceSettings + + --- + + ### Description Gets the current stream service settings (stream destination). @@ -11,20 +19,32 @@ Gets the current stream service settings (stream destination). Get-OBSStreamServiceSettings calls the OBS WebSocket with a request of type GetStreamServiceSettings. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getstreamservicesettings](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getstreamservicesettings) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSStreamServiceSettings ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSStreamServiceSettings [-PassThru] [] ``` ---- From 3339a2e98dbc08faf536740b9c347b4952fdde17 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:44 +0000 Subject: [PATCH 069/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSStreamStatus.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSStreamStatus.md b/docs/Get-OBSStreamStatus.md index e581a547b..1119d3017 100644 --- a/docs/Get-OBSStreamStatus.md +++ b/docs/Get-OBSStreamStatus.md @@ -1,9 +1,17 @@ Get-OBSStreamStatus ------------------- + + + + ### Synopsis Get-OBSStreamStatus : GetStreamStatus + + --- + + ### Description Gets the status of the stream output. @@ -11,20 +19,32 @@ Gets the status of the stream output. Get-OBSStreamStatus calls the OBS WebSocket with a request of type GetStreamStatus. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getstreamstatus](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getstreamstatus) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSStreamStatus ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSStreamStatus [-PassThru] [] ``` ---- From 349dfa19566c1459fe2335ec5184e765962dcb31 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:44 +0000 Subject: [PATCH 070/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSStudioModeEnabled.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSStudioModeEnabled.md b/docs/Get-OBSStudioModeEnabled.md index 7378dc1c1..fec24b9a2 100644 --- a/docs/Get-OBSStudioModeEnabled.md +++ b/docs/Get-OBSStudioModeEnabled.md @@ -1,9 +1,17 @@ Get-OBSStudioModeEnabled ------------------------ + + + + ### Synopsis Get-OBSStudioModeEnabled : GetStudioModeEnabled + + --- + + ### Description Gets whether studio is enabled. @@ -11,20 +19,32 @@ Gets whether studio is enabled. Get-OBSStudioModeEnabled calls the OBS WebSocket with a request of type GetStudioModeEnabled. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getstudiomodeenabled](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getstudiomodeenabled) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSStudioModeEnabled ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSStudioModeEnabled [-PassThru] [] ``` ---- From 755b4c42adbce6ce6065e157f16498b1179bb2a0 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:44 +0000 Subject: [PATCH 071/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSTransitionKind.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSTransitionKind.md b/docs/Get-OBSTransitionKind.md index 2de809085..66050f2fb 100644 --- a/docs/Get-OBSTransitionKind.md +++ b/docs/Get-OBSTransitionKind.md @@ -1,9 +1,17 @@ Get-OBSTransitionKind --------------------- + + + + ### Synopsis Get-OBSTransitionKind : GetTransitionKindList + + --- + + ### Description Gets an array of all available transition kinds. @@ -13,20 +21,32 @@ Similar to `GetInputKindList` Get-OBSTransitionKind calls the OBS WebSocket with a request of type GetTransitionKindList. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#gettransitionkindlist](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#gettransitionkindlist) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSTransitionKind ``` + + --- + + ### Parameters #### **PassThru** @@ -37,15 +57,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSTransitionKind [-PassThru] [] ``` ---- From 38c6c463638ae6f464c1b8ad39e73edf7653b6a9 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:44 +0000 Subject: [PATCH 072/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSVersion.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSVersion.md b/docs/Get-OBSVersion.md index 39473f321..9d91e5b41 100644 --- a/docs/Get-OBSVersion.md +++ b/docs/Get-OBSVersion.md @@ -1,9 +1,17 @@ Get-OBSVersion -------------- + + + + ### Synopsis Get-OBSVersion : GetVersion + + --- + + ### Description Gets data about the current plugin and RPC version. @@ -11,20 +19,32 @@ Gets data about the current plugin and RPC version. Get-OBSVersion calls the OBS WebSocket with a request of type GetVersion. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getversion](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getversion) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSVersion ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSVersion [-PassThru] [] ``` ---- From 54670a127b2b4ae47d663b1b0aea368bbc7020df Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:44 +0000 Subject: [PATCH 073/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSVideoSettings.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSVideoSettings.md b/docs/Get-OBSVideoSettings.md index 98b885c7d..60c86e112 100644 --- a/docs/Get-OBSVideoSettings.md +++ b/docs/Get-OBSVideoSettings.md @@ -1,9 +1,17 @@ Get-OBSVideoSettings -------------------- + + + + ### Synopsis Get-OBSVideoSettings : GetVideoSettings + + --- + + ### Description Gets the current video settings. @@ -13,20 +21,32 @@ Note: To get the true FPS value, divide the FPS numerator by the FPS denominator Get-OBSVideoSettings calls the OBS WebSocket with a request of type GetVideoSettings. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getvideosettings](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getvideosettings) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSVideoSettings ``` + + --- + + ### Parameters #### **PassThru** @@ -37,15 +57,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSVideoSettings [-PassThru] [] ``` ---- From a1066743129fbd4686ddbb5da62dad20acc0c7d9 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:44 +0000 Subject: [PATCH 074/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Get-OBSVirtualCamStatus.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Get-OBSVirtualCamStatus.md b/docs/Get-OBSVirtualCamStatus.md index 6f55f25e4..6ee15d04b 100644 --- a/docs/Get-OBSVirtualCamStatus.md +++ b/docs/Get-OBSVirtualCamStatus.md @@ -1,9 +1,17 @@ Get-OBSVirtualCamStatus ----------------------- + + + + ### Synopsis Get-OBSVirtualCamStatus : GetVirtualCamStatus + + --- + + ### Description Gets the status of the virtualcam output. @@ -11,20 +19,32 @@ Gets the status of the virtualcam output. Get-OBSVirtualCamStatus calls the OBS WebSocket with a request of type GetVirtualCamStatus. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getvirtualcamstatus](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getvirtualcamstatus) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Get-OBSVirtualCamStatus ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Get-OBSVirtualCamStatus [-PassThru] [] ``` ---- From bf175279f260432b8c70e541513c38456302ab73 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:44 +0000 Subject: [PATCH 075/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Open-OBSInputFiltersDialog.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Open-OBSInputFiltersDialog.md b/docs/Open-OBSInputFiltersDialog.md index 4e0d30352..1420d2e00 100644 --- a/docs/Open-OBSInputFiltersDialog.md +++ b/docs/Open-OBSInputFiltersDialog.md @@ -1,9 +1,17 @@ Open-OBSInputFiltersDialog -------------------------- + + + + ### Synopsis Open-OBSInputFiltersDialog : OpenInputFiltersDialog + + --- + + ### Description Opens the filters dialog of an input. @@ -11,13 +19,21 @@ Opens the filters dialog of an input. Open-OBSInputFiltersDialog calls the OBS WebSocket with a request of type OpenInputFiltersDialog. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#openinputfiltersdialog](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#openinputfiltersdialog) + + --- + + ### Parameters #### **InputName** @@ -34,7 +50,6 @@ Name of the input to open the dialog of ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Open-OBSInputFiltersDialog [-InputName] [-PassThru] [] ``` ---- From 3e968b7b93f9ae8ea5a8639e9b497daa742db610 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:44 +0000 Subject: [PATCH 076/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Open-OBSInputInteractDialog.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Open-OBSInputInteractDialog.md b/docs/Open-OBSInputInteractDialog.md index b99ed4e91..14aed9259 100644 --- a/docs/Open-OBSInputInteractDialog.md +++ b/docs/Open-OBSInputInteractDialog.md @@ -1,9 +1,17 @@ Open-OBSInputInteractDialog --------------------------- + + + + ### Synopsis Open-OBSInputInteractDialog : OpenInputInteractDialog + + --- + + ### Description Opens the interact dialog of an input. @@ -11,13 +19,21 @@ Opens the interact dialog of an input. Open-OBSInputInteractDialog calls the OBS WebSocket with a request of type OpenInputInteractDialog. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#openinputinteractdialog](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#openinputinteractdialog) + + --- + + ### Parameters #### **InputName** @@ -34,7 +50,6 @@ Name of the input to open the dialog of ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Open-OBSInputInteractDialog [-InputName] [-PassThru] [] ``` ---- From 71f4a0156c2fd23d6a488ee29cb347e0f5108738 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:45 +0000 Subject: [PATCH 077/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Open-OBSInputPropertiesDialog.md | 28 ++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Open-OBSInputPropertiesDialog.md b/docs/Open-OBSInputPropertiesDialog.md index dbf88570a..7f8cfe5ed 100644 --- a/docs/Open-OBSInputPropertiesDialog.md +++ b/docs/Open-OBSInputPropertiesDialog.md @@ -1,9 +1,17 @@ Open-OBSInputPropertiesDialog ----------------------------- + + + + ### Synopsis Open-OBSInputPropertiesDialog : OpenInputPropertiesDialog + + --- + + ### Description Opens the properties dialog of an input. @@ -11,13 +19,21 @@ Opens the properties dialog of an input. Open-OBSInputPropertiesDialog calls the OBS WebSocket with a request of type OpenInputPropertiesDialog. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#openinputpropertiesdialog](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#openinputpropertiesdialog) + + --- + + ### Parameters #### **InputName** @@ -34,7 +50,6 @@ Name of the input to open the dialog of ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Open-OBSInputPropertiesDialog [-InputName] [-PassThru] [] ``` ---- From a7256b4a4ca700b4426a56fb163d93905742713b Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:45 +0000 Subject: [PATCH 078/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Open-OBSSourceProjector.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Open-OBSSourceProjector.md b/docs/Open-OBSSourceProjector.md index 26b5acea9..05a82c9d6 100644 --- a/docs/Open-OBSSourceProjector.md +++ b/docs/Open-OBSSourceProjector.md @@ -1,9 +1,17 @@ Open-OBSSourceProjector ----------------------- + + + + ### Synopsis Open-OBSSourceProjector : OpenSourceProjector + + --- + + ### Description Opens a projector for a source. @@ -13,13 +21,21 @@ Note: This request serves to provide feature parity with 4.x. It is very likely Open-OBSSourceProjector calls the OBS WebSocket with a request of type OpenSourceProjector. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#opensourceprojector](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#opensourceprojector) + + --- + + ### Parameters #### **SourceName** @@ -36,7 +52,6 @@ Name of the source to open a projector for ---- #### **MonitorIndex** Monitor index, use `GetMonitorList` to obtain index @@ -52,7 +67,6 @@ Monitor index, use `GetMonitorList` to obtain index ---- #### **ProjectorGeometry** Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with `monitorIndex` @@ -68,7 +82,6 @@ Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutual ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -78,15 +91,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Open-OBSSourceProjector [-SourceName] [[-MonitorIndex] ] [[-ProjectorGeometry] ] [-PassThru] [] ``` ---- From f38f4de30ed9c3c66a997dd631a9594944176094 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:45 +0000 Subject: [PATCH 079/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Open-OBSVideoMixProjector.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Open-OBSVideoMixProjector.md b/docs/Open-OBSVideoMixProjector.md index 28f7c4e22..2abb9d8bf 100644 --- a/docs/Open-OBSVideoMixProjector.md +++ b/docs/Open-OBSVideoMixProjector.md @@ -1,9 +1,17 @@ Open-OBSVideoMixProjector ------------------------- + + + + ### Synopsis Open-OBSVideoMixProjector : OpenVideoMixProjector + + --- + + ### Description Opens a projector for a specific output video mix. @@ -19,13 +27,21 @@ Note: This request serves to provide feature parity with 4.x. It is very likely Open-OBSVideoMixProjector calls the OBS WebSocket with a request of type OpenVideoMixProjector. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#openvideomixprojector](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#openvideomixprojector) + + --- + + ### Parameters #### **VideoMixType** @@ -42,7 +58,6 @@ Type of mix to open ---- #### **MonitorIndex** Monitor index, use `GetMonitorList` to obtain index @@ -58,7 +73,6 @@ Monitor index, use `GetMonitorList` to obtain index ---- #### **ProjectorGeometry** Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with `monitorIndex` @@ -74,7 +88,6 @@ Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutual ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -84,15 +97,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Open-OBSVideoMixProjector [-VideoMixType] [[-MonitorIndex] ] [[-ProjectorGeometry] ] [-PassThru] [] ``` ---- From 06aa7fd3ca5abacc39052844442779df05080409 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:45 +0000 Subject: [PATCH 080/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Receive-OBS.md | 39 +++++++++++++++++++++++++-------------- 1 file changed, 25 insertions(+), 14 deletions(-) diff --git a/docs/Receive-OBS.md b/docs/Receive-OBS.md index 2eea2e09f..a760059aa 100644 --- a/docs/Receive-OBS.md +++ b/docs/Receive-OBS.md @@ -1,14 +1,26 @@ Receive-OBS ----------- + + + + ### Synopsis Receives data from OBS + + --- + + ### Description Receives responses from the OBS WebSocket + + --- + + ### Parameters #### **MessageData** @@ -25,7 +37,6 @@ The message data that has been received ---- #### **WaitForReponse** If set will wait for a response from the message and expand the results. @@ -41,7 +52,6 @@ If set will wait for a response from the message and expand the results. ---- #### **SendEvent** If set, will responsd to known events, like 'hello', and resend other events as PowerShell events @@ -51,13 +61,12 @@ If set, will responsd to known events, like 'hello', and resend other events as -|Type |Required|Position|PipelineInput| -|----------|--------|--------|-------------| -|`[Switch]`|false |named |false | +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[Switch]`|false |named |false |Resend | ---- #### **WebSocketURI** The OBS websocket URL. If not provided, this will default to loopback on port 4455. @@ -67,13 +76,12 @@ The OBS websocket URL. If not provided, this will default to loopback on port 4 -|Type |Required|Position|PipelineInput| -|-------|--------|--------|-------------| -|`[Uri]`|true |named |false | +|Type |Required|Position|PipelineInput|Aliases | +|-------|--------|--------|-------------|------------| +|`[Uri]`|true |named |false |WebSocketURL| ---- #### **WebSocketToken** A randomly generated password used to connect to OBS. @@ -84,13 +92,17 @@ You can see the websocket password in Tools -> obs-websocket settings -> show co -|Type |Required|Position|PipelineInput| -|----------|--------|--------|-------------| -|`[String]`|true |named |false | +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|-----------------| +|`[String]`|true |named |false |WebSocketPassword| + + --- + + ### Syntax ```PowerShell Receive-OBS [-MessageData ] [-WaitForReponse] [] @@ -98,4 +110,3 @@ Receive-OBS [-MessageData ] [-WaitForReponse] [] ```PowerShell Receive-OBS [-MessageData ] [-SendEvent] -WebSocketURI -WebSocketToken [] ``` ---- From 84b6b561683126a339ac300e1f501d839253a887 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:45 +0000 Subject: [PATCH 081/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Remove-OBSInput.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Remove-OBSInput.md b/docs/Remove-OBSInput.md index 829083698..6dd08820f 100644 --- a/docs/Remove-OBSInput.md +++ b/docs/Remove-OBSInput.md @@ -1,9 +1,17 @@ Remove-OBSInput --------------- + + + + ### Synopsis Remove-OBSInput : RemoveInput + + --- + + ### Description Removes an existing input. @@ -13,13 +21,21 @@ Note: Will immediately remove all associated scene items. Remove-OBSInput calls the OBS WebSocket with a request of type RemoveInput. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#removeinput](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#removeinput) + + --- + + ### Parameters #### **InputName** @@ -36,7 +52,6 @@ Name of the input to remove ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -46,15 +61,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Remove-OBSInput [-InputName] [-PassThru] [] ``` ---- From e47017be080b623d1f980f51b89a73e2a1106081 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:45 +0000 Subject: [PATCH 082/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Remove-OBSProfile.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Remove-OBSProfile.md b/docs/Remove-OBSProfile.md index 5deed5907..2ae27de9b 100644 --- a/docs/Remove-OBSProfile.md +++ b/docs/Remove-OBSProfile.md @@ -1,9 +1,17 @@ Remove-OBSProfile ----------------- + + + + ### Synopsis Remove-OBSProfile : RemoveProfile + + --- + + ### Description Removes a profile. If the current profile is chosen, it will change to a different profile first. @@ -11,13 +19,21 @@ Removes a profile. If the current profile is chosen, it will change to a differe Remove-OBSProfile calls the OBS WebSocket with a request of type RemoveProfile. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#removeprofile](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#removeprofile) + + --- + + ### Parameters #### **ProfileName** @@ -34,7 +50,6 @@ Name of the profile to remove ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Remove-OBSProfile [-ProfileName] [-PassThru] [] ``` ---- From d406c5eb45ba658bf2b273d8433a5ac9926cede3 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:45 +0000 Subject: [PATCH 083/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Remove-OBSScene.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Remove-OBSScene.md b/docs/Remove-OBSScene.md index 30d31c1e8..d2e679a7b 100644 --- a/docs/Remove-OBSScene.md +++ b/docs/Remove-OBSScene.md @@ -1,9 +1,17 @@ Remove-OBSScene --------------- + + + + ### Synopsis Remove-OBSScene : RemoveScene + + --- + + ### Description Removes a scene from OBS. @@ -11,13 +19,21 @@ Removes a scene from OBS. Remove-OBSScene calls the OBS WebSocket with a request of type RemoveScene. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#removescene](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#removescene) + + --- + + ### Parameters #### **SceneName** @@ -34,7 +50,6 @@ Name of the scene to remove ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Remove-OBSScene [-SceneName] [-PassThru] [] ``` ---- From 071d49b48cbb5e9ee4dce070844a28ba160756be Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:45 +0000 Subject: [PATCH 084/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Remove-OBSSceneItem.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Remove-OBSSceneItem.md b/docs/Remove-OBSSceneItem.md index 679f101ab..6b87499cc 100644 --- a/docs/Remove-OBSSceneItem.md +++ b/docs/Remove-OBSSceneItem.md @@ -1,9 +1,17 @@ Remove-OBSSceneItem ------------------- + + + + ### Synopsis Remove-OBSSceneItem : RemoveSceneItem + + --- + + ### Description Removes a scene item from a scene. @@ -13,13 +21,21 @@ Scenes only Remove-OBSSceneItem calls the OBS WebSocket with a request of type RemoveSceneItem. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#removesceneitem](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#removesceneitem) + + --- + + ### Parameters #### **SceneName** @@ -36,7 +52,6 @@ Name of the scene the item is in ---- #### **SceneItemId** Numeric ID of the scene item @@ -52,7 +67,6 @@ Numeric ID of the scene item ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -62,15 +76,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Remove-OBSSceneItem [-SceneName] [-SceneItemId] [-PassThru] [] ``` ---- From 82b042635c16a01b2d4eeb7434758a09654e1c33 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:45 +0000 Subject: [PATCH 085/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Remove-OBSSourceFilter.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Remove-OBSSourceFilter.md b/docs/Remove-OBSSourceFilter.md index 472b198b4..2b729b6d5 100644 --- a/docs/Remove-OBSSourceFilter.md +++ b/docs/Remove-OBSSourceFilter.md @@ -1,9 +1,17 @@ Remove-OBSSourceFilter ---------------------- + + + + ### Synopsis Remove-OBSSourceFilter : RemoveSourceFilter + + --- + + ### Description Removes a filter from a source. @@ -11,13 +19,21 @@ Removes a filter from a source. Remove-OBSSourceFilter calls the OBS WebSocket with a request of type RemoveSourceFilter. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#removesourcefilter](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#removesourcefilter) + + --- + + ### Parameters #### **SourceName** @@ -34,7 +50,6 @@ Name of the source the filter is on ---- #### **FilterName** Name of the filter to remove @@ -50,7 +65,6 @@ Name of the filter to remove ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -60,15 +74,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Remove-OBSSourceFilter [-SourceName] [-FilterName] [-PassThru] [] ``` ---- From 069beabf430dfb63c3cc2160803105c82e735d3f Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:46 +0000 Subject: [PATCH 086/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Resume-OBSRecord.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Resume-OBSRecord.md b/docs/Resume-OBSRecord.md index ff3c9dc9a..d9fce0ba0 100644 --- a/docs/Resume-OBSRecord.md +++ b/docs/Resume-OBSRecord.md @@ -1,9 +1,17 @@ Resume-OBSRecord ---------------- + + + + ### Synopsis Resume-OBSRecord : ResumeRecord + + --- + + ### Description Resumes the record output. @@ -11,20 +19,32 @@ Resumes the record output. Resume-OBSRecord calls the OBS WebSocket with a request of type ResumeRecord. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#resumerecord](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#resumerecord) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Resume-OBSRecord ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Resume-OBSRecord [-PassThru] [] ``` ---- From 5240217ae178d8003a032d5f386e969eba889002 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:46 +0000 Subject: [PATCH 087/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Save-OBSReplayBuffer.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Save-OBSReplayBuffer.md b/docs/Save-OBSReplayBuffer.md index d037ed8bf..bbbcf7b81 100644 --- a/docs/Save-OBSReplayBuffer.md +++ b/docs/Save-OBSReplayBuffer.md @@ -1,9 +1,17 @@ Save-OBSReplayBuffer -------------------- + + + + ### Synopsis Save-OBSReplayBuffer : SaveReplayBuffer + + --- + + ### Description Saves the contents of the replay buffer output. @@ -11,20 +19,32 @@ Saves the contents of the replay buffer output. Save-OBSReplayBuffer calls the OBS WebSocket with a request of type SaveReplayBuffer. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#savereplaybuffer](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#savereplaybuffer) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Save-OBSReplayBuffer ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Save-OBSReplayBuffer [-PassThru] [] ``` ---- From 66ef5709c76b2533101c1c06df3215ad3cec91a0 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:46 +0000 Subject: [PATCH 088/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Save-OBSSourceScreenshot.md | 33 ++++++++++++++++++++++---------- 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/docs/Save-OBSSourceScreenshot.md b/docs/Save-OBSSourceScreenshot.md index aa5a47819..4d65d3b5f 100644 --- a/docs/Save-OBSSourceScreenshot.md +++ b/docs/Save-OBSSourceScreenshot.md @@ -1,9 +1,17 @@ Save-OBSSourceScreenshot ------------------------ + + + + ### Synopsis Save-OBSSourceScreenshot : SaveSourceScreenshot + + --- + + ### Description Saves a screenshot of a source to the filesystem. @@ -16,13 +24,21 @@ If `imageWidth` and `imageHeight` are not specified, the compressed image will u Save-OBSSourceScreenshot calls the OBS WebSocket with a request of type SaveSourceScreenshot. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#savesourcescreenshot](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#savesourcescreenshot) + + --- + + ### Parameters #### **SourceName** @@ -39,7 +55,6 @@ Name of the source to take a screenshot of ---- #### **ImageFormat** Image compression format to use. Use `GetVersion` to get compatible image formats @@ -55,7 +70,6 @@ Image compression format to use. Use `GetVersion` to get compatible image format ---- #### **ImageFilePath** Path to save the screenshot file to. Eg. `C:\Users\user\Desktop\screenshot.png` @@ -71,7 +85,6 @@ Path to save the screenshot file to. Eg. `C:\Users\user\Desktop\screenshot.png` ---- #### **ImageWidth** Width to scale the screenshot to @@ -87,7 +100,6 @@ Width to scale the screenshot to ---- #### **ImageHeight** Height to scale the screenshot to @@ -103,7 +115,6 @@ Height to scale the screenshot to ---- #### **ImageCompressionQuality** Compression quality to use. 0 for high compression, 100 for uncompressed. -1 to use "default" (whatever that means, idk) @@ -119,7 +130,6 @@ Compression quality to use. 0 for high compression, 100 for uncompressed. -1 to ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -129,15 +139,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Save-OBSSourceScreenshot [-SourceName] [-ImageFormat] [-ImageFilePath] [[-ImageWidth] ] [[-ImageHeight] ] [[-ImageCompressionQuality] ] [-PassThru] [] ``` ---- From 03695c637a4a75ae723c2b7ed81aa02158c2a43f Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:46 +0000 Subject: [PATCH 089/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Send-OBS.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Send-OBS.md b/docs/Send-OBS.md index f454e6b67..5b46cd7bf 100644 --- a/docs/Send-OBS.md +++ b/docs/Send-OBS.md @@ -1,14 +1,26 @@ Send-OBS -------- + + + + ### Synopsis Sends messages to the OBS websocket. + + --- + + ### Description Sends one or more messages to the OBS websocket. + + --- + + ### Related Links * [Receive-OBS](Receive-OBS.md) @@ -18,7 +30,11 @@ Sends one or more messages to the OBS websocket. + + --- + + ### Parameters #### **MessageData** @@ -29,13 +45,12 @@ The data to send to the obs websocket. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|------------------------------| -|`[Object]`|false |1 |true (ByValue, ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|------------------------------|-------| +|`[Object]`|false |1 |true (ByValue, ByPropertyName)|Payload| ---- #### **StepTime** If provided, will sleep after each step. @@ -53,7 +68,6 @@ If -SerialFrame was provied, -StepTime will be the number of frames to wait. ---- #### **Parallel** If set, will process a batch of requests in parallel. @@ -69,7 +83,6 @@ If set, will process a batch of requests in parallel. ---- #### **SerialFrame** If set, will process a batch of requests in parallel. @@ -85,9 +98,12 @@ If set, will process a batch of requests in parallel. + + --- + + ### Syntax ```PowerShell Send-OBS [[-MessageData] ] [[-StepTime] ] [-Parallel] [-SerialFrame] [] ``` ---- From 5cb25d18de83306d12caf1bbf75e08fd19486d50 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:46 +0000 Subject: [PATCH 090/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Send-OBSCallVendorRequest.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Send-OBSCallVendorRequest.md b/docs/Send-OBSCallVendorRequest.md index c8e7ffba1..cfaf38f8d 100644 --- a/docs/Send-OBSCallVendorRequest.md +++ b/docs/Send-OBSCallVendorRequest.md @@ -1,9 +1,17 @@ Send-OBSCallVendorRequest ------------------------- + + + + ### Synopsis Send-OBSCallVendorRequest : CallVendorRequest + + --- + + ### Description Call a request registered to a vendor. @@ -14,13 +22,21 @@ If a plugin or script implements vendor requests or events, documentation is exp Send-OBSCallVendorRequest calls the OBS WebSocket with a request of type CallVendorRequest. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#callvendorrequest](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#callvendorrequest) + + --- + + ### Parameters #### **VendorName** @@ -37,7 +53,6 @@ Name of the vendor to use ---- #### **RequestType** The request type to call @@ -53,7 +68,6 @@ The request type to call ---- #### **RequestData** Object containing appropriate request data @@ -69,7 +83,6 @@ Object containing appropriate request data ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -79,15 +92,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Send-OBSCallVendorRequest [-VendorName] [-RequestType] [[-RequestData] ] [-PassThru] [] ``` ---- From 485e264c37ddf6b28b14701e5fda84ce3944df88 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:46 +0000 Subject: [PATCH 091/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Send-OBSCustomEvent.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Send-OBSCustomEvent.md b/docs/Send-OBSCustomEvent.md index cdc22d9fd..f0fea724c 100644 --- a/docs/Send-OBSCustomEvent.md +++ b/docs/Send-OBSCustomEvent.md @@ -1,9 +1,17 @@ Send-OBSCustomEvent ------------------- + + + + ### Synopsis Send-OBSCustomEvent : BroadcastCustomEvent + + --- + + ### Description Broadcasts a `CustomEvent` to all WebSocket clients. Receivers are clients which are identified and subscribed. @@ -11,13 +19,21 @@ Broadcasts a `CustomEvent` to all WebSocket clients. Receivers are clients which Send-OBSCustomEvent calls the OBS WebSocket with a request of type BroadcastCustomEvent. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#broadcastcustomevent](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#broadcastcustomevent) + + --- + + ### Parameters #### **EventData** @@ -34,7 +50,6 @@ Data payload to emit to all receivers ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Send-OBSCustomEvent [-EventData] [-PassThru] [] ``` ---- From 2d992934260d0b5ec410134f7222d896a7567338 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:46 +0000 Subject: [PATCH 092/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Send-OBSOffsetMediaInputCursor.md | 29 ++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Send-OBSOffsetMediaInputCursor.md b/docs/Send-OBSOffsetMediaInputCursor.md index f0d375a55..3f8c4f3f7 100644 --- a/docs/Send-OBSOffsetMediaInputCursor.md +++ b/docs/Send-OBSOffsetMediaInputCursor.md @@ -1,9 +1,17 @@ Send-OBSOffsetMediaInputCursor ------------------------------ + + + + ### Synopsis Send-OBSOffsetMediaInputCursor : OffsetMediaInputCursor + + --- + + ### Description Offsets the current cursor position of a media input by the specified value. @@ -13,13 +21,21 @@ This request does not perform bounds checking of the cursor position. Send-OBSOffsetMediaInputCursor calls the OBS WebSocket with a request of type OffsetMediaInputCursor. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#offsetmediainputcursor](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#offsetmediainputcursor) + + --- + + ### Parameters #### **InputName** @@ -36,7 +52,6 @@ Name of the media input ---- #### **MediaCursorOffset** Value to offset the current cursor position by @@ -52,7 +67,6 @@ Value to offset the current cursor position by ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -62,15 +76,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Send-OBSOffsetMediaInputCursor [-InputName] [-MediaCursorOffset] [-PassThru] [] ``` ---- From 9120dbc2e2e84ad1e5aeb16edf4aa7eee51c4c15 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:46 +0000 Subject: [PATCH 093/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Send-OBSPauseRecord.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Send-OBSPauseRecord.md b/docs/Send-OBSPauseRecord.md index 9fc5b4958..be4f58a7d 100644 --- a/docs/Send-OBSPauseRecord.md +++ b/docs/Send-OBSPauseRecord.md @@ -1,9 +1,17 @@ Send-OBSPauseRecord ------------------- + + + + ### Synopsis Send-OBSPauseRecord : PauseRecord + + --- + + ### Description Pauses the record output. @@ -11,20 +19,32 @@ Pauses the record output. Send-OBSPauseRecord calls the OBS WebSocket with a request of type PauseRecord. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#pauserecord](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#pauserecord) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Send-OBSPauseRecord ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Send-OBSPauseRecord [-PassThru] [] ``` ---- From a31f2145c17400757b2f3e569b5475fa676b6d4e Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:46 +0000 Subject: [PATCH 094/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Send-OBSPressInputPropertiesButton.md | 29 +++++++++++++++++----- 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Send-OBSPressInputPropertiesButton.md b/docs/Send-OBSPressInputPropertiesButton.md index a21b2bc2f..f79f0424a 100644 --- a/docs/Send-OBSPressInputPropertiesButton.md +++ b/docs/Send-OBSPressInputPropertiesButton.md @@ -1,9 +1,17 @@ Send-OBSPressInputPropertiesButton ---------------------------------- + + + + ### Synopsis Send-OBSPressInputPropertiesButton : PressInputPropertiesButton + + --- + + ### Description Presses a button in the properties of an input. @@ -17,13 +25,21 @@ Note: Use this in cases where there is a button in the properties of an input th Send-OBSPressInputPropertiesButton calls the OBS WebSocket with a request of type PressInputPropertiesButton. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#pressinputpropertiesbutton](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#pressinputpropertiesbutton) + + --- + + ### Parameters #### **InputName** @@ -40,7 +56,6 @@ Name of the input ---- #### **PropertyName** Name of the button property to press @@ -56,7 +71,6 @@ Name of the button property to press ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -66,15 +80,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Send-OBSPressInputPropertiesButton [-InputName] [-PropertyName] [-PassThru] [] ``` ---- From 1ad8dcf1ffbc1c173aae08c524f4b9fa59aac3bd Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:46 +0000 Subject: [PATCH 095/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Send-OBSSleep.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Send-OBSSleep.md b/docs/Send-OBSSleep.md index 5eb832e4f..12a43d884 100644 --- a/docs/Send-OBSSleep.md +++ b/docs/Send-OBSSleep.md @@ -1,9 +1,17 @@ Send-OBSSleep ------------- + + + + ### Synopsis Send-OBSSleep : Sleep + + --- + + ### Description Sleeps for a time duration or number of frames. Only available in request batches with types `SERIAL_REALTIME` or `SERIAL_FRAME`. @@ -11,13 +19,21 @@ Sleeps for a time duration or number of frames. Only available in request batche Send-OBSSleep calls the OBS WebSocket with a request of type Sleep. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#sleep](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#sleep) + + --- + + ### Parameters #### **SleepMillis** @@ -34,7 +50,6 @@ Number of milliseconds to sleep for (if `SERIAL_REALTIME` mode) ---- #### **SleepFrames** Number of frames to sleep for (if `SERIAL_FRAME` mode) @@ -50,7 +65,6 @@ Number of frames to sleep for (if `SERIAL_FRAME` mode) ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -60,15 +74,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Send-OBSSleep [[-SleepMillis] ] [[-SleepFrames] ] [-PassThru] [] ``` ---- From 480834e619b6d08b886789d9f8c666782633a1d7 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:47 +0000 Subject: [PATCH 096/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Send-OBSStreamCaption.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Send-OBSStreamCaption.md b/docs/Send-OBSStreamCaption.md index de4d6f462..9a4380aff 100644 --- a/docs/Send-OBSStreamCaption.md +++ b/docs/Send-OBSStreamCaption.md @@ -1,9 +1,17 @@ Send-OBSStreamCaption --------------------- + + + + ### Synopsis Send-OBSStreamCaption : SendStreamCaption + + --- + + ### Description Sends CEA-608 caption text over the stream output. @@ -11,13 +19,21 @@ Sends CEA-608 caption text over the stream output. Send-OBSStreamCaption calls the OBS WebSocket with a request of type SendStreamCaption. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#sendstreamcaption](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#sendstreamcaption) + + --- + + ### Parameters #### **CaptionText** @@ -34,7 +50,6 @@ Caption text ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Send-OBSStreamCaption [-CaptionText] [-PassThru] [] ``` ---- From 941a51bde6022944b38c4e852f11fa4da6bbd01a Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:47 +0000 Subject: [PATCH 097/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Send-OBSTriggerHotkeyByKeySequence.md | 33 +++++++++++++++------- 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/docs/Send-OBSTriggerHotkeyByKeySequence.md b/docs/Send-OBSTriggerHotkeyByKeySequence.md index 6db555141..341ca2442 100644 --- a/docs/Send-OBSTriggerHotkeyByKeySequence.md +++ b/docs/Send-OBSTriggerHotkeyByKeySequence.md @@ -1,9 +1,17 @@ Send-OBSTriggerHotkeyByKeySequence ---------------------------------- + + + + ### Synopsis Send-OBSTriggerHotkeyByKeySequence : TriggerHotkeyByKeySequence + + --- + + ### Description Triggers a hotkey using a sequence of keys. @@ -11,13 +19,21 @@ Triggers a hotkey using a sequence of keys. Send-OBSTriggerHotkeyByKeySequence calls the OBS WebSocket with a request of type TriggerHotkeyByKeySequence. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#triggerhotkeybykeysequence](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#triggerhotkeybykeysequence) + + --- + + ### Parameters #### **KeyId** @@ -34,7 +50,6 @@ The OBS key ID to use. See https://github.com/obsproject/obs-studio/blob/master/ ---- #### **KeyModifiers** Object containing key modifiers to apply @@ -50,7 +65,6 @@ Object containing key modifiers to apply ---- #### **KeyModifiersshift** Press Shift @@ -66,7 +80,6 @@ Press Shift ---- #### **KeyModifierscontrol** Press CTRL @@ -82,7 +95,6 @@ Press CTRL ---- #### **KeyModifiersalt** Press ALT @@ -98,7 +110,6 @@ Press ALT ---- #### **KeyModifierscommand** Press CMD (Mac) @@ -114,7 +125,6 @@ Press CMD (Mac) ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -124,15 +134,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Send-OBSTriggerHotkeyByKeySequence [[-KeyId] ] [[-KeyModifiers] ] [-KeyModifiersshift] [-KeyModifierscontrol] [-KeyModifiersalt] [-KeyModifierscommand] [-PassThru] [] ``` ---- From 639e7bd763c39709f7f709822cb52c413b57e9c0 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:47 +0000 Subject: [PATCH 098/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Send-OBSTriggerHotkeyByName.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Send-OBSTriggerHotkeyByName.md b/docs/Send-OBSTriggerHotkeyByName.md index 0ffcc6c0a..03f2da083 100644 --- a/docs/Send-OBSTriggerHotkeyByName.md +++ b/docs/Send-OBSTriggerHotkeyByName.md @@ -1,9 +1,17 @@ Send-OBSTriggerHotkeyByName --------------------------- + + + + ### Synopsis Send-OBSTriggerHotkeyByName : TriggerHotkeyByName + + --- + + ### Description Triggers a hotkey using its name. See `GetHotkeyList` @@ -11,13 +19,21 @@ Triggers a hotkey using its name. See `GetHotkeyList` Send-OBSTriggerHotkeyByName calls the OBS WebSocket with a request of type TriggerHotkeyByName. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#triggerhotkeybyname](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#triggerhotkeybyname) + + --- + + ### Parameters #### **HotkeyName** @@ -34,7 +50,6 @@ Name of the hotkey to trigger ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Send-OBSTriggerHotkeyByName [-HotkeyName] [-PassThru] [] ``` ---- From 8ee4a4a85feddefb3a940ee15840365d6007c42c Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:47 +0000 Subject: [PATCH 099/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Send-OBSTriggerMediaInputAction.md | 29 ++++++++++++++++++++----- 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Send-OBSTriggerMediaInputAction.md b/docs/Send-OBSTriggerMediaInputAction.md index 522eed754..8906f53c9 100644 --- a/docs/Send-OBSTriggerMediaInputAction.md +++ b/docs/Send-OBSTriggerMediaInputAction.md @@ -1,9 +1,17 @@ Send-OBSTriggerMediaInputAction ------------------------------- + + + + ### Synopsis Send-OBSTriggerMediaInputAction : TriggerMediaInputAction + + --- + + ### Description Triggers an action on a media input. @@ -11,13 +19,21 @@ Triggers an action on a media input. Send-OBSTriggerMediaInputAction calls the OBS WebSocket with a request of type TriggerMediaInputAction. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#triggermediainputaction](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#triggermediainputaction) + + --- + + ### Parameters #### **InputName** @@ -34,7 +50,6 @@ Name of the media input ---- #### **MediaAction** Identifier of the `ObsMediaInputAction` enum @@ -50,7 +65,6 @@ Identifier of the `ObsMediaInputAction` enum ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -60,15 +74,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Send-OBSTriggerMediaInputAction [-InputName] [-MediaAction] [-PassThru] [] ``` ---- From 6a06749aaaeb2567ab269cd4b1cf2fea16526e8b Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:47 +0000 Subject: [PATCH 100/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Send-OBSTriggerStudioModeTransition.md | 31 ++++++++++++++++++--- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Send-OBSTriggerStudioModeTransition.md b/docs/Send-OBSTriggerStudioModeTransition.md index ceaa992af..d31d966e9 100644 --- a/docs/Send-OBSTriggerStudioModeTransition.md +++ b/docs/Send-OBSTriggerStudioModeTransition.md @@ -1,9 +1,17 @@ Send-OBSTriggerStudioModeTransition ----------------------------------- + + + + ### Synopsis Send-OBSTriggerStudioModeTransition : TriggerStudioModeTransition + + --- + + ### Description Triggers the current scene transition. Same functionality as the `Transition` button in studio mode. @@ -11,20 +19,32 @@ Triggers the current scene transition. Same functionality as the `Transition` bu Send-OBSTriggerStudioModeTransition calls the OBS WebSocket with a request of type TriggerStudioModeTransition. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#triggerstudiomodetransition](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#triggerstudiomodetransition) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Send-OBSTriggerStudioModeTransition ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Send-OBSTriggerStudioModeTransition [-PassThru] [] ``` ---- From 39557e1f2865bdc9c7e012878af236abea327d24 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:47 +0000 Subject: [PATCH 101/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSCurrentPreviewScene.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Set-OBSCurrentPreviewScene.md b/docs/Set-OBSCurrentPreviewScene.md index afde18a21..657f09a6e 100644 --- a/docs/Set-OBSCurrentPreviewScene.md +++ b/docs/Set-OBSCurrentPreviewScene.md @@ -1,9 +1,17 @@ Set-OBSCurrentPreviewScene -------------------------- + + + + ### Synopsis Set-OBSCurrentPreviewScene : SetCurrentPreviewScene + + --- + + ### Description Sets the current preview scene. @@ -13,13 +21,21 @@ Only available when studio mode is enabled. Set-OBSCurrentPreviewScene calls the OBS WebSocket with a request of type SetCurrentPreviewScene. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setcurrentpreviewscene](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setcurrentpreviewscene) + + --- + + ### Parameters #### **SceneName** @@ -36,7 +52,6 @@ Scene to set as the current preview scene ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -46,15 +61,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSCurrentPreviewScene [-SceneName] [-PassThru] [] ``` ---- From 7fe542e2a014ad5f67c45b616ed239f34fff85a8 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:47 +0000 Subject: [PATCH 102/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSCurrentProfile.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Set-OBSCurrentProfile.md b/docs/Set-OBSCurrentProfile.md index 4be5fdaac..fe79eec0d 100644 --- a/docs/Set-OBSCurrentProfile.md +++ b/docs/Set-OBSCurrentProfile.md @@ -1,9 +1,17 @@ Set-OBSCurrentProfile --------------------- + + + + ### Synopsis Set-OBSCurrentProfile : SetCurrentProfile + + --- + + ### Description Switches to a profile. @@ -11,13 +19,21 @@ Switches to a profile. Set-OBSCurrentProfile calls the OBS WebSocket with a request of type SetCurrentProfile. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setcurrentprofile](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setcurrentprofile) + + --- + + ### Parameters #### **ProfileName** @@ -34,7 +50,6 @@ Name of the profile to switch to ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSCurrentProfile [-ProfileName] [-PassThru] [] ``` ---- From 8f17cf400a8b0c89736bc1e4d2085c56ebaf1ecd Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:47 +0000 Subject: [PATCH 103/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSCurrentProgramScene.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Set-OBSCurrentProgramScene.md b/docs/Set-OBSCurrentProgramScene.md index 29ca01589..35b6b9fa2 100644 --- a/docs/Set-OBSCurrentProgramScene.md +++ b/docs/Set-OBSCurrentProgramScene.md @@ -1,9 +1,17 @@ Set-OBSCurrentProgramScene -------------------------- + + + + ### Synopsis Set-OBSCurrentProgramScene : SetCurrentProgramScene + + --- + + ### Description Sets the current program scene. @@ -11,13 +19,21 @@ Sets the current program scene. Set-OBSCurrentProgramScene calls the OBS WebSocket with a request of type SetCurrentProgramScene. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setcurrentprogramscene](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setcurrentprogramscene) + + --- + + ### Parameters #### **SceneName** @@ -34,7 +50,6 @@ Scene to set as the current program scene ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSCurrentProgramScene [-SceneName] [-PassThru] [] ``` ---- From 9574278e02560125c94647e22ad2974cae878647 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:47 +0000 Subject: [PATCH 104/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSCurrentSceneCollection.md | 28 ++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Set-OBSCurrentSceneCollection.md b/docs/Set-OBSCurrentSceneCollection.md index 45f883d72..50c2ef163 100644 --- a/docs/Set-OBSCurrentSceneCollection.md +++ b/docs/Set-OBSCurrentSceneCollection.md @@ -1,9 +1,17 @@ Set-OBSCurrentSceneCollection ----------------------------- + + + + ### Synopsis Set-OBSCurrentSceneCollection : SetCurrentSceneCollection + + --- + + ### Description Switches to a scene collection. @@ -13,13 +21,21 @@ Note: This will block until the collection has finished changing. Set-OBSCurrentSceneCollection calls the OBS WebSocket with a request of type SetCurrentSceneCollection. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setcurrentscenecollection](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setcurrentscenecollection) + + --- + + ### Parameters #### **SceneCollectionName** @@ -36,7 +52,6 @@ Name of the scene collection to switch to ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -46,15 +61,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSCurrentSceneCollection [-SceneCollectionName] [-PassThru] [] ``` ---- From a798f65a508a6267f03b4c41e9d55ba269743ce4 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:48 +0000 Subject: [PATCH 105/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSCurrentSceneTransition.md | 28 ++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Set-OBSCurrentSceneTransition.md b/docs/Set-OBSCurrentSceneTransition.md index 666db466c..07049fd9a 100644 --- a/docs/Set-OBSCurrentSceneTransition.md +++ b/docs/Set-OBSCurrentSceneTransition.md @@ -1,9 +1,17 @@ Set-OBSCurrentSceneTransition ----------------------------- + + + + ### Synopsis Set-OBSCurrentSceneTransition : SetCurrentSceneTransition + + --- + + ### Description Sets the current scene transition. @@ -13,13 +21,21 @@ Small note: While the namespace of scene transitions is generally unique, that u Set-OBSCurrentSceneTransition calls the OBS WebSocket with a request of type SetCurrentSceneTransition. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setcurrentscenetransition](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setcurrentscenetransition) + + --- + + ### Parameters #### **TransitionName** @@ -36,7 +52,6 @@ Name of the transition to make active ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -46,15 +61,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSCurrentSceneTransition [-TransitionName] [-PassThru] [] ``` ---- From f2431b06821d511d9dd371cc05363e627d6df74e Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:48 +0000 Subject: [PATCH 106/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSCurrentSceneTransitionDuration.md | 28 +++++++++++++++---- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Set-OBSCurrentSceneTransitionDuration.md b/docs/Set-OBSCurrentSceneTransitionDuration.md index eb1dcc7a0..7bc5a17c7 100644 --- a/docs/Set-OBSCurrentSceneTransitionDuration.md +++ b/docs/Set-OBSCurrentSceneTransitionDuration.md @@ -1,9 +1,17 @@ Set-OBSCurrentSceneTransitionDuration ------------------------------------- + + + + ### Synopsis Set-OBSCurrentSceneTransitionDuration : SetCurrentSceneTransitionDuration + + --- + + ### Description Sets the duration of the current scene transition, if it is not fixed. @@ -11,13 +19,21 @@ Sets the duration of the current scene transition, if it is not fixed. Set-OBSCurrentSceneTransitionDuration calls the OBS WebSocket with a request of type SetCurrentSceneTransitionDuration. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setcurrentscenetransitionduration](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setcurrentscenetransitionduration) + + --- + + ### Parameters #### **TransitionDuration** @@ -34,7 +50,6 @@ Duration in milliseconds ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSCurrentSceneTransitionDuration [-TransitionDuration] [-PassThru] [] ``` ---- From 7e8bf589f53d1859cb5ca8f8487d59950d5e55c3 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:48 +0000 Subject: [PATCH 107/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSCurrentSceneTransitionSettings.md | 29 +++++++++++++++---- 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Set-OBSCurrentSceneTransitionSettings.md b/docs/Set-OBSCurrentSceneTransitionSettings.md index 67ce02ed0..51c8dfe60 100644 --- a/docs/Set-OBSCurrentSceneTransitionSettings.md +++ b/docs/Set-OBSCurrentSceneTransitionSettings.md @@ -1,9 +1,17 @@ Set-OBSCurrentSceneTransitionSettings ------------------------------------- + + + + ### Synopsis Set-OBSCurrentSceneTransitionSettings : SetCurrentSceneTransitionSettings + + --- + + ### Description Sets the settings of the current scene transition. @@ -11,13 +19,21 @@ Sets the settings of the current scene transition. Set-OBSCurrentSceneTransitionSettings calls the OBS WebSocket with a request of type SetCurrentSceneTransitionSettings. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setcurrentscenetransitionsettings](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setcurrentscenetransitionsettings) + + --- + + ### Parameters #### **TransitionSettings** @@ -34,7 +50,6 @@ Settings object to apply to the transition. Can be `{}` ---- #### **Overlay** Whether to overlay over the current settings or replace them @@ -50,7 +65,6 @@ Whether to overlay over the current settings or replace them ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -60,15 +74,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSCurrentSceneTransitionSettings [-TransitionSettings] [-Overlay] [-PassThru] [] ``` ---- From a3e2406a605ca517f95c4551dbd5a1a750e9b864 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:48 +0000 Subject: [PATCH 108/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSInputAudioBalance.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Set-OBSInputAudioBalance.md b/docs/Set-OBSInputAudioBalance.md index 9a3db84f0..75ac0fcf2 100644 --- a/docs/Set-OBSInputAudioBalance.md +++ b/docs/Set-OBSInputAudioBalance.md @@ -1,9 +1,17 @@ Set-OBSInputAudioBalance ------------------------ + + + + ### Synopsis Set-OBSInputAudioBalance : SetInputAudioBalance + + --- + + ### Description Sets the audio balance of an input. @@ -11,13 +19,21 @@ Sets the audio balance of an input. Set-OBSInputAudioBalance calls the OBS WebSocket with a request of type SetInputAudioBalance. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setinputaudiobalance](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setinputaudiobalance) + + --- + + ### Parameters #### **InputName** @@ -34,7 +50,6 @@ Name of the input to set the audio balance of ---- #### **InputAudioBalance** New audio balance value @@ -50,7 +65,6 @@ New audio balance value ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -60,15 +74,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSInputAudioBalance [-InputName] [-InputAudioBalance] [-PassThru] [] ``` ---- From 02414258facd9d59e33e1f96df373f367b8bfe0f Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:48 +0000 Subject: [PATCH 109/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSInputAudioMonitorType.md | 29 ++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Set-OBSInputAudioMonitorType.md b/docs/Set-OBSInputAudioMonitorType.md index 476b16efb..41b604a6b 100644 --- a/docs/Set-OBSInputAudioMonitorType.md +++ b/docs/Set-OBSInputAudioMonitorType.md @@ -1,9 +1,17 @@ Set-OBSInputAudioMonitorType ---------------------------- + + + + ### Synopsis Set-OBSInputAudioMonitorType : SetInputAudioMonitorType + + --- + + ### Description Sets the audio monitor type of an input. @@ -11,13 +19,21 @@ Sets the audio monitor type of an input. Set-OBSInputAudioMonitorType calls the OBS WebSocket with a request of type SetInputAudioMonitorType. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setinputaudiomonitortype](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setinputaudiomonitortype) + + --- + + ### Parameters #### **InputName** @@ -34,7 +50,6 @@ Name of the input to set the audio monitor type of ---- #### **MonitorType** Audio monitor type @@ -50,7 +65,6 @@ Audio monitor type ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -60,15 +74,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSInputAudioMonitorType [-InputName] [-MonitorType] [-PassThru] [] ``` ---- From aba5a4af84176c8cb610635b217a9ac7c92da353 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:48 +0000 Subject: [PATCH 110/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSInputAudioSyncOffset.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Set-OBSInputAudioSyncOffset.md b/docs/Set-OBSInputAudioSyncOffset.md index db9c6ae29..8369e229f 100644 --- a/docs/Set-OBSInputAudioSyncOffset.md +++ b/docs/Set-OBSInputAudioSyncOffset.md @@ -1,9 +1,17 @@ Set-OBSInputAudioSyncOffset --------------------------- + + + + ### Synopsis Set-OBSInputAudioSyncOffset : SetInputAudioSyncOffset + + --- + + ### Description Sets the audio sync offset of an input. @@ -11,13 +19,21 @@ Sets the audio sync offset of an input. Set-OBSInputAudioSyncOffset calls the OBS WebSocket with a request of type SetInputAudioSyncOffset. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setinputaudiosyncoffset](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setinputaudiosyncoffset) + + --- + + ### Parameters #### **InputName** @@ -34,7 +50,6 @@ Name of the input to set the audio sync offset of ---- #### **InputAudioSyncOffset** New audio sync offset in milliseconds @@ -50,7 +65,6 @@ New audio sync offset in milliseconds ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -60,15 +74,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSInputAudioSyncOffset [-InputName] [-InputAudioSyncOffset] [-PassThru] [] ``` ---- From a2517a6248062a3dc57490357ff3c302e9b96a20 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:48 +0000 Subject: [PATCH 111/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSInputAudioTracks.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Set-OBSInputAudioTracks.md b/docs/Set-OBSInputAudioTracks.md index 8c1f5ac1a..5e2ab196d 100644 --- a/docs/Set-OBSInputAudioTracks.md +++ b/docs/Set-OBSInputAudioTracks.md @@ -1,9 +1,17 @@ Set-OBSInputAudioTracks ----------------------- + + + + ### Synopsis Set-OBSInputAudioTracks : SetInputAudioTracks + + --- + + ### Description Sets the enable state of audio tracks of an input. @@ -11,13 +19,21 @@ Sets the enable state of audio tracks of an input. Set-OBSInputAudioTracks calls the OBS WebSocket with a request of type SetInputAudioTracks. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setinputaudiotracks](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setinputaudiotracks) + + --- + + ### Parameters #### **InputName** @@ -34,7 +50,6 @@ Name of the input ---- #### **InputAudioTracks** Track settings to apply @@ -50,7 +65,6 @@ Track settings to apply ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -60,15 +74,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSInputAudioTracks [-InputName] [-InputAudioTracks] [-PassThru] [] ``` ---- From 97383367ece356b574a4ea6e8d2bb205f7709f36 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:48 +0000 Subject: [PATCH 112/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSInputMute.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Set-OBSInputMute.md b/docs/Set-OBSInputMute.md index 62f545503..6a0d2f1f6 100644 --- a/docs/Set-OBSInputMute.md +++ b/docs/Set-OBSInputMute.md @@ -1,9 +1,17 @@ Set-OBSInputMute ---------------- + + + + ### Synopsis Set-OBSInputMute : SetInputMute + + --- + + ### Description Sets the audio mute state of an input. @@ -11,13 +19,21 @@ Sets the audio mute state of an input. Set-OBSInputMute calls the OBS WebSocket with a request of type SetInputMute. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setinputmute](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setinputmute) + + --- + + ### Parameters #### **InputName** @@ -34,7 +50,6 @@ Name of the input to set the mute state of ---- #### **InputMuted** Whether to mute the input or not @@ -50,7 +65,6 @@ Whether to mute the input or not ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -60,15 +74,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSInputMute [-InputName] -InputMuted [-PassThru] [] ``` ---- From ea2dde717c516899ff9e3e16c4e83d55491c0ada Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:48 +0000 Subject: [PATCH 113/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSInputName.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Set-OBSInputName.md b/docs/Set-OBSInputName.md index a40887c1b..d439c0d3e 100644 --- a/docs/Set-OBSInputName.md +++ b/docs/Set-OBSInputName.md @@ -1,9 +1,17 @@ Set-OBSInputName ---------------- + + + + ### Synopsis Set-OBSInputName : SetInputName + + --- + + ### Description Sets the name of an input (rename). @@ -11,13 +19,21 @@ Sets the name of an input (rename). Set-OBSInputName calls the OBS WebSocket with a request of type SetInputName. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setinputname](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setinputname) + + --- + + ### Parameters #### **InputName** @@ -34,7 +50,6 @@ Current input name ---- #### **NewInputName** New name for the input @@ -50,7 +65,6 @@ New name for the input ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -60,15 +74,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSInputName [-InputName] [-NewInputName] [-PassThru] [] ``` ---- From f3b5d17e65757e7bd02b20d47fc48d850d1b6391 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:49 +0000 Subject: [PATCH 114/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSInputSettings.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Set-OBSInputSettings.md b/docs/Set-OBSInputSettings.md index 3cb1d7477..35e2da63c 100644 --- a/docs/Set-OBSInputSettings.md +++ b/docs/Set-OBSInputSettings.md @@ -1,9 +1,17 @@ Set-OBSInputSettings -------------------- + + + + ### Synopsis Set-OBSInputSettings : SetInputSettings + + --- + + ### Description Sets the settings of an input. @@ -11,13 +19,21 @@ Sets the settings of an input. Set-OBSInputSettings calls the OBS WebSocket with a request of type SetInputSettings. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setinputsettings](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setinputsettings) + + --- + + ### Parameters #### **InputName** @@ -34,7 +50,6 @@ Name of the input to set the settings of ---- #### **InputSettings** Object of settings to apply @@ -50,7 +65,6 @@ Object of settings to apply ---- #### **Overlay** True == apply the settings on top of existing ones, False == reset the input to its defaults, then apply settings. @@ -66,7 +80,6 @@ True == apply the settings on top of existing ones, False == reset the input to ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -76,15 +89,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSInputSettings [-InputName] [-InputSettings] [-Overlay] [-PassThru] [] ``` ---- From ff2c8c1f89234cdd7f9be577847e53c090e203b7 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:49 +0000 Subject: [PATCH 115/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSInputVolume.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Set-OBSInputVolume.md b/docs/Set-OBSInputVolume.md index f1a5752f3..8f61cc2d3 100644 --- a/docs/Set-OBSInputVolume.md +++ b/docs/Set-OBSInputVolume.md @@ -1,9 +1,17 @@ Set-OBSInputVolume ------------------ + + + + ### Synopsis Set-OBSInputVolume : SetInputVolume + + --- + + ### Description Sets the volume setting of an input. @@ -11,13 +19,21 @@ Sets the volume setting of an input. Set-OBSInputVolume calls the OBS WebSocket with a request of type SetInputVolume. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setinputvolume](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setinputvolume) + + --- + + ### Parameters #### **InputName** @@ -34,7 +50,6 @@ Name of the input to set the volume of ---- #### **InputVolumeMul** Volume setting in mul @@ -50,7 +65,6 @@ Volume setting in mul ---- #### **InputVolumeDb** Volume setting in dB @@ -66,7 +80,6 @@ Volume setting in dB ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -76,15 +89,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSInputVolume [-InputName] [[-InputVolumeMul] ] [[-InputVolumeDb] ] [-PassThru] [] ``` ---- From 5a35dbdf338f15f470b73e6f8e7ac4265e6e0a8d Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:49 +0000 Subject: [PATCH 116/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSMediaInputCursor.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Set-OBSMediaInputCursor.md b/docs/Set-OBSMediaInputCursor.md index 87dc2e375..64475ceeb 100644 --- a/docs/Set-OBSMediaInputCursor.md +++ b/docs/Set-OBSMediaInputCursor.md @@ -1,9 +1,17 @@ Set-OBSMediaInputCursor ----------------------- + + + + ### Synopsis Set-OBSMediaInputCursor : SetMediaInputCursor + + --- + + ### Description Sets the cursor position of a media input. @@ -13,13 +21,21 @@ This request does not perform bounds checking of the cursor position. Set-OBSMediaInputCursor calls the OBS WebSocket with a request of type SetMediaInputCursor. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setmediainputcursor](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setmediainputcursor) + + --- + + ### Parameters #### **InputName** @@ -36,7 +52,6 @@ Name of the media input ---- #### **MediaCursor** New cursor position to set @@ -52,7 +67,6 @@ New cursor position to set ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -62,15 +76,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSMediaInputCursor [-InputName] [-MediaCursor] [-PassThru] [] ``` ---- From 1caabd0ea66104860b0ae327278e265a89f0f81b Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:49 +0000 Subject: [PATCH 117/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSOutputSettings.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Set-OBSOutputSettings.md b/docs/Set-OBSOutputSettings.md index 51d1d9f6d..f33978bba 100644 --- a/docs/Set-OBSOutputSettings.md +++ b/docs/Set-OBSOutputSettings.md @@ -1,9 +1,17 @@ Set-OBSOutputSettings --------------------- + + + + ### Synopsis Set-OBSOutputSettings : SetOutputSettings + + --- + + ### Description Sets the settings of an output. @@ -11,13 +19,21 @@ Sets the settings of an output. Set-OBSOutputSettings calls the OBS WebSocket with a request of type SetOutputSettings. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setoutputsettings](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setoutputsettings) + + --- + + ### Parameters #### **OutputName** @@ -34,7 +50,6 @@ Output name ---- #### **OutputSettings** Output settings @@ -50,7 +65,6 @@ Output settings ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -60,15 +74,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSOutputSettings [-OutputName] [-OutputSettings] [-PassThru] [] ``` ---- From b4626dd75358f67f1fb6265d7cbfa9d5eaa8ea05 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:49 +0000 Subject: [PATCH 118/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSPersistentData.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Set-OBSPersistentData.md b/docs/Set-OBSPersistentData.md index 0a6df1ac5..0d1b460d1 100644 --- a/docs/Set-OBSPersistentData.md +++ b/docs/Set-OBSPersistentData.md @@ -1,9 +1,17 @@ Set-OBSPersistentData --------------------- + + + + ### Synopsis Set-OBSPersistentData : SetPersistentData + + --- + + ### Description Sets the value of a "slot" from the selected persistent data realm. @@ -11,13 +19,21 @@ Sets the value of a "slot" from the selected persistent data realm. Set-OBSPersistentData calls the OBS WebSocket with a request of type SetPersistentData. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setpersistentdata](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setpersistentdata) + + --- + + ### Parameters #### **Realm** @@ -34,7 +50,6 @@ The data realm to select. `OBS_WEBSOCKET_DATA_REALM_GLOBAL` or `OBS_WEBSOCKET_DA ---- #### **SlotName** The name of the slot to retrieve data from @@ -50,7 +65,6 @@ The name of the slot to retrieve data from ---- #### **SlotValue** The value to apply to the slot @@ -66,7 +80,6 @@ The value to apply to the slot ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -76,15 +89,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSPersistentData [-Realm] [-SlotName] [-SlotValue] [-PassThru] [] ``` ---- From ac75cbbc58674b31b24377da13adef9c5ea3656d Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:49 +0000 Subject: [PATCH 119/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSProfileParameter.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Set-OBSProfileParameter.md b/docs/Set-OBSProfileParameter.md index 661fa6df6..4b156084e 100644 --- a/docs/Set-OBSProfileParameter.md +++ b/docs/Set-OBSProfileParameter.md @@ -1,9 +1,17 @@ Set-OBSProfileParameter ----------------------- + + + + ### Synopsis Set-OBSProfileParameter : SetProfileParameter + + --- + + ### Description Sets the value of a parameter in the current profile's configuration. @@ -11,13 +19,21 @@ Sets the value of a parameter in the current profile's configuration. Set-OBSProfileParameter calls the OBS WebSocket with a request of type SetProfileParameter. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setprofileparameter](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setprofileparameter) + + --- + + ### Parameters #### **ParameterCategory** @@ -34,7 +50,6 @@ Category of the parameter to set ---- #### **ParameterName** Name of the parameter to set @@ -50,7 +65,6 @@ Name of the parameter to set ---- #### **ParameterValue** Value of the parameter to set. Use `null` to delete @@ -66,7 +80,6 @@ Value of the parameter to set. Use `null` to delete ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -76,15 +89,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSProfileParameter [-ParameterCategory] [-ParameterName] [-ParameterValue] [-PassThru] [] ``` ---- From a2dea76423f20597a461496c2a19b5e167a7b409 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:49 +0000 Subject: [PATCH 120/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSSceneItemBlendMode.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Set-OBSSceneItemBlendMode.md b/docs/Set-OBSSceneItemBlendMode.md index 307cb3e70..1a38425a2 100644 --- a/docs/Set-OBSSceneItemBlendMode.md +++ b/docs/Set-OBSSceneItemBlendMode.md @@ -1,9 +1,17 @@ Set-OBSSceneItemBlendMode ------------------------- + + + + ### Synopsis Set-OBSSceneItemBlendMode : SetSceneItemBlendMode + + --- + + ### Description Sets the blend mode of a scene item. @@ -13,13 +21,21 @@ Scenes and Groups Set-OBSSceneItemBlendMode calls the OBS WebSocket with a request of type SetSceneItemBlendMode. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsceneitemblendmode](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsceneitemblendmode) + + --- + + ### Parameters #### **SceneName** @@ -36,7 +52,6 @@ Name of the scene the item is in ---- #### **SceneItemId** Numeric ID of the scene item @@ -52,7 +67,6 @@ Numeric ID of the scene item ---- #### **SceneItemBlendMode** New blend mode @@ -68,7 +82,6 @@ New blend mode ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -78,15 +91,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSSceneItemBlendMode [-SceneName] [-SceneItemId] [-SceneItemBlendMode] [-PassThru] [] ``` ---- From 3486a42739be4341cce0b5f64a6ac62b3901048c Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:49 +0000 Subject: [PATCH 121/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSSceneItemEnabled.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Set-OBSSceneItemEnabled.md b/docs/Set-OBSSceneItemEnabled.md index 66a5c7a82..1127c6eac 100644 --- a/docs/Set-OBSSceneItemEnabled.md +++ b/docs/Set-OBSSceneItemEnabled.md @@ -1,9 +1,17 @@ Set-OBSSceneItemEnabled ----------------------- + + + + ### Synopsis Set-OBSSceneItemEnabled : SetSceneItemEnabled + + --- + + ### Description Sets the enable state of a scene item. @@ -13,13 +21,21 @@ Scenes and Groups Set-OBSSceneItemEnabled calls the OBS WebSocket with a request of type SetSceneItemEnabled. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsceneitemenabled](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsceneitemenabled) + + --- + + ### Parameters #### **SceneName** @@ -36,7 +52,6 @@ Name of the scene the item is in ---- #### **SceneItemId** Numeric ID of the scene item @@ -52,7 +67,6 @@ Numeric ID of the scene item ---- #### **SceneItemEnabled** New enable state of the scene item @@ -68,7 +82,6 @@ New enable state of the scene item ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -78,15 +91,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSSceneItemEnabled [-SceneName] [-SceneItemId] -SceneItemEnabled [-PassThru] [] ``` ---- From d8dc5e4d0e35d6b64cf64bf0999bceb355e13c30 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:50 +0000 Subject: [PATCH 122/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSSceneItemIndex.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Set-OBSSceneItemIndex.md b/docs/Set-OBSSceneItemIndex.md index 58f0e3a3e..9d1bb1f30 100644 --- a/docs/Set-OBSSceneItemIndex.md +++ b/docs/Set-OBSSceneItemIndex.md @@ -1,9 +1,17 @@ Set-OBSSceneItemIndex --------------------- + + + + ### Synopsis Set-OBSSceneItemIndex : SetSceneItemIndex + + --- + + ### Description Sets the index position of a scene item in a scene. @@ -13,13 +21,21 @@ Scenes and Groups Set-OBSSceneItemIndex calls the OBS WebSocket with a request of type SetSceneItemIndex. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsceneitemindex](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsceneitemindex) + + --- + + ### Parameters #### **SceneName** @@ -36,7 +52,6 @@ Name of the scene the item is in ---- #### **SceneItemId** Numeric ID of the scene item @@ -52,7 +67,6 @@ Numeric ID of the scene item ---- #### **SceneItemIndex** New index position of the scene item @@ -68,7 +82,6 @@ New index position of the scene item ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -78,15 +91,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSSceneItemIndex [-SceneName] [-SceneItemId] [-SceneItemIndex] [-PassThru] [] ``` ---- From cc276399f0434f199eeaea17342e162847b0fb87 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:50 +0000 Subject: [PATCH 123/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSSceneItemLocked.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Set-OBSSceneItemLocked.md b/docs/Set-OBSSceneItemLocked.md index 061f39d1e..5c0a29ec7 100644 --- a/docs/Set-OBSSceneItemLocked.md +++ b/docs/Set-OBSSceneItemLocked.md @@ -1,9 +1,17 @@ Set-OBSSceneItemLocked ---------------------- + + + + ### Synopsis Set-OBSSceneItemLocked : SetSceneItemLocked + + --- + + ### Description Sets the lock state of a scene item. @@ -13,13 +21,21 @@ Scenes and Group Set-OBSSceneItemLocked calls the OBS WebSocket with a request of type SetSceneItemLocked. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsceneitemlocked](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsceneitemlocked) + + --- + + ### Parameters #### **SceneName** @@ -36,7 +52,6 @@ Name of the scene the item is in ---- #### **SceneItemId** Numeric ID of the scene item @@ -52,7 +67,6 @@ Numeric ID of the scene item ---- #### **SceneItemLocked** New lock state of the scene item @@ -68,7 +82,6 @@ New lock state of the scene item ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -78,15 +91,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSSceneItemLocked [-SceneName] [-SceneItemId] -SceneItemLocked [-PassThru] [] ``` ---- From d9687bcf4d83400b2f8fa663ef932525f0fa572a Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:50 +0000 Subject: [PATCH 124/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSSceneItemTransform.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Set-OBSSceneItemTransform.md b/docs/Set-OBSSceneItemTransform.md index fd701d7f3..42071767d 100644 --- a/docs/Set-OBSSceneItemTransform.md +++ b/docs/Set-OBSSceneItemTransform.md @@ -1,9 +1,17 @@ Set-OBSSceneItemTransform ------------------------- + + + + ### Synopsis Set-OBSSceneItemTransform : SetSceneItemTransform + + --- + + ### Description Sets the transform and crop info of a scene item. @@ -11,13 +19,21 @@ Sets the transform and crop info of a scene item. Set-OBSSceneItemTransform calls the OBS WebSocket with a request of type SetSceneItemTransform. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsceneitemtransform](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsceneitemtransform) + + --- + + ### Parameters #### **SceneName** @@ -34,7 +50,6 @@ Name of the scene the item is in ---- #### **SceneItemId** Numeric ID of the scene item @@ -50,7 +65,6 @@ Numeric ID of the scene item ---- #### **SceneItemTransform** Object containing scene item transform info to update @@ -66,7 +80,6 @@ Object containing scene item transform info to update ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -76,15 +89,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSSceneItemTransform [-SceneName] [-SceneItemId] [-SceneItemTransform] [-PassThru] [] ``` ---- From 5851bd0b4cc165c32a39da51938028c0d524bb23 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:50 +0000 Subject: [PATCH 125/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSSceneName.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Set-OBSSceneName.md b/docs/Set-OBSSceneName.md index 86396fd97..90c48cfc3 100644 --- a/docs/Set-OBSSceneName.md +++ b/docs/Set-OBSSceneName.md @@ -1,9 +1,17 @@ Set-OBSSceneName ---------------- + + + + ### Synopsis Set-OBSSceneName : SetSceneName + + --- + + ### Description Sets the name of a scene (rename). @@ -11,13 +19,21 @@ Sets the name of a scene (rename). Set-OBSSceneName calls the OBS WebSocket with a request of type SetSceneName. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setscenename](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setscenename) + + --- + + ### Parameters #### **SceneName** @@ -34,7 +50,6 @@ Name of the scene to be renamed ---- #### **NewSceneName** New name for the scene @@ -50,7 +65,6 @@ New name for the scene ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -60,15 +74,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSSceneName [-SceneName] [-NewSceneName] [-PassThru] [] ``` ---- From d63d924a87cffae17f9a331d00b8c193047fbdbf Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:50 +0000 Subject: [PATCH 126/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSSceneSceneTransitionOverride.md | 30 ++++++++++++++++----- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Set-OBSSceneSceneTransitionOverride.md b/docs/Set-OBSSceneSceneTransitionOverride.md index 9b489bac5..80b5ce42c 100644 --- a/docs/Set-OBSSceneSceneTransitionOverride.md +++ b/docs/Set-OBSSceneSceneTransitionOverride.md @@ -1,9 +1,17 @@ Set-OBSSceneSceneTransitionOverride ----------------------------------- + + + + ### Synopsis Set-OBSSceneSceneTransitionOverride : SetSceneSceneTransitionOverride + + --- + + ### Description Gets the scene transition overridden for a scene. @@ -11,13 +19,21 @@ Gets the scene transition overridden for a scene. Set-OBSSceneSceneTransitionOverride calls the OBS WebSocket with a request of type SetSceneSceneTransitionOverride. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setscenescenetransitionoverride](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setscenescenetransitionoverride) + + --- + + ### Parameters #### **SceneName** @@ -34,7 +50,6 @@ Name of the scene ---- #### **TransitionName** Name of the scene transition to use as override. Specify `null` to remove @@ -50,7 +65,6 @@ Name of the scene transition to use as override. Specify `null` to remove ---- #### **TransitionDuration** Duration to use for any overridden transition. Specify `null` to remove @@ -66,7 +80,6 @@ Duration to use for any overridden transition. Specify `null` to remove ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -76,15 +89,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSSceneSceneTransitionOverride [-SceneName] [[-TransitionName] ] [[-TransitionDuration] ] [-PassThru] [] ``` ---- From 728be92894b0e37bb3f86546b24a031a1732ea33 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:50 +0000 Subject: [PATCH 127/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSSourceFilterEnabled.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Set-OBSSourceFilterEnabled.md b/docs/Set-OBSSourceFilterEnabled.md index 08dbe1c6e..89ad07c69 100644 --- a/docs/Set-OBSSourceFilterEnabled.md +++ b/docs/Set-OBSSourceFilterEnabled.md @@ -1,9 +1,17 @@ Set-OBSSourceFilterEnabled -------------------------- + + + + ### Synopsis Set-OBSSourceFilterEnabled : SetSourceFilterEnabled + + --- + + ### Description Sets the enable state of a source filter. @@ -11,13 +19,21 @@ Sets the enable state of a source filter. Set-OBSSourceFilterEnabled calls the OBS WebSocket with a request of type SetSourceFilterEnabled. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsourcefilterenabled](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsourcefilterenabled) + + --- + + ### Parameters #### **SourceName** @@ -34,7 +50,6 @@ Name of the source the filter is on ---- #### **FilterName** Name of the filter @@ -50,7 +65,6 @@ Name of the filter ---- #### **FilterEnabled** New enable state of the filter @@ -66,7 +80,6 @@ New enable state of the filter ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -76,15 +89,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSSourceFilterEnabled [-SourceName] [-FilterName] -FilterEnabled [-PassThru] [] ``` ---- From 066ec092bcdb71c136b21ce24afee753e7885d91 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:50 +0000 Subject: [PATCH 128/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSSourceFilterIndex.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Set-OBSSourceFilterIndex.md b/docs/Set-OBSSourceFilterIndex.md index 9397611e3..e8a3a6994 100644 --- a/docs/Set-OBSSourceFilterIndex.md +++ b/docs/Set-OBSSourceFilterIndex.md @@ -1,9 +1,17 @@ Set-OBSSourceFilterIndex ------------------------ + + + + ### Synopsis Set-OBSSourceFilterIndex : SetSourceFilterIndex + + --- + + ### Description Sets the index position of a filter on a source. @@ -11,13 +19,21 @@ Sets the index position of a filter on a source. Set-OBSSourceFilterIndex calls the OBS WebSocket with a request of type SetSourceFilterIndex. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsourcefilterindex](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsourcefilterindex) + + --- + + ### Parameters #### **SourceName** @@ -34,7 +50,6 @@ Name of the source the filter is on ---- #### **FilterName** Name of the filter @@ -50,7 +65,6 @@ Name of the filter ---- #### **FilterIndex** New index position of the filter @@ -66,7 +80,6 @@ New index position of the filter ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -76,15 +89,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSSourceFilterIndex [-SourceName] [-FilterName] [-FilterIndex] [-PassThru] [] ``` ---- From 05a4efba188647a34fef58125a5dab5c915a3815 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:50 +0000 Subject: [PATCH 129/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSSourceFilterName.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Set-OBSSourceFilterName.md b/docs/Set-OBSSourceFilterName.md index 403b0f13d..49cb140aa 100644 --- a/docs/Set-OBSSourceFilterName.md +++ b/docs/Set-OBSSourceFilterName.md @@ -1,9 +1,17 @@ Set-OBSSourceFilterName ----------------------- + + + + ### Synopsis Set-OBSSourceFilterName : SetSourceFilterName + + --- + + ### Description Sets the name of a source filter (rename). @@ -11,13 +19,21 @@ Sets the name of a source filter (rename). Set-OBSSourceFilterName calls the OBS WebSocket with a request of type SetSourceFilterName. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsourcefiltername](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsourcefiltername) + + --- + + ### Parameters #### **SourceName** @@ -34,7 +50,6 @@ Name of the source the filter is on ---- #### **FilterName** Current name of the filter @@ -50,7 +65,6 @@ Current name of the filter ---- #### **NewFilterName** New name for the filter @@ -66,7 +80,6 @@ New name for the filter ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -76,15 +89,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSSourceFilterName [-SourceName] [-FilterName] [-NewFilterName] [-PassThru] [] ``` ---- From 31818745a6ec4226b93ae862fcb3edeb350b790a Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:50 +0000 Subject: [PATCH 130/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSSourceFilterSettings.md | 31 +++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/docs/Set-OBSSourceFilterSettings.md b/docs/Set-OBSSourceFilterSettings.md index a99b113b6..0bb7862c1 100644 --- a/docs/Set-OBSSourceFilterSettings.md +++ b/docs/Set-OBSSourceFilterSettings.md @@ -1,9 +1,17 @@ Set-OBSSourceFilterSettings --------------------------- + + + + ### Synopsis Set-OBSSourceFilterSettings : SetSourceFilterSettings + + --- + + ### Description Sets the settings of a source filter. @@ -11,13 +19,21 @@ Sets the settings of a source filter. Set-OBSSourceFilterSettings calls the OBS WebSocket with a request of type SetSourceFilterSettings. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsourcefiltersettings](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsourcefiltersettings) + + --- + + ### Parameters #### **SourceName** @@ -34,7 +50,6 @@ Name of the source the filter is on ---- #### **FilterName** Name of the filter to set the settings of @@ -50,7 +65,6 @@ Name of the filter to set the settings of ---- #### **FilterSettings** Object of settings to apply @@ -66,7 +80,6 @@ Object of settings to apply ---- #### **Overlay** True == apply the settings on top of existing ones, False == reset the input to its defaults, then apply settings. @@ -82,7 +95,6 @@ True == apply the settings on top of existing ones, False == reset the input to ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -92,15 +104,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSSourceFilterSettings [-SourceName] [-FilterName] [-FilterSettings] [-Overlay] [-PassThru] [] ``` ---- From 2070d9239b5226ea668374ff991ed7a3741814e1 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:51 +0000 Subject: [PATCH 131/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSStreamServiceSettings.md | 29 ++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Set-OBSStreamServiceSettings.md b/docs/Set-OBSStreamServiceSettings.md index f20d3a047..a4cc0226d 100644 --- a/docs/Set-OBSStreamServiceSettings.md +++ b/docs/Set-OBSStreamServiceSettings.md @@ -1,9 +1,17 @@ Set-OBSStreamServiceSettings ---------------------------- + + + + ### Synopsis Set-OBSStreamServiceSettings : SetStreamServiceSettings + + --- + + ### Description Sets the current stream service settings (stream destination). @@ -13,13 +21,21 @@ Note: Simple RTMP settings can be set with type `rtmp_custom` and the settings f Set-OBSStreamServiceSettings calls the OBS WebSocket with a request of type SetStreamServiceSettings. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setstreamservicesettings](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setstreamservicesettings) + + --- + + ### Parameters #### **StreamServiceType** @@ -36,7 +52,6 @@ Type of stream service to apply. Example: `rtmp_common` or `rtmp_custom` ---- #### **StreamServiceSettings** Settings to apply to the service @@ -52,7 +67,6 @@ Settings to apply to the service ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -62,15 +76,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSStreamServiceSettings [-StreamServiceType] [-StreamServiceSettings] [-PassThru] [] ``` ---- From 275a94053238551fbe5fa91a5d2a80bfe46428b5 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:51 +0000 Subject: [PATCH 132/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSStudioModeEnabled.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Set-OBSStudioModeEnabled.md b/docs/Set-OBSStudioModeEnabled.md index 872f1d1cb..afded6f1f 100644 --- a/docs/Set-OBSStudioModeEnabled.md +++ b/docs/Set-OBSStudioModeEnabled.md @@ -1,9 +1,17 @@ Set-OBSStudioModeEnabled ------------------------ + + + + ### Synopsis Set-OBSStudioModeEnabled : SetStudioModeEnabled + + --- + + ### Description Enables or disables studio mode @@ -11,13 +19,21 @@ Enables or disables studio mode Set-OBSStudioModeEnabled calls the OBS WebSocket with a request of type SetStudioModeEnabled. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setstudiomodeenabled](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setstudiomodeenabled) + + --- + + ### Parameters #### **StudioModeEnabled** @@ -34,7 +50,6 @@ True == Enabled, False == Disabled ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSStudioModeEnabled -StudioModeEnabled [-PassThru] [] ``` ---- From 6fb197947cfcdd4325d7fa83727da09113180c6b Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:51 +0000 Subject: [PATCH 133/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSTBarPosition.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/Set-OBSTBarPosition.md b/docs/Set-OBSTBarPosition.md index d2c8f62fb..4dfe41801 100644 --- a/docs/Set-OBSTBarPosition.md +++ b/docs/Set-OBSTBarPosition.md @@ -1,9 +1,17 @@ Set-OBSTBarPosition ------------------- + + + + ### Synopsis Set-OBSTBarPosition : SetTBarPosition + + --- + + ### Description Sets the position of the TBar. @@ -13,13 +21,21 @@ Sets the position of the TBar. Set-OBSTBarPosition calls the OBS WebSocket with a request of type SetTBarPosition. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#settbarposition](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#settbarposition) + + --- + + ### Parameters #### **Position** @@ -36,7 +52,6 @@ New position ---- #### **Release** Whether to release the TBar. Only set `false` if you know that you will be sending another position update @@ -52,7 +67,6 @@ Whether to release the TBar. Only set `false` if you know that you will be sendi ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -62,15 +76,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSTBarPosition [-Position] [-Release] [-PassThru] [] ``` ---- From 2caa7bc3ef1057b9d92b080fac000fa9407b8ea9 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:51 +0000 Subject: [PATCH 134/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Set-OBSVideoSettings.md | 33 +++++++++++++++++++++++---------- 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/docs/Set-OBSVideoSettings.md b/docs/Set-OBSVideoSettings.md index 0b127e093..7b020e7c1 100644 --- a/docs/Set-OBSVideoSettings.md +++ b/docs/Set-OBSVideoSettings.md @@ -1,9 +1,17 @@ Set-OBSVideoSettings -------------------- + + + + ### Synopsis Set-OBSVideoSettings : SetVideoSettings + + --- + + ### Description Sets the current video settings. @@ -13,13 +21,21 @@ Note: Fields must be specified in pairs. For example, you cannot set only `baseW Set-OBSVideoSettings calls the OBS WebSocket with a request of type SetVideoSettings. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setvideosettings](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setvideosettings) + + --- + + ### Parameters #### **FpsNumerator** @@ -36,7 +52,6 @@ Numerator of the fractional FPS value ---- #### **FpsDenominator** Denominator of the fractional FPS value @@ -52,7 +67,6 @@ Denominator of the fractional FPS value ---- #### **BaseWidth** Width of the base (canvas) resolution in pixels @@ -68,7 +82,6 @@ Width of the base (canvas) resolution in pixels ---- #### **BaseHeight** Height of the base (canvas) resolution in pixels @@ -84,7 +97,6 @@ Height of the base (canvas) resolution in pixels ---- #### **OutputWidth** Width of the output resolution in pixels @@ -100,7 +112,6 @@ Width of the output resolution in pixels ---- #### **OutputHeight** Height of the output resolution in pixels @@ -116,7 +127,6 @@ Height of the output resolution in pixels ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -126,15 +136,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Set-OBSVideoSettings [[-FpsNumerator] ] [[-FpsDenominator] ] [[-BaseWidth] ] [[-BaseHeight] ] [[-OutputWidth] ] [[-OutputHeight] ] [-PassThru] [] ``` ---- From be0f38d81f4520e354fc894f3f652b16715ca590 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:51 +0000 Subject: [PATCH 135/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Start-OBSOutput.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Start-OBSOutput.md b/docs/Start-OBSOutput.md index a6d04ac70..1bdca8d99 100644 --- a/docs/Start-OBSOutput.md +++ b/docs/Start-OBSOutput.md @@ -1,9 +1,17 @@ Start-OBSOutput --------------- + + + + ### Synopsis Start-OBSOutput : StartOutput + + --- + + ### Description Starts an output. @@ -11,13 +19,21 @@ Starts an output. Start-OBSOutput calls the OBS WebSocket with a request of type StartOutput. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#startoutput](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#startoutput) + + --- + + ### Parameters #### **OutputName** @@ -34,7 +50,6 @@ Output name ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Start-OBSOutput [-OutputName] [-PassThru] [] ``` ---- From d2e73fc0d525d2865f7716d8fc0510078fc020c3 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:51 +0000 Subject: [PATCH 136/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Start-OBSRecord.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Start-OBSRecord.md b/docs/Start-OBSRecord.md index 3ca6499cb..e9ab07e12 100644 --- a/docs/Start-OBSRecord.md +++ b/docs/Start-OBSRecord.md @@ -1,9 +1,17 @@ Start-OBSRecord --------------- + + + + ### Synopsis Start-OBSRecord : StartRecord + + --- + + ### Description Starts the record output. @@ -11,20 +19,32 @@ Starts the record output. Start-OBSRecord calls the OBS WebSocket with a request of type StartRecord. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#startrecord](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#startrecord) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Start-OBSRecord ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Start-OBSRecord [-PassThru] [] ``` ---- From 796c6afce7ca3189de46ce7ab5fba72e256bdb31 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:51 +0000 Subject: [PATCH 137/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Start-OBSReplayBuffer.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Start-OBSReplayBuffer.md b/docs/Start-OBSReplayBuffer.md index bae0d542e..b3f36cae2 100644 --- a/docs/Start-OBSReplayBuffer.md +++ b/docs/Start-OBSReplayBuffer.md @@ -1,9 +1,17 @@ Start-OBSReplayBuffer --------------------- + + + + ### Synopsis Start-OBSReplayBuffer : StartReplayBuffer + + --- + + ### Description Starts the replay buffer output. @@ -11,20 +19,32 @@ Starts the replay buffer output. Start-OBSReplayBuffer calls the OBS WebSocket with a request of type StartReplayBuffer. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#startreplaybuffer](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#startreplaybuffer) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Start-OBSReplayBuffer ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Start-OBSReplayBuffer [-PassThru] [] ``` ---- From 5ceb60f2627697b10a2c8c6d1e48a311055a4fbe Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:51 +0000 Subject: [PATCH 138/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Start-OBSStream.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Start-OBSStream.md b/docs/Start-OBSStream.md index cb61084a7..d8c3381cc 100644 --- a/docs/Start-OBSStream.md +++ b/docs/Start-OBSStream.md @@ -1,9 +1,17 @@ Start-OBSStream --------------- + + + + ### Synopsis Start-OBSStream : StartStream + + --- + + ### Description Starts the stream output. @@ -11,20 +19,32 @@ Starts the stream output. Start-OBSStream calls the OBS WebSocket with a request of type StartStream. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#startstream](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#startstream) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Start-OBSStream ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Start-OBSStream [-PassThru] [] ``` ---- From 5697adeac497d93d2bb0fded058dbcb0c4eabf03 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:51 +0000 Subject: [PATCH 139/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Start-OBSVirtualCam.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Start-OBSVirtualCam.md b/docs/Start-OBSVirtualCam.md index b8229f7b4..adb313fe8 100644 --- a/docs/Start-OBSVirtualCam.md +++ b/docs/Start-OBSVirtualCam.md @@ -1,9 +1,17 @@ Start-OBSVirtualCam ------------------- + + + + ### Synopsis Start-OBSVirtualCam : StartVirtualCam + + --- + + ### Description Starts the virtualcam output. @@ -11,20 +19,32 @@ Starts the virtualcam output. Start-OBSVirtualCam calls the OBS WebSocket with a request of type StartVirtualCam. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#startvirtualcam](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#startvirtualcam) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Start-OBSVirtualCam ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Start-OBSVirtualCam [-PassThru] [] ``` ---- From ddcd032e149294d533d5fda8ef710a015f35a945 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:52 +0000 Subject: [PATCH 140/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Stop-OBSOutput.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Stop-OBSOutput.md b/docs/Stop-OBSOutput.md index ade63d64a..36e6c0ac2 100644 --- a/docs/Stop-OBSOutput.md +++ b/docs/Stop-OBSOutput.md @@ -1,9 +1,17 @@ Stop-OBSOutput -------------- + + + + ### Synopsis Stop-OBSOutput : StopOutput + + --- + + ### Description Stops an output. @@ -11,13 +19,21 @@ Stops an output. Stop-OBSOutput calls the OBS WebSocket with a request of type StopOutput. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#stopoutput](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#stopoutput) + + --- + + ### Parameters #### **OutputName** @@ -34,7 +50,6 @@ Output name ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Stop-OBSOutput [-OutputName] [-PassThru] [] ``` ---- From 376ce026c8a82b3a59c1bfa6ee578dd0105af447 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:52 +0000 Subject: [PATCH 141/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Stop-OBSRecord.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Stop-OBSRecord.md b/docs/Stop-OBSRecord.md index 8246b8760..3e011609b 100644 --- a/docs/Stop-OBSRecord.md +++ b/docs/Stop-OBSRecord.md @@ -1,9 +1,17 @@ Stop-OBSRecord -------------- + + + + ### Synopsis Stop-OBSRecord : StopRecord + + --- + + ### Description Stops the record output. @@ -11,20 +19,32 @@ Stops the record output. Stop-OBSRecord calls the OBS WebSocket with a request of type StopRecord. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#stoprecord](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#stoprecord) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Stop-OBSRecord ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Stop-OBSRecord [-PassThru] [] ``` ---- From 8755b2bdc36cb2abc0ff7b36087041cfbb66fc4b Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:52 +0000 Subject: [PATCH 142/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Stop-OBSReplayBuffer.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Stop-OBSReplayBuffer.md b/docs/Stop-OBSReplayBuffer.md index a29f48f8f..658c7c7ab 100644 --- a/docs/Stop-OBSReplayBuffer.md +++ b/docs/Stop-OBSReplayBuffer.md @@ -1,9 +1,17 @@ Stop-OBSReplayBuffer -------------------- + + + + ### Synopsis Stop-OBSReplayBuffer : StopReplayBuffer + + --- + + ### Description Stops the replay buffer output. @@ -11,20 +19,32 @@ Stops the replay buffer output. Stop-OBSReplayBuffer calls the OBS WebSocket with a request of type StopReplayBuffer. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#stopreplaybuffer](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#stopreplaybuffer) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Stop-OBSReplayBuffer ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Stop-OBSReplayBuffer [-PassThru] [] ``` ---- From 0a878374a61741755fdd43f0b657f825c2069d17 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:52 +0000 Subject: [PATCH 143/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Stop-OBSStream.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Stop-OBSStream.md b/docs/Stop-OBSStream.md index 5ea829192..ebdbef7e4 100644 --- a/docs/Stop-OBSStream.md +++ b/docs/Stop-OBSStream.md @@ -1,9 +1,17 @@ Stop-OBSStream -------------- + + + + ### Synopsis Stop-OBSStream : StopStream + + --- + + ### Description Stops the stream output. @@ -11,20 +19,32 @@ Stops the stream output. Stop-OBSStream calls the OBS WebSocket with a request of type StopStream. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#stopstream](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#stopstream) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Stop-OBSStream ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Stop-OBSStream [-PassThru] [] ``` ---- From 12dc35893d0b62a2305d390cefce6d70a6cbed26 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:52 +0000 Subject: [PATCH 144/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Stop-OBSVirtualCam.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Stop-OBSVirtualCam.md b/docs/Stop-OBSVirtualCam.md index 093411fb5..ce1e01c20 100644 --- a/docs/Stop-OBSVirtualCam.md +++ b/docs/Stop-OBSVirtualCam.md @@ -1,9 +1,17 @@ Stop-OBSVirtualCam ------------------ + + + + ### Synopsis Stop-OBSVirtualCam : StopVirtualCam + + --- + + ### Description Stops the virtualcam output. @@ -11,20 +19,32 @@ Stops the virtualcam output. Stop-OBSVirtualCam calls the OBS WebSocket with a request of type StopVirtualCam. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#stopvirtualcam](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#stopvirtualcam) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Stop-OBSVirtualCam ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Stop-OBSVirtualCam [-PassThru] [] ``` ---- From c2a71bcb6fae6ab431ea6ce158c2423ca0029536 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:52 +0000 Subject: [PATCH 145/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Switch-OBSInputMute.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Switch-OBSInputMute.md b/docs/Switch-OBSInputMute.md index 7b18f66cc..843a9680c 100644 --- a/docs/Switch-OBSInputMute.md +++ b/docs/Switch-OBSInputMute.md @@ -1,9 +1,17 @@ Switch-OBSInputMute ------------------- + + + + ### Synopsis Switch-OBSInputMute : ToggleInputMute + + --- + + ### Description Toggles the audio mute state of an input. @@ -11,13 +19,21 @@ Toggles the audio mute state of an input. Switch-OBSInputMute calls the OBS WebSocket with a request of type ToggleInputMute. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#toggleinputmute](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#toggleinputmute) + + --- + + ### Parameters #### **InputName** @@ -34,7 +50,6 @@ Name of the input to toggle the mute state of ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Switch-OBSInputMute [-InputName] [-PassThru] [] ``` ---- From ec005cd0777e7019464a8e6e4a9f317dd770221d Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:52 +0000 Subject: [PATCH 146/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Switch-OBSOutput.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/Switch-OBSOutput.md b/docs/Switch-OBSOutput.md index a23ec4eba..b8feea085 100644 --- a/docs/Switch-OBSOutput.md +++ b/docs/Switch-OBSOutput.md @@ -1,9 +1,17 @@ Switch-OBSOutput ---------------- + + + + ### Synopsis Switch-OBSOutput : ToggleOutput + + --- + + ### Description Toggles the status of an output. @@ -11,13 +19,21 @@ Toggles the status of an output. Switch-OBSOutput calls the OBS WebSocket with a request of type ToggleOutput. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#toggleoutput](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#toggleoutput) + + --- + + ### Parameters #### **OutputName** @@ -34,7 +50,6 @@ Output name ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -44,15 +59,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Switch-OBSOutput [-OutputName] [-PassThru] [] ``` ---- From 46e0fbc9d24503923ab01a766e2f22f8363eb81b Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:52 +0000 Subject: [PATCH 147/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Switch-OBSRecord.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Switch-OBSRecord.md b/docs/Switch-OBSRecord.md index 58e9e9ce1..702e7a167 100644 --- a/docs/Switch-OBSRecord.md +++ b/docs/Switch-OBSRecord.md @@ -1,9 +1,17 @@ Switch-OBSRecord ---------------- + + + + ### Synopsis Switch-OBSRecord : ToggleRecord + + --- + + ### Description Toggles the status of the record output. @@ -11,20 +19,32 @@ Toggles the status of the record output. Switch-OBSRecord calls the OBS WebSocket with a request of type ToggleRecord. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#togglerecord](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#togglerecord) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Switch-OBSRecord ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Switch-OBSRecord [-PassThru] [] ``` ---- From c8a1f71c56d1c07d2c8cf8b061b62b070b9563b4 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:52 +0000 Subject: [PATCH 148/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Switch-OBSRecordPause.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Switch-OBSRecordPause.md b/docs/Switch-OBSRecordPause.md index 1b6c79462..36f4b31c7 100644 --- a/docs/Switch-OBSRecordPause.md +++ b/docs/Switch-OBSRecordPause.md @@ -1,9 +1,17 @@ Switch-OBSRecordPause --------------------- + + + + ### Synopsis Switch-OBSRecordPause : ToggleRecordPause + + --- + + ### Description Toggles pause on the record output. @@ -11,20 +19,32 @@ Toggles pause on the record output. Switch-OBSRecordPause calls the OBS WebSocket with a request of type ToggleRecordPause. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#togglerecordpause](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#togglerecordpause) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Switch-OBSRecordPause ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Switch-OBSRecordPause [-PassThru] [] ``` ---- From d89c4c40ecce2ee61d6b3dd4536dcf66cc9bd597 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:52 +0000 Subject: [PATCH 149/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Switch-OBSReplayBuffer.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Switch-OBSReplayBuffer.md b/docs/Switch-OBSReplayBuffer.md index 2703edbc1..551e032f1 100644 --- a/docs/Switch-OBSReplayBuffer.md +++ b/docs/Switch-OBSReplayBuffer.md @@ -1,9 +1,17 @@ Switch-OBSReplayBuffer ---------------------- + + + + ### Synopsis Switch-OBSReplayBuffer : ToggleReplayBuffer + + --- + + ### Description Toggles the state of the replay buffer output. @@ -11,20 +19,32 @@ Toggles the state of the replay buffer output. Switch-OBSReplayBuffer calls the OBS WebSocket with a request of type ToggleReplayBuffer. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#togglereplaybuffer](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#togglereplaybuffer) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Switch-OBSReplayBuffer ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Switch-OBSReplayBuffer [-PassThru] [] ``` ---- From 0b57f44eff33c8ffd58461b67e7101ab73c62c46 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:53 +0000 Subject: [PATCH 150/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Switch-OBSStream.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Switch-OBSStream.md b/docs/Switch-OBSStream.md index 388bd2476..341b59015 100644 --- a/docs/Switch-OBSStream.md +++ b/docs/Switch-OBSStream.md @@ -1,9 +1,17 @@ Switch-OBSStream ---------------- + + + + ### Synopsis Switch-OBSStream : ToggleStream + + --- + + ### Description Toggles the status of the stream output. @@ -11,20 +19,32 @@ Toggles the status of the stream output. Switch-OBSStream calls the OBS WebSocket with a request of type ToggleStream. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#togglestream](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#togglestream) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Switch-OBSStream ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Switch-OBSStream [-PassThru] [] ``` ---- From aa2caaa0cb8c840e534df7ae300c28079975db4e Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:53 +0000 Subject: [PATCH 151/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Switch-OBSVirtualCam.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/Switch-OBSVirtualCam.md b/docs/Switch-OBSVirtualCam.md index 9c065ae07..c5135994f 100644 --- a/docs/Switch-OBSVirtualCam.md +++ b/docs/Switch-OBSVirtualCam.md @@ -1,9 +1,17 @@ Switch-OBSVirtualCam -------------------- + + + + ### Synopsis Switch-OBSVirtualCam : ToggleVirtualCam + + --- + + ### Description Toggles the state of the virtualcam output. @@ -11,20 +19,32 @@ Toggles the state of the virtualcam output. Switch-OBSVirtualCam calls the OBS WebSocket with a request of type ToggleVirtualCam. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#togglevirtualcam](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#togglevirtualcam) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Switch-OBSVirtualCam ``` + + --- + + ### Parameters #### **PassThru** @@ -35,15 +55,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Switch-OBSVirtualCam [-PassThru] [] ``` ---- From d2e0290bbf6fa9b9fb867a8905b6cc93b13a8ee9 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:53 +0000 Subject: [PATCH 152/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Watch-OBS.md | 38 ++++++++++++++++++++++++++++++-------- 1 file changed, 30 insertions(+), 8 deletions(-) diff --git a/docs/Watch-OBS.md b/docs/Watch-OBS.md index 609764dc5..2a4074b4b 100644 --- a/docs/Watch-OBS.md +++ b/docs/Watch-OBS.md @@ -1,14 +1,26 @@ Watch-OBS --------- + + + + ### Synopsis Watches OBS + + --- + + ### Description Watches the OBS websocket for events. + + --- + + ### Related Links * [Connect-OBS](Connect-OBS.md) @@ -18,7 +30,11 @@ Watches the OBS websocket for events. + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell @@ -30,7 +46,11 @@ Watch-OBS -WebSocketToken 12345 # Obviously, replace this with your password. Watch-OBS # If you turn off authentication on OBS ``` + + --- + + ### Parameters #### **WebSocketURI** @@ -41,13 +61,12 @@ The OBS websocket URL. If not provided, this will default to loopback on port 4 -|Type |Required|Position|PipelineInput | -|-------|--------|--------|---------------------| -|`[Uri]`|false |1 |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|-------|--------|--------|---------------------|------------| +|`[Uri]`|false |1 |true (ByPropertyName)|WebSocketURL| ---- #### **WebSocketToken** A randomly generated password used to connect to OBS. @@ -58,15 +77,18 @@ You can see the websocket password in Tools -> obs-websocket settings -> show co -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[String]`|false |2 |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------| +|`[String]`|false |2 |true (ByPropertyName)|WebSocketPassword| + + --- + + ### Syntax ```PowerShell Watch-OBS [[-WebSocketURI] ] [[-WebSocketToken] ] [] ``` ---- From 0a7b3852f937d8db1ba2a8ba37bc709079143272 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:53 +0000 Subject: [PATCH 153/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Add-OBSFFMpegSource.md | 80 ++++++++++++++++++++++++++----------- 1 file changed, 56 insertions(+), 24 deletions(-) diff --git a/docs/Add-OBSFFMpegSource.md b/docs/Add-OBSFFMpegSource.md index 180a18fee..20c7b5eea 100644 --- a/docs/Add-OBSFFMpegSource.md +++ b/docs/Add-OBSFFMpegSource.md @@ -1,27 +1,47 @@ Add-OBSMediaSource ------------------ + + + + ### Synopsis Adds a media source + + --- + + ### Description Adds a media source to OBS. + + --- + + ### Related Links * [Add-OBSInput](Add-OBSInput.md) + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell Add-OBSMediaSource -FilePath My.mp4 ``` + + --- + + ### Parameters #### **FilePath** @@ -32,13 +52,12 @@ The path to the media file. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[String]`|true |1 |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------------------------------| +|`[String]`|true |1 |true (ByPropertyName)|FullName
LocalFile
local_file| ---- #### **CloseWhenInactive** If set, the source will close when it is inactive. @@ -56,7 +75,6 @@ To explicitly set it to false, use -CloseWhenInactive:$false ---- #### **Loop** If set, the source will automatically restart. @@ -66,13 +84,12 @@ If set, the source will automatically restart. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|false |named |true (ByPropertyName)|Looping| ---- #### **UseHardwareDecoding** If set, will use hardware decoding, if available. @@ -82,13 +99,12 @@ If set, will use hardware decoding, if available. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|HardwareDecoding
hw_decode| ---- #### **ClearOnMediaEnd** If set, will clear the output on the end of the media. @@ -101,13 +117,12 @@ To explicitly set to false, use -ClearMediaEnd:$false -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|ClearOnEnd
NoFreezeFrameOnEnd| ---- #### **FFMpegOption** Any FFMpeg demuxer options. @@ -117,13 +132,12 @@ Any FFMpeg demuxer options. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[String]`|false |2 |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------------------------------| +|`[String]`|false |2 |true (ByPropertyName)|FFMpegOptions
FFMpeg_Options| ---- #### **Scene** The name of the scene. @@ -140,7 +154,6 @@ If no scene name is provided, the current program scene will be used. ---- #### **Name** The name of the input. @@ -157,9 +170,28 @@ If no name is provided, the last segment of the URI or file path will be the inp +#### **Force** + +If set, will check if the source exists in the scene before creating it and removing any existing sources found. +If not set, you will get an error if a source with the same name exists. + + + + + + +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| + + + + + --- + + ### Syntax ```PowerShell -Add-OBSMediaSource [-FilePath] [-CloseWhenInactive] [-Loop] [-UseHardwareDecoding] [-ClearOnMediaEnd] [[-FFMpegOption] ] [[-Scene] ] [[-Name] ] [] +Add-OBSMediaSource [-FilePath] [-CloseWhenInactive] [-Loop] [-UseHardwareDecoding] [-ClearOnMediaEnd] [[-FFMpegOption] ] [[-Scene] ] [[-Name] ] [-Force] [] ``` ---- From 309215e37db789c84ea7f05b06ce525de7d13b48 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:53 +0000 Subject: [PATCH 154/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Add-OBSMonitorSource.md | 56 ++++++++++++++++++++++++++++-------- 1 file changed, 44 insertions(+), 12 deletions(-) diff --git a/docs/Add-OBSMonitorSource.md b/docs/Add-OBSMonitorSource.md index 548e822e9..2eaee3785 100644 --- a/docs/Add-OBSMonitorSource.md +++ b/docs/Add-OBSMonitorSource.md @@ -1,14 +1,26 @@ Add-OBSDisplaySource -------------------- + + + + ### Synopsis Adds a display source + + --- + + ### Description Adds a display source to OBS. This captures the contents of the display. + + --- + + ### Examples #### EXAMPLE 1 ```PowerShell @@ -20,7 +32,11 @@ Add-OBSMonitorSource # Adds a display source of the primary monitor Add-OBSMonitorSource -Display 2 # Adds a display source of the second monitor ``` + + --- + + ### Parameters #### **Monitor** @@ -32,13 +48,12 @@ This the number of the monitor you would like to capture. -|Type |Required|Position|PipelineInput | -|---------|--------|--------|---------------------| -|`[Int32]`|false |1 |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|---------|--------|--------|---------------------|-------------------------------------------| +|`[Int32]`|false |1 |true (ByPropertyName)|MonitorNumber
Display
DisplayNumber| ---- #### **CaptureCursor** If set, will capture the cursor. @@ -56,7 +71,6 @@ If explicitly set to false, the cursor will not be captured. ---- #### **Scene** The name of the scene. @@ -67,13 +81,12 @@ If no scene name is provided, the current program scene will be used. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[String]`|false |2 |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[String]`|false |2 |true (ByPropertyName)|SceneName| ---- #### **Name** The name of the input. @@ -84,15 +97,34 @@ If no name is provided, "Display $($Monitor + 1)" will be the input source name. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[String]`|false |3 |true (ByPropertyName)|InputName| + + + +#### **Force** + +If set, will check if the source exists in the scene before creating it and removing any existing sources found. +If not set, you will get an error if a source with the same name exists. + + + + + + |Type |Required|Position|PipelineInput | |----------|--------|--------|---------------------| -|`[String]`|false |3 |true (ByPropertyName)| +|`[Switch]`|false |named |true (ByPropertyName)| + + --- + + ### Syntax ```PowerShell -Add-OBSDisplaySource [[-Monitor] ] [-CaptureCursor] [[-Scene] ] [[-Name] ] [] +Add-OBSDisplaySource [[-Monitor] ] [-CaptureCursor] [[-Scene] ] [[-Name] ] [-Force] [] ``` ---- From 6d16212c29fe6daaa9e8dfc2b98755913bd2e765 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:04:53 +0000 Subject: [PATCH 155/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- docs/Add-OBSSceneSource.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/Add-OBSSceneSource.md b/docs/Add-OBSSceneSource.md index 1f0e418bc..719e056c2 100644 --- a/docs/Add-OBSSceneSource.md +++ b/docs/Add-OBSSceneSource.md @@ -1,9 +1,17 @@ Add-OBSSceneItem ---------------- + + + + ### Synopsis Add-OBSSceneItem : CreateSceneItem + + --- + + ### Description Creates a new scene item using a source. @@ -13,13 +21,21 @@ Scenes only Add-OBSSceneItem calls the OBS WebSocket with a request of type CreateSceneItem. + + --- + + ### Related Links * [https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#createsceneitem](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#createsceneitem) + + --- + + ### Parameters #### **SceneName** @@ -36,7 +52,6 @@ Name of the scene to create the new item in ---- #### **SourceName** Name of the source to add to the scene @@ -52,7 +67,6 @@ Name of the source to add to the scene ---- #### **SceneItemEnabled** Enable state to apply to the scene item on creation @@ -68,7 +82,6 @@ Enable state to apply to the scene item on creation ---- #### **PassThru** If set, will return the information that would otherwise be sent to OBS. @@ -78,15 +91,18 @@ If set, will return the information that would otherwise be sent to OBS. -|Type |Required|Position|PipelineInput | -|----------|--------|--------|---------------------| -|`[Switch]`|false |named |true (ByPropertyName)| +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputRequest
OutputInput| + + --- + + ### Syntax ```PowerShell Add-OBSSceneItem [-SceneName] [-SourceName] [-SceneItemEnabled] [-PassThru] [] ``` ---- From 44becf06ee18ffaa50995672719484ce3520bfcf Mon Sep 17 00:00:00 2001 From: James Brundage <@github.com> Date: Wed, 8 Mar 2023 19:10:02 -0800 Subject: [PATCH 156/181] Adding -Force to Add-OBS*Source commands (Fixes #69) --- Commands/Sources/Add-OBSMediaSource.ps.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Commands/Sources/Add-OBSMediaSource.ps.ps1 b/Commands/Sources/Add-OBSMediaSource.ps.ps1 index d0637f40c..1f6a9715f 100644 --- a/Commands/Sources/Add-OBSMediaSource.ps.ps1 +++ b/Commands/Sources/Add-OBSMediaSource.ps.ps1 @@ -148,7 +148,7 @@ function Add-OBSMediaSource if ($Force) { # Clear any items from that scene Get-OBSSceneItem -sceneName $myParameters["Scene"] | - Where-Object SourceName -eq $myParameters["Name"] | + Where-Object SourceName -eq $name | Remove-OBSInput -InputName { $_.SourceName } } From 40a18c64a1c98cffc0c3755e59c287d51dd9b241 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Thu, 9 Mar 2023 03:11:25 +0000 Subject: [PATCH 157/181] Merge branch 'Show-OBS' of https://github.com/StartAutomating/obs-powershell into Show-OBS --- Commands/Sources/Add-OBSMediaSource.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Commands/Sources/Add-OBSMediaSource.ps1 b/Commands/Sources/Add-OBSMediaSource.ps1 index addbc8837..2d5b7f65e 100644 --- a/Commands/Sources/Add-OBSMediaSource.ps1 +++ b/Commands/Sources/Add-OBSMediaSource.ps1 @@ -164,7 +164,7 @@ dynamicParam { if ($Force) { # Clear any items from that scene Get-OBSSceneItem -sceneName $myParameters["Scene"] | - Where-Object SourceName -eq $myParameters["Name"] | + Where-Object SourceName -eq $name | Remove-OBSInput -InputName { $_.SourceName } } $outputAddedResult = Add-OBSInput @addSplat From 4c008f12942ed2032cc097ee7cb8d63f6985aad3 Mon Sep 17 00:00:00 2001 From: James Brundage <@github.com> Date: Fri, 10 Mar 2023 16:54:19 -0800 Subject: [PATCH 158/181] Adding Remove-OBS (Fixes #68) --- Commands/Remove-OBS.ps1 | 51 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 Commands/Remove-OBS.ps1 diff --git a/Commands/Remove-OBS.ps1 b/Commands/Remove-OBS.ps1 new file mode 100644 index 000000000..af894cbfc --- /dev/null +++ b/Commands/Remove-OBS.ps1 @@ -0,0 +1,51 @@ +function Remove-OBS { + <# + .SYNOPSIS + Remove OBS + .DESCRIPTION + Removes items from OBS + .EXAMPLE + Remove-OBS -SourceName "foo" + .EXAMPLE + Remove-OBS -SceneName "bar" + .LINK + Remove-OBSInput + .LINK + Remove-OBSScene + #> + [CmdletBinding(SupportsShouldProcess,ConfirmImpact='High')] + param( + # The name of the item we want to remove + [Parameter(Mandatory,ValueFromPipelineByPropertyName)] + [Alias('SourceName','InputName','SceneName')] + $ItemName + ) + + process { + # If we remove an input, we don't want to remove a scene + $removedAnInput = $false + # Go over each input + foreach ($obsInput in Get-OBSInput) { + # If it matches our wildcard and we confirm + if ($obsInput.InputName -like $ItemName -and + $PSCmdlet.ShouldProcess("Remove input $($obsInput.InputName)")) { + # remove it. + Remove-OBSInput -InputName $obsInput.InputName + $removedAnInput = $true + } + } + + # Return if we removed an input. + if ($removedAnInput) { return } + + # Go over all scenes + foreach ($obsScene in (Get-OBSScene).Scenes) { + # If the name matches our wildcard and we confirm + if ($obsScene.SceneName -like $ItemName -and + $PSCmdlet.ShouldProcess("Remove scene $($obsScene.SceneName)")) { + # remove the scene. + Remove-OBSScene -SceneName $obsScene.SceneName + } + } + } +} \ No newline at end of file From 140d43092f28395988a6c5da80e4a387b51ff160 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sat, 11 Mar 2023 00:55:31 +0000 Subject: [PATCH 159/181] Adding Remove-OBS (Fixes #68) --- obs-powershell.psd1 | 1 + 1 file changed, 1 insertion(+) diff --git a/obs-powershell.psd1 b/obs-powershell.psd1 index c075e1ae6..b91db9021 100644 --- a/obs-powershell.psd1 +++ b/obs-powershell.psd1 @@ -103,6 +103,7 @@ Initial Release of obs-powershell 'Connect-OBS', 'Disconnect-OBS', 'Receive-OBS', +'Remove-OBS', 'Send-OBS', 'Watch-OBS', 'Add-OBSBrowserSource', From 9f94868346bcf6605f9a2dec4b1a018e4c22c760 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sat, 11 Mar 2023 00:55:52 +0000 Subject: [PATCH 160/181] Adding Remove-OBS (Fixes #68) --- docs/Remove-OBS.md | 90 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 docs/Remove-OBS.md diff --git a/docs/Remove-OBS.md b/docs/Remove-OBS.md new file mode 100644 index 000000000..a011974cc --- /dev/null +++ b/docs/Remove-OBS.md @@ -0,0 +1,90 @@ +Remove-OBS +---------- + + + + +### Synopsis +Remove OBS + + + +--- + + +### Description + +Removes items from OBS + + + +--- + + +### Related Links +* [Remove-OBSInput](Remove-OBSInput.md) + + + +* [Remove-OBSScene](Remove-OBSScene.md) + + + + + +--- + + +### Examples +#### EXAMPLE 1 +```PowerShell +Remove-OBS -SourceName "foo" +``` + +#### EXAMPLE 2 +```PowerShell +Remove-OBS -SceneName "bar" +``` + + + +--- + + +### Parameters +#### **ItemName** + +The name of the item we want to remove + + + + + + +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------------------------------------| +|`[Object]`|true |1 |true (ByPropertyName)|SourceName
InputName
SceneName| + + + +#### **WhatIf** +-WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. +-WhatIf is used to see what would happen, or return operations without executing them +#### **Confirm** +-Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. +-Confirm is used to -Confirm each operation. + +If you pass ```-Confirm:$false``` you will not be prompted. + + +If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. + + + +--- + + +### Syntax +```PowerShell +Remove-OBS [-ItemName] [-WhatIf] [-Confirm] [] +``` From 9650032ce16019f3d728826dce285378be9a5941 Mon Sep 17 00:00:00 2001 From: James Brundage <@github.com> Date: Fri, 10 Mar 2023 17:02:13 -0800 Subject: [PATCH 161/181] Adding Hide-OBS (Fixes #67) --- Commands/Hide-OBS.ps1 | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 Commands/Hide-OBS.ps1 diff --git a/Commands/Hide-OBS.ps1 b/Commands/Hide-OBS.ps1 new file mode 100644 index 000000000..48e47cc90 --- /dev/null +++ b/Commands/Hide-OBS.ps1 @@ -0,0 +1,43 @@ +function Hide-OBS { + <# + .SYNOPSIS + Hide OBS + .DESCRIPTION + Hides items in OBS + .EXAMPLE + Hide-OBS -SourceName "foo" + .LINK + Set-OBSSceneItemEnabled + #> + [CmdletBinding(SupportsShouldProcess,ConfirmImpact='Medium')] + param( + # The name of the item we want to Hide + [Parameter(Mandatory,ValueFromPipelineByPropertyName)] + [Alias('SourceName','InputName','SceneName')] + $ItemName, + + # The name of the scene. If not provided, the current program scene will be used. + [Parameter(ValueFromPipelineByPropertyName)] + [string] + $SceneName + ) + + process { + # If no scene was provided + if (-not $SceneName) { + # find the current program scene + $sceneName = Get-OBSCurrentProgramScene + } + + # Walk over all items in the scene + foreach ($sceneItem in Get-OBSSceneItem -SceneName $SceneName) { + # If the match our wildcard and we confirm, remove it. + if ($sceneItem.SourceName -like $sourceName -and + $PSCmdlet.ShouldProcess("Hide input $($sceneItem.SourceName)")) { + # Hide it. + $sceneItem | Set-OBSSceneItemEnabled -SceneItemEnabled:$false + } + } + } +} + From e02cff4bbb277e9999d9f60a28084eccd09903f5 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sat, 11 Mar 2023 01:03:30 +0000 Subject: [PATCH 162/181] Adding Hide-OBS (Fixes #67) --- obs-powershell.psd1 | 1 + 1 file changed, 1 insertion(+) diff --git a/obs-powershell.psd1 b/obs-powershell.psd1 index b91db9021..9a613f9bb 100644 --- a/obs-powershell.psd1 +++ b/obs-powershell.psd1 @@ -102,6 +102,7 @@ Initial Release of obs-powershell FunctionsToExport = 'Clear-OBSScene', 'Connect-OBS', 'Disconnect-OBS', +'Hide-OBS', 'Receive-OBS', 'Remove-OBS', 'Send-OBS', From 2d1a91bdd4fde2849771484fce1cdb8556fba8a3 Mon Sep 17 00:00:00 2001 From: James Brundage <@github.com> Date: Fri, 10 Mar 2023 17:06:16 -0800 Subject: [PATCH 163/181] Hide-OBS: Fixing parameter signature (re #67) --- Commands/Hide-OBS.ps1 | 2 +- Commands/Show-OBS.ps1 | 147 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 148 insertions(+), 1 deletion(-) create mode 100644 Commands/Show-OBS.ps1 diff --git a/Commands/Hide-OBS.ps1 b/Commands/Hide-OBS.ps1 index 48e47cc90..5f7565089 100644 --- a/Commands/Hide-OBS.ps1 +++ b/Commands/Hide-OBS.ps1 @@ -13,7 +13,7 @@ function Hide-OBS { param( # The name of the item we want to Hide [Parameter(Mandatory,ValueFromPipelineByPropertyName)] - [Alias('SourceName','InputName','SceneName')] + [Alias('SourceName','InputName')] $ItemName, # The name of the scene. If not provided, the current program scene will be used. diff --git a/Commands/Show-OBS.ps1 b/Commands/Show-OBS.ps1 new file mode 100644 index 000000000..f4c6b4715 --- /dev/null +++ b/Commands/Show-OBS.ps1 @@ -0,0 +1,147 @@ +function Show-OBS { + <# + .SYNOPSIS + Shows content in OBS + .DESCRIPTION + Shows content in Open Broadcasting Studio + .EXAMPLE + ' + + ' | Set-Content .\BlueRect.svg + Show-OBS -FilePath .\BlueRect.svg + .EXAMPLE + Show-OBS -FilePath *excited* -RootPath $home\Pictures\Gif + #> + param( + # The path or URI to show in OBS. + [Parameter(Mandatory,ValueFromPipelineByPropertyName)] + [Alias('FullName','Src', 'Uri','FileName')] + [string] + $FilePath, + + # The name of the source in OBS. + # If this is not provided, it will be derived from the -FilePath. + [Parameter(ValueFromPipelineByPropertyName)] + [string] + $Name, + + # A root path. + # If not provided, this will be the root of the -FilePath (if it is a filepath). + # If the file path was a URI, the root path will be ignored. + [Parameter(ValueFromPipelineByPropertyName)] + [string] + $RootPath, + + # The name of the scene. + # If no scene name is provided, the current program scene will be used. + [Parameter(ValueFromPipelineByPropertyName)] + [string] + $Scene, + + # The opacity to use for the input. + # If not provided, will default to 2/3rds. + # Will only be used when showing a browser source with a -FilePath + [Parameter(ValueFromPipelineByPropertyName)] + [double] + $Opacity = (2/3), + + # Any parameters to pass to the source command. + [Parameter(ValueFromPipelineByPropertyName)] + [Collections.IDictionary] + $SourceParameter = [ordered]@{}, + + # If set, will check if the source exists in the scene before creating it and removing any existing sources found. + # If not set, you will get an error if a source with the same name exists. + [Parameter(ValueFromPipelineByPropertyName)] + [switch] + $Force + ) + + process { + # If we had a -RootPath + if ($RootPath) { + # Look in the root path + $imageFiles = @(Get-ChildItem $RootPath -Recurse -File| + # For files like this keyword + Where-Object FullName -like "*$filePath*" | + # that are extensions we could show + Where-Object Extension -in '.html', '.jpg', '.jpeg', '.gif', '.apng', '.png' + ) + if ($imageFiles.Count) { + $FilePath = ($imageFiles | Get-Random).FullName + } + } + + + + # Determine if the thing we are showing will be a ffmpeg source. + $IsMediaSource = + # If it's an http path, it's not + if ($FilePath -like 'http*') { + $false + } elseif ( + # If it's an HTML-friendly path, it's not + $FilePath -match '.(?>html?|gif|jpe?g|a?png|svg)$' + ) { + $false + } else { + # Otherwise, let's give it a try. + $true + } + + if (-not $RootPath -and $filePath -notlike 'http*') { + $RootPath = "$($FilePath | Split-Path)" + } + + # If we provided a scene + if ($Scene) { + # pass it down. + $SourceParameter.Scene = $Scene + } + + # If we want to use -Force + if ($Force) { + # pass it down + $SourceParameter.Force = $Force + } + + if (-not $IsMediaSource) { + # Create a browser source + $SourceParameter.Uri = $FilePath + if ($RootPath -and $FilePath -notmatch '\.html{0,1}$') { + # Make a minimal frame in a .html file + $relativePath = $FilePath.Substring($RootPath.Length + 1) + $htmlFrame = " + + ' + + " + + $leafPath = $filePath | Split-Path -Leaf + $htmlPath = Join-Path $RootPath "$($leafPath).html" + + $htmlFrame | Set-Content -Path $htmlPath + # And set up the CSS for that frame. + $css = " + body { + background-color: rgba(0, 0, 0, 0); margin: 0px auto; overflow: hidden; + } + img { + width: 100% + height: 100%; + opacity: $opacity; + } + " + $SourceParameter.Uri = $htmlPath + $SourceParameter.CSS = $css + Add-OBSBrowserSource @SourceParameter + } else { + Add-OBSBrowserSource @SourceParameter + } + + } else { + $SourceParameter.FilePath = $FilePath + Add-OBSMediaSource @SourceParameter + } + } +} \ No newline at end of file From 74b631628462ee3acc36edd84174f1a48a799013 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sat, 11 Mar 2023 01:07:31 +0000 Subject: [PATCH 164/181] Hide-OBS: Fixing parameter signature (re #67) --- obs-powershell.psd1 | 1 + 1 file changed, 1 insertion(+) diff --git a/obs-powershell.psd1 b/obs-powershell.psd1 index 9a613f9bb..d2131c15e 100644 --- a/obs-powershell.psd1 +++ b/obs-powershell.psd1 @@ -106,6 +106,7 @@ Initial Release of obs-powershell 'Receive-OBS', 'Remove-OBS', 'Send-OBS', +'Show-OBS', 'Watch-OBS', 'Add-OBSBrowserSource', 'Add-OBSColorSource', From 69252d2845426ee3033bb87668cc7352d449b081 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sat, 11 Mar 2023 01:07:56 +0000 Subject: [PATCH 165/181] Hide-OBS: Fixing parameter signature (re #67) --- docs/Hide-OBS.md | 96 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) create mode 100644 docs/Hide-OBS.md diff --git a/docs/Hide-OBS.md b/docs/Hide-OBS.md new file mode 100644 index 000000000..8e49a5a16 --- /dev/null +++ b/docs/Hide-OBS.md @@ -0,0 +1,96 @@ +Hide-OBS +-------- + + + + +### Synopsis +Hide OBS + + + +--- + + +### Description + +Hides items in OBS + + + +--- + + +### Related Links +* [Set-OBSSceneItemEnabled](Set-OBSSceneItemEnabled.md) + + + + + +--- + + +### Examples +#### EXAMPLE 1 +```PowerShell +Hide-OBS -SourceName "foo" +``` + + + +--- + + +### Parameters +#### **ItemName** + +The name of the item we want to Hide + + + + + + +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------| +|`[Object]`|true |1 |true (ByPropertyName)|SourceName
InputName| + + + +#### **SceneName** + +The name of the scene. If not provided, the current program scene will be used. + + + + + + +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |2 |true (ByPropertyName)| + + + +#### **WhatIf** +-WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. +-WhatIf is used to see what would happen, or return operations without executing them +#### **Confirm** +-Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. +-Confirm is used to -Confirm each operation. + +If you pass ```-Confirm:$false``` you will not be prompted. + + +If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. + + + +--- + + +### Syntax +```PowerShell +Hide-OBS [-ItemName] [[-SceneName] ] [-WhatIf] [-Confirm] [] +``` From ca9cae7b0b1fb3e018872da1f6739dacbfdf1381 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sat, 11 Mar 2023 01:08:01 +0000 Subject: [PATCH 166/181] Hide-OBS: Fixing parameter signature (re #67) --- docs/Show-OBS.md | 163 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 163 insertions(+) create mode 100644 docs/Show-OBS.md diff --git a/docs/Show-OBS.md b/docs/Show-OBS.md new file mode 100644 index 000000000..82c5dc2cd --- /dev/null +++ b/docs/Show-OBS.md @@ -0,0 +1,163 @@ +Show-OBS +-------- + + + + +### Synopsis +Shows content in OBS + + + +--- + + +### Description + +Shows content in Open Broadcasting Studio + + + +--- + + +### Examples +#### EXAMPLE 1 +```PowerShell + +' | Set-Content .\BlueRect.svg +Show-OBS -FilePath .\BlueRect.svg +``` + +#### EXAMPLE 2 +```PowerShell +Show-OBS -FilePath *excited* -RootPath $home\Pictures\Gif +``` + + + +--- + + +### Parameters +#### **FilePath** + +The path or URI to show in OBS. + + + + + + +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------------------------------| +|`[String]`|true |1 |true (ByPropertyName)|FullName
Src
Uri
FileName| + + + +#### **Name** + +The name of the source in OBS. +If this is not provided, it will be derived from the -FilePath. + + + + + + +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |2 |true (ByPropertyName)| + + + +#### **RootPath** + +A root path. +If not provided, this will be the root of the -FilePath (if it is a filepath). +If the file path was a URI, the root path will be ignored. + + + + + + +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| + + + +#### **Scene** + +The name of the scene. +If no scene name is provided, the current program scene will be used. + + + + + + +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |4 |true (ByPropertyName)| + + + +#### **Opacity** + +The opacity to use for the input. +If not provided, will default to 2/3rds. +Will only be used when showing a browser source with a -FilePath + + + + + + +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |5 |true (ByPropertyName)| + + + +#### **SourceParameter** + +Any parameters to pass to the source command. + + + + + + +|Type |Required|Position|PipelineInput | +|---------------|--------|--------|---------------------| +|`[IDictionary]`|false |6 |true (ByPropertyName)| + + + +#### **Force** + +If set, will check if the source exists in the scene before creating it and removing any existing sources found. +If not set, you will get an error if a source with the same name exists. + + + + + + +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| + + + + + +--- + + +### Syntax +```PowerShell +Show-OBS [-FilePath] [[-Name] ] [[-RootPath] ] [[-Scene] ] [[-Opacity] ] [[-SourceParameter] ] [-Force] [] +``` From 01915790020a1367a14de2a2a69f6f03c8be84b2 Mon Sep 17 00:00:00 2001 From: James Brundage <@github.com> Date: Fri, 10 Mar 2023 17:08:42 -0800 Subject: [PATCH 167/181] Adding Show-OBS (Fixes #66) --- Commands/Show-OBS.ps1 | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/Commands/Show-OBS.ps1 b/Commands/Show-OBS.ps1 index f4c6b4715..9e2c2e4ee 100644 --- a/Commands/Show-OBS.ps1 +++ b/Commands/Show-OBS.ps1 @@ -105,11 +105,13 @@ function Show-OBS { $SourceParameter.Force = $Force } + # If we do not want to create a media source, if (-not $IsMediaSource) { - # Create a browser source + # we create a browser source. $SourceParameter.Uri = $FilePath + # If the path was not already HTML, if ($RootPath -and $FilePath -notmatch '\.html{0,1}$') { - # Make a minimal frame in a .html file + # we make a minimal frame in a .html file $relativePath = $FilePath.Substring($RootPath.Length + 1) $htmlFrame = " @@ -121,7 +123,8 @@ function Show-OBS { $htmlPath = Join-Path $RootPath "$($leafPath).html" $htmlFrame | Set-Content -Path $htmlPath - # And set up the CSS for that frame. + # And set up the CSS for that frame, passing down -Opacity. + # (this may not work for all images) $css = " body { background-color: rgba(0, 0, 0, 0); margin: 0px auto; overflow: hidden; @@ -134,7 +137,7 @@ function Show-OBS { " $SourceParameter.Uri = $htmlPath $SourceParameter.CSS = $css - Add-OBSBrowserSource @SourceParameter + Add-OBSBrowserSource @SourceParameter } else { Add-OBSBrowserSource @SourceParameter } From a1089b0f18da9d19580a34ef42496e59e35e778f Mon Sep 17 00:00:00 2001 From: James Brundage <@github.com> Date: Fri, 10 Mar 2023 17:24:00 -0800 Subject: [PATCH 168/181] Add-OBS*Source Commands: Supporting -SceneItemEnabled (Fixes #70) --- Commands/Sources/Add-OBSBrowserSource.ps.ps1 | 15 ++++++++++++++- Commands/Sources/Add-OBSColorSource.ps.ps1 | 7 +++++++ Commands/Sources/Add-OBSDisplaySource.ps.ps1 | 7 ++++++- 3 files changed, 27 insertions(+), 2 deletions(-) diff --git a/Commands/Sources/Add-OBSBrowserSource.ps.ps1 b/Commands/Sources/Add-OBSBrowserSource.ps.ps1 index 8927c8d48..ea54dc798 100644 --- a/Commands/Sources/Add-OBSBrowserSource.ps.ps1 +++ b/Commands/Sources/Add-OBSBrowserSource.ps.ps1 @@ -158,8 +158,21 @@ function Add-OBSBrowserSource Remove-OBSInput -InputName { $_.SourceName } } + + $addObsInputParams = [Ordered]@{ + sceneName = $myParameters["Scene"] + inputKind = "browser_source" + inputSettings = $myParameterData + inputName = $Name + } + # If -SceneItemEnabled was passed, + if ($myParameters.Contains('SceneItemEnabled')) { + # propagate it to Add-OBSInput. + $addObsInputParams.SceneItemEnabled = $myParameters['SceneItemEnabled'] -as [bool] + } + $outputAddedResult = - Add-OBSInput -sceneName $myParameters["Scene"] -inputKind "browser_source" -inputSettings $myParameterData -inputName $Name + Add-OBSInput @addObsInputParams if ($outputAddedResult) { Get-OBSSceneItem -sceneName $myParameters["Scene"] | diff --git a/Commands/Sources/Add-OBSColorSource.ps.ps1 b/Commands/Sources/Add-OBSColorSource.ps.ps1 index 225da043e..4c2bf0fea 100644 --- a/Commands/Sources/Add-OBSColorSource.ps.ps1 +++ b/Commands/Sources/Add-OBSColorSource.ps.ps1 @@ -113,6 +113,13 @@ function Add-OBSColorSource Remove-OBSInput -InputName { $_.SourceName } } + + # If -SceneItemEnabled was passed, + if ($myParameters.Contains('SceneItemEnabled')) { + # propagate it to Add-OBSInput. + $addObsInputParams.SceneItemEnabled = $myParameters['SceneItemEnabled'] -as [bool] + } + $outputAddedResult = Add-OBSInput @addObsInputParams if ($outputAddedResult) { Get-OBSSceneItem -sceneName $myParameters["Scene"] | diff --git a/Commands/Sources/Add-OBSDisplaySource.ps.ps1 b/Commands/Sources/Add-OBSDisplaySource.ps.ps1 index f65a4ab6c..4f35b726b 100644 --- a/Commands/Sources/Add-OBSDisplaySource.ps.ps1 +++ b/Commands/Sources/Add-OBSDisplaySource.ps.ps1 @@ -99,7 +99,12 @@ function Add-OBSDisplaySource Where-Object SourceName -eq $myParameters["Name"] | Remove-OBSInput -InputName { $_.SourceName } } - + + # If -SceneItemEnabled was passed, + if ($myParameters.Contains('SceneItemEnabled')) { + # propagate it to Add-OBSInput. + $addSplat.SceneItemEnabled = $myParameters['SceneItemEnabled'] -as [bool] + } $outputAddedResult = Add-OBSInput @addObsInputParams if ($outputAddedResult) { From 4ae733df94fd964fabc47896de1fe0de347ed213 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sat, 11 Mar 2023 01:25:15 +0000 Subject: [PATCH 169/181] Add-OBS*Source Commands: Supporting -SceneItemEnabled (Fixes #70) --- Commands/Sources/Add-OBSBrowserSource.ps1 | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/Commands/Sources/Add-OBSBrowserSource.ps1 b/Commands/Sources/Add-OBSBrowserSource.ps1 index 9758c95c0..91ca3d077 100644 --- a/Commands/Sources/Add-OBSBrowserSource.ps1 +++ b/Commands/Sources/Add-OBSBrowserSource.ps1 @@ -172,8 +172,20 @@ dynamicParam { Where-Object SourceName -eq $name | Remove-OBSInput -InputName { $_.SourceName } } + $addObsInputParams = [Ordered]@{ + sceneName = $myParameters["Scene"] + inputKind = "browser_source" + inputSettings = $myParameterData + inputName = $Name + } + # If -SceneItemEnabled was passed, + if ($myParameters.Contains('SceneItemEnabled')) { + # propagate it to Add-OBSInput. + $addObsInputParams.SceneItemEnabled = $myParameters['SceneItemEnabled'] -as [bool] + } + $outputAddedResult = - Add-OBSInput -sceneName $myParameters["Scene"] -inputKind "browser_source" -inputSettings $myParameterData -inputName $Name + Add-OBSInput @addObsInputParams if ($outputAddedResult) { Get-OBSSceneItem -sceneName $myParameters["Scene"] | Where-Object SourceName -eq $name From 925c14a56838d658fe501dbf4dcb5240d043fcd1 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sat, 11 Mar 2023 01:25:15 +0000 Subject: [PATCH 170/181] Add-OBS*Source Commands: Supporting -SceneItemEnabled (Fixes #70) --- Commands/Sources/Add-OBSColorSource.ps1 | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Commands/Sources/Add-OBSColorSource.ps1 b/Commands/Sources/Add-OBSColorSource.ps1 index a0af3be5a..2a5378b87 100644 --- a/Commands/Sources/Add-OBSColorSource.ps1 +++ b/Commands/Sources/Add-OBSColorSource.ps1 @@ -136,6 +136,11 @@ dynamicParam { Where-Object SourceName -eq $myParameters["Name"] | Remove-OBSInput -InputName { $_.SourceName } } + # If -SceneItemEnabled was passed, + if ($myParameters.Contains('SceneItemEnabled')) { + # propagate it to Add-OBSInput. + $addObsInputParams.SceneItemEnabled = $myParameters['SceneItemEnabled'] -as [bool] + } $outputAddedResult = Add-OBSInput @addObsInputParams if ($outputAddedResult) { Get-OBSSceneItem -sceneName $myParameters["Scene"] | From 52a768deb6912202fddc9c670c1346ba60bb2846 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sat, 11 Mar 2023 01:25:15 +0000 Subject: [PATCH 171/181] Add-OBS*Source Commands: Supporting -SceneItemEnabled (Fixes #70) --- Commands/Sources/Add-OBSDisplaySource.ps1 | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Commands/Sources/Add-OBSDisplaySource.ps1 b/Commands/Sources/Add-OBSDisplaySource.ps1 index e276d4fdf..69c39486a 100644 --- a/Commands/Sources/Add-OBSDisplaySource.ps1 +++ b/Commands/Sources/Add-OBSDisplaySource.ps1 @@ -123,7 +123,11 @@ dynamicParam { Where-Object SourceName -eq $myParameters["Name"] | Remove-OBSInput -InputName { $_.SourceName } } - + # If -SceneItemEnabled was passed, + if ($myParameters.Contains('SceneItemEnabled')) { + # propagate it to Add-OBSInput. + $addSplat.SceneItemEnabled = $myParameters['SceneItemEnabled'] -as [bool] + } $outputAddedResult = Add-OBSInput @addObsInputParams if ($outputAddedResult) { Get-OBSSceneItem -sceneName $myParameters["Scene"] | From 6ce46b51d142615b91ab91ac7d41efa585f40c30 Mon Sep 17 00:00:00 2001 From: James Brundage <@github.com> Date: Fri, 10 Mar 2023 17:25:52 -0800 Subject: [PATCH 172/181] Add-OBSMediaSource, adding -FitToScreen --- Commands/Sources/Add-OBSMediaSource.ps.ps1 | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/Commands/Sources/Add-OBSMediaSource.ps.ps1 b/Commands/Sources/Add-OBSMediaSource.ps.ps1 index 1f6a9715f..4795b6377 100644 --- a/Commands/Sources/Add-OBSMediaSource.ps.ps1 +++ b/Commands/Sources/Add-OBSMediaSource.ps.ps1 @@ -74,7 +74,12 @@ function Add-OBSMediaSource # If not set, you will get an error if a source with the same name exists. [Parameter(ValueFromPipelineByPropertyName)] [switch] - $Force + $Force, + + # If set, will fit the input to the screen. + [Parameter(ValueFromPipelineByPropertyName)] + [switch] + $FitToScreen ) process { @@ -155,7 +160,13 @@ function Add-OBSMediaSource $outputAddedResult = Add-OBSInput @addSplat if ($outputAddedResult) { Get-OBSSceneItem -sceneName $myParameters["Scene"] | - Where-Object SourceName -eq $name + Where-Object SourceName -eq $name | + Foreach-Object { + if ($FitToScreen) { + $_.FitToScreen() + } + $_ + } } } } \ No newline at end of file From 3d5143fae2006d8e8ccf06c5d10b183359857829 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sat, 11 Mar 2023 01:27:07 +0000 Subject: [PATCH 173/181] Add-OBSMediaSource, adding -FitToScreen --- Commands/Sources/Add-OBSMediaSource.ps1 | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/Commands/Sources/Add-OBSMediaSource.ps1 b/Commands/Sources/Add-OBSMediaSource.ps1 index 2d5b7f65e..dfe5d4091 100644 --- a/Commands/Sources/Add-OBSMediaSource.ps1 +++ b/Commands/Sources/Add-OBSMediaSource.ps1 @@ -67,7 +67,11 @@ function Add-OBSMediaSource { # If not set, you will get an error if a source with the same name exists. [Parameter(ValueFromPipelineByPropertyName)] [switch] - $Force + $Force, +# If set, will fit the input to the screen. + [Parameter(ValueFromPipelineByPropertyName)] + [switch] + $FitToScreen ) dynamicParam { $baseCommand = @@ -170,7 +174,13 @@ dynamicParam { $outputAddedResult = Add-OBSInput @addSplat if ($outputAddedResult) { Get-OBSSceneItem -sceneName $myParameters["Scene"] | - Where-Object SourceName -eq $name + Where-Object SourceName -eq $name | + Foreach-Object { + if ($FitToScreen) { + $_.FitToScreen() + } + $_ + } } } From e461bac196814d7743748d7d718f21c72e36bd53 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sat, 11 Mar 2023 01:27:23 +0000 Subject: [PATCH 174/181] Add-OBSMediaSource, adding -FitToScreen --- docs/Add-OBSMediaSource.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/Add-OBSMediaSource.md b/docs/Add-OBSMediaSource.md index 20c7b5eea..1b217625c 100644 --- a/docs/Add-OBSMediaSource.md +++ b/docs/Add-OBSMediaSource.md @@ -180,6 +180,21 @@ If not set, you will get an error if a source with the same name exists. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| + + + +#### **FitToScreen** + +If set, will fit the input to the screen. + + + + + + |Type |Required|Position|PipelineInput | |----------|--------|--------|---------------------| |`[Switch]`|false |named |true (ByPropertyName)| @@ -193,5 +208,5 @@ If not set, you will get an error if a source with the same name exists. ### Syntax ```PowerShell -Add-OBSMediaSource [-FilePath] [-CloseWhenInactive] [-Loop] [-UseHardwareDecoding] [-ClearOnMediaEnd] [[-FFMpegOption] ] [[-Scene] ] [[-Name] ] [-Force] [] +Add-OBSMediaSource [-FilePath] [-CloseWhenInactive] [-Loop] [-UseHardwareDecoding] [-ClearOnMediaEnd] [[-FFMpegOption] ] [[-Scene] ] [[-Name] ] [-Force] [-FitToScreen] [] ``` From 9bd92cb1132762912f16907c11d03a4e4a2d5baa Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sat, 11 Mar 2023 01:27:34 +0000 Subject: [PATCH 175/181] Add-OBSMediaSource, adding -FitToScreen --- docs/Add-OBSFFMpegSource.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/Add-OBSFFMpegSource.md b/docs/Add-OBSFFMpegSource.md index 20c7b5eea..1b217625c 100644 --- a/docs/Add-OBSFFMpegSource.md +++ b/docs/Add-OBSFFMpegSource.md @@ -180,6 +180,21 @@ If not set, you will get an error if a source with the same name exists. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| + + + +#### **FitToScreen** + +If set, will fit the input to the screen. + + + + + + |Type |Required|Position|PipelineInput | |----------|--------|--------|---------------------| |`[Switch]`|false |named |true (ByPropertyName)| @@ -193,5 +208,5 @@ If not set, you will get an error if a source with the same name exists. ### Syntax ```PowerShell -Add-OBSMediaSource [-FilePath] [-CloseWhenInactive] [-Loop] [-UseHardwareDecoding] [-ClearOnMediaEnd] [[-FFMpegOption] ] [[-Scene] ] [[-Name] ] [-Force] [] +Add-OBSMediaSource [-FilePath] [-CloseWhenInactive] [-Loop] [-UseHardwareDecoding] [-ClearOnMediaEnd] [[-FFMpegOption] ] [[-Scene] ] [[-Name] ] [-Force] [-FitToScreen] [] ``` From 6897cf10d073e1698d05f5f3feaff33a71f8b670 Mon Sep 17 00:00:00 2001 From: James Brundage <@github.com> Date: Fri, 10 Mar 2023 17:31:54 -0800 Subject: [PATCH 176/181] Show-OBS: Adding -FitToScreen (re #66) --- Commands/Show-OBS.ps1 | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/Commands/Show-OBS.ps1 b/Commands/Show-OBS.ps1 index 9e2c2e4ee..8b9af1947 100644 --- a/Commands/Show-OBS.ps1 +++ b/Commands/Show-OBS.ps1 @@ -54,9 +54,23 @@ function Show-OBS { # If not set, you will get an error if a source with the same name exists. [Parameter(ValueFromPipelineByPropertyName)] [switch] - $Force + $Force, + + # If set, will make the input become the size of the screen. + [Parameter(ValueFromPipelineByPropertyName)] + [switch] + $FitToScreen ) + begin { + filter FitToScreenAndOutput { + if ($FitToScreen -and $_.FitToScreen) { + $_.FitToScreen() + } + $_ + } + } + process { # If we had a -RootPath if ($RootPath) { @@ -137,14 +151,14 @@ function Show-OBS { " $SourceParameter.Uri = $htmlPath $SourceParameter.CSS = $css - Add-OBSBrowserSource @SourceParameter + Add-OBSBrowserSource @SourceParameter | FitToScreenAndOutput } else { - Add-OBSBrowserSource @SourceParameter + Add-OBSBrowserSource @SourceParameter | FitToScreenAndOutput } } else { $SourceParameter.FilePath = $FilePath - Add-OBSMediaSource @SourceParameter + Add-OBSMediaSource @SourceParameter | FitToScreenAndOutput } } } \ No newline at end of file From f982e082a95748dc33ffab541e101db4d867fa5a Mon Sep 17 00:00:00 2001 From: James Brundage <@github.com> Date: Fri, 10 Mar 2023 17:32:21 -0800 Subject: [PATCH 177/181] Hide-OBS: Fixing filter (re #67) --- Commands/Hide-OBS.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Commands/Hide-OBS.ps1 b/Commands/Hide-OBS.ps1 index 5f7565089..9b829ee4e 100644 --- a/Commands/Hide-OBS.ps1 +++ b/Commands/Hide-OBS.ps1 @@ -32,7 +32,7 @@ function Hide-OBS { # Walk over all items in the scene foreach ($sceneItem in Get-OBSSceneItem -SceneName $SceneName) { # If the match our wildcard and we confirm, remove it. - if ($sceneItem.SourceName -like $sourceName -and + if ($sceneItem.SourceName -like $ItemName -and $PSCmdlet.ShouldProcess("Hide input $($sceneItem.SourceName)")) { # Hide it. $sceneItem | Set-OBSSceneItemEnabled -SceneItemEnabled:$false From 6ee6de68bc6b6b88308ade0589e342fc0fc5c31b Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sat, 11 Mar 2023 01:33:44 +0000 Subject: [PATCH 178/181] Show-OBS: Adding -FitToScreen (re #66) --- docs/Show-OBS.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/Show-OBS.md b/docs/Show-OBS.md index 82c5dc2cd..dede41754 100644 --- a/docs/Show-OBS.md +++ b/docs/Show-OBS.md @@ -146,6 +146,21 @@ If not set, you will get an error if a source with the same name exists. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| + + + +#### **FitToScreen** + +If set, will make the input become the size of the screen. + + + + + + |Type |Required|Position|PipelineInput | |----------|--------|--------|---------------------| |`[Switch]`|false |named |true (ByPropertyName)| @@ -159,5 +174,5 @@ If not set, you will get an error if a source with the same name exists. ### Syntax ```PowerShell -Show-OBS [-FilePath] [[-Name] ] [[-RootPath] ] [[-Scene] ] [[-Opacity] ] [[-SourceParameter] ] [-Force] [] +Show-OBS [-FilePath] [[-Name] ] [[-RootPath] ] [[-Scene] ] [[-Opacity] ] [[-SourceParameter] ] [-Force] [-FitToScreen] [] ``` From 810b98f8712e0b11b7ce6ca199644f4e7e6f5c1d Mon Sep 17 00:00:00 2001 From: James Brundage <@github.com> Date: Fri, 10 Mar 2023 17:35:16 -0800 Subject: [PATCH 179/181] Updating Module Version [0.1.7] and CHANGELOG --- CHANGELOG.md | 13 +++++++++++++ obs-powershell.ps.psd1 | 17 +++++++++++++++-- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 09aa4da6d..aea783963 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,16 @@ +## obs-powershell 0.1.7: + +* New Commands: + * Show-OBS (Fixes #66) + * Hide-OBS (Fixes #67) + * Remove-OBS (Fixes #68) + +* Adding -Force to Add-OBS*Source commands (Fixes #69) +* Add-OBS*Source Commands: Supporting -SceneItemEnabled (Fixes #70) +* Add-OBSMediaSource, adding -FitToScreen (Fixes #71) + +--- + ## obs-powershell 0.1.6: * Adding OBS.SceneItem .Scale (Fixes #64) diff --git a/obs-powershell.ps.psd1 b/obs-powershell.ps.psd1 index ed8e83cbd..a5dafa0f2 100644 --- a/obs-powershell.ps.psd1 +++ b/obs-powershell.ps.psd1 @@ -1,11 +1,11 @@ @{ - ModuleVersion = '0.1.6' + ModuleVersion = '0.1.7' RootModule = 'obs-powershell.psm1' Description = 'Script OBS with PowerShell' Guid = '1417123e-a932-439f-9b68-a7313cf1e170' Author = 'James Brundage' CompanyName = 'Start-Automating' - Copyright = '2022 Start-Automating' + Copyright = '2022-2023 Start-Automating' FormatsToProcess = 'obs-powershell.format.ps1xml' TypesToProcess = 'obs-powershell.types.ps1xml' RequiredModules = 'ThreadJob' @@ -16,6 +16,19 @@ ProjectURI = 'https://github.com/StartAutomating/obs-powershell' LicenseURI = 'https://github.com/StartAutomating/obs-powershell/blob/main/LICENSE' ReleaseNotes = @' +## obs-powershell 0.1.7: + +* New Commands: + * Show-OBS (Fixes #66) + * Hide-OBS (Fixes #67) + * Remove-OBS (Fixes #68) + +* Adding -Force to Add-OBS*Source commands (Fixes #69) +* Add-OBS*Source Commands: Supporting -SceneItemEnabled (Fixes #70) +* Add-OBSMediaSource, adding -FitToScreen (Fixes #71) + +--- + ## obs-powershell 0.1.6: * Adding OBS.SceneItem .Scale (Fixes #64) From 183555b86978b79cc547c2fb4c88577c430d4fa3 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sat, 11 Mar 2023 01:36:31 +0000 Subject: [PATCH 180/181] Updating Module Version [0.1.7] and CHANGELOG --- obs-powershell.psd1 | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/obs-powershell.psd1 b/obs-powershell.psd1 index d2131c15e..1cfdbb044 100644 --- a/obs-powershell.psd1 +++ b/obs-powershell.psd1 @@ -1,11 +1,11 @@ @{ - ModuleVersion = '0.1.6' + ModuleVersion = '0.1.7' RootModule = 'obs-powershell.psm1' Description = 'Script OBS with PowerShell' Guid = '1417123e-a932-439f-9b68-a7313cf1e170' Author = 'James Brundage' CompanyName = 'Start-Automating' - Copyright = '2022 Start-Automating' + Copyright = '2022-2023 Start-Automating' FormatsToProcess = 'obs-powershell.format.ps1xml' TypesToProcess = 'obs-powershell.types.ps1xml' RequiredModules = 'ThreadJob' @@ -16,6 +16,19 @@ ProjectURI = 'https://github.com/StartAutomating/obs-powershell' LicenseURI = 'https://github.com/StartAutomating/obs-powershell/blob/main/LICENSE' ReleaseNotes = @' +## obs-powershell 0.1.7: + +* New Commands: + * Show-OBS (Fixes #66) + * Hide-OBS (Fixes #67) + * Remove-OBS (Fixes #68) + +* Adding -Force to Add-OBS*Source commands (Fixes #69) +* Add-OBS*Source Commands: Supporting -SceneItemEnabled (Fixes #70) +* Add-OBSMediaSource, adding -FitToScreen (Fixes #71) + +--- + ## obs-powershell 0.1.6: * Adding OBS.SceneItem .Scale (Fixes #64) From 50e22a1dfd1463e3ea5ee3b9a7678373eb92fc2e Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sat, 11 Mar 2023 01:37:00 +0000 Subject: [PATCH 181/181] Updating Module Version [0.1.7] and CHANGELOG --- docs/CHANGELOG.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 107fa5ad8..87b67e222 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,3 +1,16 @@ +## obs-powershell 0.1.7: + +* New Commands: + * Show-OBS (Fixes #66) + * Hide-OBS (Fixes #67) + * Remove-OBS (Fixes #68) + +* Adding -Force to Add-OBS*Source commands (Fixes #69) +* Add-OBS*Source Commands: Supporting -SceneItemEnabled (Fixes #70) +* Add-OBSMediaSource, adding -FitToScreen (Fixes #71) + +--- + ## obs-powershell 0.1.6: * Adding OBS.SceneItem .Scale (Fixes #64)