The CreateSnapshot action creates a snapshot image in JPEG format from a VMS storage archive.
Type: Asynchronous
| Parameter | Description | Required |
|---|---|---|
AuthToken
|
The authentication token to pass to VMS when VMS is configured for token authentication. | Optional |
frame
|
The frame number to use for the snapshot, within the specified utc. |
Yes |
outpath
|
Full UNC path of output snapshot file, in JPEG format. If you do not specify a path, the file is saved in the folder specified by FileOutputPath and you can retrieve it using the DownloadSnapshot action. | Optional |
track
|
The storage area to create the snapshot from. | Yes |
utc
|
The time for which to create a snapshot, in epoch seconds. | Yes |
To create a snapshot image from a VMS storage archive:
/a=createsnapshot
&track=0
&utc=1317314631
&frame=1
&outpath=\\box1\SharedFolder\example.jpg
|
|