DSVideoFrameTag

The DSVideoFrameTag class represents a video frame tag, which is a type of image tag that is used to store additional information about a video frame. It inherits from the DSImageTag class and adds additional attributes and methods specific to video frames.

Definition

Assembly: DynamsoftCaptureVisionBundle.xcframework

Objective-C
Swift

@interface DSVideoFrameTag : DSImageTage

```
class VideoFrameTag : ImageTag
```

Attributes & Methods

Attributes	Type	Description
`clarity`	NSInteger	The clarity of the video frame.
`quality`	DSVideoFrameQuality	The quality of the video frame.
`isCropped`	BOOL	Indicates whether the video frame is cropped.
`cropRegion`	CGRect	The region based on which the original frame was cropped. If `isCropped` is false, the region covers the entire original image.
`originalWidth`	NSInteger	The original width of the video frame before any cropping.
`originalHeight`	NSInteger	The original height of the video frame before any cropping.

Method	Description
`initWithImageId`	The constructor of `DSVideoFrameTag`.

clarity

The clarity of the video frame.

Objective-C
Swift

@property (nonatomic, readonly, assign) NSInteger clarity;

```
var clarity: Int { get }
```

quality

The quality of the video frame.

Objective-C
Swift

@property (nonatomic, readonly, assign) DSFrameQuality quality;

```
var quality: FrameQuality { get }
```

isCropped

Whether the video frame is cropped.

Objective-C
Swift

@property (nonatomic, readonly, assign) BOOL isCropped;

```
var isCropped: Bool { get }
```

cropRegion

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

Objective-C
Swift

@property (nonatomic, readonly, assign) CGRect cropRegion;

```
var cropRegion: CGRect { get }
```

originalWidth

The original width of the video frame.

Objective-C
Swift

@property (nonatomic, readonly, assign) NSUInteger originalWidth;

```
var originalWidth: Int { get }
```

originalHeight

The original height of the video frame.

Objective-C
Swift

@property (nonatomic, readonly, assign) NSUInteger originalHeight;

```
var originalHeight: Int { get }
```

initWithImageId

The constructor of DSVideoFrameTag.

Objective-C
Swift

- (instancetype)initWithImageId:(NSInteger)imageId
                    quality:(DSVideoFrameQuality)quality
                  isCropped:(BOOL)isCropped
                 cropRegion:(CGRect)cropRegion
              originalWidth:(NSUInteger)originalWidth
             originalHeight:(NSUInteger)originalHeight
                    clarity:(NSInteger)clarity;

init(imageId: Int, quality: FrameQuality, isCropped: Bool, cropRegion: CGRect, originalWidth: Int, originalHeight: Int, clarity: Int)

Parameters

imageId: The image ID of the video frame.
quality: The quality of the video frame.
isCropped: Whether the video frame is cropped.
cropRegion: The crop region of the video frame.
originalWidth: The original width of the video frame.
originalHeight: The original height of the video frame. clarity: The clarity of the video frame.

Return Value

An instance of the DSVideoFrameTag.