Class FadingOptions

Namespace

Nyra.Entities

Assembly

Nyra.dll

Fades around the player lifecycle, applied with SetFadingAsync(FadingOptions?, CancellationToken).

public sealed record FadingOptions : IEquatable<FadingOptions>

Inheritance

object

FadingOptions

Implements

IEquatable<FadingOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A sent chain replaces the whole configuration, sections left null fall back to no fade, same as FilterChain. NodeLink only.

Properties

Ducking

Speaking-detection ducking.

[JsonPropertyName("ducking")]
public DuckingOptions? Ducking { get; init; }

Property Value

DuckingOptions

Remarks

NodeLink only.

Enabled

Whether the fade chain is active.

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

Property Value

bool?

Remarks

Left null, the server stores the sections but keeps the chain disabled, only trackEnd still runs (scheduled before the enabled check), everything else is silently ignored. Set true to activate.

Pause

The fade applied when playback pauses.

[JsonPropertyName("pause")]
public FadeSection? Pause { get; init; }

Property Value

FadeSection

Resume

The fade applied when playback resumes.

[JsonPropertyName("resume")]
public FadeSection? Resume { get; init; }

Property Value

FadeSection

Seek

The fade applied when the position is sought.

[JsonPropertyName("seek")]
public FadeSection? Seek { get; init; }

Property Value

FadeSection

TrackEnd

The fade applied when a track ends.

[JsonPropertyName("trackEnd")]
public FadeSection? TrackEnd { get; init; }

Property Value

FadeSection

TrackStart

The fade applied when a track starts.

[JsonPropertyName("trackStart")]
public FadeSection? TrackStart { get; init; }

Property Value

FadeSection

TrackStop

The fade applied when the track is stopped.

[JsonPropertyName("trackStop")]
public FadeSection? TrackStop { get; init; }

Property Value

FadeSection