Class AudioCaptureDeviceFormat

Namespace

VisioForge.Core.Types.X.Sources

Assembly

VisioForge.Core.dll

Audio capture device format.

public class AudioCaptureDeviceFormat : IComparable

Inheritance

object

AudioCaptureDeviceFormat

Implements

IComparable

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Constructors

AudioCaptureDeviceFormat()

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

public AudioCaptureDeviceFormat()

AudioCaptureDeviceFormat(AudioFormatX, int, int)

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

public AudioCaptureDeviceFormat(AudioFormatX format, int sampleRate, int channels)

Parameters

format AudioFormatX

The format.

sampleRate int

The sample rate.

channels int

The channels.

Properties

Channels

Gets or sets the channels.

public int Channels { get; set; }

Property Value

int

Format

Gets or sets the format.

public AudioFormatX Format { get; set; }

Property Value

AudioFormatX

Name

Gets the name.

public string Name { get; }

Property Value

string

SampleRate

Gets or sets the sample rate.

public int SampleRate { 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 ==(AudioCaptureDeviceFormat, AudioCaptureDeviceFormat)

Implements the == operator.

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

Parameters

left AudioCaptureDeviceFormat

The left.

right AudioCaptureDeviceFormat

The right.

Returns

bool

The result of the operator.

operator >(AudioCaptureDeviceFormat, AudioCaptureDeviceFormat)

Implements the > operator.

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

Parameters

left AudioCaptureDeviceFormat

The left.

right AudioCaptureDeviceFormat

The right.

Returns

bool

The result of the operator.

operator >=(AudioCaptureDeviceFormat, AudioCaptureDeviceFormat)

Implements the >= operator.

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

Parameters

left AudioCaptureDeviceFormat

The left.

right AudioCaptureDeviceFormat

The right.

Returns

bool

The result of the operator.

operator !=(AudioCaptureDeviceFormat, AudioCaptureDeviceFormat)

Implements the != operator.

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

Parameters

left AudioCaptureDeviceFormat

The left.

right AudioCaptureDeviceFormat

The right.

Returns

bool

The result of the operator.

operator <(AudioCaptureDeviceFormat, AudioCaptureDeviceFormat)

Implements the < operator.

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

Parameters

left AudioCaptureDeviceFormat

The left.

right AudioCaptureDeviceFormat

The right.

Returns

bool

The result of the operator.

operator <=(AudioCaptureDeviceFormat, AudioCaptureDeviceFormat)

Implements the <= operator.

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

Parameters

left AudioCaptureDeviceFormat

The left.

right AudioCaptureDeviceFormat

The right.

Returns

bool

The result of the operator.