NodeLinkNode

Defined in: src/node/NodeLink.ts:38

Extends

• RyanlinkNode

Constructors

Constructor

new NodeLinkNode(options: NodeConfiguration, manager: NodeManager): NodeLinkNode;

Defined in: src/node/NodeLink.ts:41

Parameters

Parameter	Type
options	NodeConfiguration
manager	NodeManager

Returns

NodeLinkNode

Overrides

RyanlinkNode.constructor

Properties

Property (defined in)	Type	Default value
calls (src/node/Node.ts:69)	number	0
decode (src/node/Node.ts:694)	object	undefined
decode.multipleTracks (src/node/Node.ts:704)	(encodeds: string[], requester: unknown) => Promise<Track[]>	undefined
decode.singleTrack (src/node/Node.ts:695)	(encoded: string, requester: unknown) => Promise<Track>	undefined
handshakePing (src/node/Node.ts:71)	number	0
info (src/node/Node.ts:117)	NodeInfo	null
isAlive (src/node/Node.ts:64)	boolean	false
lyrics (src/node/Node.ts:717)	object	undefined
lyrics.get (src/node/Node.ts:718)	(track: Track, skipTrackSource: boolean) => Promise<LyricsResult>	undefined
lyrics.getCurrent (src/node/Node.ts:748)	(guildId: string, skipTrackSource: boolean) => Promise<LyricsResult>	undefined
lyrics.subscribe (src/node/Node.ts:767)	(guildId: string, skipTrackSource?: boolean) => Promise<unknown>	undefined
lyrics.unsubscribe (src/node/Node.ts:790)	(guildId: string) => Promise<void>	undefined
nodeType ({RyanlinkNode.nodeType} src/node/NodeLink.ts:39)	"NodeLink"	undefined
options (src/node/Node.ts:67)	NodeConfiguration	undefined
reconnectionState (src/node/Node.ts:121)	ReconnectionState	ReconnectionState.IDLE
resuming (src/node/Node.ts:116)	object	undefined
resuming.enabled (src/node/Node.ts:116)	boolean	undefined
resuming.timeout (src/node/Node.ts:116)	number	undefined
routePlannerApi (src/node/Node.ts:1035)	object	undefined
routePlannerApi.getStatus (src/node/Node.ts:1036)	() => Promise<RoutePlanner>	undefined
routePlannerApi.unmarkAllFailedAddresses (src/node/Node.ts:1051)	() => Promise<unknown>	undefined
routePlannerApi.unmarkFailedAddress (src/node/Node.ts:1041)	(address: string) => Promise<unknown>	undefined
sessionId? (src/node/Node.ts:114)	string	null
sourceRegistry (src/node/Node.ts:119)	SourceRegistry	undefined
specificFilters (src/node/NodeLink.ts:305)	object	undefined
specificFilters.chorus (src/node/NodeLink.ts:313)	(player: Player, options: NodeLink_ChorusFilter, disableFilter: boolean) => Promise<boolean>	undefined
specificFilters.compressor (src/node/NodeLink.ts:320)	(player: Player, options: NodeLink_CompressorFilter, disableFilter: boolean) => Promise<boolean>	undefined
specificFilters.echo (src/node/NodeLink.ts:306)	(player: Player, options: NodeLink_EchoFilter, disableFilter: boolean) => Promise<boolean>	undefined
specificFilters.highPass (src/node/NodeLink.ts:327)	(player: Player, options: NodeLink_HighPassFilter, disableFilter: boolean) => Promise<boolean>	undefined
specificFilters.phaser (src/node/NodeLink.ts:334)	(player: Player, options: NodeLink_PhaserFilter, disableFilter: boolean) => Promise<boolean>	undefined
specificFilters.resetNodeLinkFilters (src/node/NodeLink.ts:348)	(player: Player) => Promise<boolean>	undefined
specificFilters.spatial (src/node/NodeLink.ts:341)	(player: Player, options: NodeLink_SpatialFilter, disableFilter: boolean) => Promise<boolean>	undefined
stats (src/node/Node.ts:81)	NodeStats	undefined
timedLyrics (src/node/Node.ts:811)	object	undefined
timedLyrics.getByVideoId (src/node/Node.ts:824)	(videoId: string) => Promise<any>	undefined
timedLyrics.getCurrent (src/node/Node.ts:812)	(guildId: string) => Promise<any>	undefined
timedLyrics.search ({undefined} -)	(query: string, source?: "youtube" \	"genius") => Promise<any[]>
_NodeLinkClass (src/node/Node.ts:65)	unknown	null

Accessors

