Skip to content

Get-VmsCameraGeneralSetting

SYNOPSIS

Gets the general settings for one or more cameras.

SYNTAX

Get-VmsCameraGeneralSetting [-Camera] <Camera[]> [-RawValues] [-ValueTypeInfo] [<CommonParameters>]

DESCRIPTION

This cmdlet returns a hashtable with all the general settings available for a camera, including read-only settings and settings usually hidden from the Management Client user interface.

General settings often include properties like "Rotation", "Saturation", and "Brightness", which usually apply to all streams available from the camera.

Each camera model will have a different set of general settings, and some cameras may not have any general settings at all.

The values returned by this cmdlet are the "display values" you should see in the Management Client. To see the raw, internal values used by the MIP SDK, you may use the "-RawValues" switch.

REQUIREMENTS

  • Requires VMS connection and will attempt to connect automatically

EXAMPLES

Example 1

Connect-Vms -ShowDialog -AcceptEula
$camera = Select-Camera -SingleSelect -Title 'Select a camera (double-click)'
$camera | Get-VmsCameraGeneralSetting

<# OUTPUT (display values)
Name                           Value
----                           -----
RecorderMode                   Disabled
MulticastVideoPort             0
RecorderRetentionTime          336
Saturation                     50
RecorderAudioEnabled           No
Sharpness                      50
Brightness                     50
EdgeStorageRecording           Continuous
EdgeStorageStreamIndex         0
Rotation                       0
MulticastAddress               239.244.177.82
RecorderStreamIndex            1
OSDDateTime                    Disabled
RecorderPostTriggerTime        0
MulticastTTL                   5
EdgeStorageEnabled             false
BlackAndWhiteMode              Color
MulticastForceSSM              No
WhiteBalance                   Automatic
RecorderPreTriggerTime         0
#>

$camera | Get-VmsCameraGeneralSetting -RawValues

<# OUTPUT (raw values)
Name                           Value
----                           -----
RecorderMode                   Disabled
MulticastVideoPort             0
RecorderRetentionTime          336
Saturation                     50
RecorderAudioEnabled           no
Sharpness                      50
Brightness                     50
EdgeStorageRecording           Continuous
EdgeStorageStreamIndex         0
Rotation                       0
MulticastAddress               239.244.177.82
RecorderStreamIndex            1
OSDDateTime                    Disabled
RecorderPostTriggerTime        0
MulticastTTL                   5
EdgeStorageEnabled             False
BlackAndWhiteMode              Yes
MulticastForceSSM              no
WhiteBalance                   Automatic
RecorderPreTriggerTime         0
#>

($camera | Get-VmsCameraGeneralSetting -ValueTypeInfo).BlackAndWhiteMode

<# OUTPUT
TranslationId                        Name          Value
-------------                        ----          -----
d65be37a-9416-4bbf-8ed3-36ebd12cd837 Color         Yes
f7729675-9e20-4593-9611-f53c11c6fdd4 Black & White No
#>

In this example we show how to login, select a camera using an interactive camera selection dialog, and then display the general settings for the camera using the default "display values". Then we show how the same settings appear when using the raw values. For example, the display value for BlackAndWhiteMode is "Color", and the raw value is "Yes".

For reference, the ValueTypeInfo collection for the BlackAndWhiteMode setting is displayed. You can see how the ValueTypeInfo collection maps the raw value "Yes" to the display value "Color".

PARAMETERS

-Camera

Specifies one or more camera objects such as are returned by Get-VmsCamera.

Type: Camera[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-RawValues

Specifies that the raw, internal values of settings should be returned instead of returning the display values seen in Management Client.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ValueTypeInfo

Specifies that the hashtable should contain a "ValueTypeInfo" collection for each general setting, instead of the value of the setting. The "ValueTypeInfo" collections can be used to discover the valid ranges or values for each setting.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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.

INPUTS

VideoOS.Platform.ConfigurationItems.Camera[]

OUTPUTS

VmsDeviceGeneralSettings

NOTES