VideoFormatDesc

A VideoFormatDesc describes an available video format using the media subtype, horizontal and vertical binning and skipping factors and size constraints. The size constraints are described by a minimum size, a maximum size and a step size.

To set a video format for a device, a VideoFormat instance has to be created by using VideoFormatDesc.CreateVideoFormat.

Information

    Namespace: TIS.Imaging
    Introduced in version 3.2

Properties

Property Description
BinningFactor

[Deprecated] Returns the binning factor of the VideoFormatDesc.

BinningFactorHorizontal

Returns the horizontal binning factor of the VideoFormatDesc.

BinningFactorVertical

Returns the vertical binning factor of the VideoFormatDesc.

IsROIFormat

Returns whether this VideoFormatDesc describes a ROI format.

MaxSize

Returns the maximum possible size for video formats created from this VideoFormatDesc.

MinSize

Returns the minimum possible size for video formats created from this VideoFormatDesc.

Name

Returns a text representation of the VideoFormatDesc.

SkippingFactorHorizontal

Returns the horizontal skipping factor of the VideoFormatDesc.

SkippingFactorVertical

Returns the vertical skipping factor of the VideoFormatDesc.

StepSize

Returns the step size for video formats created from this VideoFormatDesc.

Subtype

Returns the GUID of the media subtype of this video format description.

Methods

Method Description
CreateVideoFormat

This method creates a VideoFormat with the specified size based on the specification of this VideoFormatDesc.

IsValidSize

This method checks whether a specified size matches the size constraints of this VideoFormatDesc.

<< Classes