obs-powershell 0.1.7

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)

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')]
+    $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 $ItemName -and
+                $PSCmdlet.ShouldProcess("Hide input $($sceneItem.SourceName)")) {
+                # Hide it.
+                $sceneItem | Set-OBSSceneItemEnabled -SceneItemEnabled:$false
+            }            
+        }
+    }
+}
+

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
+            }
+        }
+    }
+}

Commands/Show-OBS.ps1

@@ -0,0 +1,164 @@
+function Show-OBS {
+    <#
+    .SYNOPSIS
+        Shows content in OBS
+    .DESCRIPTION
+        Shows content in Open Broadcasting Studio
+    .EXAMPLE
+        '<svg viewBox="0 0 1 1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg">
+            <polygon points="0 0 0 1 1 1 1 0" fill="blue" />
+        </svg>' | 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,
+
+    # 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) {
+            # 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 we do not want to create a media source, 
+        if (-not $IsMediaSource) {
+            # we create a browser source.
+            $SourceParameter.Uri = $FilePath
+            # If the path was not already HTML,
+            if ($RootPath -and $FilePath -notmatch '\.html{0,1}$') {
+                # we make a minimal frame in a .html file
+                $relativePath = $FilePath.Substring($RootPath.Length + 1)
+                $htmlFrame = "<html>
+                <body style='width:100%;height:100%'>
+                <img src='$relativePath' style='width:100%;height:100%' />'
+                <body>
+                </html>"
+
+                $leafPath = $filePath | Split-Path -Leaf
+                $htmlPath = Join-Path $RootPath "$($leafPath).html"
+
+                $htmlFrame | Set-Content -Path $htmlPath
+                # 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;                    
+                }
+                img {
+                    width: 100%
+                    height: 100%;
+                    opacity: $opacity;
+                }
+                "
+                $SourceParameter.Uri = $htmlPath
+                $SourceParameter.CSS = $css
+                Add-OBSBrowserSource @SourceParameter | FitToScreenAndOutput
+            } else {
+                Add-OBSBrowserSource @SourceParameter | FitToScreenAndOutput
+            }
+
+        } else {
+            $SourceParameter.FilePath = $FilePath
+            Add-OBSMediaSource @SourceParameter | FitToScreenAndOutput
+        }
+    }
+}

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,8 +150,29 @@ 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 }
+        }
+
+
+        $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"] |

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,8 +165,27 @@ 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 }
+        }
+        $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