Resource Base
Table of contents

VideoFrameTag

The VideoFrameTag interface extends the ImageTag interface and introduces additional attributes tailored for characterizing images extracted from video streams, known as DCEFrames.

interface VideoFrameTag extends ImageTag {
    cropRegion: DSRect;
    currentHeight: number;
    currentWidth: number;
    isCropped: boolean;
    originalHeight: number;
    originalWidth: number;
    timeSpent: number;
    timeStamp: number;
}

cropRegion

The region based on which the original frame was cropped. If isCropped is false, the region covers the entire original image.

See Also

DSRect

currentWidth

The current width of the video frame after cropping.

currentHeight

The current height of the video frame after cropping.

isCropped

Indicates whether the video frame is cropped.

originalWidth

The original width of the video frame before any cropping.

originalHeight

The original height of the video frame before any cropping.

timeSpent

The time spent acquiring the frame, in milliseconds.

timeStamp

The timestamp marking the completion of the frame acquisition.

This page is compatible for:

Version 1.0

Is this page helpful?

YesYes NoNo

latest version

    • Latest version(4.0.2)
    • Version 4.x
      • Version 4.0.1
      • Version 4.0.0
    • Version 3.x
      • Version 3.3.10
      • Version 3.3.9
      • Version 3.3.8
      • Version 3.3.7
      • Version 3.3.6
      • Version 3.3.5
      • Version 3.3.4
      • Version 3.3.3
      • Version 3.3.2
      • Version 3.3.1
      • Version 3.3.0
      • Version 3.2.0
      • Version 3.1.0
      • Version 3.0.1
      • Version 3.0.0
    • Version 2.x
      • Version 2.3.5
      • Version 2.3.2
      • Version 2.3.1
      • Version 2.3.0
      • Version 2.1.4
      • Version 2.1.3
      • Version 2.1.0
      • Version 2.0.0
    Change +