BaseNode | @skyra/audio

Hierarchy

EventEmitter
- BaseNode
  - ClusterNode
  - Node

Index

Constructors

constructor

Properties

Accessors

connected

Methods

Constructors

constructor

new BaseNode(__namedParameters: NodeOptions): BaseNode

Overrides EventEmitter.constructor
- Defined in base/BaseNode.ts:112
Parameters
- __namedParameters: NodeOptions
Returns BaseNode

Properties

Private _expectingConnection

_expectingConnection: Set<string> = ...

connection

connection: null | Connection<BaseNode> = null

http

http: null | Http = null

password

password: string

players

players: PlayerStore<BaseNode>

Abstract send

send: NodeSend

Optional shardCount

shardCount?: number

userID

userID: string

voiceServers

voiceServers: Map<string, GatewayVoiceServerUpdateDispatchData> = ...

voiceStates

voiceStates: Map<string, GatewayVoiceState> = ...

Accessors

connected

get connected(): boolean

- Defined in base/BaseNode.ts:142
Whether or not the node is connected to the websocket.

Returns boolean

Methods

Private _tryConnection

_tryConnection(guildID: string): Promise<boolean>

- Defined in base/BaseNode.ts:273
Parameters
- guildID: string
Returns Promise<boolean>

addListener

addListener(event: Close, cb: (code: number, reason: string) => void): BaseNode
addListener(event: Error, cb: (error: Error) => void): BaseNode
addListener(event: Event, cb: (payload: IncomingEventPayload) => void): BaseNode
addListener(event: Open, cb: () => void): BaseNode
addListener(event: PlayerUpdate, cb: (payload: IncomingPlayerUpdatePayload) => void): BaseNode
addListener(event: Stats, cb: (payload: IncomingStatsPayload) => void): BaseNode
addListener(event: Upgrade, cb: (req: IncomingMessage) => void): BaseNode

Inherited from EventEmitter.addListener
- Defined in base/BaseNode.ts:302
Parameters
- event: Close
- cb: (code: number, reason: string) => void
  - - (code: number, reason: string): void
    - Parameters
      - code: number
      - reason: string
      Returns void
Returns BaseNode
Inherited from EventEmitter.addListener
- Defined in base/BaseNode.ts:303
Parameters
- event: Error
- cb: (error: Error) => void
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns BaseNode
Inherited from EventEmitter.addListener
- Defined in base/BaseNode.ts:304
Parameters
- event: Event
- cb: (payload: IncomingEventPayload) => void
  - - (payload: IncomingEventPayload): void
    - Parameters
      - payload: IncomingEventPayload
      Returns void
Returns BaseNode
Inherited from EventEmitter.addListener
- Defined in base/BaseNode.ts:305
Parameters
- event: Open
- cb: () => void
  - - (): void
    - Returns void
Returns BaseNode
Inherited from EventEmitter.addListener
- Defined in base/BaseNode.ts:306
Parameters
- event: PlayerUpdate
- cb: (payload: IncomingPlayerUpdatePayload) => void
  - - (payload: IncomingPlayerUpdatePayload): void
    - Parameters
      - payload: IncomingPlayerUpdatePayload
      Returns void
Returns BaseNode
Inherited from EventEmitter.addListener
- Defined in base/BaseNode.ts:307
Parameters
- event: Stats
- cb: (payload: IncomingStatsPayload) => void
  - - (payload: IncomingStatsPayload): void
    - Parameters
      - payload: IncomingStatsPayload
      Returns void
Returns BaseNode
Inherited from EventEmitter.addListener
- Defined in base/BaseNode.ts:308
Parameters
- event: Upgrade
- cb: (req: IncomingMessage) => void
  - - (req: IncomingMessage): void
    - Parameters
      - req: IncomingMessage
      Returns void
Returns BaseNode

connect

connect(): Promise<void>

- Defined in base/BaseNode.ts:135
Connects to the server.

Returns Promise<void>

decode

decode(track: string): Promise<TrackInfo>
decode(tracks: string[]): Promise<Track[]>

Decodes a track.

example

