Class VideoCaptureDeviceFormat

Namespace

VisioForge.Core.Types.X.Sources

Assembly

VisioForge.Core.dll

Class VideoCaptureDeviceFormat.

public class VideoCaptureDeviceFormat : IComparable

Inheritance

object

VideoCaptureDeviceFormat

Implements

IComparable

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Constructors

VideoCaptureDeviceFormat()

Initializes a new instance of the VisioForge.Core.Types.X.Sources.VideoCaptureDeviceFormat class.

public VideoCaptureDeviceFormat()

VideoCaptureDeviceFormat(int, int, string)

Initializes a new instance of the VisioForge.Core.Types.X.Sources.VideoCaptureDeviceFormat class.

public VideoCaptureDeviceFormat(int width, int height, string format)

Parameters

width int

The width.

height int

The height.

format string

The format.

Properties

AdditionalProperties

Gets or sets the additional properties that will be applied for format.

public Dictionary<string, object> AdditionalProperties { get; set; }

Property Value

Dictionary<string, object>

AspectRatio

Gets or sets the aspect ratio.

public Tuple<float, float> AspectRatio { get; set; }

Property Value

Tuple<float, float>

ForceFrameRate

True to force the specified frame rate even if the source do not provide it or the original frame rate is unstable. SDK will duplicate or drop frames if required.

public bool ForceFrameRate { get; set; }

Property Value

bool

Format

Gets or sets the format.

public string Format { get; set; }

Property Value

string

FrameRate

Gets or sets the frame rate.

public VideoFrameRate FrameRate { get; set; }

Property Value

VideoFrameRate

Height

Gets or sets the height.

public int Height { get; set; }

Property Value

int

Name

Gets the name.

public string Name { get; }

Property Value

string

Struct

Gets the structure.

public Structure Struct { get; }

Property Value

Structure

Width

Gets or sets the width.

public int Width { get; set; }

Property Value

int

Methods

CompareTo(object)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

public int CompareTo(object obj)

Parameters

obj object

An object to compare with this instance.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes obj in the sort order. Zero This instance occurs in the same position in the sort order as obj. Greater than zero This instance follows obj in the sort order.

Equals(object)

Determines whether the specified Object is equal to this instance.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified Object is equal to this instance; otherwise, false.

Exceptions

NotImplementedException

GetHashCode()

Returns a hash code for this instance.

public override int GetHashCode()

Returns

int

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

ToString()

Returns a String that represents this instance.

public override string ToString()

Returns

string

A String that represents this instance.

Operators

operator ==(VideoCaptureDeviceFormat, VideoCaptureDeviceFormat)

Implements the == operator.

public static bool operator ==(VideoCaptureDeviceFormat left, VideoCaptureDeviceFormat right)

Parameters

left VideoCaptureDeviceFormat

The left.

right VideoCaptureDeviceFormat

The right.

Returns

bool

The result of the operator.

operator >(VideoCaptureDeviceFormat, VideoCaptureDeviceFormat)

Implements the > operator.

public static bool operator >(VideoCaptureDeviceFormat left, VideoCaptureDeviceFormat right)

Parameters

left VideoCaptureDeviceFormat

The left.

right VideoCaptureDeviceFormat

The right.

Returns

bool

The result of the operator.

operator >=(VideoCaptureDeviceFormat, VideoCaptureDeviceFormat)

Implements the >= operator.

public static bool operator >=(VideoCaptureDeviceFormat left, VideoCaptureDeviceFormat right)

Parameters

left VideoCaptureDeviceFormat

The left.

right VideoCaptureDeviceFormat

The right.

Returns

bool

The result of the operator.

operator !=(VideoCaptureDeviceFormat, VideoCaptureDeviceFormat)

Implements the != operator.

public static bool operator !=(VideoCaptureDeviceFormat left, VideoCaptureDeviceFormat right)

Parameters

left VideoCaptureDeviceFormat

The left.

right VideoCaptureDeviceFormat

The right.

Returns

bool

The result of the operator.

operator <(VideoCaptureDeviceFormat, VideoCaptureDeviceFormat)

Implements the < operator.

public static bool operator <(VideoCaptureDeviceFormat left, VideoCaptureDeviceFormat right)

Parameters

left VideoCaptureDeviceFormat

The left.

right VideoCaptureDeviceFormat

The right.

Returns

bool

The result of the operator.

operator <=(VideoCaptureDeviceFormat, VideoCaptureDeviceFormat)

Implements the <= operator.

public static bool operator <=(VideoCaptureDeviceFormat left, VideoCaptureDeviceFormat right)

Parameters

left VideoCaptureDeviceFormat

The left.

right VideoCaptureDeviceFormat

The right.

Returns

bool

The result of the operator.