Class RangedWaveFormat

Namespace

NAudio.MacOS

Assembly

NAudio.MacOS.dll

Provides information about a WaveFormat and it's acceptable sample rate range.
This is the translated counterpart of the AudioStreamRangedDescription structure, and as such is only existing and relevant with the macOS assembly.

public sealed class RangedWaveFormat

Inheritance

object

RangedWaveFormat

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Constructors

RangedWaveFormat(WaveFormat, double, double)

Constructs a new instance of the RangedWaveFormat class.

public RangedWaveFormat(WaveFormat format, double sampleRateRangeMin, double sampleRateRangeMax)

Parameters

format WaveFormat

The wave format that is the base descriptor of the audio stream.

sampleRateRangeMin double

The minimum inclusive bound of the acceptable sample rate range.

sampleRateRangeMax double

The maximum inclusive bound of the acceptable sample rate range.

Properties

AcceptableSampleRateRangeMax

The maximum inclusive bound of the acceptable sample rate range in application-provided formats.

public double AcceptableSampleRateRangeMax { get; }

Property Value

double

AcceptableSampleRateRangeMin

The minimum inclusive bound of the acceptable sample rate range in application-provided formats.

public double AcceptableSampleRateRangeMin { get; }

Property Value

double

Format

The base format describing the most properties of the audio stream that this instance is attached to.

public WaveFormat Format { get; }

Property Value

WaveFormat

Methods

IsWaveFormatSatisfied(WaveFormat)

Tests whether the specified audio format can be used instead.

public bool IsWaveFormatSatisfied(WaveFormat otherFormat)

Parameters

otherFormat WaveFormat

The audio format to use.

Returns

bool

A value whether otherFormat is satisfied by the requirements imposed by this class instance.

Exceptions

ArgumentNullException

otherFormat is null.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.