const identifier = 'QAAAjQIAJVJpY2sgQXN0bGV5IC0gTmV2ZXIgR29ubmEgR2l2ZSBZb3UgVXAADlJpY2tBc3RsZXlWRVZPAAAAAAADPCAAC2RRdzR3OVdnWGNRAAEAK2h0dHBzOi8vd3d3LnlvdXR1YmUuY29tL3dhdGNoP3Y9ZFF3NHc5V2dYY1EAB3lvdXR1YmUAAAAAAAAAAA==';

const track = await http.decode(identifier);
console.log(track);
// Logs: {
//   "identifier": "dQw4w9WgXcQ",
//   "isSeekable": true,
//   "author": "RickAstleyVEVO",
//   "length": 212000,
//   "isStream": false,
//   "position": 0,
//   "title": "Rick Astley - Never Gonna Give You Up",
//   "uri": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
// }

Parameters

track: string

The track to be decoded.

Returns Promise<TrackInfo>

- Defined in base/BaseNode.ts:237
Decodes multiple tracks.

note
This returns an array of Tracks, not a TrackInfo.

Parameters
- tracks: string[]
  
  The tracks to be decoded.
Returns Promise<Track[]>

destroy

destroy(code?: number, data?: string): Promise<void>

- Defined in base/BaseNode.ts:268
Parameters
- Optional code: number
- Optional data: string
Returns Promise<void>

disconnect

disconnect(code?: number, data?: string): Promise<boolean>

- Defined in base/BaseNode.ts:263
Parameters
- Optional code: number
- Optional data: string
Returns Promise<boolean>

emit

emit(event: Close, code: number, reason: string): boolean
emit(event: Error, error: Error): boolean
emit(event: Event, payload: IncomingEventPayload): boolean
emit(event: Open): boolean
emit(event: PlayerUpdate, payload: IncomingPlayerUpdatePayload): boolean
emit(event: Stats, payload: IncomingStatsPayload): boolean
emit(event: Upgrade, req: IncomingMessage): boolean

Inherited from EventEmitter.emit
- Defined in base/BaseNode.ts:326
Parameters
- event: Close
- code: number
- reason: string
Returns boolean
Inherited from EventEmitter.emit
- Defined in base/BaseNode.ts:327
Parameters
- event: Error
- error: Error
Returns boolean
Inherited from EventEmitter.emit
- Defined in base/BaseNode.ts:328
Parameters
- event: Event
- payload: IncomingEventPayload
Returns boolean
Inherited from EventEmitter.emit
- Defined in base/BaseNode.ts:329
Parameters
- event: Open
Returns boolean
Inherited from EventEmitter.emit
- Defined in base/BaseNode.ts:330
Parameters
- event: PlayerUpdate
- payload: IncomingPlayerUpdatePayload
Returns boolean
Inherited from EventEmitter.emit
- Defined in base/BaseNode.ts:331
Parameters
- event: Stats
- payload: IncomingStatsPayload
Returns boolean
Inherited from EventEmitter.emit
- Defined in base/BaseNode.ts:332
Parameters
- event: Upgrade
- req: IncomingMessage
Returns boolean

load

load(identifier: string): Promise<TrackResponse>

Loads a song.

example

// Load from URL:

const result = await node.load('https://www.youtube.com/watch?v=dQw4w9WgXcQ');
console.log(result);
// {
//   "loadType": "TRACK_LOADED",
//   "playlistInfo": {},
//   "tracks": [
//     {
//       "track": "QAAAjQIAJVJpY2sgQXN0bGV5IC0gTmV2ZXIgR29ubmEgR2l2ZSBZb3UgVXAADlJpY2tBc3RsZXlWRVZPAAAAAAADPCAAC2RRdzR3OVdnWGNRAAEAK2h0dHBzOi8vd3d3LnlvdXR1YmUuY29tL3dhdGNoP3Y9ZFF3NHc5V2dYY1EAB3lvdXR1YmUAAAAAAAAAAA==",
//       "info": {
//         "identifier": "dQw4w9WgXcQ",
//         "isSeekable": true,
//         "author": "RickAstleyVEVO",
//         "length": 212000,
//         "isStream": false,
//         "position": 0,
//         "title": "Rick Astley - Never Gonna Give You Up",
//         "uri": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
//       }
//     }
//   ]
// }

