snapshot

The snapshot command is used to take and manage snapshots from the video received on any input port. You can save the snapshots in JPEG or YUV format. Also, when saving in JPEG format, you can specify the compression ratio to determine the image quality. You can also specify the location where the snapshot is stored. Snapshots can be stored on a mounted SSD, SD, USB or NFS media, or within the on-board NAND flash.

When taking a snapshot of the current video input, the filename is optional. If none is specified, a unique name will be generated based on the current time if NTP is enabled, or a simple index such as snap-1.jpg if NTP is not enabled. To overwrite an existing file, use the overwrite=yes option and specify the filename when capturing the snapshot. You can specify different formats and quality per snapshot in the snapshot take command. You can also set system-wide defaults for the preferred snapshot format and quality via the snapshot set command.

Tip

Thumbnail generation can be disabled to speed up snapshot acquisition and storage time.

ID is used to select the video input on dual channel encoders (either 0 for BNC-1 or 1 for BNC-2 on #S/B-292E-HDSDI2). ID is optional on single input encoders such as the #S/B-292E-HDSDI1 and the #S/B292E-DVI. If entered, only 0 will be accepted.

Configuring a limit on the storage space available for snapshots is only valid for flash, SSD, or NFS locations. For USB and SD locations, any available space will be used without constraint.

Synopsis

snapshot ID take [format=value] [filename=<filename> [overwrite=yes,no]][quality=value]
snapshot set [format=value] [quality=value] [maxsize=value] [location=value] [thumbnail=on,off] [overwrite=yes,no] 
snapshot get
snapshot list
snapshot delete [<filename>, all]

Actions

Action	Description
take	Takes a snapshot from either: the current active video (Makito X DVI, S/B-292E-DVI or Makito X SDI single-BNC, S/B-292E-HDSDI1) the video received on any input port, where ID is the video input (Makito X SDI dual-BNC, S/B-292E-HDSDI2). ID is either 0 for BNC-1 or 1 for BNC-2. You can optionally specify the format and image quality per snapshot, as well as the filename.
set	Sets system-wide defaults for the preferred snapshot format and quality.
get	Displays the current format and quality defaults for the snapshot utility.
list	Displays the available snapshots on the system along with the resolution. Snapshot files are stored under /usr/share/haivision/snapshots.
delete	Deletes either the snapshot specified by `<filename>` or all snapshots stored under `/usr/share/haivision/snapshots`.

Parameters

Parameter	Default	Description/Values
`format`	jpeg	Specifies the image format: yuv, jpg. When saving in jpg format, you can specify the desired image quality. Note YUV snapshots always have the best possible quality but take the most amount of space.
`overwrite`	no	(Only applies when a filename is provided) When enabled, any existing snapshot file with the same filename will be overwritten. `yes,no`
`quality`	100	Specifies the desired image quality from 1 (lowest) to 100 (highest). `1..100` Note This setting only applies for jpg snapshots
`maxsize`	100 MB	(Users must be assigned Administrator role) Specifies the amount of storage in MB available to snapshots. -1, 0..4096 `0` disables the snapshot feature. `-1` is used for unlimited storage and is only available when the location is an NFS-mounted drive.
`location`	Internal Flash	Specifies the storage location, either: flash - Internal on-board NAND flash ssd - SATA Solid State Drive sd - Secure Digital card usb - Universal Serial Bus Mounted media nfs - Network file system
`thumbnails`	on	When set to On, enables thumbnail generation for snapshots. `on,off`

Examples

# snapshot 0 take format=jpg filename=mysnaphot.jpg quality=80

Takes a single image snapshot (immediately) in JPEG format at 80% image quality and stores it under the filename mysnapshot.jpg.

# snapshot set format=jpg quality=80

Sets the system-wide defaults for the preferred snapshot format to jpg at 80% image quality.

# snapshot set location=ssd

Sets the snapshot storage location to an SSD.

# snapshot set thumbnail=off

Disables thumbnail generation for snapshots.

# snapshot get

Returns the system-wide settings for the snapshot format, for example:

Current Defaults:
  Format          : JPEG
  Quality         : 100
  Thumbnails      : On
  Storage Device  : Internal Flash
  Max Storage     : 100MB

# snapshot list

Lists the contents of the snapshot folder:

Snapshot Files (in /usr/share/haivision/snapshots/):
  snap-2015-05-01-11h58m15s.jpg (BUSY)
  snap-2015-05-01-11h58m39s.jpg (BUSY)
  snap-2015-05-01-12h00m25s.jpg (BUSY)
  snap-2015-05-01-12h03m19s.jpg (BUSY)

4 snapshot files are available.
5.90MB (5%) of snapshot disk storage space used.

Related Topics