VideoFormat Class

Namespace: id3.Devices

Definition

Defines a specific video format, including its resolution, frame rate, internal representation, and codec
This class is essential for applications that interact with video capturing devices, as it allows for the precise specification and selection of video formats based on the device’s capabilities and the application’s requirements.
class VideoFormat
class VideoFormat implements Finalizable
public partial class VideoFormat
public class VideoFormat implements AutoCloseable, Serializable
typedef struct id3DevicesVideoFormat *ID3_DEVICES_VIDEO_FORMAT;

Usage

videoFormatInstance = VideoFormat()
# ...

Explicit destruction

# ...
del videoFormatInstance
final videoFormatInstance = sdk.VideoFormat();
// ...

Explicit destruction

// ...
videoFormatInstance.dispose()
using (var videoFormatInstance = new VideoFormat())
{
   // ...
}

Explicit destruction

var videoFormatInstance = new VideoFormat()
// ...
videoFormatInstance.Dispose()
try (VideoFormat videoFormatInstance = new VideoFormat()) {
// ...
}

Explicit destruction

VideoFormat videoFormatInstance = new VideoFormat();
// ...
videoFormatInstance.close();
ID3_DEVICES_VIDEO_FORMAT hVideoFormat{};
int err = id3DevicesVideoFormat_Initialize(&hVideoFormat);
if (err == ID3_SUCCESS) {
    // ...
    id3DevicesVideoFormat_Dispose(&hVideoFormat);
}

Properties

Name

Type

Description

codec

string

Identifies the video codec used to compress or decompress the video frames, represented by a FOURCC (Four-Character Code)

framerate

float

Defines the frame rate of the video format in frames per second (fps), indicating how smoothly the video plays back.

height

int

Specifies the height of the video frame in pixels, determining the vertical resolution of the video format.

name

string

A human-readable description of the video format, typically including resolution and frame rate (e.g., ‘160 x 120 (7.50 fps)’)

value

int

Represents the video format using an internal code specific to the device

width

int

Specifies the width of the video frame in pixels, determining the horizontal resolution of the video format.