Class GuildEffects

Namespace

Nyra

Assembly

Nyra.dll

The fading, ducking, loudness and crossfade effects of a guild connection.

public sealed class GuildEffects

Inheritance

object

GuildEffects

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

SetCrossfadeAsync(CrossfadeOptions?, CancellationToken)

Configures the crossfade between consecutive tracks, null turns it off.

public Task SetCrossfadeAsync(CrossfadeOptions? options = null, CancellationToken cancellationToken = default)

Parameters

options CrossfadeOptions

The crossfade to apply, null resets it.

cancellationToken CancellationToken

A token to cancel the operation.

Returns

Task

A task that completes when the crossfade was applied.

Exceptions

NotSupportedException

The node is not NodeLink.

SetDuckingAsync(bool, CancellationToken)

Turns speaking-detection ducking on or off, the depth and timing live in Ducking instead.

public Task SetDuckingAsync(bool enabled, CancellationToken cancellationToken = default)

Parameters

enabled bool

Whether ducking is on.

cancellationToken CancellationToken

A token to cancel the operation.

Returns

Task

A task that completes when ducking was switched.

Remarks

NodeLink 3.9.0 answers this switch with a 500, which surfaces as a RestException against that build. The stored configuration survives the failed write.

Exceptions

NotSupportedException

The node is not NodeLink.

SetFadingAsync(FadingOptions?, CancellationToken)

Configures fades around the player lifecycle, null disables every fade.

public Task SetFadingAsync(FadingOptions? options = null, CancellationToken cancellationToken = default)

Parameters

options FadingOptions

The fades to apply, null resets them.

cancellationToken CancellationToken

A token to cancel the operation.

Returns

Task

A task that completes when the fades were applied.

Exceptions

NotSupportedException

The node is not NodeLink.

SetLoudnessNormalizerAsync(bool, CancellationToken)

Turns loudness normalization on or off.

public Task SetLoudnessNormalizerAsync(bool enabled, CancellationToken cancellationToken = default)

Parameters

enabled bool

Whether the loudness normalizer is on.

cancellationToken CancellationToken

A token to cancel the operation.

Returns

Task

A task that completes when the normalizer was switched.

Exceptions

NotSupportedException

The node is not NodeLink.

SetNextTrackAsync(Track?, CancellationToken)

Preloads the next track for a gapless/crossfaded transition when the current one ends, null clears it.

public Task SetNextTrackAsync(Track? nextTrack, CancellationToken cancellationToken = default)

Parameters

nextTrack Track

The track to crossfade into, null clears it.

cancellationToken CancellationToken

A token to cancel the operation.

Returns

Task

A task that completes when the next track was set.

Remarks

The encoded track is self-contained on the wire, no node pairing is required or enforced.

Exceptions

NotSupportedException

The node is not NodeLink.