Get-VmsSpeaker¶
SYNOPSIS¶
Gets speaker devices from the currently connected XProtect VMS site.
SYNTAX¶
QueryItems (Default)¶
Get-VmsSpeaker [[-Name] <String>] [[-Description] <String>] [[-Channel] <Int32[]>]
[[-EnableFilter] <EnableFilter>] [[-Comparison] <Operator>] [[-MaxResults] <Int32>] [<CommonParameters>]
Hardware¶
Get-VmsSpeaker [-Hardware] <Hardware[]> [[-Name] <String>] [[-Description] <String>] [[-Channel] <Int32[]>]
[[-EnableFilter] <EnableFilter>] [[-Comparison] <Operator>] [<CommonParameters>]
Id¶
Path¶
DESCRIPTION¶
The Get-VmsSpeaker cmdlet gets speaker devices from the currently connected XProtect VMS site. Speakers are logical child
devices attached to "hardware" which are most often an IP camera. The VideoOS.Platform.ConfigurationItems.Speaker
object returned from this command represents a configurable device on the XProtect VMS.
The corresponding Set-VmsSpeaker command can be used in conjunction with this cmdlet to modify the device settings.
REQUIREMENTS
- Requires VMS connection and will attempt to connect automatically
EXAMPLES¶
Example 1¶
Get all enabled speaker devices.
Example 2¶
$recorder = Get-VmsRecordingServer | Out-GridView -OutputMode Multiple
$recorder | Get-VmsHardware | Get-VmsSpeaker
Get all enabled speaker devices from the selected recording server(s).
Example 3¶
Get all enabled speakers with the case-insensitive word "garage" in the name.
Example 4¶
Get all disabled speakers.
Example 5¶
Get-VmsSpeaker -EnableFilter All -Channel 0 | Set-VmsSpeaker -Enabled $true -PassThru
Get-VmsSpeaker -EnableFilter All -Channel (1..64) | Set-VmsSpeaker -Enabled $false -PassThru
Get all speakers with a channel value of "0" (port number 1), and enable them if they aren't enabled already. Then get all speakers with a higher channel number from 1 to 64, and disable them. In most cases this should leave you with only the first speaker enabled.
PARAMETERS¶
-Channel¶
When providing one or more channel numbers, only devices with a matching channel number are returned. Channel numbering starts at zero, which means the first device of any given type will be assigned channel number "0", the second device will be assigned channel number "1", and so on.
Type: Int32[]
Parameter Sets: QueryItems, Hardware
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Comparison¶
When providing a value for the Name, or Description parameters, the Comparison operator determines how thes values
are compared with the corresponding device properties. The default value is Contains.
Type: Operator
Parameter Sets: QueryItems, Hardware
Aliases:
Accepted values: Equals, NotEquals, LessThan, GreaterThan, Contains, BeginsWith
Required: False
Position: 4
Default value: Contains
Accept pipeline input: False
Accept wildcard characters: False
-Description¶
Specifies all, or part of a device description which is used with the Comparison parameter to filter the results of
the request.
Type: String
Parameter Sets: QueryItems, Hardware
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableFilter¶
Specifies whether to return enabled, disabled, or all matching devices. By default, only enabled devices are returned.
Type: EnableFilter
Parameter Sets: QueryItems, Hardware
Aliases:
Accepted values: All, Enabled, Disabled
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Hardware¶
Specifies the hardware object(s) from which to return matching devices.
Type: Hardware[]
Parameter Sets: Hardware
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Id¶
Specifies the Id of an existing device.
Type: Guid[]
Parameter Sets: Id
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-MaxResults¶
Specifies the maximum number of matching devices to return. On a very large XProtect VMS, setting a reasonable number
may result in better performance. The default value is [int]::MaxValue or 2147483647.
Type: Int32
Parameter Sets: QueryItems
Aliases:
Required: False
Position: 5
Default value: 2147483647
Accept pipeline input: False
Accept wildcard characters: False
-Name¶
Specifies all, or part of a device name which is used with the Comparison parameter to filter the results of the
request.
Type: String
Parameter Sets: QueryItems, Hardware
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Path¶
The Milestone Configuration API string representing the device in the format DeviceType[DeviceId].
Type: String[]
Parameter Sets: Path
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
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.