_checkForPlugins

Get Signature

get _checkForPlugins(): boolean;

Defined in: src/node/Node.ts:143

Returns

boolean

Inherited from

RyanlinkNode._checkForPlugins

---

_checkForSources

Get Signature

get _checkForSources(): boolean;

Defined in: src/node/Node.ts:148

Returns

boolean

Inherited from

RyanlinkNode._checkForSources

---

connected

Get Signature

get connected(): boolean;

Defined in: src/node/Node.ts:162

Returns

boolean

Inherited from

RyanlinkNode.connected

---

connectionStatus

Get Signature

get connectionStatus(): string;

Defined in: src/node/Node.ts:166

Returns

string

Inherited from

RyanlinkNode.connectionStatus

---

heartBeatPing

Get Signature

get heartBeatPing(): number;

Defined in: src/node/Node.ts:139

Returns

number

Inherited from

RyanlinkNode.heartBeatPing

---

id

Get Signature

get id(): string;

Defined in: src/node/Node.ts:544

Returns

string

Inherited from

RyanlinkNode.id

---

isNodeReconnecting

Get Signature

get isNodeReconnecting(): boolean;

Defined in: src/node/Node.ts:1196

Returns

boolean

Inherited from

RyanlinkNode.isNodeReconnecting

---

reconnectionAttemptCount

Get Signature

get reconnectionAttemptCount(): number;

Defined in: src/node/Node.ts:1225

Returns

number

Inherited from

RyanlinkNode.reconnectionAttemptCount

---

weightedScore

Get Signature

get weightedScore(): number;

Defined in: src/node/Node.ts:73

Returns

number

Inherited from

RyanlinkNode.weightedScore

Methods

addMixerLayer()

addMixerLayer(
   player: Player,
   trackToAdd: Track,
volume: number): Promise<AddMixerLayerResponse>;

Defined in: src/node/NodeLink.ts:79

Parameters

Parameter	Type
player	Player
trackToAdd	Track
volume	number

Returns

Promise<AddMixerLayerResponse>

---

audioSearch()

audioSearch(
   query: AudioSearchQuery,
   requestUser: unknown,
   throwOnEmpty?: boolean): Promise<
  | AudioSearchResponse
| SearchResult>;

Defined in: src/node/Node.ts:371

Parameters

Parameter	Type	Default value
query	AudioSearchQuery	undefined
requestUser	unknown	undefined
throwOnEmpty	boolean	false

Returns

Promise< | AudioSearchResponse | SearchResult>

Inherited from

RyanlinkNode.audioSearch

---

changeAudioTrackLanguage()

changeAudioTrackLanguage(player: Player, language_audioTrackId: string): Promise<any>;

Defined in: src/node/NodeLink.ts:251

Parameters

Parameter	Type
player	Player
language_audioTrackId	string

Returns

Promise<any>

---

connect()

connect(sessionId?: string): void;

Defined in: src/node/Node.ts:487

Parameters

Parameter	Type
sessionId?	string

Returns

void

Inherited from

RyanlinkNode.connect

---

deleteSponsorBlock()

deleteSponsorBlock(player: Player): Promise<void>;

Defined in: src/node/Node.ts:1725

Parameters

Parameter	Type
player	Player

Returns

Promise<void>

Inherited from

RyanlinkNode.deleteSponsorBlock

---

destroy()

destroy(
   destroyReason?: string,
   deleteNode?: boolean,
   movePlayers?: boolean): void;

Defined in: src/node/Node.ts:548

Parameters

Parameter	Type	Default value
destroyReason?	string	undefined
deleteNode?	boolean	true
movePlayers?	boolean	false

Returns

void

Inherited from

RyanlinkNode.destroy

---

destroyPlayer()

destroyPlayer(guildId: string): Promise<void>;

Defined in: src/node/Node.ts:479

Parameters

Parameter	Type
guildId	string

Returns

Promise<void>

Inherited from

RyanlinkNode.destroyPlayer

---

disconnect()

disconnect(disconnectReason?: string): void;

Defined in: src/node/Node.ts:644

Parameters

Parameter	Type
disconnectReason?	string

Returns

void

Inherited from

RyanlinkNode.disconnect

---

encodeTrack()

encodeTrack(trackInfo: Record<string, unknown>): Promise<EncodeTrackResponse>;

Defined in: src/node/NodeLink.ts:215

Parameters

Parameter	Type
trackInfo	Record<string, unknown>

Returns

Promise<EncodeTrackResponse>

---

encodeTracks()

encodeTracks(tracks: Record<string, unknown>[]): Promise<EncodeTracksResponse>;