example

// Load from YouTube search:

const result = await node.load('ytsearch: Never Gonna Give You Up');
console.log(result);
// {
//   "loadType": "SEARCH_RESULT",
//   "playlistInfo": {},
//   "tracks": [
//     {
//       "track": "...",
//       "info": {
//         "identifier": "dQw4w9WgXcQ",
//         "isSeekable": true,
//         "author": "RickAstleyVEVO",
//         "length": 212000,
//         "isStream": false,
//         "position": 0,
//         "title": "Rick Astley - Never Gonna Give You Up",
//         "uri": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
//       }
//     },
//     ...
//   ]
// }

Parameters

identifier: string

The track to be loaded.

Returns Promise<TrackResponse>

off

off(event: Close, cb: (code: number, reason: string) => void): BaseNode
off(event: Error, cb: (error: Error) => void): BaseNode
off(event: Event, cb: (payload: IncomingEventPayload) => void): BaseNode
off(event: Open, cb: () => void): BaseNode
off(event: PlayerUpdate, cb: (payload: IncomingPlayerUpdatePayload) => void): BaseNode
off(event: Stats, cb: (payload: IncomingStatsPayload) => void): BaseNode
off(event: Upgrade, cb: (req: IncomingMessage) => void): BaseNode

Inherited from EventEmitter.off
- Defined in base/BaseNode.ts:310
Parameters
- event: Close
- cb: (code: number, reason: string) => void
  - - (code: number, reason: string): void
    - Parameters
      - code: number
      - reason: string
      Returns void
Returns BaseNode
Inherited from EventEmitter.off
- Defined in base/BaseNode.ts:311
Parameters
- event: Error
- cb: (error: Error) => void
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns BaseNode
Inherited from EventEmitter.off
- Defined in base/BaseNode.ts:312
Parameters
- event: Event
- cb: (payload: IncomingEventPayload) => void
  - - (payload: IncomingEventPayload): void
    - Parameters
      - payload: IncomingEventPayload
      Returns void
Returns BaseNode
Inherited from EventEmitter.off
- Defined in base/BaseNode.ts:313
Parameters
- event: Open
- cb: () => void
  - - (): void
    - Returns void
Returns BaseNode
Inherited from EventEmitter.off
- Defined in base/BaseNode.ts:314
Parameters
- event: PlayerUpdate
- cb: (payload: IncomingPlayerUpdatePayload) => void
  - - (payload: IncomingPlayerUpdatePayload): void
    - Parameters
      - payload: IncomingPlayerUpdatePayload
      Returns void
Returns BaseNode
Inherited from EventEmitter.off
- Defined in base/BaseNode.ts:315
Parameters
- event: Stats
- cb: (payload: IncomingStatsPayload) => void
  - - (payload: IncomingStatsPayload): void
    - Parameters
      - payload: IncomingStatsPayload
      Returns void
Returns BaseNode
Inherited from EventEmitter.off
- Defined in base/BaseNode.ts:316
Parameters
- event: Upgrade
- cb: (req: IncomingMessage) => void
  - - (req: IncomingMessage): void
    - Parameters
      - req: IncomingMessage
      Returns void
Returns BaseNode

on

on(event: Close, cb: (code: number, reason: string) => void): BaseNode
on(event: Error, cb: (error: Error) => void): BaseNode
on(event: Event, cb: (payload: IncomingEventPayload) => void): BaseNode
on(event: Open, cb: () => void): BaseNode
on(event: PlayerUpdate, cb: (payload: IncomingPlayerUpdatePayload) => void): BaseNode
on(event: Stats, cb: (payload: IncomingStatsPayload) => void): BaseNode
on(event: Upgrade, cb: (req: IncomingMessage) => void): BaseNode

Inherited from EventEmitter.on
- Defined in base/BaseNode.ts:286
Parameters
- event: Close
- cb: (code: number, reason: string) => void
  - - (code: number, reason: string): void
    - Parameters
      - code: number
      - reason: string
      Returns void
