Class VideoCaptureDeviceInfo

Video capture device information.

Inheritance

object

VideoCaptureDeviceInfo

Implements

IComparable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: VisioForge.Core.Types.X.Sources

Assembly: VisioForge.Core.dll

Syntax

public class VideoCaptureDeviceInfo : IComparable

Constructors

VideoCaptureDeviceInfo()

Declaration

public VideoCaptureDeviceInfo()

VideoCaptureDeviceInfo(Device)

Initializes a new instance of the VideoCaptureDeviceInfo class.

Declaration

public VideoCaptureDeviceInfo(Device device)

Parameters

Type	Name	Description
Device	device	The device.

Properties

API

Gets the API.

Declaration

public VideoCaptureDeviceAPI API { get; protected set; }

Property Value

Type	Description
VideoCaptureDeviceAPI	The API.

AudioFormats

Gets audio formats (if device have audio pin).

Declaration

public List<string> AudioFormats { get; protected set; }

Property Value

Type	Description
List<string>

AudioOutput

Gets a value indicating whether audio output pin present on video capture device.

Declaration

public bool AudioOutput { get; protected set; }

Property Value

Type	Description
bool

DevicePath

Gets device path.

Declaration

public string DevicePath { get; set; }

Property Value

Type	Description
string

DisplayName

Gets device name including API.

Declaration

public string DisplayName { get; }

Property Value

Type	Description
string

Facing

Gets the facing.

Declaration

public VideoCaptureDeviceFacing Facing { get; protected set; }

Property Value

Type	Description
VideoCaptureDeviceFacing	The facing.

InternalName

Gets the internal name.

Declaration

public string InternalName { get; protected set; }

Property Value

Type	Description
string	The internal name.

Name

Gets device name.

Declaration

public string Name { get; protected set; }

Property Value

Type	Description
string

Orientation

Gets the orientation.

Declaration

public VideoCaptureDeviceOrientation Orientation { get; }

Property Value

Type	Description
VideoCaptureDeviceOrientation	The orientation.

VideoFormats

Gets video formats.

Declaration

public List<VideoCaptureDeviceFormatInfo> VideoFormats { get; protected set; }

Property Value

Type	Description
List<VideoCaptureDeviceFormatInfo>

Methods

CalculateVideoRotation()

Calculates the video rotation.

Declaration

public virtual int CalculateVideoRotation()

Returns

Type	Description
int	System.Int32.

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.

GetHDOrAnyVideoFormatAndFrameRate(out VideoFrameRate)

Gets the HD (if available) or any video format and frame rate.

Declaration

public VideoCaptureDeviceFormatInfo GetHDOrAnyVideoFormatAndFrameRate(out VideoFrameRate frameRate)

Parameters

Type	Name	Description
VideoFrameRate	frameRate	The frame rate.

Returns

Type	Description
VideoCaptureDeviceFormatInfo	VideoCaptureDeviceFormatInfo.

GetHDVideoFormatAndFrameRate(out VideoFrameRate)

Gets the HD video format and frame rate.

Declaration

public VideoCaptureDeviceFormatInfo GetHDVideoFormatAndFrameRate(out VideoFrameRate frameRate)

Parameters

Type	Name	Description
VideoFrameRate	frameRate	The frame rate.

Returns

Type	Description
VideoCaptureDeviceFormatInfo	VideoCaptureDeviceFormatInfo.

GetVideoFormatAndFrameRate(int, int, out VideoFrameRate)

Gets the HD video format and frame rate.

Declaration

public VideoCaptureDeviceFormatInfo GetVideoFormatAndFrameRate(int widthLimit, int heightLimit, out VideoFrameRate frameRate)

Parameters

Type	Name	Description
int	widthLimit	The max width.
int	heightLimit	The max height.
VideoFrameRate	frameRate	The frame rate.

Returns

Type	Description
VideoCaptureDeviceFormatInfo	VideoCaptureDeviceFormatInfo.

ToString()

Class as a string.

Declaration

public override string ToString()

Returns

Type	Description
string	Returns string.

Overrides

object.ToString()

Implements

IComparable