Class VideoCaptureDeviceFormat

Class VideoCaptureDeviceFormat.

Inheritance

object

VideoCaptureDeviceFormat

Implements

IComparable

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: VisioForge.Core.Types.X.Sources

Assembly: VisioForge.Core.dll

Syntax

public class VideoCaptureDeviceFormat : IComparable

Constructors

VideoCaptureDeviceFormat()

Initializes a new instance of the VideoCaptureDeviceFormat class.

Declaration

public VideoCaptureDeviceFormat()

VideoCaptureDeviceFormat(int, int, string)

Initializes a new instance of the VideoCaptureDeviceFormat class.

Declaration

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

Parameters

Type	Name	Description
int	width	The width.
int	height	The height.
string	format	The format.

Properties

AdditionalProperties

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

Declaration

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

Property Value

Type	Description
Dictionary<string, object>	The additional properties.

AspectRatio

Gets or sets the aspect ratio.

Declaration

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

Property Value

Type	Description
Tuple<float, float>	The aspect ratio.

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.

Declaration

public bool ForceFrameRate { get; set; }

Property Value

Type	Description
bool

Format

Gets or sets the format.

Declaration

public string Format { get; set; }

Property Value

Type	Description
string	The format.

FrameRate

Gets or sets the frame rate.

Declaration

public VideoFrameRate FrameRate { get; set; }

Property Value

Type	Description
VideoFrameRate	The frame rate.

Height

Gets or sets the height.

Declaration

public int Height { get; set; }

Property Value

Type	Description
int	The height.

Name

Gets the name.

Declaration

public string Name { get; }

Property Value

Type	Description
string	The name.

Struct

Gets the structure.

Declaration

public Structure Struct { get; }

Property Value

Type	Description
Structure	The structure.

Width

Gets or sets the width.

Declaration

public int Width { get; set; }

Property Value

Type	Description
int	The width.

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.

Declaration

public int CompareTo(object obj)

Parameters

Type	Name	Description
object	obj	An object to compare with this instance.

Returns

Type	Description
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.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to this instance; otherwise, false.

Overrides

object.Equals(object)

Exceptions

Type	Condition
NotImplementedException

GetHashCode()

Returns a hash code for this instance.

Declaration

public override int GetHashCode()

Returns

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

Overrides

object.GetHashCode()

ToString()

Returns a string that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents this instance.

Overrides

object.ToString()

Operators

operator ==(VideoCaptureDeviceFormat, VideoCaptureDeviceFormat)

Implements the == operator.

Declaration

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

Parameters

Type	Name	Description
VideoCaptureDeviceFormat	left	The left.
VideoCaptureDeviceFormat	right	The right.

Returns

Type	Description
bool	The result of the operator.

operator >(VideoCaptureDeviceFormat, VideoCaptureDeviceFormat)

Implements the > operator.

Declaration

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

Parameters

Type	Name	Description
VideoCaptureDeviceFormat	left	The left.
VideoCaptureDeviceFormat	right	The right.

Returns

Type	Description
bool	The result of the operator.

operator >=(VideoCaptureDeviceFormat, VideoCaptureDeviceFormat)

Implements the >= operator.

Declaration

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

Parameters

Type	Name	Description
VideoCaptureDeviceFormat	left	The left.
VideoCaptureDeviceFormat	right	The right.

Returns

Type	Description
bool	The result of the operator.

operator !=(VideoCaptureDeviceFormat, VideoCaptureDeviceFormat)

Implements the != operator.

Declaration

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

Parameters

Type	Name	Description
VideoCaptureDeviceFormat	left	The left.
VideoCaptureDeviceFormat	right	The right.

Returns

Type	Description
bool	The result of the operator.

operator <(VideoCaptureDeviceFormat, VideoCaptureDeviceFormat)

Implements the < operator.

Declaration

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

Parameters

Type	Name	Description
VideoCaptureDeviceFormat	left	The left.
VideoCaptureDeviceFormat	right	The right.

Returns

Type	Description
bool	The result of the operator.

operator <=(VideoCaptureDeviceFormat, VideoCaptureDeviceFormat)

Implements the <= operator.

Declaration

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

Parameters

Type	Name	Description
VideoCaptureDeviceFormat	left	The left.
VideoCaptureDeviceFormat	right	The right.

Returns

Type	Description
bool	The result of the operator.

Implements

IComparable