Returns BaseNode
Inherited from EventEmitter.on
- Defined in base/BaseNode.ts:287
Parameters
- event: Error
- cb: (error: Error) => void
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns BaseNode
Inherited from EventEmitter.on
- Defined in base/BaseNode.ts:288
Parameters
- event: Event
- cb: (payload: IncomingEventPayload) => void
  - - (payload: IncomingEventPayload): void
    - Parameters
      - payload: IncomingEventPayload
      Returns void
Returns BaseNode
Inherited from EventEmitter.on
- Defined in base/BaseNode.ts:289
Parameters
- event: Open
- cb: () => void
  - - (): void
    - Returns void
Returns BaseNode
Inherited from EventEmitter.on
- Defined in base/BaseNode.ts:290
Parameters
- event: PlayerUpdate
- cb: (payload: IncomingPlayerUpdatePayload) => void
  - - (payload: IncomingPlayerUpdatePayload): void
    - Parameters
      - payload: IncomingPlayerUpdatePayload
      Returns void
Returns BaseNode
Inherited from EventEmitter.on
- Defined in base/BaseNode.ts:291
Parameters
- event: Stats
- cb: (payload: IncomingStatsPayload) => void
  - - (payload: IncomingStatsPayload): void
    - Parameters
      - payload: IncomingStatsPayload
      Returns void
Returns BaseNode
Inherited from EventEmitter.on
- Defined in base/BaseNode.ts:292
Parameters
- event: Upgrade
- cb: (req: IncomingMessage) => void
  - - (req: IncomingMessage): void
    - Parameters
      - req: IncomingMessage
      Returns void
Returns BaseNode

once

once(event: Close, cb: (code: number, reason: string) => void): BaseNode
once(event: Error, cb: (error: Error) => void): BaseNode
once(event: Event, cb: (payload: IncomingEventPayload) => void): BaseNode
once(event: Open, cb: () => void): BaseNode
once(event: PlayerUpdate, cb: (payload: IncomingPlayerUpdatePayload) => void): BaseNode
once(event: Stats, cb: (payload: IncomingStatsPayload) => void): BaseNode
once(event: Upgrade, cb: (req: IncomingMessage) => void): BaseNode

Inherited from EventEmitter.once
- Defined in base/BaseNode.ts:294
Parameters
- event: Close
- cb: (code: number, reason: string) => void
  - - (code: number, reason: string): void
    - Parameters
      - code: number
      - reason: string
      Returns void
Returns BaseNode
Inherited from EventEmitter.once
- Defined in base/BaseNode.ts:295
Parameters
- event: Error
- cb: (error: Error) => void
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns BaseNode
Inherited from EventEmitter.once
- Defined in base/BaseNode.ts:296
Parameters
- event: Event
- cb: (payload: IncomingEventPayload) => void
  - - (payload: IncomingEventPayload): void
    - Parameters
      - payload: IncomingEventPayload
      Returns void
Returns BaseNode
Inherited from EventEmitter.once
- Defined in base/BaseNode.ts:297
Parameters
- event: Open
- cb: () => void
  - - (): void
    - Returns void
Returns BaseNode
Inherited from EventEmitter.once
- Defined in base/BaseNode.ts:298
Parameters
- event: PlayerUpdate
- cb: (payload: IncomingPlayerUpdatePayload) => void
  - - (payload: IncomingPlayerUpdatePayload): void
    - Parameters
      - payload: IncomingPlayerUpdatePayload
      Returns void
Returns BaseNode
Inherited from EventEmitter.once
- Defined in base/BaseNode.ts:299
Parameters
- event: Stats
- cb: (payload: IncomingStatsPayload) => void
  - - (payload: IncomingStatsPayload): void
    - Parameters
      - payload: IncomingStatsPayload
      Returns void
Returns BaseNode
Inherited from EventEmitter.once
- Defined in base/BaseNode.ts:300
Parameters
- event: Upgrade
- cb: (req: IncomingMessage) => void
  - - (req: IncomingMessage): void
    - Parameters
      - req: IncomingMessage
      Returns void
Returns BaseNode

removeListener

