🌋
Vulkava
  • Introduction
  • Getting started
  • Custom Queue
  • Filters example
  • Common issues
  • 📚Docs
    • 🌋Vulkava
    • 🎵Player
    • 🎙️Recorder
    • 📑DefaultQueue
    • 🎛️Filters
    • 🪢Node
    • 💿Track
    • 💿UnresolvedTrack
  • 🖌️Abstract Classes
    • 📶AbstractExternalSource
    • 🎹AbstractQueue
  • 🔖Typedefs
    • 🔍SearchResult
    • 🌋VulkavaOptions
    • 🎛️FilterOptions
    • 🪢NodeOptions
    • 📡NodeStats
    • 🔎SEARCH_SOURCE
  • 📑Enums
    • ConnectionState
    • NodeState
Powered by GitBook
On this page
  1. Typedefs

VulkavaOptions

The main Vulkava constructor options

PreviousSearchResultNextFilterOptions

Last updated 3 years ago

Property
Description
Type

nodes

The lavalink node array

<>

sendWS

Send voice channel connect payloads to main discord gateway

defaultSearchSource

The default source to search for tracks (default value: youtube)

(optional)

unresolvedSearchSource

The default source to search for unresolved tracks (default value: youtube music)

(optional)

spotify *

The spotify credentials config

(optional)

spotify.clientId

The spotify client id

spotify.clientSecret

The spotify client secret

spotify.market

The spotify market (eg. US, PT, BR, IT), used for fetching artist top tracks. Default is US

(optional)

disabledSources

Disables spotify, apple music or deezer

<ExternalSource>

* If you don't provide the spotify credentials, vulkava will attempt to get a spotify anonymous token.

type ExternalSource = 'APPLE_MUSIC' | 'DEEZER' | 'SPOTIFY';

NOTE:

sendWS function signature

sendWS: (guildId, payload) => void;
🔖
🌋
Array
NodeOptions
Function
SEARCH_SOURCE
SEARCH_SOURCE
Object
String
String
String
Array