Get-ValueDisplayName¶
SYNOPSIS¶
Gets the display name of the value of a property.
SYNTAX¶
ConfigurationApi¶
Get-ValueDisplayName -PropertyList <Property[]> -PropertyName <String[]> [-DefaultValue <String>]
[<CommonParameters>]
StrongTypes¶
Get-ValueDisplayName -Properties <ConfigurationApiProperties> -PropertyName <String[]> [-DefaultValue <String>]
[<CommonParameters>]
DESCRIPTION¶
Some propertie values such as FPS or Resolution might have different property names by which those values are referenced depending on the camera driver. For example, some cameras use the propery name 'Resolution' to refer to camera resolution, and others might use 'StreamProperty'. And the value for resolution might be '6' internally, while the display name for that value might be 1920x1080 for example.
This function simplifies the process of finding out the best display name to use for the value of a property.
REQUIREMENTS
- Does not require a VMS connection
EXAMPLES¶
EXAMPLE 1¶
Get-ValueDisplayName -PropertyList (Select-Camera | Get-StreamProperties -StreamNumber 0) -PropertyName 'Resolution', 'StreamProperty'
Presents a camera selection dialog and then returns the display name for the configured resolution for the camera from the first video stream's settings.
PARAMETERS¶
-DefaultValue¶
The default value to return if the property is not found in any of the items in PropertyList
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: NotAvailable
Accept pipeline input: False
Accept wildcard characters: False
-Properties¶
{{ Fill Properties Description }}
Type: ConfigurationApiProperties
Parameter Sets: StrongTypes
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PropertyList¶
The collection of properties associated with a configuration item such as a camera's stream settings.
Type: Property[]
Parameter Sets: ConfigurationApi
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PropertyName¶
One or more related property names to look for such as FPS, Framerate
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
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.