Class AudioCaptureDeviceFormat

Audio capture device format.

Inheritance

object

AudioCaptureDeviceFormat

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 AudioCaptureDeviceFormat : IComparable

Constructors

AudioCaptureDeviceFormat()

Initializes a new instance of the AudioCaptureDeviceFormat class.

Declaration

public AudioCaptureDeviceFormat()

AudioCaptureDeviceFormat(AudioFormatX, int, int)

Initializes a new instance of the AudioCaptureDeviceFormat class.

Declaration

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

Parameters

Type	Name	Description
AudioFormatX	format	The format.
int	sampleRate	The sample rate.
int	channels	The channels.

Properties

Channels

Gets or sets the channels.

Declaration

public int Channels { get; set; }

Property Value

Type	Description
int

Format

Gets or sets the format.

Declaration

public AudioFormatX Format { get; set; }

Property Value

Type	Description
AudioFormatX	The format.

Name

Gets the name.

Declaration

public string Name { get; }

Property Value

Type	Description
string	The name.

SampleRate

Gets or sets the sample rate.

Declaration

public int SampleRate { get; set; }

Property Value

Type	Description
int	The sample rate.

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 ==(AudioCaptureDeviceFormat, AudioCaptureDeviceFormat)

Implements the == operator.

Declaration

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

Parameters

Type	Name	Description
AudioCaptureDeviceFormat	left	The left.
AudioCaptureDeviceFormat	right	The right.

Returns

Type	Description
bool	The result of the operator.

operator >(AudioCaptureDeviceFormat, AudioCaptureDeviceFormat)

Implements the > operator.

Declaration

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

Parameters

Type	Name	Description
AudioCaptureDeviceFormat	left	The left.
AudioCaptureDeviceFormat	right	The right.

Returns

Type	Description
bool	The result of the operator.

operator >=(AudioCaptureDeviceFormat, AudioCaptureDeviceFormat)

Implements the >= operator.

Declaration

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

Parameters

Type	Name	Description
AudioCaptureDeviceFormat	left	The left.
AudioCaptureDeviceFormat	right	The right.

Returns

Type	Description
bool	The result of the operator.

operator !=(AudioCaptureDeviceFormat, AudioCaptureDeviceFormat)

Implements the != operator.

Declaration

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

Parameters

Type	Name	Description
AudioCaptureDeviceFormat	left	The left.
AudioCaptureDeviceFormat	right	The right.

Returns

Type	Description
bool	The result of the operator.

operator <(AudioCaptureDeviceFormat, AudioCaptureDeviceFormat)

Implements the < operator.

Declaration

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

Parameters

Type	Name	Description
AudioCaptureDeviceFormat	left	The left.
AudioCaptureDeviceFormat	right	The right.

Returns

Type	Description
bool	The result of the operator.

operator <=(AudioCaptureDeviceFormat, AudioCaptureDeviceFormat)

Implements the <= operator.

Declaration

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

Parameters

Type	Name	Description
AudioCaptureDeviceFormat	left	The left.
AudioCaptureDeviceFormat	right	The right.

Returns

Type	Description
bool	The result of the operator.

Implements

IComparable