Class VideoCaptureDeviceFormat

Namespace

VisioForge.Core.Types.VideoCapture

Assembly

VisioForge.Core.dll

Represents a video capture device format with resolution, frame rates, and media subtype information.

public class VideoCaptureDeviceFormat

Inheritance

object

VideoCaptureDeviceFormat

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Remarks

This class encapsulates the format capabilities of a video capture device, including the supported resolution (width and height), available frame rates, and the media subtype that identifies the video format (e.g., RGB, YUV, MJPEG).

Constructors

VideoCaptureDeviceFormat(string, int, int, Guid)

Initializes a new instance of the VisioForge.Core.Types.VideoCapture.VideoCaptureDeviceFormat class with all properties.

public VideoCaptureDeviceFormat(string name, int width, int height, Guid subtype)

Parameters

name string

The display name of the video format.

width int

The horizontal resolution in pixels.

height int

The vertical resolution in pixels.

subtype Guid

The media subtype GUID that identifies the video format.

VideoCaptureDeviceFormat(string)

Initializes a new instance of the VisioForge.Core.Types.VideoCapture.VideoCaptureDeviceFormat class with only a name.

public VideoCaptureDeviceFormat(string name)

Parameters

name string

The display name of the video format.

Remarks

This constructor is typically used when only the format name is known initially, with other properties to be set later.

Properties

FrameRates

Gets or sets the list of supported frame rates for this format.

public List<VideoFrameRate> FrameRates { get; set; }

Property Value

List<VideoFrameRate>

Height

Gets or sets the vertical resolution (height) of the video format in pixels.

public int Height { get; set; }

Property Value

int

Name

Gets or sets the display name of the video format.

public string Name { get; set; }

Property Value

string

SubType

Gets or sets the media subtype GUID that identifies the video format.

public Guid SubType { get; set; }

Property Value

Guid

Remarks

The subtype GUID corresponds to standard DirectShow media subtypes that define the pixel format and encoding of the video data.

Width

Gets or sets the horizontal resolution (width) of the video format in pixels.

public int Width { get; set; }

Property Value

int

Methods

ToString()

Returns a string representation of the video format.

public override string ToString()

Returns

string

The VisioForge.Core.Types.VideoCapture.VideoCaptureDeviceFormat.Name property value, which provides a human-readable description of the format.