Defined in: src/node/NodeLink.ts:222

Parameters

Parameter	Type
tracks	Record<string, unknown>[]

Returns

Promise<EncodeTracksResponse>

---

fetchAllPlayers()

fetchAllPlayers(): Promise<
  | InvalidRestRequest
| AudioPlayerState[]>;

Defined in: src/node/Node.ts:657

Returns

Promise< | InvalidRestRequest | AudioPlayerState[]>

Inherited from

RyanlinkNode.fetchAllPlayers

---

fetchConnectionMetrics()

fetchConnectionMetrics(): Promise<NodeLinkConnectionMetrics>;

Defined in: src/node/Node.ts:859

Returns

Promise<NodeLinkConnectionMetrics>

Inherited from

RyanlinkNode.fetchConnectionMetrics

---

fetchInfo()

fetchInfo(): Promise<NodeInfo>;

Defined in: src/node/Node.ts:875

Returns

Promise<NodeInfo>

Inherited from

RyanlinkNode.fetchInfo

---

fetchPlayer()

fetchPlayer(guildId: string): Promise<
  | AudioPlayerState
| InvalidRestRequest>;

Defined in: src/node/Node.ts:665

Parameters

Parameter	Type
guildId	string

Returns

Promise< | AudioPlayerState | InvalidRestRequest>

Inherited from

RyanlinkNode.fetchPlayer

---

fetchStats()

fetchStats(): Promise<BaseNodeStats>;

Defined in: src/node/Node.ts:855

Returns

Promise<BaseNodeStats>

Inherited from

RyanlinkNode.fetchStats

---

fetchVersion()

fetchVersion(): Promise<string>;

Defined in: src/node/Node.ts:865

Returns

Promise<string>

Inherited from

RyanlinkNode.fetchVersion

---

getChapters()

getChapters(player: Player, track?:
  | Track
| UnresolvedTrack): Promise<NodeLinkChapter[]>;

Defined in: src/node/NodeLink.ts:160

Parameters

Parameter	Type
player	Player
track?	| Track | UnresolvedTrack

Returns

Promise<NodeLinkChapter[]>

---

getConnectionMetrics()

getConnectionMetrics(): Promise<ConnectionMetricsResponse>;

Defined in: src/node/NodeLink.ts:170

Returns

Promise<ConnectionMetricsResponse>

---

getDetailedStats()

getDetailedStats(): Promise<NodeLinkDetailedStats>;

Defined in: src/node/NodeLink.ts:297

Returns

Promise<NodeLinkDetailedStats>

---

getDirectStream()

getDirectStream(track:
  | Track
| UnresolvedTrack, itag?: number): Promise<DirectStreamResponse>;

Defined in: src/node/NodeLink.ts:174

Parameters

Parameter	Type
track	| Track | UnresolvedTrack
itag?	number

Returns

Promise<DirectStreamResponse>

---

getHealthStatus()

getHealthStatus(thresholds?: HealthStatusThresholdOptions): HealthStatusObject;

Defined in: src/node/Node.ts:905

Parameters

Parameter	Type
thresholds?	HealthStatusThresholdOptions

Returns

HealthStatusObject

Inherited from

RyanlinkNode.getHealthStatus

---

getMeaning()

getMeaning(track?:
  | Track
| UnresolvedTrack, lang?: string): Promise<MeaningResponse>;

Defined in: src/node/NodeLink.ts:70

Parameters

Parameter	Type	Default value
track?	| Track | UnresolvedTrack	undefined
lang?	string	'en'

Returns

Promise<MeaningResponse>

---

getNodeLinkInfo()

getNodeLinkInfo(): Promise<NodeLinkInfo>;

Defined in: src/node/NodeLink.ts:301

Returns

Promise<NodeLinkInfo>

---

getSponsorBlock()

getSponsorBlock(player: Player): Promise<SponsorBlockSegment[]>;

Defined in: src/node/Node.ts:1679

Parameters

Parameter	Type
player	Player

Returns

Promise<SponsorBlockSegment[]>

Inherited from

RyanlinkNode.getSponsorBlock

---

getWorkers()

getWorkers(): Promise<WorkersResponse>;

Defined in: src/node/NodeLink.ts:230

Returns

Promise<WorkersResponse>

---

getYoutubeConfig()

getYoutubeConfig(validate?: boolean): Promise<YoutubeConfigResponse>;

Defined in: src/node/NodeLink.ts:275

Parameters

Parameter	Type	Default value
validate	boolean	false

Returns

Promise<YoutubeConfigResponse>

