Skip to content

Get-Snapshot

SYNOPSIS

{{ Fill in the Synopsis }}

SYNTAX

FromLive (Default)

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>]

FromPlayback

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>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

Example 1

{{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-Behavior

{{ Fill Behavior Description }}

Type: String
Parameter Sets: FromPlayback
Aliases:
Accepted values: GetBegin, GetEnd, GetNearest

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

-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: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EndTime

{{ Fill EndTime Description }}

Type: DateTime
Parameter Sets: FromPlayback
Aliases:

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

-FileName

{{ Fill FileName Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-Height

{{ Fill Height Description }}

Type: Int32
Parameter Sets: (All)
Aliases:

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

-IncludeBlackBars

{{ Fill IncludeBlackBars Description }}

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Interval

{{ Fill Interval Description }}

Type: Double
Parameter Sets: FromPlayback
Aliases:

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

-KeepAspectRatio

{{ Fill KeepAspectRatio Description }}

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-LiftPrivacyMask

{{ Fill LiftPrivacyMask Description }}

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Live

{{ Fill Live Description }}

Type: SwitchParameter
Parameter Sets: FromLive
Aliases:

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

-LiveTimeoutMS

{{ Fill LiveTimeoutMS Description }}

Type: Int32
Parameter Sets: (All)
Aliases:

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

-LocalTimestamp

{{ Fill LocalTimestamp Description }}

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Path

{{ Fill Path Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-Quality

{{ Fill Quality Description }}

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Save

{{ Fill Save Description }}

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Timestamp

{{ Fill Timestamp Description }}

Type: DateTime
Parameter Sets: FromPlayback
Aliases:

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

-UseFriendlyName

{{ Fill UseFriendlyName Description }}

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Width

{{ Fill Width Description }}

Type: Int32
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

VideoOS.Platform.Live.LiveSourceContent

VideoOS.Platform.Data.JPEGData

NOTES

Online Help