Table of Contents

Namespace Nyra.Entities

Classes

ApiCounters

API counters of the detailed stats snapshot.

Chapter

Chapter of a track, from NodeLink's /v4/loadchapters, only YouTube and YouTube Music tracks carry them.

ConnectionStatus

The node's own outbound network health, from GET /v4/connection or pushed through ConnectionStatusEvent.

CpuStats

CPU load statistics of the server.

CrossfadeOptions

Per-player crossfade configuration, applied with SetCrossfadeAsync(CrossfadeOptions?, CancellationToken).

DetailedStats

Per-domain counter snapshot of NodeLink's stats manager, REST only.

DuckingOptions

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

ErrorInfo

An error reported by an audio node, in load results and track exception events.

EternalBoxAnalysisSummary

Count summary of the EternalBox beat analysis, every count is null when the analysis could not be built for the track.

EternalBoxInfo

Context of the EternalBox continuous-playback engine for the playing track.

EternalBoxJump

A beat-to-beat move of the EternalBox engine.

EternalBoxLinks

Alternate URLs for an EternalBox track, pages, analysis, and audio sources.

EternalBoxSpotify

Spotify cross-reference of an EternalBox track.

FadeSection

One fade of a FadingOptions chain.

FadingOptions

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

FailingAddress

An address the planner currently treats as failing.

FilterChain

Audio filter chain of a player.

FrameStats

Audio frame statistics of the server. The window is the last minute on Lavalink, lifetime totals per voice connection on NodeLink, the members are not comparable across the two servers.

Group

A group of players under one id, from NodeLink's group routes.

GroupGuildError

One guild's failure inside a GroupUpdateResult, the update continued past it.

GroupMembership

Membership changes of a GroupUpdate.

GroupTrack

The track a GroupUpdate makes every member play.

GroupUpdate

What a group update changes.

GroupUpdateResult

The result of a group update, the players it reached and the per-guild failures.

IcyMetadata

Shoutcast/Icecast metadata of a live stream, reported while the stream plays.

IcyStreamHeaders

Station headers announced with the stream.

LoadResult

Result of a load-tracks operation, pattern-match on the derived record type.

LoadResult.LoadFailed

The load failed.

LoadResult.NoMatches

The load matched nothing.

LoadResult.PlaylistLoaded

A playlist was loaded.

LoadResult.SearchLoaded

Search results were loaded.

LoadResult.TrackLoaded

One track was loaded.

LyricsData

Lyrics of a track, as resolved by the node's providers.

LyricsLine

One timed line of a lyrics result.

LyricsResult

Result of a lyrics load, the data shape depends on LoadType.

MeaningData

The meaning text of a track, a summary of what the song is about.

MeaningMeta

Editorial metadata of a meaning, as Letras.mus curates it.

MeaningResult

Outcome of a meaning load, the data member is present for every load type, the meaning when Meaning, an empty object when Empty, the error details when Error.

MeaningSong

The song the meaning was written about.

MeaningTranslation

Translated counterpart of a meaning text.

MeaningTranslationLanguage

Language pair of a meaning translation.

MemoryStats

Memory statistics of an audio node, in bytes.

MixLayer

One mix layer of a player, a track playing on top of the main one.

NodeInfo

Descriptive information about an audio node, from GET /v4/info.

NodeInfoGit

Git revision a server was built from.

NodeInfoPlugin

A plugin loaded by the server.

NodeInfoVersion

Version of a server.

NodeInfoVoice

The voice library a NodeLink server speaks Discord voice through.

PlayOptions

Options of a playback request issued through PlayAsync(Track, PlayOptions?, CancellationToken) or PlayIdentifierAsync(string, PlayOptions?, CancellationToken).

PlaybackCounters

Playback counters of the detailed stats snapshot.

Player

A player as returned by the audio node.

PlayerState

Player state, delivered through playerUpdate operations and player REST responses.

PlayerVoiceState

Discord voice state of a player.

PlaylistInfo

The metadata of a loaded playlist.

RoutePlannerDetails

Planner details.

RoutePlannerIpBlock

The IP pool the planner draws addresses from.

RoutePlannerStatus

Status of the server's IP route planner, served by both.

SessionConfig

Session resuming configuration, request body and response of a session update.

SourceCounters

Per-source counters of the detailed stats snapshot.

SponsorBlockSegment

A SponsorBlock segment of the current track.

SponsorBlockSettings

SponsorBlock settings to change, members left null keep their current value.

SponsorBlockState

SponsorBlock state of a player, as reported by the server.

Stats

Statistics of an audio node, from the stats websocket operation or GET /v4/stats.

StreamMetadata

One live-stream metadata update, delivered through StreamMetadataEvent.

Track

An audio track, as returned by load results, player updates and playback events.

TrackInfo

The descriptive info of a track.

TrackStreamUrl

The direct stream URL of a track, as NodeLink's track stream route resolved it.

YouTubeAudioTrack

One audio track of a multi-audio YouTube video, such as a dubbed language.

YouTubeConfig

The runtime YouTube configuration of a NodeLink server, as the config route reports it.

YouTubeConfigUpdate

The outcome of a YouTube configuration update on a NodeLink server.

YouTubeToken

An access token the YouTube OAuth route issued for a refresh token.

YouTubeTrackExtensions

Reads the YouTube audio tracks NodeLink reports for a video.

Structs

EqualizerBand

A single equalizer band adjustment.

Enums

ConnectionQuality

Classification of the node's own outbound network health.

CrossfadeCurve

Crossfade fade curve, the server defaults to Sinusoidal.

CrossfadeMode

How the server prepares the crossfade, the default is Preload.

ErrorSeverity

How severe the server considers a load error.

EternalBoxJumpType

Why the EternalBox engine moved to another beat.

FadeType

What a fade acts on, the server default is Volume.

IpBlockType

Address family of the planner's IP block.

LoadType

Outcome of a load-tracks operation.

LyricsLoadType

Outcome of a lyrics load.

MeaningLoadType

Outcome of a meaning load.

MixEndReason

Why a mix layer ended.

RoutePlannerClass

The route planner implementation the server reports.

SearchType

Strategy for resolving a track query on LoadTracksAsync(string, SearchType, CancellationToken).

TrackEndReason

Why a track ended.