Gets live or recorded still images from a camera connected to a Milestone VMS.
Get-Snapshot [-Camera <Camera>] [[-CameraId] <Guid>] [-Live] [-Save] [[-Path] <String>] [[-FileName] <String>] [-LocalTimestamp] [-Width <Int32>] [-Height <Int32>] [-KeepAspectRatio] [-IncludeBlackBars] [-UseFriendlyName] [-LiftPrivacyMask] [-Quality <Int32>] [-LiveTimeoutMS <Int32>] [<CommonParameters>]
Get-Snapshot [-Camera <Camera>] [[-CameraId] <Guid>] [[-Timestamp] <DateTime>] [-EndTime <DateTime>] [-Interval <Double>] [[-Behavior] <String>] [-Save] [[-Path] <String>] [[-FileName] <String>] [-LocalTimestamp] [-Width <Int32>] [-Height <Int32>] [-KeepAspectRatio] [-IncludeBlackBars] [-UseFriendlyName] [-LiftPrivacyMask] [-Quality <Int32>] [-LiveTimeoutMS <Int32>] [<CommonParameters>]
Get-Snapshot cmdlet is used to retrieve a live still image, a recorded
still image, or a series of recorded images between two
on a given interval.
Currently these images are in JPEG format, and in a future update the output format will be configurable.
- Requires VMS connection and will attempt to connect automatically
VideoOS.Platform.Live.LiveSourceContent object where the JPEG image is
defined as a byte array in the Contents property.
Saves a file to C:\temp\ in JPG format with the camera's display name followed by a timestamp as the file name.
Gets the oldest recorded image for a camera.
Gets the most recent recorded image for a camera.
Gets a recorded image with a timestamp nearest to 24 hours ago.
Specifies whether to get the oldest, or newest recorded image available, or whether to get the nearest image to the specified timestamp. The default behavior is to get the nearest recorded image to the specified timestamp.
Specifies the camera from which to retrieve a snaphot.
Specifies the ID of a camera from which to retrieve a snapshot.
Specifies the end timestamp for retrieving many snapshots of recorded video between two timestamps.
Specifies the filename to use when saving a snapshot.
When it is desired to scale the snapshot, this specifies the desired image height.
Specifies whether the image should be centered on a black background resulting in black bars when the resulting image resolution does not match the original camera resolution.
Specifies an interval, in seconds, on which to retrieve snapshots from recorded video between Timestamp and EndTime.
Specifies that the original image aspect ratio should be maintained when resizing the snapshot.
Specifies that the privacy mask, if present, should be lifted on the snapshot, assuming the current user has permission to lift privacy masks.
Specifies that the snapshots should come from the live stream instead of recorded video.
Specifies the number of milliseconds to wait for a live snapshot image to arrive. The default value is 2000ms or 2 seconds.
Specifies that a local timestamp should be used in the file name instead of a UTC timestamp.
Specifies the folder to which snapshots should be saved.
Specifies the image quality of the resulting JPEG as a percentage. The default value is 75%.
Specifies that the image should be saved to disk.
Specifies the timestamp from which the nearest snapshot should be retrieved from recorded video.
Specifies that the display name should be used in the filename of saved images.
Specifies the desired image width for the resulting snapshot.
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.