help/PSHDHomeRun-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-HDHomeRunRecording</command:name> <command:verb>Get</command:verb> <command:noun>HDHomeRunRecording</command:noun> <maml:description> <maml:para>Get the list of recordings from the HDHomeRun DVR</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the list of recordings from the HDHomeRun DVR</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HDHomeRunRecording</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>HDHomeRunHostnameOrIp</maml:name> <maml:description> <maml:para>The hostname or IP address of the HDHomeRun device</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>PSHDHomeRunSettingsFile</maml:name> <maml:description> <maml:para>The path to the PSHDHomeRunSettings.json file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>UnusedArguments</maml:name> <maml:description> <maml:para>{{ Fill UnusedArguments Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>HDHomeRunHostnameOrIp</maml:name> <maml:description> <maml:para>The hostname or IP address of the HDHomeRun device</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>PSHDHomeRunSettingsFile</maml:name> <maml:description> <maml:para>The path to the PSHDHomeRunSettings.json file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>UnusedArguments</maml:name> <maml:description> <maml:para>{{ Fill UnusedArguments Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>PSHDHomeRun - Manage HDHomeRun DVR using PowerShell and JSON Copyright (C) 2024 Robert D. Biddle</maml:para> <maml:para>This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</maml:para> <maml:para>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</maml:para> <maml:para>You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code># Returns all recordings from the HDHomeRun DVR using $Global:PSHDHomeRunSettings</dev:code> <dev:remarks> <maml:para>Get-HDHomeRunRecording</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code># Returns all recordings from the HDHomeRun DVR, obtains HDHomeRunHostnameOrIp from PSHDHomeRunSettings.json</dev:code> <dev:remarks> <maml:para>Get-HDHomeRunRecording -PSHDHomeRunSettingsFile .\PSHDHomeRunSettings.json</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code># Returns all recordings from the HDHomeRun DVR, specifies HDHomeRunHostnameOrIp explicitly by hostname</dev:code> <dev:remarks> <maml:para>Get-HDHomeRunRecording -HDHomeRunHostnameOrIp HDHomeRun.local</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code># Returns all recordings from the HDHomeRun DVR, specifies HDHomeRunHostnameOrIp explicitly by IP address</dev:code> <dev:remarks> <maml:para>Get-HDHomeRunRecording -HDHomeRunHostnameOrIp 192.168.1.2</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/RobBiddle/PSHDHomeRun</maml:linkText> <maml:uri>https://github.com/RobBiddle/PSHDHomeRun</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PSHDHomeRunSetting</command:name> <command:verb>Get</command:verb> <command:noun>PSHDHomeRunSetting</command:noun> <maml:description> <maml:para>Get the Settings which should be stored in PSHDHomeRunSettings.json file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the Settings which should be stored in PSHDHomeRunSettings.json file, although you can rename the file if you want. Upon Module import, the PSHDHomeRunSettings.json file is used to polulate values in the $PSHDHomeRunSettings variable. If you rename the file you will always need to provide the path to the file for this and other functions in PSHDHomeRun.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PSHDHomeRunSetting</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the PSHDHomeRunSettings.json file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the PSHDHomeRunSettings.json file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>PSHDHomeRun - Manage HDHomeRun DVR using PowerShell and JSON Copyright (C) 2024 Robert D. Biddle</maml:para> <maml:para>This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</maml:para> <maml:para>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</maml:para> <maml:para>You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-PSHDHomeRunSetting</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-PSHDHomeRunSetting -Path .\PSHDHomeRunSettings.json</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/RobBiddle/PSHDHomeRun</maml:linkText> <maml:uri>https://github.com/RobBiddle/PSHDHomeRun</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-PSHDHomeRunCleanup</command:name> <command:verb>Invoke</command:verb> <command:noun>PSHDHomeRunCleanup</command:noun> <maml:description> <maml:para>Invoke the HDHomeRun DVR cleanup process. Very fast! Be careful!</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Invoke the HDHomeRun DVR cleanup process which will delete recordings older than the specified number of days in the PSHDHomeRunSettings.json file. If the ReRecord parameter is set to 1, the episode will be re-recorded if it airs again. If the ReRecord parameter is set to 0, the episode will not be re-recorded. The default value for ReRecord is 0.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-PSHDHomeRunCleanup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>HDHomeRunHostnameOrIp</maml:name> <maml:description> <maml:para>The hostname or IP address of the HDHomeRun device</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>SettingsFilePath</maml:name> <maml:description> <maml:para>The path to the PSHDHomeRunSettings.json file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>ReRecord</maml:name> <maml:description> <maml:para>If 1, attempt to re-record the episode after deletion. Default is 0.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>{{ Fill Title Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none"> <maml:name>NumberOfEpisodesToKeep</maml:name> <maml:description> <maml:para>{{ Fill NumberOfEpisodesToKeep Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="none"> <maml:name>DeleteOlderThanDays</maml:name> <maml:description> <maml:para>{{ Fill DeleteOlderThanDays Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="none"> <maml:name>SortBy</maml:name> <maml:description> <maml:para>{{ Fill SortBy Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>HDHomeRunHostnameOrIp</maml:name> <maml:description> <maml:para>The hostname or IP address of the HDHomeRun device</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>SettingsFilePath</maml:name> <maml:description> <maml:para>The path to the PSHDHomeRunSettings.json file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>ReRecord</maml:name> <maml:description> <maml:para>If 1, attempt to re-record the episode after deletion. Default is 0.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>{{ Fill Title Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none"> <maml:name>NumberOfEpisodesToKeep</maml:name> <maml:description> <maml:para>{{ Fill NumberOfEpisodesToKeep Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="none"> <maml:name>DeleteOlderThanDays</maml:name> <maml:description> <maml:para>{{ Fill DeleteOlderThanDays Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="none"> <maml:name>SortBy</maml:name> <maml:description> <maml:para>{{ Fill SortBy Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>PSHDHomeRun - Manage HDHomeRun DVR using PowerShell and JSON Copyright (C) 2024 Robert D. Biddle</maml:para> <maml:para>This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</maml:para> <maml:para>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</maml:para> <maml:para>You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Invoke the HDHomeRun DVR cleanup process with parameters loaded during Module import</dev:code> <dev:remarks> <maml:para>Invoke-PSHDHomeRunCleanup</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Invoke the HDHomeRun DVR cleanup process with parameters from the PSHDHomeRunSettings.json file</dev:code> <dev:remarks> <maml:para>Invoke-PSHDHomeRunCleanup -SettingsFilePath ".\PSHDHomeRunSettings.json"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Invoke the HDHomeRun DVR cleanup process with explicit parameters</dev:code> <dev:remarks> <maml:para>Invoke-PSHDHomeRunCleanup -HDHomeRunHostnameOrIp "HDHomeRun.local" ` -Title "Jeopardy!" ` -NumberOfEpisodesToKeep 4 ` -DeleteOlderThanDays 30 ` -SortBy "OriginalAirdate"</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/RobBiddle/PSHDHomeRun</maml:linkText> <maml:uri>https://github.com/RobBiddle/PSHDHomeRun</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-HDHomeRunRecording</command:name> <command:verb>Remove</command:verb> <command:noun>HDHomeRunRecording</command:noun> <maml:description> <maml:para>Removes a recording from the HDHomeRun DVR. Very fast! Be careful!</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a recording from the HDHomeRun DVR via the CmdURL property. CmdURL is the only mandatory parameter Upon Module import, the PSHDHomeRunSettings.json file is used to polulate values in the $PSHDHomeRunSettings variable. Accepts pipeline input including extra properties from Get-HDHomeRunRecording.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HDHomeRunRecording</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>CmdURL</maml:name> <maml:description> <maml:para>The CmdURL property from Get-HDHomeRunRecording output</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>ReRecord</maml:name> <maml:description> <maml:para>If 1, attempt to re-record the episode after deletion. Default is 0.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>UnusedArguments</maml:name> <maml:description> <maml:para>{{ Fill UnusedArguments Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>CmdURL</maml:name> <maml:description> <maml:para>The CmdURL property from Get-HDHomeRunRecording output</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>ReRecord</maml:name> <maml:description> <maml:para>If 1, attempt to re-record the episode after deletion. Default is 0.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>UnusedArguments</maml:name> <maml:description> <maml:para>{{ Fill UnusedArguments Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>PSHDHomeRun - Manage HDHomeRun DVR using PowerShell and JSON Copyright (C) 2024 Robert D. Biddle</maml:para> <maml:para>This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</maml:para> <maml:para>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</maml:para> <maml:para>You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Remove-HDHomeRunRecording -CmdURL http://hdhr-11111111.local/recorded/cmd?id=12345678abcdef12</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code># Remove ALL recordings using pipeline input</dev:code> <dev:remarks> <maml:para>Get-HDHomeRunRecording | Remove-HDHomeRunRecording</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code># Remove a specific recording using pipeline input</dev:code> <dev:remarks> <maml:para>Get-HDHomeRunRecording | Where-Object { ($ .Title -eq "The Simpsons" -and ($ .EpisodeNumber -eq "S01E01" } | Remove-HDHomeRunRecording</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/RobBiddle/PSHDHomeRun</maml:linkText> <maml:uri>https://github.com/RobBiddle/PSHDHomeRun</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-HDHomeRunRecording</command:name> <command:verb>Save</command:verb> <command:noun>HDHomeRunRecording</command:noun> <maml:description> <maml:para>Save HDHomeRun Recording to location specified. Very Slow! Seems to be throttled by the HDHomeRun device to playback speed.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Save HDHomeRun Recording to location specified. Very Slow! Seems to be throttled by the HDHomeRun device to playback speed. Upon Module import, the PSHDHomeRunSettings.json file is used to polulate values in the $PSHDHomeRunSettings variable. Accepts pipeline input including extra properties from Get-HDHomeRunRecording.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-HDHomeRunRecording</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Filename</maml:name> <maml:description> <maml:para>The Filename property from Get-HDHomeRunRecording output</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>PlayURL</maml:name> <maml:description> <maml:para>The PlayURL property from Get-HDHomeRunRecording output</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>SaveToDirectory</maml:name> <maml:description> <maml:para>The directory to save the recording to, default is the current directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.IO.Path</command:parameterValue> <dev:type> <maml:name>System.IO.Path</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>UnusedArguments</maml:name> <maml:description> <maml:para>{{ Fill UnusedArguments Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Filename</maml:name> <maml:description> <maml:para>The Filename property from Get-HDHomeRunRecording output</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>PlayURL</maml:name> <maml:description> <maml:para>The PlayURL property from Get-HDHomeRunRecording output</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>SaveToDirectory</maml:name> <maml:description> <maml:para>The directory to save the recording to, default is the current directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.IO.Path</command:parameterValue> <dev:type> <maml:name>System.IO.Path</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>UnusedArguments</maml:name> <maml:description> <maml:para>{{ Fill UnusedArguments Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>PSHDHomeRun - Manage HDHomeRun DVR using PowerShell and JSON Copyright (C) 2024 Robert D. Biddle</maml:para> <maml:para>This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</maml:para> <maml:para>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</maml:para> <maml:para>You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code># Save the recording to the current directory</dev:code> <dev:remarks> <maml:para>Save-HDHomeRunRecording -Filename "The_Simpsons_2024-01-01_12-00-00.ts" -PlayURL "http://hdhr-11111111.local/recorded/12345678abcdef12"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code># Save the recording to a specific directory</dev:code> <dev:remarks> <maml:para>Save-HDHomeRunRecording -Filename "The_Simpsons_2024-01-01_12-00-00.ts" -PlayURL "http://hdhr-11111111.local/recorded/12345678abcdef12" -SaveToDirectory "C:\Recordings"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code># Save the recording to the current directory using pipeline input</dev:code> <dev:remarks> <maml:para>Get-HDHomeRunRecording | Save-HDHomeRunRecording</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/RobBiddle/PSHDHomeRun</maml:linkText> <maml:uri>https://github.com/RobBiddle/PSHDHomeRun</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |