Test-Playback¶
SYNOPSIS¶
Tests whether the recording server has recordings at, before, or after the given DateTime.
SYNTAX¶
Test-Playback [-Camera <Camera>] [-CameraId <Guid>] [-Timestamp <DateTime>] [-Mode <String>]
[<CommonParameters>]
DESCRIPTION¶
The Test-Playback cmdlet tests whether the recording server has recordings at, before, or after the given DateTime.
Recordings in a Milestone XProtect VMS are stored with UTC timestamps, so the provided DateTime object will be converted to UTC if the Kind property on the specified timestamp is either "Local" or "Unspecified".
REQUIREMENTS
- Requires VMS connection and will attempt to connect automatically
EXAMPLES¶
Example 1¶
Get-VmsCamera | Where-Object { ($_ | Test-Playback -Timestamp (Get-Date).AddDays(-30) -Mode Reverse) -eq $false }
Returns a list of cameras without recordings older than 30 days.
Example 2¶
Returns a list of cameras without any available recordings.
Camera¶
Specifies a camera object as is returned by Get-VmsCamera
Type: Camera
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
CameraId¶
Specifies the ID of a camera object. Scripts can often be optimized to retrieve device IDs using a less-expensive method than Get-VmsCamera
such as Get-VmsVideoOSItem.
Type: Guid
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 00000000-0000-0000-0000-000000000000
Accept pipeline input: False
Accept wildcard characters: False
Mode¶
Specifies the mode for the underlying MIP SDK GoToWithResult() method call. See the related links for more information.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Forward, Reverse, Any
Required: False
Position: Named
Default value: Any
Accept pipeline input: False
Accept wildcard characters: False
Timestamp¶
Specifies a DateTime value representing the point in time to check for recordings in the media database. DateTime objects
will be automatically converted to UTC timestamps by calling the .ToUniversalTime() method, as all recordings are stored
with UTC timestamps.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 1/1/0001 12:00:00 AM
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.
PARAMETERS¶
-Camera¶
{{ Fill Camera Description }}
Type: Camera
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-CameraId¶
{{ Fill CameraId Description }}
Type: Guid
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Mode¶
{{ Fill Mode Description }}
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Forward, Reverse, Any
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Timestamp¶
{{ Fill Timestamp Description }}
Type: DateTime
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.