Class AudioEngineSettings

Namespace: MicroEngine.Audio
Assembly: MicroEngine.Audio.dll
Guide: Audio

Settings of an AudioEngine.

C#

public sealed record AudioEngineSettings : IEquatable<AudioEngineSettings>

Inheritance

object ← AudioEngineSettings

Implements

IEquatable<AudioEngineSettings>

Constructors

AudioEngineSettings()

C#

public AudioEngineSettings()

Properties

DelayFrames

Frames between a step and the sounds it starts; raised to the sink’s LatencyFrames, so every sound starts at an exact frame whatever block sizes the sink renders. Null for the sink’s latency.

C#

public int? DelayFrames { get; init; }

Property Value

int?

MaxVoices

Sounds that can play at once (32 by default); the voice policy decides beyond that.

C#

public int MaxVoices { get; init; }

Property Value

int

StreamAheadSeconds

Output frames of streamed music decoded ahead (by Pump); half a second by default.

C#

public double StreamAheadSeconds { get; init; }

Property Value

double

UpdateRate

Simulation steps per second: the engine stamps each sound with the output frame of its step.

C#

public int UpdateRate { get; init; }

Property Value

int

Methods

<Clone>$()

C#

public AudioEngineSettings <Clone>$()

Returns

AudioEngineSettings

Equals(object?)

C#

public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

Equals(AudioEngineSettings?)

C#

public bool Equals(AudioEngineSettings? other)

Parameters

other AudioEngineSettings?

Returns

bool

GetHashCode()

C#

public override int GetHashCode()

Returns

int

ToString()

C#

public override string ToString()

Returns

string

Operators

operator ==(AudioEngineSettings?, AudioEngineSettings?)

C#

public static bool operator ==(AudioEngineSettings? left, AudioEngineSettings? right)

Parameters

left AudioEngineSettings?

right AudioEngineSettings?

Returns

bool

operator !=(AudioEngineSettings?, AudioEngineSettings?)

C#

public static bool operator !=(AudioEngineSettings? left, AudioEngineSettings? right)

Parameters

left AudioEngineSettings?

right AudioEngineSettings?

Returns

bool