Class DuckingOptions

Namespace

Nyra.Entities

Assembly

Nyra.dll

Depth and timing of speaking-detection ducking, part of FadingOptions.

public sealed record DuckingOptions : IEquatable<DuckingOptions>

Inheritance

object

DuckingOptions

Implements

IEquatable<DuckingOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Configuring this does not by itself enable ducking. The switch is SetDuckingAsync(bool, CancellationToken), which picks up these values, and Enabled only travels with the stored configuration. NodeLink only.

NodeLink 3.9.0 answers the switch itself with a 500. The stored configuration survives the failed write.

Properties

Curve

Ducking curve by name, case-sensitive, linear, exponential, logarithmic or s-curve.

[JsonPropertyName("curve")]
public string? Curve { get; init; }

Property Value

string

Remarks

Null uses the engine default.

DurationMilliseconds

How long the ducking takes, in milliseconds, the server default is 500.

[JsonPropertyName("duration")]
[JsonConverter(typeof(RoundedInt32Converter))]
public int? DurationMilliseconds { get; init; }

Property Value

int?

Enabled

Whether ducking lowers the volume of the main track.

[JsonPropertyName("enabled")]
public bool? Enabled { get; init; }

Property Value

bool?

TargetVolume

Volume to duck to, 0-1, the server default is 0.3.

[JsonPropertyName("targetVolume")]
[JsonConverter(typeof(FiniteFloatConverter))]
public float? TargetVolume { get; init; }

Property Value

float?

Remarks

The converter fails an out-of-range echo inside the read (1e40 reads back non-finite).