Struct Synthesizer.Options

Namespace

SpessaSharp.Synthesizer

Assembly

SpessaSharp.dll

The maximum buffer size the synthesizer can render at once. Attempting to .Process() more samples than this will result in an error. Defaults to 128.

public readonly record struct Synthesizer.Options : IEquatable<Synthesizer.Options>

Implements

IEquatable<Synthesizer.Options>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

Options(int, bool, float, bool, ReverbProcessor?, ChorusProcessor?, DelayProcessor?)

The maximum buffer size the synthesizer can render at once. Attempting to .Process() more samples than this will result in an error. Defaults to 128.

public Options(int MaxBufferSize, bool EventsEnabled, float InitialTime, bool EffectsEnabled, Effect.ReverbProcessor? ReverbProcessor = null, Effect.ChorusProcessor? ChorusProcessor = null, Effect.DelayProcessor? DelayProcessor = null)

Parameters

MaxBufferSize int

EventsEnabled bool

Indicates if the event system is enabled. This can be changed later.

InitialTime float

The initial time of the synth, in seconds.

EffectsEnabled bool

Indicates if the effects are enabled. This can be changed later.

ReverbProcessor Effect.ReverbProcessor

Reverb processor for the synthesizer. Leave undefined to use the default.

ChorusProcessor Effect.ChorusProcessor

Chorus processor for the synthesizer. Leave undefined to use the default.

DelayProcessor Effect.DelayProcessor

Delay processor for the synthesizer. Leave undefined to use the default.

Fields

Default

public static readonly Synthesizer.Options Default

Field Value

Synthesizer.Options

Properties

ChorusProcessor

Chorus processor for the synthesizer. Leave undefined to use the default.

public Effect.ChorusProcessor? ChorusProcessor { get; init; }

Property Value

Effect.ChorusProcessor

DelayProcessor

Delay processor for the synthesizer. Leave undefined to use the default.

public Effect.DelayProcessor? DelayProcessor { get; init; }

Property Value

Effect.DelayProcessor

EffectsEnabled

Indicates if the effects are enabled. This can be changed later.

public bool EffectsEnabled { get; init; }

Property Value

bool

EventsEnabled

Indicates if the event system is enabled. This can be changed later.

public bool EventsEnabled { get; init; }

Property Value

bool

InitialTime

The initial time of the synth, in seconds.

public float InitialTime { get; init; }

Property Value

float

MaxBufferSize

public int MaxBufferSize { get; init; }

Property Value

int

ReverbProcessor

Reverb processor for the synthesizer. Leave undefined to use the default.

public Effect.ReverbProcessor? ReverbProcessor { get; init; }

Property Value

Effect.ReverbProcessor