removeListener(event: Close, cb: (code: number, reason: string) => void): BaseNode
removeListener(event: Error, cb: (error: Error) => void): BaseNode
removeListener(event: Event, cb: (payload: IncomingEventPayload) => void): BaseNode
removeListener(event: Open, cb: () => void): BaseNode
removeListener(event: PlayerUpdate, cb: (payload: IncomingPlayerUpdatePayload) => void): BaseNode
removeListener(event: Stats, cb: (payload: IncomingStatsPayload) => void): BaseNode
removeListener(event: Upgrade, cb: (req: IncomingMessage) => void): BaseNode

Inherited from EventEmitter.removeListener
- Defined in base/BaseNode.ts:318
Parameters
- event: Close
- cb: (code: number, reason: string) => void
  - - (code: number, reason: string): void
    - Parameters
      - code: number
      - reason: string
      Returns void
Returns BaseNode
Inherited from EventEmitter.removeListener
- Defined in base/BaseNode.ts:319
Parameters
- event: Error
- cb: (error: Error) => void
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns BaseNode
Inherited from EventEmitter.removeListener
- Defined in base/BaseNode.ts:320
Parameters
- event: Event
- cb: (payload: IncomingEventPayload) => void
  - - (payload: IncomingEventPayload): void
    - Parameters
      - payload: IncomingEventPayload
      Returns void
Returns BaseNode
Inherited from EventEmitter.removeListener
- Defined in base/BaseNode.ts:321
Parameters
- event: Open
- cb: () => void
  - - (): void
    - Returns void
Returns BaseNode
Inherited from EventEmitter.removeListener
- Defined in base/BaseNode.ts:322
Parameters
- event: PlayerUpdate
- cb: (payload: IncomingPlayerUpdatePayload) => void
  - - (payload: IncomingPlayerUpdatePayload): void
    - Parameters
      - payload: IncomingPlayerUpdatePayload
      Returns void
Returns BaseNode
Inherited from EventEmitter.removeListener
- Defined in base/BaseNode.ts:323
Parameters
- event: Stats
- cb: (payload: IncomingStatsPayload) => void
  - - (payload: IncomingStatsPayload): void
    - Parameters
      - payload: IncomingStatsPayload
      Returns void
Returns BaseNode
Inherited from EventEmitter.removeListener
- Defined in base/BaseNode.ts:324
Parameters
- event: Upgrade
- cb: (req: IncomingMessage) => void
  - - (req: IncomingMessage): void
    - Parameters
      - req: IncomingMessage
      Returns void
Returns BaseNode

voiceServerUpdate

voiceServerUpdate(packet: GatewayVoiceServerUpdateDispatchData): Promise<boolean>

- Defined in base/BaseNode.ts:257
Parameters
- packet: GatewayVoiceServerUpdateDispatchData
Returns Promise<boolean>

voiceStateUpdate

voiceStateUpdate(packet: GatewayVoiceState): Promise<boolean>

- Defined in base/BaseNode.ts:243
Parameters
- packet: GatewayVoiceState
Returns Promise<boolean>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: NodeOptions

Returns BaseNode

Properties

Private _expectingConnection

connection

http

password

players

Abstract send

Optional shardCount

userID

voiceServers

voiceStates

Accessors

connected

Returns boolean

Methods

Private _tryConnection

Parameters

guildID: string

Returns Promise<boolean>

addListener

Parameters

event: Close

cb: (code: number, reason: string) => void

Parameters

code: number

reason: string

Returns void

Returns BaseNode

Parameters

event: Error

cb: (error: Error) => void

Parameters

error: Error

Returns void

Returns BaseNode

Parameters

event: Event

cb: (payload: IncomingEventPayload) => void

Parameters

payload: IncomingEventPayload

Returns void

Returns BaseNode

Parameters

event: Open

cb: () => void

Returns void

Returns BaseNode

Parameters

event: PlayerUpdate

cb: (payload: IncomingPlayerUpdatePayload) => void

Parameters

payload: IncomingPlayerUpdatePayload

Returns void

Returns BaseNode

Parameters

event: Stats

cb: (payload: IncomingStatsPayload) => void

Parameters

payload: IncomingStatsPayload

Returns void

Returns BaseNode

Parameters

event: Upgrade

cb: (req: IncomingMessage) => void

Parameters

req: IncomingMessage

Returns void

Returns BaseNode

connect