---

getYoutubeOAUTH()

getYoutubeOAUTH(refreshToken: string): Promise<YoutubeOAuthResponse>;

Defined in: src/node/NodeLink.ts:282

Parameters

Parameter	Type
refreshToken	string

Returns

Promise<YoutubeOAuthResponse>

---

hasXMPlugin()

hasXMPlugin(): boolean;

Defined in: src/node/Node.ts:851

Returns

boolean

Inherited from

RyanlinkNode.hasXMPlugin

---

isNodeLink()

isNodeLink(): this is NodeLinkNode;

Defined in: src/node/Node.ts:1091

Returns

this is NodeLinkNode

Inherited from

RyanlinkNode.isNodeLink

---

isRyanlinkNode()

isRyanlinkNode(): this is RyanlinkNode;

Defined in: src/node/Node.ts:1118

Returns

this is RyanlinkNode

Inherited from

RyanlinkNode.isRyanlinkNode

---

listMixerLayers()

listMixerLayers(player: Player): Promise<ListMixerLayersResponse>;

Defined in: src/node/NodeLink.ts:91

Parameters

Parameter	Type
player	Player

Returns

Promise<ListMixerLayersResponse>

---

loadChapters()

loadChapters(track:
  | Track
| UnresolvedTrack): Promise<LoadChaptersResponse>;

Defined in: src/node/NodeLink.ts:125

Parameters

Parameter	Type
track	| Track | UnresolvedTrack

Returns

Promise<LoadChaptersResponse>

---

loadDirectStream()

loadDirectStream(
   track:
  | Track
  | UnresolvedTrack,
   volume?: number,
   position?: number,
filters?: string | object): Promise<ReadableStream<any>>;

Defined in: src/node/NodeLink.ts:181

Parameters

Parameter	Type
track	| Track | UnresolvedTrack
volume?	number
position?	number
filters?	string | object

Returns

Promise<ReadableStream<any>>

---

loadDirectStreamPost()

loadDirectStreamPost(
   track:
  | Track
  | UnresolvedTrack,
   volume?: number,
   position?: number,
filters?: object): Promise<ReadableStream<any>>;

Defined in: src/node/NodeLink.ts:196

Parameters

Parameter	Type
track	| Track | UnresolvedTrack
volume?	number
position?	number
filters?	object

Returns

Promise<ReadableStream<any>>

---

loadLyrics()

loadLyrics(track:
  | Track
| UnresolvedTrack, lang?: string): Promise<LoadLyricsResponse>;

Defined in: src/node/NodeLink.ts:116

Parameters

Parameter	Type	Default value
track	| Track | UnresolvedTrack	undefined
lang	string	'en'

Returns

Promise<LoadLyricsResponse>

---

nodeLinkLyrics()

nodeLinkLyrics(
   player: Player,
   track?:
  | Track
  | UnresolvedTrack,
   language?: string): Promise<
  | NodeLinkLyrics
| NodeLinkNoLyrics>;

Defined in: src/node/NodeLink.ts:134

Parameters

Parameter	Type	Default value
player	Player	undefined
track?	| Track | UnresolvedTrack	undefined
language?	string	'en'

Returns

Promise< | NodeLinkLyrics | NodeLinkNoLyrics>

---

nodeMetricSummary()

nodeMetricSummary(): NodeMetricSummary;

Defined in: src/node/Node.ts:879

Returns

NodeMetricSummary

Inherited from

RyanlinkNode.nodeMetricSummary

---

patchWorker()

patchWorker(code: string, options: object): Promise<void>;

Defined in: src/node/NodeLink.ts:234

Parameters

Parameter	Type
code	string
options	{ clusterId?: number; id?: number; pid?: number; }
options.clusterId?	number
options.id?	number
options.pid?	number

Returns

Promise<void>

---

rawRequest()

rawRequest(endpoint: string, modify?: ModifyRequest): Promise<{
  options: RequestInit & object;
  response: Response;
}>;

Defined in: src/node/Node.ts:202

Parameters

Parameter	Type
endpoint	string
modify?	ModifyRequest

Returns

Promise<{ options: RequestInit & object; response: Response; }>

Inherited from

RyanlinkNode.rawRequest

---

removeMixerLayer()

removeMixerLayer(player: Player, mixId: string): Promise<boolean>;

Defined in: src/node/NodeLink.ts:108

Parameters

Parameter	Type
player	Player
mixId	string

Returns

Promise<boolean>

---

removeNextTrackGapLess()

removeNextTrackGapLess(player: Player): Promise<boolean>;

