Snapshot template parameters

更新时间:
复制 MD 格式

This topic describes a sample Intelligent Media Services (IMS) snapshot template and the template parameters.

ParameterData typeRequiredDescriptionExample
TypestringYesThe type of the snapshot template. Valid values:
  • Cover: cover snapshot
  • Normal: normal snapshot
  • Sprite: Sprite snapshot
Sprite
FrameTypestringYesThe frame type. Default value: intra. Valid values:
  • normal: normal frame
  • intra: I-frame
intra
TimeLongYesThe time at which the system starts to capture snapshots. Unit: milliseconds. 1000
CountLongYesThe number of snapshots to be captured. 5
IntervalLongNoThe interval at which snapshots are captured. Unit: seconds. 10
WidthintegerNoThe width of a captured snapshot. 720
HeightintegerNoThe height of a captured snapshot. 480
BlackLevelintegerNoThe threshold that is used to filter out black frames for the first snapshot to be captured. This feature is available if you request the system to capture multiple snapshots. 30
PixelBlackThresholdintegerNoThe color value threshold that determines whether a pixel is black. 70
SpriteSnapshotConfigSpriteSnapshotConfigNoThe configuration of the sprite snapshot. For more information, see SpriteSnapshotConfig.
IsSptFragbooleanNoSpecifies whether to tile the Web Video Text Tracks (WebVTT) snapshots. Valid values:
  • true: The WebVTT snapshots are
  • false: The WebVTT snapshots are not tiled.
true

SpriteSnapshotConfig

ParameterData typeRequiredDescriptionExample
CellWidthintegerNoThe width of a snapshot. Unit: pixels. The default value is the width of the output snapshot. 720
CellHeightintegerNoThe height of a snapshot. Unit: pixels. The default value is the height of the output snapshot. 480
PaddingintegerNoThe spacing between two adjacent snapshots. Default value: 0. Unit: pixels. 20
MarginintegerNoThe margin width of the snapshot. Default value: 0. Unit: pixels. 20
ColumnsintegerNoThe number of columns that the tiled snapshot contains. 20
LinesintegerNoThe number of rows that the tiled snapshot contains. 20
ColorstringNoThe background color. #000000

Sample template

{
  "Type": "Normal",
  "FrameType": "normal",
  "Time": 10000,
  "Count": 8,
  "Interval": 3
}