Set-VmsCameraGeneralSetting¶
SYNOPSIS¶
Sets one or more general setting values for a camera.
SYNTAX¶
Set-VmsCameraGeneralSetting -Camera <Camera[]> [-Settings] <Hashtable> [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION¶
This cmdlet enables one or more settings to be updated on one or more cameras with minimal effort.
REQUIREMENTS
- Requires VMS connection and will attempt to connect automatically
EXAMPLES¶
Example 1¶
Connect-ManagementServer -ShowDialog -AcceptEula
$camera = Select-Camera -SingleSelect -Title 'Select a camera (double-click)'
$settings = @{
BlackAndWhiteMode = 'Yes'
}
$camera | Set-VmsCameraGeneralSetting -Settings $settings -Verbose
<# OUTPUT
VERBOSE: Performing the operation "Changing BlackAndWhiteMode from No to Yes" on target "Elevator".
VERBOSE: Performing the operation "Save changes" on target "Elevator".
#>
$camera = Select-Camera -SingleSelect -Title 'Select a camera (double-click)'
$camera | Set-VmsCameraGeneralSetting -Settings $settings -Verbose
<# OUTPUT (no BlackAndWhiteMode setting available)
WARNING: A general setting named 'BlackAndWhiteMode' was not found on Garage.
#>
In this example we login to the Management Server, present a camera selection dialog, and then attempt to update the BlackAndWhiteMode value to "Yes" which, perhaps counter-intuitively, represents "Color" based on the ValueTypeInfo for the camera used for testing.
We then present another camera selection dialog, where you can choose a different camera lacking a "BlackAndWhiteMode" general setting, and demonstrate the warning message you can expect when attempting to update general settings that are not present on a camera.
PARAMETERS¶
-Camera¶
Specifies one or more camera objects such as are returned by Get-VmsCamera.
Type: Camera[]
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Settings¶
Accepts a hashtable of settings used to update the general settings for a given camera.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm¶
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf¶
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.