Defined in: src/node/NodeLink.ts:61

Parameters

Parameter	Type
player	Player

Returns

Promise<boolean>

---

request()

Call Signature

request(
   endpoint: string,
   modify: ModifyRequest,
parseAsText: true): Promise<string>;

Defined in: src/node/Node.ts:243

Parameters

Parameter	Type
endpoint	string
modify	ModifyRequest
parseAsText	true

Returns

Promise<string>

Inherited from

RyanlinkNode.request

Call Signature

request(
   endpoint: string,
   modify?: ModifyRequest,
parseAsText?: false): Promise<any>;

Defined in: src/node/Node.ts:244

Parameters

Parameter	Type
endpoint	string
modify?	ModifyRequest
parseAsText?	false

Returns

Promise<any>

Inherited from

RyanlinkNode.request

---

search()

search(
   query: SearchQuery,
   requestUser: unknown,
throwOnEmpty?: boolean): Promise<SearchResult>;

Defined in: src/node/Node.ts:263

Parameters

Parameter	Type	Default value
query	SearchQuery	undefined
requestUser	unknown	undefined
throwOnEmpty	boolean	false

Returns

Promise<SearchResult>

Inherited from

RyanlinkNode.search

---

setFading()

setFading(player: Player, fading: FadingConfig): Promise<void>;

Defined in: src/node/NodeLink.ts:242

Parameters

Parameter	Type
player	Player
fading	FadingConfig

Returns

Promise<void>

---

setNextTrackGapLess()

setNextTrackGapLess(player: Player, track?:
  | Track
| UnresolvedTrack): Promise<boolean>;

Defined in: src/node/NodeLink.ts:50

Parameters

Parameter	Type
player	Player
track?	| Track | UnresolvedTrack

Returns

Promise<boolean>

---

setSponsorBlock()

setSponsorBlock(player: Player, segments?: SponsorBlockSegment[]): Promise<void>;

Defined in: src/node/Node.ts:1690

Parameters

Parameter	Type
player	Player
segments	SponsorBlockSegment[]

Returns

Promise<void>

Inherited from

RyanlinkNode.setSponsorBlock

---

subscribeLyricsNodeLink()

subscribeLyricsNodeLink(player: Player, skipTrackSource?: boolean): Promise<void>;

Defined in: src/node/NodeLink.ts:144

Parameters

Parameter	Type	Default value
player	Player	undefined
skipTrackSource	boolean	false

Returns

Promise<void>

---

toJSON()

toJSON(): object;

Defined in: src/node/Node.ts:1850

Returns

object

Name	Type	Defined in
connected	boolean	src/node/Node.ts:1855
options	NodeConfiguration	src/node/Node.ts:1852
sessionId	string	src/node/Node.ts:1854
stats	NodeStats	src/node/Node.ts:1853
version	string	src/node/Node.ts:1856

Inherited from

RyanlinkNode.toJSON

---

unsubscribeLyricsNodeLink()

unsubscribeLyricsNodeLink(player: Player): Promise<void>;

Defined in: src/node/NodeLink.ts:152

Parameters

Parameter	Type
player	Player

Returns

Promise<void>

---

updateMixerLayerVolume()

updateMixerLayerVolume(
   player: Player,
   mixId: string,
volume: number): Promise<boolean>;

Defined in: src/node/NodeLink.ts:98

Parameters

Parameter	Type
player	Player
mixId	string
volume	number

Returns

Promise<boolean>

---

updatePlayer()

updatePlayer(data: PlayerUpdateInfo): Promise<AudioPlayerState>;

Defined in: src/node/Node.ts:450

Parameters

Parameter	Type
data	PlayerUpdateInfo

Returns

Promise<AudioPlayerState>

Inherited from

RyanlinkNode.updatePlayer

---

updateSession()

updateSession(): Promise<
  | InvalidRestRequest
| Session>;

Defined in: src/node/Node.ts:670

Returns

Promise< | InvalidRestRequest | Session>

Inherited from

RyanlinkNode.updateSession

---

updateYoutubeConfig()

updateYoutubeConfig(refreshToken?: string, visitorData?: string): Promise<any>;

Defined in: src/node/NodeLink.ts:266

Parameters

Parameter	Type
refreshToken?	string
visitorData?	string

Returns

Promise<any>

---

updateYoutubeOAUTH()

updateYoutubeOAUTH(refreshToken: string): Promise<YoutubeOAuthResponse>;

Defined in: src/node/NodeLink.ts:289

Parameters

Parameter	Type
refreshToken	string

Returns

Promise<YoutubeOAuthResponse>