From 8d37670265eaafd9af8d6d405bab8017c80b0620 Mon Sep 17 00:00:00 2001 From: Deivu Date: Wed, 1 Apr 2020 23:49:25 +0800 Subject: [PATCH 1/2] Fix ShokakuPlayer#start event documentation --- docs/js/docma-web.js | 2 +- src/guild/ShoukakuPlayer.js | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/js/docma-web.js b/docs/js/docma-web.js index ccb28704..19192e0d 100644 --- a/docs/js/docma-web.js +++ b/docs/js/docma-web.js @@ -44,6 +44,6 @@ dust.filters=dust.filters||{},dust.filters.$pt=function(e){return DocmaWeb.Utils DocmaWeb.version = "3.2.2"; return DocmaWeb; })(); -var docma = Object.freeze(new DocmaWeb({"version":"3.2.2","routes":[{"id":"api:","type":"api","name":"_def_","path":"?api","contentPath":null,"sourceType":"js"},{"id":"content:readme","type":"content","name":"readme","path":"?content=readme","contentPath":"content/readme.html","sourceType":"md"}],"apis":{"_def_":{"documentation":[{"comment":"/**\r\n * Shoukaku, governs the client's node connections.\r\n * @class Shoukaku\r\n * @extends {external:EventEmitter}\r\n */","meta":{"filename":"Shoukaku.js","lineno":33,"columnno":0,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{}},"description":"

Shoukaku, governs the client's node connections.

","kind":"class","name":"Shoukaku","augments":["external:EventEmitter"],"longname":"Shoukaku","scope":"global","$longname":"Shoukaku","$kind":"class","$docmaLink":"?api#Shoukaku","$members":[{"comment":"/**\r\n * Function to register a Lavalink Node\r\n * @param {ShoukakuConstants#ShoukakuNodeOptions} nodeOptions The Node Options to be used to connect to.\r\n * @memberof Shoukaku\r\n * @returns {void}\r\n */","meta":{"range":[5588,6235],"filename":"Shoukaku.js","lineno":152,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000288","name":"Shoukaku#addNode","type":"MethodDefinition","paramnames":["nodeOptions"]},"vars":{"":null}},"description":"

Function to register a Lavalink Node

","params":[{"type":{"names":["ShoukakuConstants#ShoukakuNodeOptions"]},"description":"

The Node Options to be used to connect to.

","name":"nodeOptions"}],"memberof":"Shoukaku","returns":[{"type":{"names":["void"]}}],"name":"addNode","longname":"Shoukaku#addNode","kind":"function","scope":"instance","$longname":"Shoukaku#addNode","$kind":"method","$docmaLink":"?api#Shoukaku#addNode"},{"comment":"/**\r\n * Shortcut to get the Ideal Node or a manually specified Node from the current nodes that Shoukaku governs.\r\n * @param {string} [name] If blank, Shoukaku will automatically return the Ideal Node for you to connect to. If name is specifed, she will try to return the node you specified.\r\n * @memberof Shoukaku\r\n * @returns {ShoukakuSocket}\r\n * @example\r\n * const node = .getNode();\r\n * node.rest.resolve('Kongou Burning Love', 'youtube')\r\n * .then(data => {\r\n * node.joinVoiceChannel({\r\n * guildID: 'guild_id',\r\n * voiceChannelID: 'voice_channel_id'\r\n * }).then(player => player.playTrack(data.track))\r\n * })\r\n */","meta":{"range":[8128,9083],"filename":"Shoukaku.js","lineno":207,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000520","name":"Shoukaku#getNode","type":"MethodDefinition","paramnames":["name"]},"vars":{"":null}},"description":"

Shortcut to get the Ideal Node or a manually specified Node from the current nodes that Shoukaku governs.

","params":[{"type":{"names":["string"]},"optional":true,"description":"

If blank, Shoukaku will automatically return the Ideal Node for you to connect to. If name is specifed, she will try to return the node you specified.

","name":"name"}],"memberof":"Shoukaku","returns":[{"type":{"names":["ShoukakuSocket"]}}],"examples":["const node = .getNode();\rnode.rest.resolve('Kongou Burning Love', 'youtube')\r .then(data => {\r node.joinVoiceChannel({\r guildID: 'guild_id',\r voiceChannelID: 'voice_channel_id'\r }).then(player => player.playTrack(data.track))\r })"],"name":"getNode","longname":"Shoukaku#getNode","kind":"function","scope":"instance","$longname":"Shoukaku#getNode","$kind":"method","$docmaLink":"?api#Shoukaku#getNode"},{"comment":"/**\r\n * Shortcut to get the Player of a guild, if there is any.\r\n * @param {string} guildID The guildID of the guild we are trying to get.\r\n * @memberof Shoukaku\r\n * @returns {?ShoukakuPlayer}\r\n */","meta":{"range":[9307,9598],"filename":"Shoukaku.js","lineno":232,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000633","name":"Shoukaku#getPlayer","type":"MethodDefinition","paramnames":["guildID"]},"vars":{"":null}},"description":"

Shortcut to get the Player of a guild, if there is any.

","params":[{"type":{"names":["string"]},"description":"

The guildID of the guild we are trying to get.

","name":"guildID"}],"memberof":"Shoukaku","returns":[{"type":{"names":["ShoukakuPlayer"]},"nullable":true}],"name":"getPlayer","longname":"Shoukaku#getPlayer","kind":"function","scope":"instance","$longname":"Shoukaku#getPlayer","$kind":"method","$docmaLink":"?api#Shoukaku#getPlayer"},{"comment":"/**\r\n * Function to remove a Lavalink Node\r\n * @param {string} name The Lavalink Node to remove\r\n * @param {string} reason Optional reason for this disconnect.\r\n * @memberof Shoukaku\r\n * @returns {void}\r\n */","meta":{"range":[6478,7384],"filename":"Shoukaku.js","lineno":172,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000398","name":"Shoukaku#removeNode","type":"MethodDefinition","paramnames":["name","reason"]},"vars":{"":null}},"description":"

Function to remove a Lavalink Node

","params":[{"type":{"names":["string"]},"description":"

The Lavalink Node to remove

","name":"name"},{"type":{"names":["string"]},"description":"

Optional reason for this disconnect.

","name":"reason"}],"memberof":"Shoukaku","returns":[{"type":{"names":["void"]}}],"name":"removeNode","longname":"Shoukaku#removeNode","kind":"function","scope":"instance","$longname":"Shoukaku#removeNode","$kind":"method","$docmaLink":"?api#Shoukaku#removeNode"},{"comment":"/**\r\n * The instance of Discord.js client used with Shoukaku.\r\n * @type {external:Client}\r\n */","meta":{"range":[1733,1753],"filename":"Shoukaku.js","lineno":52,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000086","name":"this.client","type":"Identifier","value":"client","paramnames":[]}},"description":"

The instance of Discord.js client used with Shoukaku.

","type":{"names":["external:Client"]},"name":"client","longname":"Shoukaku#client","kind":"member","memberof":"Shoukaku","scope":"instance","$longname":"Shoukaku#client","$kind":"property","$docmaLink":"?api#Shoukaku#client"},{"comment":"/**\r\n * The user id of the bot that is being governed by Shoukaku.\r\n * @type {?string}\r\n */","meta":{"range":[1886,1900],"filename":"Shoukaku.js","lineno":57,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000092","name":"this.id","type":"Literal","value":null,"paramnames":[]}},"description":"

The user id of the bot that is being governed by Shoukaku.

","type":{"names":["string"]},"nullable":true,"name":"id","longname":"Shoukaku#id","kind":"member","memberof":"Shoukaku","scope":"instance","$longname":"Shoukaku#id","$kind":"property","$docmaLink":"?api#Shoukaku#id"},{"comment":"/**\r\n * The current nodes that is being handled by Shoukaku.\r\n * @type {external:Map}\r\n */","meta":{"range":[2187,2209],"filename":"Shoukaku.js","lineno":67,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000104","name":"this.nodes","type":"NewExpression","value":"","paramnames":[]}},"description":"

The current nodes that is being handled by Shoukaku.

","type":{"names":["external:Map"]},"name":"nodes","longname":"Shoukaku#nodes","kind":"member","memberof":"Shoukaku","scope":"instance","$longname":"Shoukaku#nodes","$kind":"property","$docmaLink":"?api#Shoukaku#nodes"},{"comment":"/**\r\n * Gets all the Players that is currently active on all nodes in this instance.\r\n * @type {external:Map}\r\n * @memberof Shoukaku\r\n */","meta":{"range":[3038,3262],"filename":"Shoukaku.js","lineno":88,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000224","name":"Shoukaku#players","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"

Gets all the Players that is currently active on all nodes in this instance.

","type":{"names":["external:Map"]},"memberof":"Shoukaku","name":"players","longname":"Shoukaku#players","kind":"member","scope":"instance","params":[],"$longname":"Shoukaku#players","$kind":"property","$docmaLink":"?api#Shoukaku#players"},{"comment":"/**\r\n * The shard count of the bot that is being governed by Shoukaku.\r\n * @type {number}\r\n */","meta":{"range":[2036,2055],"filename":"Shoukaku.js","lineno":62,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000098","name":"this.shardCount","type":"Literal","value":1,"paramnames":[]}},"description":"

The shard count of the bot that is being governed by Shoukaku.

","type":{"names":["number"]},"name":"shardCount","longname":"Shoukaku#shardCount","kind":"member","memberof":"Shoukaku","scope":"instance","$longname":"Shoukaku#shardCount","$kind":"property","$docmaLink":"?api#Shoukaku#shardCount"},{"comment":"/**\r\n * Gets the number of total Players that is currently active on all nodes in this instance.\r\n * @type {number}\r\n * @memberof Shoukaku\r\n */","meta":{"range":[3433,3590],"filename":"Shoukaku.js","lineno":100,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000260","name":"Shoukaku#totalPlayers","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"

Gets the number of total Players that is currently active on all nodes in this instance.

","type":{"names":["number"]},"memberof":"Shoukaku","name":"totalPlayers","longname":"Shoukaku#totalPlayers","kind":"member","scope":"instance","params":[],"$longname":"Shoukaku#totalPlayers","$kind":"property","$docmaLink":"?api#Shoukaku#totalPlayers"},{"comment":"/**\r\n * Emitted when a Lavalink Node closed.\r\n * @event Shoukaku#close\r\n * @param {string} name The name of the Lavalink Node that sent a close event.\r\n * @param {number} code The WebSocket close code https://github.com/Luka967/websocket-close-codes\r\n * @param {reason} reason The reason for this close event.\r\n * @memberof Shoukaku\r\n */","meta":{"filename":"Shoukaku.js","lineno":130,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{}},"description":"

Emitted when a Lavalink Node closed.

","kind":"event","name":"close","params":[{"type":{"names":["string"]},"description":"

The name of the Lavalink Node that sent a close event.

","name":"name"},{"type":{"names":["number"]},"description":"

The WebSocket close code https://github.com/Luka967/websocket-close-codes

","name":"code"},{"type":{"names":["reason"]},"description":"

The reason for this close event.

","name":"reason"}],"memberof":"Shoukaku","longname":"Shoukaku#event:close","scope":"instance","$longname":"Shoukaku#event:close","$kind":"event","$docmaLink":"?api#Shoukaku#event:close"},{"comment":"/**\r\n * Emitted when a Lavalink Node sends a debug event.\r\n * @event Shoukaku#debug\r\n * @param {string} name The name of the Lavalink Node that sent a debug event.\r\n * @param {Object} data The actual debug data\r\n * @memberof Shoukaku\r\n */","meta":{"filename":"Shoukaku.js","lineno":106,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{}},"description":"

Emitted when a Lavalink Node sends a debug event.

","kind":"event","name":"debug","params":[{"type":{"names":["string"]},"description":"

The name of the Lavalink Node that sent a debug event.

","name":"name"},{"type":{"names":["Object"]},"description":"

The actual debug data

","name":"data"}],"memberof":"Shoukaku","longname":"Shoukaku#event:debug","scope":"instance","$longname":"Shoukaku#event:debug","$kind":"event","$docmaLink":"?api#Shoukaku#event:debug"},{"comment":"/**\r\n * Emitted when a Lavalink Node will not try to reconnect again.\r\n * @event Shoukaku#disconnected\r\n * @param {string} name The name of the Lavalink Node that sent a close event.\r\n * @param {string} reason The reason for the disconnect.\r\n * @memberof Shoukaku\r\n */","meta":{"filename":"Shoukaku.js","lineno":138,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{}},"description":"

Emitted when a Lavalink Node will not try to reconnect again.

","kind":"event","name":"disconnected","params":[{"type":{"names":["string"]},"description":"

The name of the Lavalink Node that sent a close event.

","name":"name"},{"type":{"names":["string"]},"description":"

The reason for the disconnect.

","name":"reason"}],"memberof":"Shoukaku","longname":"Shoukaku#event:disconnected","scope":"instance","$longname":"Shoukaku#event:disconnected","$kind":"event","$docmaLink":"?api#Shoukaku#event:disconnected"},{"comment":"/**\r\n * Emitted when a lavalink Node encouters an error. This event MUST BE HANDLED.\r\n * @event Shoukaku#error\r\n * @param {string} name The name of the Lavalink Node that sent an error event or 'Shoukaku' if the error is from Shoukaku.\r\n * @param {Error} error The error encountered.\r\n * @memberof Shoukaku\r\n * @example\r\n * // is your own instance of Shoukaku\r\n * .on('error', console.error);\r\n */","meta":{"filename":"Shoukaku.js","lineno":113,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{}},"description":"

Emitted when a lavalink Node encouters an error. This event MUST BE HANDLED.

","kind":"event","name":"error","params":[{"type":{"names":["string"]},"description":"

The name of the Lavalink Node that sent an error event or 'Shoukaku' if the error is from Shoukaku.

","name":"name"},{"type":{"names":["Error"]},"description":"

The error encountered.

","name":"error"}],"memberof":"Shoukaku","examples":["// is your own instance of Shoukaku\r.on('error', console.error);"],"longname":"Shoukaku#event:error","scope":"instance","$longname":"Shoukaku#event:error","$kind":"event","$docmaLink":"?api#Shoukaku#event:error"},{"comment":"/** name, code, reason, isReconnectable\r\n * Emitted when a Lavalink Node becomes Ready from a Reconnection or First Connection.\r\n * @event Shoukaku#ready\r\n * @param {string} name The name of the Lavalink Node that sent a ready event.\r\n * @param {boolean} reconnect True if the session reconnected, otherwise false.\r\n * @memberof Shoukaku\r\n */","meta":{"filename":"Shoukaku.js","lineno":123,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{}},"description":"

name, code, reason, isReconnectable\nEmitted when a Lavalink Node becomes Ready from a Reconnection or First Connection.

","kind":"event","name":"ready","params":[{"type":{"names":["string"]},"description":"

The name of the Lavalink Node that sent a ready event.

","name":"name"},{"type":{"names":["boolean"]},"description":"

True if the session reconnected, otherwise false.

","name":"reconnect"}],"memberof":"Shoukaku","longname":"Shoukaku#event:ready","scope":"instance","$longname":"Shoukaku#event:ready","$kind":"event","$docmaLink":"?api#Shoukaku#event:ready"}],"$constructor":{"comment":"/**\r\n * @param {external:Client} client Your Discord.js client\r\n * @param {ShoukakuConstants#ShoukakuNodes} nodes Lavalink Nodes where Shoukaku will try to connect to.\r\n * @param {ShoukakuConstants#ShoukakuOptions} options Options to initialize Shoukaku with\r\n */","meta":{"range":[1333,2873],"filename":"Shoukaku.js","lineno":44,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000062","name":"Shoukaku","type":"MethodDefinition","paramnames":["client","nodes","options"]},"vars":{"":null}},"params":[{"type":{"names":["external:Client"]},"description":"

Your Discord.js client

","name":"client"},{"type":{"names":["ShoukakuConstants#ShoukakuNodes"]},"description":"

Lavalink Nodes where Shoukaku will try to connect to.

","name":"nodes"},{"type":{"names":["ShoukakuConstants#ShoukakuOptions"]},"description":"

Options to initialize Shoukaku with

","name":"options"}],"name":"Shoukaku","longname":"Shoukaku","kind":"class","scope":"global","$longname":"Shoukaku","$kind":"constructor","$docmaLink":"?api#Shoukaku"}},{"comment":"/**\n * Constants for Shoukaku.\n * @class ShoukakuConstants\n */","meta":{"filename":"ShoukakuConstants.js","lineno":1,"columnno":0,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

Constants for Shoukaku.

","kind":"class","name":"ShoukakuConstants","longname":"ShoukakuConstants","scope":"global","$longname":"ShoukakuConstants","$kind":"class","$docmaLink":"?api#ShoukakuConstants","$members":[{"comment":"/**\n * Available Status for Node / Link managers.\n * @typedef {string} ShoukakuStatus\n * @enum {ShoukakuStatus}\n * @memberof ShoukakuConstants#\n */","meta":{"filename":"ShoukakuConstants.js","lineno":6,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

Available Status for Node / Link managers.

","kind":"typedef","name":"ShoukakuStatus","type":{"names":["string"]},"isEnum":true,"memberof":"ShoukakuConstants","longname":"ShoukakuConstants#ShoukakuStatus","scope":"instance","$longname":"ShoukakuConstants#ShoukakuStatus","$kind":"enum","$docmaLink":"?api#ShoukakuConstants#ShoukakuStatus"},{"comment":"/**\n * Required Object in Shoukaku's join method.\n * @typedef {Object} ShoukakuJoinOptions\n * @property {string} guildID Guild ID of the Voice Channel you want to join to.\n * @property {string} voiceChannelID Voice Channel ID of the Voice Channel you want to join to.\n * @property {boolean} [mute=false] Whether to mute the client.\n * @property {boolean} [deaf=false] Whether to deafen the client.\n * @memberof ShoukakuConstants#\n */","meta":{"filename":"ShoukakuConstants.js","lineno":49,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

Required Object in Shoukaku's join method.

","kind":"typedef","name":"ShoukakuJoinOptions","type":{"names":["Object"]},"properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"

Whether to deafen the client.

","name":"deaf"},{"type":{"names":["string"]},"description":"

Guild ID of the Voice Channel you want to join to.

","name":"guildID"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"

Whether to mute the client.

","name":"mute"},{"type":{"names":["string"]},"description":"

Voice Channel ID of the Voice Channel you want to join to.

","name":"voiceChannelID"}],"memberof":"ShoukakuConstants","longname":"ShoukakuConstants#ShoukakuJoinOptions","scope":"instance","$longname":"ShoukakuConstants#ShoukakuJoinOptions","$kind":"typedef","$docmaLink":"?api#ShoukakuConstants#ShoukakuJoinOptions"},{"comment":"/**\n * Options that Shoukaku needs to initialize a lavalink node.\n * @typedef {Object} ShoukakuNodeOptions\n * @property {string} [name] Your Node Name, anything you want to name your node.\n * @property {string} [host] Your node host / ip address of where the lavalink is hosted.\n * @property {number} [port] The Port Number of your lavalink instance.\n * @property {string} [auth] The authentication key you set on your lavalink config.\n * @memberof ShoukakuConstants#\n */","meta":{"filename":"ShoukakuConstants.js","lineno":100,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

Options that Shoukaku needs to initialize a lavalink node.

","kind":"typedef","name":"ShoukakuNodeOptions","type":{"names":["Object"]},"properties":[{"type":{"names":["string"]},"optional":true,"description":"

The authentication key you set on your lavalink config.

","name":"auth"},{"type":{"names":["string"]},"optional":true,"description":"

Your node host / ip address of where the lavalink is hosted.

","name":"host"},{"type":{"names":["string"]},"optional":true,"description":"

Your Node Name, anything you want to name your node.

","name":"name"},{"type":{"names":["number"]},"optional":true,"description":"

The Port Number of your lavalink instance.

","name":"port"}],"memberof":"ShoukakuConstants","longname":"ShoukakuConstants#ShoukakuNodeOptions","scope":"instance","$longname":"ShoukakuConstants#ShoukakuNodeOptions","$kind":"typedef","$docmaLink":"?api#ShoukakuConstants#ShoukakuNodeOptions"},{"comment":"/**\n * An array of ShoukakuNodeOptions\n * @typedef {Array} ShoukakuNodes\n * @memberof ShoukakuConstants#\n */","meta":{"filename":"ShoukakuConstants.js","lineno":117,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

An array of ShoukakuNodeOptions

","kind":"typedef","name":"ShoukakuNodes","type":{"names":["Array."]},"memberof":"ShoukakuConstants","longname":"ShoukakuConstants#ShoukakuNodes","scope":"instance","$longname":"ShoukakuConstants#ShoukakuNodes","$kind":"typedef","$docmaLink":"?api#ShoukakuConstants#ShoukakuNodes"},{"comment":"/**\n * Shoukaku's Node Stats Object.\n * @typedef {Object} ShoukakuNodeStats\n * @memberof ShoukakuConstants#\n */","meta":{"filename":"ShoukakuConstants.js","lineno":20,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

Shoukaku's Node Stats Object.

","kind":"typedef","name":"ShoukakuNodeStats","type":{"names":["Object"]},"memberof":"ShoukakuConstants","longname":"ShoukakuConstants#ShoukakuNodeStats","scope":"instance","$longname":"ShoukakuConstants#ShoukakuNodeStats","$kind":"typedef","$docmaLink":"?api#ShoukakuConstants#ShoukakuNodeStats"},{"comment":"/**\n * Options that Shoukaku accepts upon initialization.\n * @typedef {Object} ShoukakuOptions\n * @property {boolean|string} [resumable=false] If you want your node to support resuming. Just replace the false with the resume-key you want to enable resuming.\n * @property {number} [resumableTimeout=30] Timeout when Lavalink will decide a player isn't resumed and will destroy the connection to it.\n * @property {number} [reconnectTries=2] Amount of tries to connect to the lavalink Node before it decides that the node is unreconnectable.\n * @property {number} [moveOnDisconnect=false] Specifies if the library will attempt to reconnect players on a disconnected node to another node.\n * @property {number} [restTimeout=10000] Timeout on rest requests to your lavalink node.\n * @memberof ShoukakuConstants#\n */","meta":{"filename":"ShoukakuConstants.js","lineno":81,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

Options that Shoukaku accepts upon initialization.

","kind":"typedef","name":"ShoukakuOptions","type":{"names":["Object"]},"properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":false,"description":"

Specifies if the library will attempt to reconnect players on a disconnected node to another node.

","name":"moveOnDisconnect"},{"type":{"names":["number"]},"optional":true,"defaultvalue":2,"description":"

Amount of tries to connect to the lavalink Node before it decides that the node is unreconnectable.

","name":"reconnectTries"},{"type":{"names":["number"]},"optional":true,"defaultvalue":10000,"description":"

Timeout on rest requests to your lavalink node.

","name":"restTimeout"},{"type":{"names":["boolean","string"]},"optional":true,"defaultvalue":false,"description":"

If you want your node to support resuming. Just replace the false with the resume-key you want to enable resuming.

","name":"resumable"},{"type":{"names":["number"]},"optional":true,"defaultvalue":30,"description":"

Timeout when Lavalink will decide a player isn't resumed and will destroy the connection to it.

","name":"resumableTimeout"}],"memberof":"ShoukakuConstants","longname":"ShoukakuConstants#ShoukakuOptions","scope":"instance","$longname":"ShoukakuConstants#ShoukakuOptions","$kind":"typedef","$docmaLink":"?api#ShoukakuConstants#ShoukakuOptions"},{"comment":"/**\n * Required Object in Shoukaku's join method.\n * @typedef {Object} ShoukakuPlayOptions\n * @property {boolean} [noReplace=true] Specifies if the player will not replace the current track when executing this action.\n * @property {boolean|number} [startTime=false] In milliseconds on when to start.\n * @property {boolean|number} [endTime=false] In milliseconds on when to end.\n * @memberof ShoukakuConstants#\n */","meta":{"filename":"ShoukakuConstants.js","lineno":66,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

Required Object in Shoukaku's join method.

","kind":"typedef","name":"ShoukakuPlayOptions","type":{"names":["Object"]},"properties":[{"type":{"names":["boolean","number"]},"optional":true,"defaultvalue":false,"description":"

In milliseconds on when to end.

","name":"endTime"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"

Specifies if the player will not replace the current track when executing this action.

","name":"noReplace"},{"type":{"names":["boolean","number"]},"optional":true,"defaultvalue":false,"description":"

In milliseconds on when to start.

","name":"startTime"}],"memberof":"ShoukakuConstants","longname":"ShoukakuConstants#ShoukakuPlayOptions","scope":"instance","$longname":"ShoukakuConstants#ShoukakuPlayOptions","$kind":"typedef","$docmaLink":"?api#ShoukakuConstants#ShoukakuPlayOptions"}]},{"comment":"/**\n * ShoukakuError. Extended Error class.\n * @class ShoukakuError\n * @extends {Error}\n */","meta":{"filename":"ShoukakuError.js","lineno":1,"columnno":0,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

ShoukakuError. Extended Error class.

","kind":"class","name":"ShoukakuError","augments":["Error"],"longname":"ShoukakuError","scope":"global","$longname":"ShoukakuError","$kind":"class","$docmaLink":"?api#ShoukakuError","$constructor":{"comment":"/**\n * @param message The Error Message\n */","meta":{"range":[192,281],"filename":"ShoukakuError.js","lineno":10,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{"id":"astnode100000955","name":"ShoukakuError","type":"MethodDefinition","paramnames":["message"]},"vars":{"":null}},"params":[{"description":"

The Error Message

","name":"message"}],"name":"ShoukakuError","longname":"ShoukakuError","kind":"class","scope":"global","$longname":"ShoukakuError","$kind":"constructor","$docmaLink":"?api#ShoukakuError"}},{"comment":"/**\r\n * ShoukakuLink, contains data about the voice connection on the guild.\r\n * @class ShoukakuLink\r\n */","meta":{"filename":"ShoukakuLink.js","lineno":4,"columnno":0,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

ShoukakuLink, contains data about the voice connection on the guild.

","kind":"class","name":"ShoukakuLink","longname":"ShoukakuLink","scope":"global","$longname":"ShoukakuLink","$kind":"class","$docmaLink":"?api#ShoukakuLink","$members":[{"comment":"/**\r\n * Attempts to reconnect this connection.\r\n * @memberOf ShoukakuLink\r\n * @returns {Promise}\r\n */","meta":{"range":[3509,4301],"filename":"ShoukakuLink.js","lineno":103,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001310","name":"ShoukakuLink#attemptReconnect","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"

Attempts to reconnect this connection.

","memberof":"ShoukakuLink","returns":[{"type":{"names":["Promise."]}}],"name":"attemptReconnect","longname":"ShoukakuLink#attemptReconnect","kind":"function","scope":"instance","params":[],"$longname":"ShoukakuLink#attemptReconnect","$kind":"method","$docmaLink":"?api#ShoukakuLink#attemptReconnect"},{"comment":"/**\r\n * The ID of the guild that is being governed by this Link.\r\n * @type {string}\r\n */","meta":{"range":[924,947],"filename":"ShoukakuLink.js","lineno":29,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001042","name":"this.guildID","type":"MemberExpression","value":"guild.id","paramnames":[]}},"description":"

The ID of the guild that is being governed by this Link.

","type":{"names":["string"]},"name":"guildID","longname":"ShoukakuLink#guildID","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#guildID","$kind":"property","$docmaLink":"?api#ShoukakuLink#guildID"},{"comment":"/**\r\n * The node that governs this Link\r\n * @type {ShoukakuSocket}\r\n */","meta":{"range":[640,656],"filename":"ShoukakuLink.js","lineno":19,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001030","name":"this.node","type":"Identifier","value":"node","paramnames":[]}},"description":"

The node that governs this Link

","type":{"names":["ShoukakuSocket"]},"name":"node","longname":"ShoukakuLink#node","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#node","$kind":"property","$docmaLink":"?api#ShoukakuLink#node"},{"comment":"/**\r\n * The player class of this link.\r\n * @type {ShoukakuPlayer}\r\n */","meta":{"range":[771,791],"filename":"ShoukakuLink.js","lineno":24,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001036","name":"this.player","type":"Identifier","value":"player","paramnames":[]}},"description":"

The player class of this link.

","type":{"names":["ShoukakuPlayer"]},"name":"player","longname":"ShoukakuLink#player","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#player","$kind":"property","$docmaLink":"?api#ShoukakuLink#player"},{"comment":"/**\r\n * If the client user is self defeaned.\r\n * @type {boolean}\r\n */","meta":{"range":[1799,1820],"filename":"ShoukakuLink.js","lineno":59,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001088","name":"this.selfDeaf","type":"Literal","value":false,"paramnames":[]}},"description":"

If the client user is self defeaned.

","type":{"names":["boolean"]},"name":"selfDeaf","longname":"ShoukakuLink#selfDeaf","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#selfDeaf","$kind":"property","$docmaLink":"?api#ShoukakuLink#selfDeaf"},{"comment":"/**\r\n * If the client user is self muted.\r\n * @type {boolean}\r\n */","meta":{"range":[1664,1685],"filename":"ShoukakuLink.js","lineno":54,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001082","name":"this.selfMute","type":"Literal","value":false,"paramnames":[]}},"description":"

If the client user is self muted.

","type":{"names":["boolean"]},"name":"selfMute","longname":"ShoukakuLink#selfMute","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#selfMute","$kind":"property","$docmaLink":"?api#ShoukakuLink#selfMute"},{"comment":"/**\r\n * The sessionID of this Link\r\n * @type {?string}\r\n */","meta":{"range":[1364,1385],"filename":"ShoukakuLink.js","lineno":44,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001070","name":"this.sessionID","type":"Literal","value":null,"paramnames":[]}},"description":"

The sessionID of this Link

","type":{"names":["string"]},"nullable":true,"name":"sessionID","longname":"ShoukakuLink#sessionID","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#sessionID","$kind":"property","$docmaLink":"?api#ShoukakuLink#sessionID"},{"comment":"/**\r\n * The ID of the shard where this guild is in\r\n * @type {number}\r\n */","meta":{"range":[1066,1094],"filename":"ShoukakuLink.js","lineno":34,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001050","name":"this.shardID","type":"MemberExpression","value":"guild.shardID","paramnames":[]}},"description":"

The ID of the shard where this guild is in

","type":{"names":["number"]},"name":"shardID","longname":"ShoukakuLink#shardID","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#shardID","$kind":"property","$docmaLink":"?api#ShoukakuLink#shardID"},{"comment":"/**\r\n * The current state of this link.\r\n * @type {ShoukakuConstants#ShoukakuStatus}\r\n */","meta":{"range":[1954,1994],"filename":"ShoukakuLink.js","lineno":64,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001094","name":"this.state","type":"MemberExpression","value":"ShoukakuStatus.DISCONNECTED","paramnames":[]}},"description":"

The current state of this link.

","type":{"names":["ShoukakuConstants#ShoukakuStatus"]},"name":"state","longname":"ShoukakuLink#state","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#state","$kind":"property","$docmaLink":"?api#ShoukakuLink#state"},{"comment":"/**\r\n * The ID of the user that is being governed by this Link\r\n * @type {string}\r\n */","meta":{"range":[1225,1260],"filename":"ShoukakuLink.js","lineno":39,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001058","name":"this.userID","type":"MemberExpression","value":"this.node.shoukaku.id","paramnames":[]}},"description":"

The ID of the user that is being governed by this Link

","type":{"names":["string"]},"name":"userID","longname":"ShoukakuLink#userID","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#userID","$kind":"property","$docmaLink":"?api#ShoukakuLink#userID"},{"comment":"/**\r\n * The ID of the voice channel that is being governed by this link.\r\n * @type {?string}\r\n */","meta":{"range":[1527,1553],"filename":"ShoukakuLink.js","lineno":49,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001076","name":"this.voiceChannelID","type":"Literal","value":null,"paramnames":[]}},"description":"

The ID of the voice channel that is being governed by this link.

","type":{"names":["string"]},"nullable":true,"name":"voiceChannelID","longname":"ShoukakuLink#voiceChannelID","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#voiceChannelID","$kind":"property","$docmaLink":"?api#ShoukakuLink#voiceChannelID"}],"$constructor":{"comment":"/**\r\n * @param {ShoukakuSocket} node The node that governs this link.\r\n * @param {ShoukakuPlayer} player The player of this link.\r\n * @param {external:Guild} guild A Discord.js Guild Object.\r\n */","meta":{"range":[491,2262],"filename":"ShoukakuLink.js","lineno":14,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001022","name":"ShoukakuLink","type":"MethodDefinition","paramnames":["node","player","guild"]},"vars":{"":null}},"params":[{"type":{"names":["ShoukakuSocket"]},"description":"

The node that governs this link.

","name":"node"},{"type":{"names":["ShoukakuPlayer"]},"description":"

The player of this link.

","name":"player"},{"type":{"names":["external:Guild"]},"description":"

A Discord.js Guild Object.

","name":"guild"}],"name":"ShoukakuLink","longname":"ShoukakuLink","kind":"class","scope":"global","$longname":"ShoukakuLink","$kind":"constructor","$docmaLink":"?api#ShoukakuLink"}},{"comment":"/**\r\n * ShoukakuPlayer, used to control the player on the guildused to control the player on the guild.\r\n * @class ShoukakuPlayer\r\n * @extends {external:EventEmitter}\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":8,"columnno":0,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

ShoukakuPlayer, used to control the player on the guildused to control the player on the guild.

","kind":"class","name":"ShoukakuPlayer","augments":["external:EventEmitter"],"longname":"ShoukakuPlayer","scope":"global","$longname":"ShoukakuPlayer","$kind":"class","$docmaLink":"?api#ShoukakuPlayer","$members":[{"comment":"/**\r\n * Eventually Connects the Bot to the voice channel in the guild. This is used internally and must not be used to connect players. Use `.joinVoiceChannel()` instead.\r\n * @memberOf ShoukakuPlayer\r\n * @returns {void}\r\n */","meta":{"range":[4180,4274],"filename":"ShoukakuPlayer.js","lineno":122,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001899","name":"ShoukakuPlayer#connect","type":"MethodDefinition","paramnames":["options","callback"]},"vars":{"":null}},"description":"

Eventually Connects the Bot to the voice channel in the guild. This is used internally and must not be used to connect players. Use <ShoukakuSocket>.joinVoiceChannel() instead.

","memberof":"ShoukakuPlayer","returns":[{"type":{"names":["void"]}}],"name":"connect","longname":"ShoukakuPlayer#connect","kind":"function","scope":"instance","params":[],"$longname":"ShoukakuPlayer#connect","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#connect"},{"comment":"/**\r\n * Eventually Disconnects the VoiceConnection & Removes the player from a Guild. Could be also used to clean up player remnants from unexpected events.\r\n * @memberOf ShoukakuPlayer\r\n * @returns {void}\r\n */","meta":{"range":[4512,4578],"filename":"ShoukakuPlayer.js","lineno":130,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001914","name":"ShoukakuPlayer#disconnect","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"

Eventually Disconnects the VoiceConnection & Removes the player from a Guild. Could be also used to clean up player remnants from unexpected events.

","memberof":"ShoukakuPlayer","returns":[{"type":{"names":["void"]}}],"name":"disconnect","longname":"ShoukakuPlayer#disconnect","kind":"function","scope":"instance","params":[],"$longname":"ShoukakuPlayer#disconnect","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#disconnect"},{"comment":"/**\r\n * Moves this Player & VoiceConnection to another lavalink node you specified.\r\n * @param {string} name Name of the Node you want to move to.\r\n * @memberOf ShoukakuPlayer\r\n * @returns {Promise}\r\n */","meta":{"range":[4819,5173],"filename":"ShoukakuPlayer.js","lineno":139,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001925","name":"ShoukakuPlayer#moveToNode","type":"MethodDefinition","paramnames":["name"]},"vars":{"":null}},"description":"

Moves this Player & VoiceConnection to another lavalink node you specified.

","params":[{"type":{"names":["string"]},"description":"

Name of the Node you want to move to.

","name":"name"}],"memberof":"ShoukakuPlayer","returns":[{"type":{"names":["Promise."]}}],"name":"moveToNode","longname":"ShoukakuPlayer#moveToNode","kind":"function","scope":"instance","async":true,"$longname":"ShoukakuPlayer#moveToNode","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#moveToNode"},{"comment":"/**\r\n * Plays the track you specifed. Warning: If the player is playing anything, calling this will just ignore your call. Call `ShoukakuPlayer.StopTrack()` first.\r\n * @param {string} track The Base64 encoded track you got from lavalink API.\r\n * @param {ShoukakuConstants#ShoukakuPlayOptions} [options=ShoukakuPlayOptions] Used if you want to put a custom track start or end time.\r\n * @memberOf ShoukakuPlayer\r\n * @returns {Promise} true if successful false if not.\r\n */","meta":{"range":[5688,6642],"filename":"ShoukakuPlayer.js","lineno":153,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001983","name":"ShoukakuPlayer#playTrack","type":"MethodDefinition","paramnames":["track","options"]},"vars":{"":null}},"description":"

Plays the track you specifed. Warning: If the player is playing anything, calling this will just ignore your call. Call ShoukakuPlayer.StopTrack() first.

","params":[{"type":{"names":["string"]},"description":"

The Base64 encoded track you got from lavalink API.

","name":"track"},{"type":{"names":["ShoukakuConstants#ShoukakuPlayOptions"]},"optional":true,"defaultvalue":"ShoukakuPlayOptions","description":"

Used if you want to put a custom track start or end time.

","name":"options"}],"memberof":"ShoukakuPlayer","returns":[{"type":{"names":["Promise."]},"description":"

true if successful false if not.

"}],"name":"playTrack","longname":"ShoukakuPlayer#playTrack","kind":"function","scope":"instance","async":true,"$longname":"ShoukakuPlayer#playTrack","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#playTrack"},{"comment":"/**\r\n * Seeks your player to the time you want\r\n * @param {number} position position in MS you want to seek to.\r\n * @memberOf ShoukakuPlayer\r\n * @returns {Promise} true if successful false if not.\r\n */","meta":{"range":[9103,9354],"filename":"ShoukakuPlayer.js","lineno":238,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100002336","name":"ShoukakuPlayer#seekTo","type":"MethodDefinition","paramnames":["position"]},"vars":{"":null}},"description":"

Seeks your player to the time you want

","params":[{"type":{"names":["number"]},"description":"

position in MS you want to seek to.

","name":"position"}],"memberof":"ShoukakuPlayer","returns":[{"type":{"names":["Promise."]},"description":"

true if successful false if not.

"}],"name":"seekTo","longname":"ShoukakuPlayer#seekTo","kind":"function","scope":"instance","async":true,"$longname":"ShoukakuPlayer#seekTo","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#seekTo"},{"comment":"/**\r\n * Sets the equalizer of your lavalink player\r\n * @param {Array} bands An array of Lavalink bands.\r\n * @memberOf ShoukakuPlayer\r\n * @returns {Promise} true if successful false if not.\r\n */","meta":{"range":[7840,8237],"filename":"ShoukakuPlayer.js","lineno":203,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100002211","name":"ShoukakuPlayer#setEqualizer","type":"MethodDefinition","paramnames":["bands"]},"vars":{"":null}},"description":"

Sets the equalizer of your lavalink player

","params":[{"type":{"names":["Array"]},"description":"

An array of Lavalink bands.

","name":"bands"}],"memberof":"ShoukakuPlayer","returns":[{"type":{"names":["Promise."]},"description":"

true if successful false if not.

"}],"name":"setEqualizer","longname":"ShoukakuPlayer#setEqualizer","kind":"function","scope":"instance","async":true,"$longname":"ShoukakuPlayer#setEqualizer","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#setEqualizer"},{"comment":"/**\r\n * Pauses / Unpauses the player\r\n * @param {boolean} [pause=true] true to pause, false to unpause\r\n * @memberOf ShoukakuPlayer\r\n * @returns {Promise} true if successful false if not.\r\n */","meta":{"range":[7281,7606],"filename":"ShoukakuPlayer.js","lineno":187,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100002161","name":"ShoukakuPlayer#setPaused","type":"MethodDefinition","paramnames":["pause"]},"vars":{"":null}},"description":"

Pauses / Unpauses the player

","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"

true to pause, false to unpause

","name":"pause"}],"memberof":"ShoukakuPlayer","returns":[{"type":{"names":["Promise."]},"description":"

true if successful false if not.

"}],"name":"setPaused","longname":"ShoukakuPlayer#setPaused","kind":"function","scope":"instance","async":true,"$longname":"ShoukakuPlayer#setPaused","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#setPaused"},{"comment":"/**\r\n * Sets the playback volume of your lavalink player\r\n * @param {number} volume The new volume you want to set on the player.\r\n * @memberOf ShoukakuPlayer\r\n * @returns {Promise} true if successful false if not.\r\n */","meta":{"range":[8497,8861],"filename":"ShoukakuPlayer.js","lineno":221,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100002277","name":"ShoukakuPlayer#setVolume","type":"MethodDefinition","paramnames":["volume"]},"vars":{"":null}},"description":"

Sets the playback volume of your lavalink player

","params":[{"type":{"names":["number"]},"description":"

The new volume you want to set on the player.

","name":"volume"}],"memberof":"ShoukakuPlayer","returns":[{"type":{"names":["Promise."]},"description":"

true if successful false if not.

"}],"name":"setVolume","longname":"ShoukakuPlayer#setVolume","kind":"function","scope":"instance","async":true,"$longname":"ShoukakuPlayer#setVolume","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#setVolume"},{"comment":"/**\r\n * Stops the player from playing.\r\n * @memberOf ShoukakuPlayer\r\n * @returns {Promise} true if successful false if not.\r\n */","meta":{"range":[6807,7048],"filename":"ShoukakuPlayer.js","lineno":172,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100002124","name":"ShoukakuPlayer#stopTrack","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"

Stops the player from playing.

","memberof":"ShoukakuPlayer","returns":[{"type":{"names":["Promise."]},"description":"

true if successful false if not.

"}],"name":"stopTrack","longname":"ShoukakuPlayer#stopTrack","kind":"function","scope":"instance","params":[],"async":true,"$longname":"ShoukakuPlayer#stopTrack","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#stopTrack"},{"comment":"/**\r\n * The current equalizer bands set in this player.\r\n * @type {Array}\r\n */","meta":{"range":[1521,1536],"filename":"ShoukakuPlayer.js","lineno":44,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001888","name":"this.bands","type":"ArrayExpression","value":"[]","paramnames":[]}},"description":"

The current equalizer bands set in this player.

","type":{"names":["Array"]},"name":"bands","longname":"ShoukakuPlayer#bands","kind":"member","memberof":"ShoukakuPlayer","scope":"instance","$longname":"ShoukakuPlayer#bands","$kind":"property","$docmaLink":"?api#ShoukakuPlayer#bands"},{"comment":"/**\r\n * If this player is currently paused.\r\n * @type {boolean}\r\n */","meta":{"range":[1252,1271],"filename":"ShoukakuPlayer.js","lineno":34,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001876","name":"this.paused","type":"Literal","value":false,"paramnames":[]}},"description":"

If this player is currently paused.

","type":{"names":["boolean"]},"name":"paused","longname":"ShoukakuPlayer#paused","kind":"member","memberof":"ShoukakuPlayer","scope":"instance","$longname":"ShoukakuPlayer#paused","$kind":"property","$docmaLink":"?api#ShoukakuPlayer#paused"},{"comment":"/**\r\n * The current postion in ms of this player\r\n * @type {number}\r\n */","meta":{"range":[1653,1670],"filename":"ShoukakuPlayer.js","lineno":49,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001894","name":"this.position","type":"Literal","value":0,"paramnames":[]}},"description":"

The current postion in ms of this player

","type":{"names":["number"]},"name":"position","longname":"ShoukakuPlayer#position","kind":"member","memberof":"ShoukakuPlayer","scope":"instance","$longname":"ShoukakuPlayer#position","$kind":"property","$docmaLink":"?api#ShoukakuPlayer#position"},{"comment":"/**\r\n * The Track that is currently being played by this player.\r\n * @type {?string}\r\n */","meta":{"range":[1122,1139],"filename":"ShoukakuPlayer.js","lineno":29,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001870","name":"this.track","type":"Literal","value":null,"paramnames":[]}},"description":"

The Track that is currently being played by this player.

","type":{"names":["string"]},"nullable":true,"name":"track","longname":"ShoukakuPlayer#track","kind":"member","memberof":"ShoukakuPlayer","scope":"instance","$longname":"ShoukakuPlayer#track","$kind":"property","$docmaLink":"?api#ShoukakuPlayer#track"},{"comment":"/**\r\n * The Voice Connection of this Player.\r\n * @type {ShoukakuLink}\r\n */","meta":{"range":[930,988],"filename":"ShoukakuPlayer.js","lineno":24,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001860","name":"this.voiceConnection","type":"NewExpression","value":"","paramnames":[]}},"description":"

The Voice Connection of this Player.

","type":{"names":["ShoukakuLink"]},"name":"voiceConnection","longname":"ShoukakuPlayer#voiceConnection","kind":"member","memberof":"ShoukakuPlayer","scope":"instance","$longname":"ShoukakuPlayer#voiceConnection","$kind":"property","$docmaLink":"?api#ShoukakuPlayer#voiceConnection"},{"comment":"/**\r\n * The current volume of this player\r\n * @type {number}\r\n */","meta":{"range":[1381,1398],"filename":"ShoukakuPlayer.js","lineno":39,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001882","name":"this.volume","type":"Literal","value":100,"paramnames":[]}},"description":"

The current volume of this player

","type":{"names":["number"]},"name":"volume","longname":"ShoukakuPlayer#volume","kind":"member","memberof":"ShoukakuPlayer","scope":"instance","$longname":"ShoukakuPlayer#volume","$kind":"property","$docmaLink":"?api#ShoukakuPlayer#volume"},{"comment":"/**\r\n * Emitted when the voiceConnection got closed.\r\n * @event ShoukakuPlayer#closed\r\n * @param {Object} reason\r\n * @memberOf ShoukakuPlayer\r\n * @example\r\n * // is your ShoukakuPlayer instance\r\n * .on('closed', (reason) => {\r\n * .disconnect();\r\n * })\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":64,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

Emitted when the voiceConnection got closed.

","kind":"event","name":"closed","params":[{"type":{"names":["Object"]},"name":"reason"}],"memberof":"ShoukakuPlayer","examples":["// is your ShoukakuPlayer instance\r.on('closed', (reason) => {\r .disconnect();\r})"],"longname":"ShoukakuPlayer#event:closed","scope":"instance","$longname":"ShoukakuPlayer#event:closed","$kind":"event","$docmaLink":"?api#ShoukakuPlayer#event:closed"},{"comment":"/**\r\n * Emitted when the Lavalink Player emits a TrackEnd or TrackStuck event.\r\n * @event ShoukakuPlayer#end\r\n * @param {Object} reason\r\n * @memberOf ShoukakuPlayer\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":58,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

Emitted when the Lavalink Player emits a TrackEnd or TrackStuck event.

","kind":"event","name":"end","params":[{"type":{"names":["Object"]},"name":"reason"}],"memberof":"ShoukakuPlayer","longname":"ShoukakuPlayer#event:end","scope":"instance","$longname":"ShoukakuPlayer#event:end","$kind":"event","$docmaLink":"?api#ShoukakuPlayer#event:end"},{"comment":"/**\r\n * Emitted when this library encounters an error in ShoukakuPlayer or ShoukakuLink class. MUST BE HANDLED.\r\n * @event ShoukakuPlayer#error\r\n * @param {Error} error The error encountered.\r\n * @memberOf ShoukakuPlayer\r\n * @example\r\n * // is your ShoukakuPlayer instance\r\n * .on('error', (error) => {\r\n * console.error(error);\r\n * .disconnect();\r\n * })\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":75,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

Emitted when this library encounters an error in ShoukakuPlayer or ShoukakuLink class. MUST BE HANDLED.

","kind":"event","name":"error","params":[{"type":{"names":["Error"]},"description":"

The error encountered.

","name":"error"}],"memberof":"ShoukakuPlayer","examples":["// is your ShoukakuPlayer instance\r.on('error', (error) => {\r console.error(error);\r .disconnect();\r})"],"longname":"ShoukakuPlayer#event:error","scope":"instance","$longname":"ShoukakuPlayer#event:error","$kind":"event","$docmaLink":"?api#ShoukakuPlayer#event:error"},{"comment":"/**\r\n * Emitted when this player's node was disconnected. MUST BE HANDLED.\r\n * @event ShoukakuPlayer#nodeDisconnect\r\n * @param {string} name The name of the node that disconnected.\r\n * @memberOf ShoukakuPlayer\r\n * @example\r\n * // is your ShoukakuPlayer instance\r\n * .on('nodeDisconnect', (name) => {\r\n * console.log(`Node ${name} which governs this player disconnected.`);\r\n * .disconnect();\r\n * })\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":87,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

Emitted when this player's node was disconnected. MUST BE HANDLED.

","kind":"event","name":"nodeDisconnect","params":[{"type":{"names":["string"]},"description":"

The name of the node that disconnected.

","name":"name"}],"memberof":"ShoukakuPlayer","examples":["// is your ShoukakuPlayer instance\r.on('nodeDisconnect', (name) => {\r console.log(`Node ${name} which governs this player disconnected.`);\r .disconnect();\r})"],"longname":"ShoukakuPlayer#event:nodeDisconnect","scope":"instance","$longname":"ShoukakuPlayer#event:nodeDisconnect","$kind":"event","$docmaLink":"?api#ShoukakuPlayer#event:nodeDisconnect"},{"comment":"/**\r\n * Emitted when Lavalink gives a Player Update event. Optional.\r\n * @event ShoukakuPlayer#playerUpdate\r\n * @param {Object} data\r\n * @memberOf ShoukakuPlayer\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":110,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

Emitted when Lavalink gives a Player Update event. Optional.

","kind":"event","name":"playerUpdate","params":[{"type":{"names":["Object"]},"name":"data"}],"memberof":"ShoukakuPlayer","longname":"ShoukakuPlayer#event:playerUpdate","scope":"instance","$longname":"ShoukakuPlayer#event:playerUpdate","$kind":"event","$docmaLink":"?api#ShoukakuPlayer#event:playerUpdate"},{"comment":"/**\r\n * Emitted when the Shoukaku Player resumes the session by resending the playing data. Optional.\r\n * @event ShoukakuPlayer#resumed\r\n * @memberOf ShoukakuPlayer\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":105,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

Emitted when the Shoukaku Player resumes the session by resending the playing data. Optional.

","kind":"event","name":"resumed","memberof":"ShoukakuPlayer","longname":"ShoukakuPlayer#event:resumed","scope":"instance","$longname":"ShoukakuPlayer#event:resumed","$kind":"event","$docmaLink":"?api#ShoukakuPlayer#event:resumed"},{"comment":"/**\r\n * Emitted when the Lavalink Player emits a TrackEnd or TrackStuck event.\r\n * @event ShoukakuPlayer#start\r\n * @param {Object} data\r\n * @memberOf ShoukakuPlayer\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":52,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

Emitted when the Lavalink Player emits a TrackEnd or TrackStuck event.

","kind":"event","name":"start","params":[{"type":{"names":["Object"]},"name":"data"}],"memberof":"ShoukakuPlayer","longname":"ShoukakuPlayer#event:start","scope":"instance","$longname":"ShoukakuPlayer#event:start","$kind":"event","$docmaLink":"?api#ShoukakuPlayer#event:start"},{"comment":"/**\r\n * Emitted when Lavalink encounters an error on playing the song. Optional.\r\n * @event ShoukakuPlayer#trackException\r\n * @param {Object} reason\r\n * @memberOf ShoukakuPlayer\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":99,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

Emitted when Lavalink encounters an error on playing the song. Optional.

","kind":"event","name":"trackException","params":[{"type":{"names":["Object"]},"name":"reason"}],"memberof":"ShoukakuPlayer","longname":"ShoukakuPlayer#event:trackException","scope":"instance","$longname":"ShoukakuPlayer#event:trackException","$kind":"event","$docmaLink":"?api#ShoukakuPlayer#event:trackException"}],"$constructor":{"comment":"/**\r\n * @param {ShoukakuSocket} node The node that governs this player.\r\n * @param {external:Guild} guild A Discord.JS Guild Object.\r\n */","meta":{"range":[768,1678],"filename":"ShoukakuPlayer.js","lineno":18,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001850","name":"ShoukakuPlayer","type":"MethodDefinition","paramnames":["node","guild"]},"vars":{"":null}},"params":[{"type":{"names":["ShoukakuSocket"]},"description":"

The node that governs this player.

","name":"node"},{"type":{"names":["external:Guild"]},"description":"

A Discord.JS Guild Object.

","name":"guild"}],"name":"ShoukakuPlayer","longname":"ShoukakuPlayer","kind":"class","scope":"global","$longname":"ShoukakuPlayer","$kind":"constructor","$docmaLink":"?api#ShoukakuPlayer"}},{"comment":"/**\n * ShoukakuRest, provides access to Lavalink REST API.\n * @class ShoukakuRest\n */","meta":{"filename":"ShoukakuRest.js","lineno":10,"columnno":0,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{}},"description":"

ShoukakuRest, provides access to Lavalink REST API.

","kind":"class","name":"ShoukakuRest","longname":"ShoukakuRest","scope":"global","$longname":"ShoukakuRest","$kind":"class","$docmaLink":"?api#ShoukakuRest","$members":[{"comment":"/**\n * Decodes the given base64 encoded track from lavalink.\n * @param {base64} track Base64 Encoded Track you got from the Lavalink API.\n * @memberof ShoukakuRest\n * @returns {Promise} The Lavalink Track details.\n */","meta":{"range":[2655,2849],"filename":"ShoukakuRest.js","lineno":69,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{"id":"astnode100003821","name":"ShoukakuRest#decode","type":"MethodDefinition","paramnames":["track"]},"vars":{"":null}},"description":"

Decodes the given base64 encoded track from lavalink.

","params":[{"type":{"names":["base64"]},"description":"

Base64 Encoded Track you got from the Lavalink API.

","name":"track"}],"memberof":"ShoukakuRest","returns":[{"type":{"names":["Promise."]},"description":"

The Lavalink Track details.

"}],"name":"decode","longname":"ShoukakuRest#decode","kind":"function","scope":"instance","$longname":"ShoukakuRest#decode","$kind":"method","$docmaLink":"?api#ShoukakuRest#decode"},{"comment":"/**\n * Gets the status of the \"RoutePlanner API\" for this Lavalink node.\n * @memberof ShoukakuRest\n * @returns {Promise} Refer to `https://github.com/Frederikam/Lavalink/blob/master/IMPLEMENTATION.md#routeplanner-api`\n */","meta":{"range":[3102,3188],"filename":"ShoukakuRest.js","lineno":79,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{"id":"astnode100003849","name":"ShoukakuRest#getRoutePlannerStatus","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"

Gets the status of the "RoutePlanner API" for this Lavalink node.

","memberof":"ShoukakuRest","returns":[{"type":{"names":["Promise."]},"description":"

Refer to https://github.com/Frederikam/Lavalink/blob/master/IMPLEMENTATION.md#routeplanner-api

"}],"name":"getRoutePlannerStatus","longname":"ShoukakuRest#getRoutePlannerStatus","kind":"function","scope":"instance","params":[],"$longname":"ShoukakuRest#getRoutePlannerStatus","$kind":"method","$docmaLink":"?api#ShoukakuRest#getRoutePlannerStatus"},{"comment":"/**\n * Resolves a identifier into a lavalink track.\n * @param {string} identifier Anything you want for lavalink to search for\n * @param {string} search Either `youtube` or `soundcloud`. If specified, resolve will return search results.\n * @memberof ShoukakuRest\n * @returns {Promise} The Lavalink Track Object.\n */","meta":{"range":[1573,2400],"filename":"ShoukakuRest.js","lineno":42,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{"id":"astnode100003708","name":"ShoukakuRest#resolve","type":"MethodDefinition","paramnames":["identifier","search"]},"vars":{"":null}},"description":"

Resolves a identifier into a lavalink track.

","params":[{"type":{"names":["string"]},"description":"

Anything you want for lavalink to search for

","name":"identifier"},{"type":{"names":["string"]},"description":"

Either youtube or soundcloud. If specified, resolve will return search results.

","name":"search"}],"memberof":"ShoukakuRest","returns":[{"type":{"names":["Promise."]},"description":"

The Lavalink Track Object.

"}],"name":"resolve","longname":"ShoukakuRest#resolve","kind":"function","scope":"instance","async":true,"$longname":"ShoukakuRest#resolve","$kind":"method","$docmaLink":"?api#ShoukakuRest#resolve"},{"comment":"/**\n * Unmarks all the failed IP(s) in the \"RoutePlanner API\" on this Lavalink node.\n * @memberof ShoukakuRest\n * @returns {Promise} Request status code\n */","meta":{"range":[3738,3828],"filename":"ShoukakuRest.js","lineno":96,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{"id":"astnode100003873","name":"ShoukakuRest#unmarkAllFailedAddress","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"

Unmarks all the failed IP(s) in the "RoutePlanner API" on this Lavalink node.

","memberof":"ShoukakuRest","returns":[{"type":{"names":["Promise."]},"description":"

Request status code

"}],"name":"unmarkAllFailedAddress","longname":"ShoukakuRest#unmarkAllFailedAddress","kind":"function","scope":"instance","params":[],"$longname":"ShoukakuRest#unmarkAllFailedAddress","$kind":"method","$docmaLink":"?api#ShoukakuRest#unmarkAllFailedAddress"},{"comment":"/**\n * Unmarks a failed IP in the \"RoutePlanner API\" on this Lavalink node.\n * @param {string} address The IP you want to unmark as failed.\n * @memberof ShoukakuRest\n * @returns {Promise} Request status code\n */","meta":{"range":[3437,3548],"filename":"ShoukakuRest.js","lineno":88,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{"id":"astnode100003859","name":"ShoukakuRest#unmarkFailedAddress","type":"MethodDefinition","paramnames":["address"]},"vars":{"":null}},"description":"

Unmarks a failed IP in the "RoutePlanner API" on this Lavalink node.

","params":[{"type":{"names":["string"]},"description":"

The IP you want to unmark as failed.

","name":"address"}],"memberof":"ShoukakuRest","returns":[{"type":{"names":["Promise."]},"description":"

Request status code

"}],"name":"unmarkFailedAddress","longname":"ShoukakuRest#unmarkFailedAddress","kind":"function","scope":"instance","$longname":"ShoukakuRest#unmarkFailedAddress","$kind":"method","$docmaLink":"?api#ShoukakuRest#unmarkFailedAddress"},{"comment":"/**\n * This Resolver Timeout before it decides to cancel the request.\n * @type {number}\n */","meta":{"range":[1121,1152],"filename":"ShoukakuRest.js","lineno":31,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{"id":"astnode100003691","name":"this.timeout","type":"LogicalExpression","value":"","paramnames":[]}},"description":"

This Resolver Timeout before it decides to cancel the request.

","type":{"names":["number"]},"name":"timeout","longname":"ShoukakuRest#timeout","kind":"member","memberof":"ShoukakuRest","scope":"instance","$longname":"ShoukakuRest#timeout","$kind":"property","$docmaLink":"?api#ShoukakuRest#timeout"},{"comment":"/**\n * URL of the host used by this resolver instance.\n * @type {string}\n */","meta":{"range":[951,987],"filename":"ShoukakuRest.js","lineno":26,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{"id":"astnode100003680","name":"this.url","type":"TemplateLiteral","value":"","paramnames":[]}},"description":"

URL of the host used by this resolver instance.

","type":{"names":["string"]},"name":"url","longname":"ShoukakuRest#url","kind":"member","memberof":"ShoukakuRest","scope":"instance","$longname":"ShoukakuRest#url","$kind":"property","$docmaLink":"?api#ShoukakuRest#url"}],"$constructor":{"comment":"/**\n * @param {string} host Your node host / ip address of where the lavalink is hosted.\n * @param {string} port The Port Number of your lavalink instance.\n * @param {string} auth The authentication key you set on your lavalink config.\n * @param {number} timeout Timeout before a request times out.\n */","meta":{"range":[796,1222],"filename":"ShoukakuRest.js","lineno":21,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{"id":"astnode100003671","name":"ShoukakuRest","type":"MethodDefinition","paramnames":["host","port","auth","timeout"]},"vars":{"":null}},"params":[{"type":{"names":["string"]},"description":"

Your node host / ip address of where the lavalink is hosted.

","name":"host"},{"type":{"names":["string"]},"description":"

The Port Number of your lavalink instance.

","name":"port"},{"type":{"names":["string"]},"description":"

The authentication key you set on your lavalink config.

","name":"auth"},{"type":{"names":["number"]},"description":"

Timeout before a request times out.

","name":"timeout"}],"name":"ShoukakuRest","longname":"ShoukakuRest","kind":"class","scope":"global","$longname":"ShoukakuRest","$kind":"constructor","$docmaLink":"?api#ShoukakuRest"}},{"comment":"/**\r\n * ShoukakuSocket, manages a single Lavalink WS connection.\r\n * @class ShoukakuSocket\r\n */","meta":{"filename":"ShoukakuSocket.js","lineno":9,"columnno":0,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{}},"description":"

ShoukakuSocket, manages a single Lavalink WS connection.

","kind":"class","name":"ShoukakuSocket","longname":"ShoukakuSocket","scope":"global","$longname":"ShoukakuSocket","$kind":"class","$docmaLink":"?api#ShoukakuSocket","$members":[{"comment":"/**\r\n * Connects this Socket.\r\n * @param {string} id Your Bot's / Client user id.\r\n * @param {number} shardCount Your Bot's / Client shard count.\r\n * @param {boolean|string} resumable Determines if we should try to resume the connection.\r\n * @memberof ShoukakuSocket\r\n * @returns {void}\r\n */","meta":{"range":[3790,4737],"filename":"ShoukakuSocket.js","lineno":100,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002863","name":"ShoukakuSocket#connect","type":"MethodDefinition","paramnames":["id","shardCount","resumable"]},"vars":{"":null}},"description":"

Connects this Socket.

","params":[{"type":{"names":["string"]},"description":"

Your Bot's / Client user id.

","name":"id"},{"type":{"names":["number"]},"description":"

Your Bot's / Client shard count.

","name":"shardCount"},{"type":{"names":["boolean","string"]},"description":"

Determines if we should try to resume the connection.

","name":"resumable"}],"memberof":"ShoukakuSocket","returns":[{"type":{"names":["void"]}}],"name":"connect","longname":"ShoukakuSocket#connect","kind":"function","scope":"instance","$longname":"ShoukakuSocket#connect","$kind":"method","$docmaLink":"?api#ShoukakuSocket#connect"},{"comment":"/**\r\n * Creates a player and connects your bot to the specified guild's voice channel\r\n * @param {ShoukakuConstants#ShoukakuJoinOptions} options Join data to send.\r\n * @memberof ShoukakuSocket\r\n * @returns {Promise}\r\n * @example\r\n * .joinVoiceChannel({\r\n * guildID: 'guild_id',\r\n * voiceChannelID: 'voice_channel_id'\r\n * }).then((player) => player.playTrack('lavalink_track'));\r\n */","meta":{"range":[5211,6496],"filename":"ShoukakuSocket.js","lineno":127,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100003037","name":"ShoukakuSocket#joinVoiceChannel","type":"MethodDefinition","paramnames":["options"]},"vars":{"":null}},"description":"

Creates a player and connects your bot to the specified guild's voice channel

","params":[{"type":{"names":["ShoukakuConstants#ShoukakuJoinOptions"]},"description":"

Join data to send.

","name":"options"}],"memberof":"ShoukakuSocket","returns":[{"type":{"names":["Promise."]}}],"examples":[".joinVoiceChannel({\r guildID: 'guild_id',\r voiceChannelID: 'voice_channel_id'\r}).then((player) => player.playTrack('lavalink_track'));"],"name":"joinVoiceChannel","longname":"ShoukakuSocket#joinVoiceChannel","kind":"function","scope":"instance","$longname":"ShoukakuSocket#joinVoiceChannel","$kind":"method","$docmaLink":"?api#ShoukakuSocket#joinVoiceChannel"},{"comment":"/**\r\n * Eventually Disconnects the VoiceConnection & Removes the Player from a Guild.\r\n * @param {string} guildID The guild id of the player you want to remove.\r\n * @memberOf ShoukakuSocket\r\n * @returns {void}\r\n */","meta":{"range":[6742,6888],"filename":"ShoukakuSocket.js","lineno":162,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100003190","name":"ShoukakuSocket#leaveVoiceChannel","type":"MethodDefinition","paramnames":["guildID"]},"vars":{"":null}},"description":"

Eventually Disconnects the VoiceConnection & Removes the Player from a Guild.

","params":[{"type":{"names":["string"]},"description":"

The guild id of the player you want to remove.

","name":"guildID"}],"memberof":"ShoukakuSocket","returns":[{"type":{"names":["void"]}}],"name":"leaveVoiceChannel","longname":"ShoukakuSocket#leaveVoiceChannel","kind":"function","scope":"instance","$longname":"ShoukakuSocket#leaveVoiceChannel","$kind":"method","$docmaLink":"?api#ShoukakuSocket#leaveVoiceChannel"},{"comment":"/**\r\n * Name of this Socket that you can use on .getNode() method of Shoukaku.\r\n * @type {string}\r\n */","meta":{"range":[2101,2122],"filename":"ShoukakuSocket.js","lineno":55,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002665","name":"this.name","type":"MemberExpression","value":"node.name","paramnames":[]}},"description":"

Name of this Socket that you can use on .getNode() method of Shoukaku.

","type":{"names":["string"]},"name":"name","longname":"ShoukakuSocket#name","kind":"member","memberof":"ShoukakuSocket","scope":"instance","$longname":"ShoukakuSocket#name","$kind":"property","$docmaLink":"?api#ShoukakuSocket#name"},{"comment":"/**\r\n * Penalties of this Socket. The higher the return number, the more loaded the server is.\r\n * @type {number}\r\n * @memberof ShoukakuSocket\r\n */","meta":{"range":[3086,3466],"filename":"ShoukakuSocket.js","lineno":82,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002791","name":"ShoukakuSocket#penalties","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"

Penalties of this Socket. The higher the return number, the more loaded the server is.

","type":{"names":["number"]},"memberof":"ShoukakuSocket","name":"penalties","longname":"ShoukakuSocket#penalties","kind":"member","scope":"instance","params":[],"$longname":"ShoukakuSocket#penalties","$kind":"property","$docmaLink":"?api#ShoukakuSocket#penalties"},{"comment":"/**\r\n * The active players in this socket/node.\r\n * @type {external:Map}\r\n */","meta":{"range":[1144,1168],"filename":"ShoukakuSocket.js","lineno":30,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002617","name":"this.players","type":"NewExpression","value":"","paramnames":[]}},"description":"

The active players in this socket/node.

","type":{"names":["external:Map"]},"name":"players","longname":"ShoukakuSocket#players","kind":"member","memberof":"ShoukakuSocket","scope":"instance","$longname":"ShoukakuSocket#players","$kind":"property","$docmaLink":"?api#ShoukakuSocket#players"},{"comment":"/**\r\n * Attempted reconnects of this Socket. Resets to 0 when the socket opens properly.\r\n * @type {number}\r\n */","meta":{"range":[1931,1957],"filename":"ShoukakuSocket.js","lineno":50,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002659","name":"this.reconnectAttempts","type":"Literal","value":0,"paramnames":[]}},"description":"

Attempted reconnects of this Socket. Resets to 0 when the socket opens properly.

","type":{"names":["number"]},"name":"reconnectAttempts","longname":"ShoukakuSocket#reconnectAttempts","kind":"member","memberof":"ShoukakuSocket","scope":"instance","$longname":"ShoukakuSocket#reconnectAttempts","$kind":"property","$docmaLink":"?api#ShoukakuSocket#reconnectAttempts"},{"comment":"/**\r\n * The REST API of this Socket, mostly to load balance your REST requests instead of relying on a single node.\r\n * @type {ShoukakuRest}\r\n */","meta":{"range":[1355,1446],"filename":"ShoukakuSocket.js","lineno":35,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002624","name":"this.rest","type":"NewExpression","value":"","paramnames":[]}},"description":"

The REST API of this Socket, mostly to load balance your REST requests instead of relying on a single node.

","type":{"names":["ShoukakuRest"]},"name":"rest","longname":"ShoukakuSocket#rest","kind":"member","memberof":"ShoukakuSocket","scope":"instance","$longname":"ShoukakuSocket#rest","$kind":"property","$docmaLink":"?api#ShoukakuSocket#rest"},{"comment":"/**\r\n * The Instance of Shoukaku where this node initialization is called.\r\n * @type {Shoukaku}\r\n */","meta":{"range":[1001,1025],"filename":"ShoukakuSocket.js","lineno":25,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002611","name":"this.shoukaku","type":"Identifier","value":"shoukaku","paramnames":[]}},"description":"

The Instance of Shoukaku where this node initialization is called.

","type":{"names":["Shoukaku"]},"name":"shoukaku","longname":"ShoukakuSocket#shoukaku","kind":"member","memberof":"ShoukakuSocket","scope":"instance","$longname":"ShoukakuSocket#shoukaku","$kind":"property","$docmaLink":"?api#ShoukakuSocket#shoukaku"},{"comment":"/**\r\n * The state of this Socket.\r\n * @type {ShoukakuConstants#ShoukakuStatus}\r\n */","meta":{"range":[1571,1611],"filename":"ShoukakuSocket.js","lineno":40,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002645","name":"this.state","type":"MemberExpression","value":"ShoukakuStatus.DISCONNECTED","paramnames":[]}},"description":"

The state of this Socket.

","type":{"names":["ShoukakuConstants#ShoukakuStatus"]},"name":"state","longname":"ShoukakuSocket#state","kind":"member","memberof":"ShoukakuSocket","scope":"instance","$longname":"ShoukakuSocket#state","$kind":"property","$docmaLink":"?api#ShoukakuSocket#state"},{"comment":"/**\r\n * The current stats of this Socket.\r\n * @type {ShoukakuConstants#ShoukakuNodeStats}\r\n */","meta":{"range":[1747,1777],"filename":"ShoukakuSocket.js","lineno":45,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002653","name":"this.stats","type":"Identifier","value":"ShoukakuNodeStats","paramnames":[]}},"description":"

The current stats of this Socket.

","type":{"names":["ShoukakuConstants#ShoukakuNodeStats"]},"name":"stats","longname":"ShoukakuSocket#stats","kind":"member","memberof":"ShoukakuSocket","scope":"instance","$longname":"ShoukakuSocket#stats","$kind":"property","$docmaLink":"?api#ShoukakuSocket#stats"}],"$constructor":{"comment":"/**\r\n * @extends {external:EventEmitter}\r\n * @param {Shoukaku} shoukaku Your Shoukaku Instance\r\n * @param {ShoukakuOptions} node ShoukakuNodeOptions Options to initialize Shoukaku with\r\n */","meta":{"range":[813,2642],"filename":"ShoukakuSocket.js","lineno":19,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002601","name":"ShoukakuSocket","type":"MethodDefinition","paramnames":["shoukaku","node"]},"vars":{"":null}},"augments":["external:EventEmitter"],"params":[{"type":{"names":["Shoukaku"]},"description":"

Your Shoukaku Instance

","name":"shoukaku"},{"type":{"names":["ShoukakuOptions"]},"description":"

ShoukakuNodeOptions Options to initialize Shoukaku with

","name":"node"}],"name":"ShoukakuSocket","longname":"ShoukakuSocket","kind":"class","scope":"global","$longname":"ShoukakuSocket","$kind":"constructor","$docmaLink":"?api#ShoukakuSocket"}},{"comment":"/**\n * ShoukakuTimeout, Timeout Error class of Shoukaku.\n * @class ShoukakuTimeout\n * @extends {Error}\n */","meta":{"filename":"ShoukakuTimeout.js","lineno":1,"columnno":0,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

ShoukakuTimeout, Timeout Error class of Shoukaku.

","kind":"class","name":"ShoukakuTimeout","augments":["Error"],"longname":"ShoukakuTimeout","scope":"global","$longname":"ShoukakuTimeout","$kind":"class","$docmaLink":"?api#ShoukakuTimeout","$constructor":{"comment":"/**\n * @param message The Error Message\n */","meta":{"range":[209,300],"filename":"ShoukakuTimeout.js","lineno":10,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{"id":"astnode100000982","name":"ShoukakuTimeout","type":"MethodDefinition","paramnames":["message"]},"vars":{"":null}},"params":[{"description":"

The Error Message

","name":"message"}],"name":"ShoukakuTimeout","longname":"ShoukakuTimeout","kind":"class","scope":"global","$longname":"ShoukakuTimeout","$kind":"constructor","$docmaLink":"?api#ShoukakuTimeout"}}],"symbols":["Shoukaku","Shoukaku#addNode","Shoukaku#client","Shoukaku#event:close","Shoukaku#event:debug","Shoukaku#event:disconnected","Shoukaku#event:error","Shoukaku#event:ready","Shoukaku#getNode","Shoukaku#getPlayer","Shoukaku#id","Shoukaku#nodes","Shoukaku#players","Shoukaku#removeNode","Shoukaku#shardCount","Shoukaku#totalPlayers","ShoukakuConstants","ShoukakuConstants#ShoukakuJoinOptions","ShoukakuConstants#ShoukakuNodeOptions","ShoukakuConstants#ShoukakuNodes","ShoukakuConstants#ShoukakuNodeStats","ShoukakuConstants#ShoukakuOptions","ShoukakuConstants#ShoukakuPlayOptions","ShoukakuConstants#ShoukakuStatus","ShoukakuError","ShoukakuLink","ShoukakuLink#attemptReconnect","ShoukakuLink#guildID","ShoukakuLink#node","ShoukakuLink#player","ShoukakuLink#selfDeaf","ShoukakuLink#selfMute","ShoukakuLink#sessionID","ShoukakuLink#shardID","ShoukakuLink#state","ShoukakuLink#userID","ShoukakuLink#voiceChannelID","ShoukakuPlayer","ShoukakuPlayer#bands","ShoukakuPlayer#connect","ShoukakuPlayer#disconnect","ShoukakuPlayer#event:closed","ShoukakuPlayer#event:end","ShoukakuPlayer#event:error","ShoukakuPlayer#event:nodeDisconnect","ShoukakuPlayer#event:playerUpdate","ShoukakuPlayer#event:resumed","ShoukakuPlayer#event:start","ShoukakuPlayer#event:trackException","ShoukakuPlayer#moveToNode","ShoukakuPlayer#paused","ShoukakuPlayer#playTrack","ShoukakuPlayer#position","ShoukakuPlayer#seekTo","ShoukakuPlayer#setEqualizer","ShoukakuPlayer#setPaused","ShoukakuPlayer#setVolume","ShoukakuPlayer#stopTrack","ShoukakuPlayer#track","ShoukakuPlayer#voiceConnection","ShoukakuPlayer#volume","ShoukakuRest","ShoukakuRest#decode","ShoukakuRest#getRoutePlannerStatus","ShoukakuRest#resolve","ShoukakuRest#timeout","ShoukakuRest#unmarkAllFailedAddress","ShoukakuRest#unmarkFailedAddress","ShoukakuRest#url","ShoukakuSocket","ShoukakuSocket#connect","ShoukakuSocket#joinVoiceChannel","ShoukakuSocket#leaveVoiceChannel","ShoukakuSocket#name","ShoukakuSocket#penalties","ShoukakuSocket#players","ShoukakuSocket#reconnectAttempts","ShoukakuSocket#rest","ShoukakuSocket#shoukaku","ShoukakuSocket#state","ShoukakuSocket#stats","ShoukakuTimeout"]}},"app":{"title":"Shoukaku | A Lavalink Library for Discord.JS v12","routing":{"method":"query","caseSensitive":true},"entrance":"content:readme","base":"/Shoukaku/","meta":null,"server":"static","favicon":""},"template":{"name":"docma-template-zebra","description":"Zebra - Default template for Docma. https://github.com/onury/docma","version":"2.3.1","supportedDocmaVersion":">=2.0.0","author":"Onur Yıldırım","license":"MIT","mainHTML":"index.html","options":{"title":{"label":"Shoukaku","href":"."},"navbar":{"menu":[{"label":"Readme","href":"."},{"label":"Documentation","href":"?api"},{"label":"GitHub","href":"https://github.com/Deivu/Shoukaku"}],"enabled":true,"fixed":true,"dark":false,"animations":true},"logo":null,"sidebar":{"enabled":true,"outline":"tree","collapsed":false,"toolbar":true,"itemsFolded":false,"itemsOverflow":"crop","badges":true,"search":true,"animations":true},"symbols":{"autoLink":true,"params":"list","enums":"list","props":"list","meta":false},"contentView":{"bookmarks":false,"faVersion":"5.5.0","faLibs":"all"}}},"partials":{"api":"docma-api","content":"docma-content","notFound":"docma-404"},"elementID":"docma-main","contentElementID":"docma-content","defaultApiName":"_def_","logsEnabled":false})); +var docma = Object.freeze(new DocmaWeb({"version":"3.2.2","routes":[{"id":"api:","type":"api","name":"_def_","path":"?api","contentPath":null,"sourceType":"js"},{"id":"content:readme","type":"content","name":"readme","path":"?content=readme","contentPath":"content/readme.html","sourceType":"md"}],"apis":{"_def_":{"documentation":[{"comment":"/**\r\n * Shoukaku, governs the client's node connections.\r\n * @class Shoukaku\r\n * @extends {external:EventEmitter}\r\n */","meta":{"filename":"Shoukaku.js","lineno":33,"columnno":0,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{}},"description":"

Shoukaku, governs the client's node connections.

","kind":"class","name":"Shoukaku","augments":["external:EventEmitter"],"longname":"Shoukaku","scope":"global","$longname":"Shoukaku","$kind":"class","$docmaLink":"?api#Shoukaku","$members":[{"comment":"/**\r\n * Function to register a Lavalink Node\r\n * @param {ShoukakuConstants#ShoukakuNodeOptions} nodeOptions The Node Options to be used to connect to.\r\n * @memberof Shoukaku\r\n * @returns {void}\r\n */","meta":{"range":[5588,6235],"filename":"Shoukaku.js","lineno":152,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000288","name":"Shoukaku#addNode","type":"MethodDefinition","paramnames":["nodeOptions"]},"vars":{"":null}},"description":"

Function to register a Lavalink Node

","params":[{"type":{"names":["ShoukakuConstants#ShoukakuNodeOptions"]},"description":"

The Node Options to be used to connect to.

","name":"nodeOptions"}],"memberof":"Shoukaku","returns":[{"type":{"names":["void"]}}],"name":"addNode","longname":"Shoukaku#addNode","kind":"function","scope":"instance","$longname":"Shoukaku#addNode","$kind":"method","$docmaLink":"?api#Shoukaku#addNode"},{"comment":"/**\r\n * Shortcut to get the Ideal Node or a manually specified Node from the current nodes that Shoukaku governs.\r\n * @param {string} [name] If blank, Shoukaku will automatically return the Ideal Node for you to connect to. If name is specifed, she will try to return the node you specified.\r\n * @memberof Shoukaku\r\n * @returns {ShoukakuSocket}\r\n * @example\r\n * const node = .getNode();\r\n * node.rest.resolve('Kongou Burning Love', 'youtube')\r\n * .then(data => {\r\n * node.joinVoiceChannel({\r\n * guildID: 'guild_id',\r\n * voiceChannelID: 'voice_channel_id'\r\n * }).then(player => player.playTrack(data.track))\r\n * })\r\n */","meta":{"range":[8128,9083],"filename":"Shoukaku.js","lineno":207,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000520","name":"Shoukaku#getNode","type":"MethodDefinition","paramnames":["name"]},"vars":{"":null}},"description":"

Shortcut to get the Ideal Node or a manually specified Node from the current nodes that Shoukaku governs.

","params":[{"type":{"names":["string"]},"optional":true,"description":"

If blank, Shoukaku will automatically return the Ideal Node for you to connect to. If name is specifed, she will try to return the node you specified.

","name":"name"}],"memberof":"Shoukaku","returns":[{"type":{"names":["ShoukakuSocket"]}}],"examples":["const node = .getNode();\rnode.rest.resolve('Kongou Burning Love', 'youtube')\r .then(data => {\r node.joinVoiceChannel({\r guildID: 'guild_id',\r voiceChannelID: 'voice_channel_id'\r }).then(player => player.playTrack(data.track))\r })"],"name":"getNode","longname":"Shoukaku#getNode","kind":"function","scope":"instance","$longname":"Shoukaku#getNode","$kind":"method","$docmaLink":"?api#Shoukaku#getNode"},{"comment":"/**\r\n * Shortcut to get the Player of a guild, if there is any.\r\n * @param {string} guildID The guildID of the guild we are trying to get.\r\n * @memberof Shoukaku\r\n * @returns {?ShoukakuPlayer}\r\n */","meta":{"range":[9307,9598],"filename":"Shoukaku.js","lineno":232,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000633","name":"Shoukaku#getPlayer","type":"MethodDefinition","paramnames":["guildID"]},"vars":{"":null}},"description":"

Shortcut to get the Player of a guild, if there is any.

","params":[{"type":{"names":["string"]},"description":"

The guildID of the guild we are trying to get.

","name":"guildID"}],"memberof":"Shoukaku","returns":[{"type":{"names":["ShoukakuPlayer"]},"nullable":true}],"name":"getPlayer","longname":"Shoukaku#getPlayer","kind":"function","scope":"instance","$longname":"Shoukaku#getPlayer","$kind":"method","$docmaLink":"?api#Shoukaku#getPlayer"},{"comment":"/**\r\n * Function to remove a Lavalink Node\r\n * @param {string} name The Lavalink Node to remove\r\n * @param {string} reason Optional reason for this disconnect.\r\n * @memberof Shoukaku\r\n * @returns {void}\r\n */","meta":{"range":[6478,7384],"filename":"Shoukaku.js","lineno":172,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000398","name":"Shoukaku#removeNode","type":"MethodDefinition","paramnames":["name","reason"]},"vars":{"":null}},"description":"

Function to remove a Lavalink Node

","params":[{"type":{"names":["string"]},"description":"

The Lavalink Node to remove

","name":"name"},{"type":{"names":["string"]},"description":"

Optional reason for this disconnect.

","name":"reason"}],"memberof":"Shoukaku","returns":[{"type":{"names":["void"]}}],"name":"removeNode","longname":"Shoukaku#removeNode","kind":"function","scope":"instance","$longname":"Shoukaku#removeNode","$kind":"method","$docmaLink":"?api#Shoukaku#removeNode"},{"comment":"/**\r\n * The instance of Discord.js client used with Shoukaku.\r\n * @type {external:Client}\r\n */","meta":{"range":[1733,1753],"filename":"Shoukaku.js","lineno":52,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000086","name":"this.client","type":"Identifier","value":"client","paramnames":[]}},"description":"

The instance of Discord.js client used with Shoukaku.

","type":{"names":["external:Client"]},"name":"client","longname":"Shoukaku#client","kind":"member","memberof":"Shoukaku","scope":"instance","$longname":"Shoukaku#client","$kind":"property","$docmaLink":"?api#Shoukaku#client"},{"comment":"/**\r\n * The user id of the bot that is being governed by Shoukaku.\r\n * @type {?string}\r\n */","meta":{"range":[1886,1900],"filename":"Shoukaku.js","lineno":57,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000092","name":"this.id","type":"Literal","value":null,"paramnames":[]}},"description":"

The user id of the bot that is being governed by Shoukaku.

","type":{"names":["string"]},"nullable":true,"name":"id","longname":"Shoukaku#id","kind":"member","memberof":"Shoukaku","scope":"instance","$longname":"Shoukaku#id","$kind":"property","$docmaLink":"?api#Shoukaku#id"},{"comment":"/**\r\n * The current nodes that is being handled by Shoukaku.\r\n * @type {external:Map}\r\n */","meta":{"range":[2187,2209],"filename":"Shoukaku.js","lineno":67,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000104","name":"this.nodes","type":"NewExpression","value":"","paramnames":[]}},"description":"

The current nodes that is being handled by Shoukaku.

","type":{"names":["external:Map"]},"name":"nodes","longname":"Shoukaku#nodes","kind":"member","memberof":"Shoukaku","scope":"instance","$longname":"Shoukaku#nodes","$kind":"property","$docmaLink":"?api#Shoukaku#nodes"},{"comment":"/**\r\n * Gets all the Players that is currently active on all nodes in this instance.\r\n * @type {external:Map}\r\n * @memberof Shoukaku\r\n */","meta":{"range":[3038,3262],"filename":"Shoukaku.js","lineno":88,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000224","name":"Shoukaku#players","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"

Gets all the Players that is currently active on all nodes in this instance.

","type":{"names":["external:Map"]},"memberof":"Shoukaku","name":"players","longname":"Shoukaku#players","kind":"member","scope":"instance","params":[],"$longname":"Shoukaku#players","$kind":"property","$docmaLink":"?api#Shoukaku#players"},{"comment":"/**\r\n * The shard count of the bot that is being governed by Shoukaku.\r\n * @type {number}\r\n */","meta":{"range":[2036,2055],"filename":"Shoukaku.js","lineno":62,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000098","name":"this.shardCount","type":"Literal","value":1,"paramnames":[]}},"description":"

The shard count of the bot that is being governed by Shoukaku.

","type":{"names":["number"]},"name":"shardCount","longname":"Shoukaku#shardCount","kind":"member","memberof":"Shoukaku","scope":"instance","$longname":"Shoukaku#shardCount","$kind":"property","$docmaLink":"?api#Shoukaku#shardCount"},{"comment":"/**\r\n * Gets the number of total Players that is currently active on all nodes in this instance.\r\n * @type {number}\r\n * @memberof Shoukaku\r\n */","meta":{"range":[3433,3590],"filename":"Shoukaku.js","lineno":100,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000260","name":"Shoukaku#totalPlayers","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"

Gets the number of total Players that is currently active on all nodes in this instance.

","type":{"names":["number"]},"memberof":"Shoukaku","name":"totalPlayers","longname":"Shoukaku#totalPlayers","kind":"member","scope":"instance","params":[],"$longname":"Shoukaku#totalPlayers","$kind":"property","$docmaLink":"?api#Shoukaku#totalPlayers"},{"comment":"/**\r\n * Emitted when a Lavalink Node closed.\r\n * @event Shoukaku#close\r\n * @param {string} name The name of the Lavalink Node that sent a close event.\r\n * @param {number} code The WebSocket close code https://github.com/Luka967/websocket-close-codes\r\n * @param {reason} reason The reason for this close event.\r\n * @memberof Shoukaku\r\n */","meta":{"filename":"Shoukaku.js","lineno":130,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{}},"description":"

Emitted when a Lavalink Node closed.

","kind":"event","name":"close","params":[{"type":{"names":["string"]},"description":"

The name of the Lavalink Node that sent a close event.

","name":"name"},{"type":{"names":["number"]},"description":"

The WebSocket close code https://github.com/Luka967/websocket-close-codes

","name":"code"},{"type":{"names":["reason"]},"description":"

The reason for this close event.

","name":"reason"}],"memberof":"Shoukaku","longname":"Shoukaku#event:close","scope":"instance","$longname":"Shoukaku#event:close","$kind":"event","$docmaLink":"?api#Shoukaku#event:close"},{"comment":"/**\r\n * Emitted when a Lavalink Node sends a debug event.\r\n * @event Shoukaku#debug\r\n * @param {string} name The name of the Lavalink Node that sent a debug event.\r\n * @param {Object} data The actual debug data\r\n * @memberof Shoukaku\r\n */","meta":{"filename":"Shoukaku.js","lineno":106,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{}},"description":"

Emitted when a Lavalink Node sends a debug event.

","kind":"event","name":"debug","params":[{"type":{"names":["string"]},"description":"

The name of the Lavalink Node that sent a debug event.

","name":"name"},{"type":{"names":["Object"]},"description":"

The actual debug data

","name":"data"}],"memberof":"Shoukaku","longname":"Shoukaku#event:debug","scope":"instance","$longname":"Shoukaku#event:debug","$kind":"event","$docmaLink":"?api#Shoukaku#event:debug"},{"comment":"/**\r\n * Emitted when a Lavalink Node will not try to reconnect again.\r\n * @event Shoukaku#disconnected\r\n * @param {string} name The name of the Lavalink Node that sent a close event.\r\n * @param {string} reason The reason for the disconnect.\r\n * @memberof Shoukaku\r\n */","meta":{"filename":"Shoukaku.js","lineno":138,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{}},"description":"

Emitted when a Lavalink Node will not try to reconnect again.

","kind":"event","name":"disconnected","params":[{"type":{"names":["string"]},"description":"

The name of the Lavalink Node that sent a close event.

","name":"name"},{"type":{"names":["string"]},"description":"

The reason for the disconnect.

","name":"reason"}],"memberof":"Shoukaku","longname":"Shoukaku#event:disconnected","scope":"instance","$longname":"Shoukaku#event:disconnected","$kind":"event","$docmaLink":"?api#Shoukaku#event:disconnected"},{"comment":"/**\r\n * Emitted when a lavalink Node encouters an error. This event MUST BE HANDLED.\r\n * @event Shoukaku#error\r\n * @param {string} name The name of the Lavalink Node that sent an error event or 'Shoukaku' if the error is from Shoukaku.\r\n * @param {Error} error The error encountered.\r\n * @memberof Shoukaku\r\n * @example\r\n * // is your own instance of Shoukaku\r\n * .on('error', console.error);\r\n */","meta":{"filename":"Shoukaku.js","lineno":113,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{}},"description":"

Emitted when a lavalink Node encouters an error. This event MUST BE HANDLED.

","kind":"event","name":"error","params":[{"type":{"names":["string"]},"description":"

The name of the Lavalink Node that sent an error event or 'Shoukaku' if the error is from Shoukaku.

","name":"name"},{"type":{"names":["Error"]},"description":"

The error encountered.

","name":"error"}],"memberof":"Shoukaku","examples":["// is your own instance of Shoukaku\r.on('error', console.error);"],"longname":"Shoukaku#event:error","scope":"instance","$longname":"Shoukaku#event:error","$kind":"event","$docmaLink":"?api#Shoukaku#event:error"},{"comment":"/** name, code, reason, isReconnectable\r\n * Emitted when a Lavalink Node becomes Ready from a Reconnection or First Connection.\r\n * @event Shoukaku#ready\r\n * @param {string} name The name of the Lavalink Node that sent a ready event.\r\n * @param {boolean} reconnect True if the session reconnected, otherwise false.\r\n * @memberof Shoukaku\r\n */","meta":{"filename":"Shoukaku.js","lineno":123,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{}},"description":"

name, code, reason, isReconnectable\nEmitted when a Lavalink Node becomes Ready from a Reconnection or First Connection.

","kind":"event","name":"ready","params":[{"type":{"names":["string"]},"description":"

The name of the Lavalink Node that sent a ready event.

","name":"name"},{"type":{"names":["boolean"]},"description":"

True if the session reconnected, otherwise false.

","name":"reconnect"}],"memberof":"Shoukaku","longname":"Shoukaku#event:ready","scope":"instance","$longname":"Shoukaku#event:ready","$kind":"event","$docmaLink":"?api#Shoukaku#event:ready"}],"$constructor":{"comment":"/**\r\n * @param {external:Client} client Your Discord.js client\r\n * @param {ShoukakuConstants#ShoukakuNodes} nodes Lavalink Nodes where Shoukaku will try to connect to.\r\n * @param {ShoukakuConstants#ShoukakuOptions} options Options to initialize Shoukaku with\r\n */","meta":{"range":[1333,2873],"filename":"Shoukaku.js","lineno":44,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src","code":{"id":"astnode100000062","name":"Shoukaku","type":"MethodDefinition","paramnames":["client","nodes","options"]},"vars":{"":null}},"params":[{"type":{"names":["external:Client"]},"description":"

Your Discord.js client

","name":"client"},{"type":{"names":["ShoukakuConstants#ShoukakuNodes"]},"description":"

Lavalink Nodes where Shoukaku will try to connect to.

","name":"nodes"},{"type":{"names":["ShoukakuConstants#ShoukakuOptions"]},"description":"

Options to initialize Shoukaku with

","name":"options"}],"name":"Shoukaku","longname":"Shoukaku","kind":"class","scope":"global","$longname":"Shoukaku","$kind":"constructor","$docmaLink":"?api#Shoukaku"}},{"comment":"/**\n * Constants for Shoukaku.\n * @class ShoukakuConstants\n */","meta":{"filename":"ShoukakuConstants.js","lineno":1,"columnno":0,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

Constants for Shoukaku.

","kind":"class","name":"ShoukakuConstants","longname":"ShoukakuConstants","scope":"global","$longname":"ShoukakuConstants","$kind":"class","$docmaLink":"?api#ShoukakuConstants","$members":[{"comment":"/**\n * Available Status for Node / Link managers.\n * @typedef {string} ShoukakuStatus\n * @enum {ShoukakuStatus}\n * @memberof ShoukakuConstants#\n */","meta":{"filename":"ShoukakuConstants.js","lineno":6,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

Available Status for Node / Link managers.

","kind":"typedef","name":"ShoukakuStatus","type":{"names":["string"]},"isEnum":true,"memberof":"ShoukakuConstants","longname":"ShoukakuConstants#ShoukakuStatus","scope":"instance","$longname":"ShoukakuConstants#ShoukakuStatus","$kind":"enum","$docmaLink":"?api#ShoukakuConstants#ShoukakuStatus"},{"comment":"/**\n * Required Object in Shoukaku's join method.\n * @typedef {Object} ShoukakuJoinOptions\n * @property {string} guildID Guild ID of the Voice Channel you want to join to.\n * @property {string} voiceChannelID Voice Channel ID of the Voice Channel you want to join to.\n * @property {boolean} [mute=false] Whether to mute the client.\n * @property {boolean} [deaf=false] Whether to deafen the client.\n * @memberof ShoukakuConstants#\n */","meta":{"filename":"ShoukakuConstants.js","lineno":49,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

Required Object in Shoukaku's join method.

","kind":"typedef","name":"ShoukakuJoinOptions","type":{"names":["Object"]},"properties":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"

Whether to deafen the client.

","name":"deaf"},{"type":{"names":["string"]},"description":"

Guild ID of the Voice Channel you want to join to.

","name":"guildID"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":false,"description":"

Whether to mute the client.

","name":"mute"},{"type":{"names":["string"]},"description":"

Voice Channel ID of the Voice Channel you want to join to.

","name":"voiceChannelID"}],"memberof":"ShoukakuConstants","longname":"ShoukakuConstants#ShoukakuJoinOptions","scope":"instance","$longname":"ShoukakuConstants#ShoukakuJoinOptions","$kind":"typedef","$docmaLink":"?api#ShoukakuConstants#ShoukakuJoinOptions"},{"comment":"/**\n * Options that Shoukaku needs to initialize a lavalink node.\n * @typedef {Object} ShoukakuNodeOptions\n * @property {string} [name] Your Node Name, anything you want to name your node.\n * @property {string} [host] Your node host / ip address of where the lavalink is hosted.\n * @property {number} [port] The Port Number of your lavalink instance.\n * @property {string} [auth] The authentication key you set on your lavalink config.\n * @memberof ShoukakuConstants#\n */","meta":{"filename":"ShoukakuConstants.js","lineno":100,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

Options that Shoukaku needs to initialize a lavalink node.

","kind":"typedef","name":"ShoukakuNodeOptions","type":{"names":["Object"]},"properties":[{"type":{"names":["string"]},"optional":true,"description":"

The authentication key you set on your lavalink config.

","name":"auth"},{"type":{"names":["string"]},"optional":true,"description":"

Your node host / ip address of where the lavalink is hosted.

","name":"host"},{"type":{"names":["string"]},"optional":true,"description":"

Your Node Name, anything you want to name your node.

","name":"name"},{"type":{"names":["number"]},"optional":true,"description":"

The Port Number of your lavalink instance.

","name":"port"}],"memberof":"ShoukakuConstants","longname":"ShoukakuConstants#ShoukakuNodeOptions","scope":"instance","$longname":"ShoukakuConstants#ShoukakuNodeOptions","$kind":"typedef","$docmaLink":"?api#ShoukakuConstants#ShoukakuNodeOptions"},{"comment":"/**\n * An array of ShoukakuNodeOptions\n * @typedef {Array} ShoukakuNodes\n * @memberof ShoukakuConstants#\n */","meta":{"filename":"ShoukakuConstants.js","lineno":117,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

An array of ShoukakuNodeOptions

","kind":"typedef","name":"ShoukakuNodes","type":{"names":["Array."]},"memberof":"ShoukakuConstants","longname":"ShoukakuConstants#ShoukakuNodes","scope":"instance","$longname":"ShoukakuConstants#ShoukakuNodes","$kind":"typedef","$docmaLink":"?api#ShoukakuConstants#ShoukakuNodes"},{"comment":"/**\n * Shoukaku's Node Stats Object.\n * @typedef {Object} ShoukakuNodeStats\n * @memberof ShoukakuConstants#\n */","meta":{"filename":"ShoukakuConstants.js","lineno":20,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

Shoukaku's Node Stats Object.

","kind":"typedef","name":"ShoukakuNodeStats","type":{"names":["Object"]},"memberof":"ShoukakuConstants","longname":"ShoukakuConstants#ShoukakuNodeStats","scope":"instance","$longname":"ShoukakuConstants#ShoukakuNodeStats","$kind":"typedef","$docmaLink":"?api#ShoukakuConstants#ShoukakuNodeStats"},{"comment":"/**\n * Options that Shoukaku accepts upon initialization.\n * @typedef {Object} ShoukakuOptions\n * @property {boolean|string} [resumable=false] If you want your node to support resuming. Just replace the false with the resume-key you want to enable resuming.\n * @property {number} [resumableTimeout=30] Timeout when Lavalink will decide a player isn't resumed and will destroy the connection to it.\n * @property {number} [reconnectTries=2] Amount of tries to connect to the lavalink Node before it decides that the node is unreconnectable.\n * @property {number} [moveOnDisconnect=false] Specifies if the library will attempt to reconnect players on a disconnected node to another node.\n * @property {number} [restTimeout=10000] Timeout on rest requests to your lavalink node.\n * @memberof ShoukakuConstants#\n */","meta":{"filename":"ShoukakuConstants.js","lineno":81,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

Options that Shoukaku accepts upon initialization.

","kind":"typedef","name":"ShoukakuOptions","type":{"names":["Object"]},"properties":[{"type":{"names":["number"]},"optional":true,"defaultvalue":false,"description":"

Specifies if the library will attempt to reconnect players on a disconnected node to another node.

","name":"moveOnDisconnect"},{"type":{"names":["number"]},"optional":true,"defaultvalue":2,"description":"

Amount of tries to connect to the lavalink Node before it decides that the node is unreconnectable.

","name":"reconnectTries"},{"type":{"names":["number"]},"optional":true,"defaultvalue":10000,"description":"

Timeout on rest requests to your lavalink node.

","name":"restTimeout"},{"type":{"names":["boolean","string"]},"optional":true,"defaultvalue":false,"description":"

If you want your node to support resuming. Just replace the false with the resume-key you want to enable resuming.

","name":"resumable"},{"type":{"names":["number"]},"optional":true,"defaultvalue":30,"description":"

Timeout when Lavalink will decide a player isn't resumed and will destroy the connection to it.

","name":"resumableTimeout"}],"memberof":"ShoukakuConstants","longname":"ShoukakuConstants#ShoukakuOptions","scope":"instance","$longname":"ShoukakuConstants#ShoukakuOptions","$kind":"typedef","$docmaLink":"?api#ShoukakuConstants#ShoukakuOptions"},{"comment":"/**\n * Required Object in Shoukaku's join method.\n * @typedef {Object} ShoukakuPlayOptions\n * @property {boolean} [noReplace=true] Specifies if the player will not replace the current track when executing this action.\n * @property {boolean|number} [startTime=false] In milliseconds on when to start.\n * @property {boolean|number} [endTime=false] In milliseconds on when to end.\n * @memberof ShoukakuConstants#\n */","meta":{"filename":"ShoukakuConstants.js","lineno":66,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

Required Object in Shoukaku's join method.

","kind":"typedef","name":"ShoukakuPlayOptions","type":{"names":["Object"]},"properties":[{"type":{"names":["boolean","number"]},"optional":true,"defaultvalue":false,"description":"

In milliseconds on when to end.

","name":"endTime"},{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"

Specifies if the player will not replace the current track when executing this action.

","name":"noReplace"},{"type":{"names":["boolean","number"]},"optional":true,"defaultvalue":false,"description":"

In milliseconds on when to start.

","name":"startTime"}],"memberof":"ShoukakuConstants","longname":"ShoukakuConstants#ShoukakuPlayOptions","scope":"instance","$longname":"ShoukakuConstants#ShoukakuPlayOptions","$kind":"typedef","$docmaLink":"?api#ShoukakuConstants#ShoukakuPlayOptions"}]},{"comment":"/**\n * ShoukakuError. Extended Error class.\n * @class ShoukakuError\n * @extends {Error}\n */","meta":{"filename":"ShoukakuError.js","lineno":1,"columnno":0,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

ShoukakuError. Extended Error class.

","kind":"class","name":"ShoukakuError","augments":["Error"],"longname":"ShoukakuError","scope":"global","$longname":"ShoukakuError","$kind":"class","$docmaLink":"?api#ShoukakuError","$constructor":{"comment":"/**\n * @param message The Error Message\n */","meta":{"range":[192,281],"filename":"ShoukakuError.js","lineno":10,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{"id":"astnode100000955","name":"ShoukakuError","type":"MethodDefinition","paramnames":["message"]},"vars":{"":null}},"params":[{"description":"

The Error Message

","name":"message"}],"name":"ShoukakuError","longname":"ShoukakuError","kind":"class","scope":"global","$longname":"ShoukakuError","$kind":"constructor","$docmaLink":"?api#ShoukakuError"}},{"comment":"/**\r\n * ShoukakuLink, contains data about the voice connection on the guild.\r\n * @class ShoukakuLink\r\n */","meta":{"filename":"ShoukakuLink.js","lineno":4,"columnno":0,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

ShoukakuLink, contains data about the voice connection on the guild.

","kind":"class","name":"ShoukakuLink","longname":"ShoukakuLink","scope":"global","$longname":"ShoukakuLink","$kind":"class","$docmaLink":"?api#ShoukakuLink","$members":[{"comment":"/**\r\n * Attempts to reconnect this connection.\r\n * @memberOf ShoukakuLink\r\n * @returns {Promise}\r\n */","meta":{"range":[3509,4301],"filename":"ShoukakuLink.js","lineno":103,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001310","name":"ShoukakuLink#attemptReconnect","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"

Attempts to reconnect this connection.

","memberof":"ShoukakuLink","returns":[{"type":{"names":["Promise."]}}],"name":"attemptReconnect","longname":"ShoukakuLink#attemptReconnect","kind":"function","scope":"instance","params":[],"$longname":"ShoukakuLink#attemptReconnect","$kind":"method","$docmaLink":"?api#ShoukakuLink#attemptReconnect"},{"comment":"/**\r\n * The ID of the guild that is being governed by this Link.\r\n * @type {string}\r\n */","meta":{"range":[924,947],"filename":"ShoukakuLink.js","lineno":29,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001042","name":"this.guildID","type":"MemberExpression","value":"guild.id","paramnames":[]}},"description":"

The ID of the guild that is being governed by this Link.

","type":{"names":["string"]},"name":"guildID","longname":"ShoukakuLink#guildID","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#guildID","$kind":"property","$docmaLink":"?api#ShoukakuLink#guildID"},{"comment":"/**\r\n * The node that governs this Link\r\n * @type {ShoukakuSocket}\r\n */","meta":{"range":[640,656],"filename":"ShoukakuLink.js","lineno":19,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001030","name":"this.node","type":"Identifier","value":"node","paramnames":[]}},"description":"

The node that governs this Link

","type":{"names":["ShoukakuSocket"]},"name":"node","longname":"ShoukakuLink#node","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#node","$kind":"property","$docmaLink":"?api#ShoukakuLink#node"},{"comment":"/**\r\n * The player class of this link.\r\n * @type {ShoukakuPlayer}\r\n */","meta":{"range":[771,791],"filename":"ShoukakuLink.js","lineno":24,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001036","name":"this.player","type":"Identifier","value":"player","paramnames":[]}},"description":"

The player class of this link.

","type":{"names":["ShoukakuPlayer"]},"name":"player","longname":"ShoukakuLink#player","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#player","$kind":"property","$docmaLink":"?api#ShoukakuLink#player"},{"comment":"/**\r\n * If the client user is self defeaned.\r\n * @type {boolean}\r\n */","meta":{"range":[1799,1820],"filename":"ShoukakuLink.js","lineno":59,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001088","name":"this.selfDeaf","type":"Literal","value":false,"paramnames":[]}},"description":"

If the client user is self defeaned.

","type":{"names":["boolean"]},"name":"selfDeaf","longname":"ShoukakuLink#selfDeaf","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#selfDeaf","$kind":"property","$docmaLink":"?api#ShoukakuLink#selfDeaf"},{"comment":"/**\r\n * If the client user is self muted.\r\n * @type {boolean}\r\n */","meta":{"range":[1664,1685],"filename":"ShoukakuLink.js","lineno":54,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001082","name":"this.selfMute","type":"Literal","value":false,"paramnames":[]}},"description":"

If the client user is self muted.

","type":{"names":["boolean"]},"name":"selfMute","longname":"ShoukakuLink#selfMute","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#selfMute","$kind":"property","$docmaLink":"?api#ShoukakuLink#selfMute"},{"comment":"/**\r\n * The sessionID of this Link\r\n * @type {?string}\r\n */","meta":{"range":[1364,1385],"filename":"ShoukakuLink.js","lineno":44,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001070","name":"this.sessionID","type":"Literal","value":null,"paramnames":[]}},"description":"

The sessionID of this Link

","type":{"names":["string"]},"nullable":true,"name":"sessionID","longname":"ShoukakuLink#sessionID","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#sessionID","$kind":"property","$docmaLink":"?api#ShoukakuLink#sessionID"},{"comment":"/**\r\n * The ID of the shard where this guild is in\r\n * @type {number}\r\n */","meta":{"range":[1066,1094],"filename":"ShoukakuLink.js","lineno":34,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001050","name":"this.shardID","type":"MemberExpression","value":"guild.shardID","paramnames":[]}},"description":"

The ID of the shard where this guild is in

","type":{"names":["number"]},"name":"shardID","longname":"ShoukakuLink#shardID","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#shardID","$kind":"property","$docmaLink":"?api#ShoukakuLink#shardID"},{"comment":"/**\r\n * The current state of this link.\r\n * @type {ShoukakuConstants#ShoukakuStatus}\r\n */","meta":{"range":[1954,1994],"filename":"ShoukakuLink.js","lineno":64,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001094","name":"this.state","type":"MemberExpression","value":"ShoukakuStatus.DISCONNECTED","paramnames":[]}},"description":"

The current state of this link.

","type":{"names":["ShoukakuConstants#ShoukakuStatus"]},"name":"state","longname":"ShoukakuLink#state","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#state","$kind":"property","$docmaLink":"?api#ShoukakuLink#state"},{"comment":"/**\r\n * The ID of the user that is being governed by this Link\r\n * @type {string}\r\n */","meta":{"range":[1225,1260],"filename":"ShoukakuLink.js","lineno":39,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001058","name":"this.userID","type":"MemberExpression","value":"this.node.shoukaku.id","paramnames":[]}},"description":"

The ID of the user that is being governed by this Link

","type":{"names":["string"]},"name":"userID","longname":"ShoukakuLink#userID","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#userID","$kind":"property","$docmaLink":"?api#ShoukakuLink#userID"},{"comment":"/**\r\n * The ID of the voice channel that is being governed by this link.\r\n * @type {?string}\r\n */","meta":{"range":[1527,1553],"filename":"ShoukakuLink.js","lineno":49,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001076","name":"this.voiceChannelID","type":"Literal","value":null,"paramnames":[]}},"description":"

The ID of the voice channel that is being governed by this link.

","type":{"names":["string"]},"nullable":true,"name":"voiceChannelID","longname":"ShoukakuLink#voiceChannelID","kind":"member","memberof":"ShoukakuLink","scope":"instance","$longname":"ShoukakuLink#voiceChannelID","$kind":"property","$docmaLink":"?api#ShoukakuLink#voiceChannelID"}],"$constructor":{"comment":"/**\r\n * @param {ShoukakuSocket} node The node that governs this link.\r\n * @param {ShoukakuPlayer} player The player of this link.\r\n * @param {external:Guild} guild A Discord.js Guild Object.\r\n */","meta":{"range":[491,2262],"filename":"ShoukakuLink.js","lineno":14,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001022","name":"ShoukakuLink","type":"MethodDefinition","paramnames":["node","player","guild"]},"vars":{"":null}},"params":[{"type":{"names":["ShoukakuSocket"]},"description":"

The node that governs this link.

","name":"node"},{"type":{"names":["ShoukakuPlayer"]},"description":"

The player of this link.

","name":"player"},{"type":{"names":["external:Guild"]},"description":"

A Discord.js Guild Object.

","name":"guild"}],"name":"ShoukakuLink","longname":"ShoukakuLink","kind":"class","scope":"global","$longname":"ShoukakuLink","$kind":"constructor","$docmaLink":"?api#ShoukakuLink"}},{"comment":"/**\r\n * ShoukakuPlayer, used to control the player on the guildused to control the player on the guild.\r\n * @class ShoukakuPlayer\r\n * @extends {external:EventEmitter}\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":8,"columnno":0,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

ShoukakuPlayer, used to control the player on the guildused to control the player on the guild.

","kind":"class","name":"ShoukakuPlayer","augments":["external:EventEmitter"],"longname":"ShoukakuPlayer","scope":"global","$longname":"ShoukakuPlayer","$kind":"class","$docmaLink":"?api#ShoukakuPlayer","$members":[{"comment":"/**\r\n * Eventually Connects the Bot to the voice channel in the guild. This is used internally and must not be used to connect players. Use `.joinVoiceChannel()` instead.\r\n * @memberOf ShoukakuPlayer\r\n * @returns {void}\r\n */","meta":{"range":[4183,4277],"filename":"ShoukakuPlayer.js","lineno":122,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001899","name":"ShoukakuPlayer#connect","type":"MethodDefinition","paramnames":["options","callback"]},"vars":{"":null}},"description":"

Eventually Connects the Bot to the voice channel in the guild. This is used internally and must not be used to connect players. Use <ShoukakuSocket>.joinVoiceChannel() instead.

","memberof":"ShoukakuPlayer","returns":[{"type":{"names":["void"]}}],"name":"connect","longname":"ShoukakuPlayer#connect","kind":"function","scope":"instance","params":[],"$longname":"ShoukakuPlayer#connect","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#connect"},{"comment":"/**\r\n * Eventually Disconnects the VoiceConnection & Removes the player from a Guild. Could be also used to clean up player remnants from unexpected events.\r\n * @memberOf ShoukakuPlayer\r\n * @returns {void}\r\n */","meta":{"range":[4515,4581],"filename":"ShoukakuPlayer.js","lineno":130,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001914","name":"ShoukakuPlayer#disconnect","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"

Eventually Disconnects the VoiceConnection & Removes the player from a Guild. Could be also used to clean up player remnants from unexpected events.

","memberof":"ShoukakuPlayer","returns":[{"type":{"names":["void"]}}],"name":"disconnect","longname":"ShoukakuPlayer#disconnect","kind":"function","scope":"instance","params":[],"$longname":"ShoukakuPlayer#disconnect","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#disconnect"},{"comment":"/**\r\n * Moves this Player & VoiceConnection to another lavalink node you specified.\r\n * @param {string} name Name of the Node you want to move to.\r\n * @memberOf ShoukakuPlayer\r\n * @returns {Promise}\r\n */","meta":{"range":[4822,5176],"filename":"ShoukakuPlayer.js","lineno":139,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001925","name":"ShoukakuPlayer#moveToNode","type":"MethodDefinition","paramnames":["name"]},"vars":{"":null}},"description":"

Moves this Player & VoiceConnection to another lavalink node you specified.

","params":[{"type":{"names":["string"]},"description":"

Name of the Node you want to move to.

","name":"name"}],"memberof":"ShoukakuPlayer","returns":[{"type":{"names":["Promise."]}}],"name":"moveToNode","longname":"ShoukakuPlayer#moveToNode","kind":"function","scope":"instance","async":true,"$longname":"ShoukakuPlayer#moveToNode","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#moveToNode"},{"comment":"/**\r\n * Plays the track you specifed. Warning: If the player is playing anything, calling this will just ignore your call. Call `ShoukakuPlayer.StopTrack()` first.\r\n * @param {string} track The Base64 encoded track you got from lavalink API.\r\n * @param {ShoukakuConstants#ShoukakuPlayOptions} [options=ShoukakuPlayOptions] Used if you want to put a custom track start or end time.\r\n * @memberOf ShoukakuPlayer\r\n * @returns {Promise} true if successful false if not.\r\n */","meta":{"range":[5691,6645],"filename":"ShoukakuPlayer.js","lineno":153,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001983","name":"ShoukakuPlayer#playTrack","type":"MethodDefinition","paramnames":["track","options"]},"vars":{"":null}},"description":"

Plays the track you specifed. Warning: If the player is playing anything, calling this will just ignore your call. Call ShoukakuPlayer.StopTrack() first.

","params":[{"type":{"names":["string"]},"description":"

The Base64 encoded track you got from lavalink API.

","name":"track"},{"type":{"names":["ShoukakuConstants#ShoukakuPlayOptions"]},"optional":true,"defaultvalue":"ShoukakuPlayOptions","description":"

Used if you want to put a custom track start or end time.

","name":"options"}],"memberof":"ShoukakuPlayer","returns":[{"type":{"names":["Promise."]},"description":"

true if successful false if not.

"}],"name":"playTrack","longname":"ShoukakuPlayer#playTrack","kind":"function","scope":"instance","async":true,"$longname":"ShoukakuPlayer#playTrack","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#playTrack"},{"comment":"/**\r\n * Seeks your player to the time you want\r\n * @param {number} position position in MS you want to seek to.\r\n * @memberOf ShoukakuPlayer\r\n * @returns {Promise} true if successful false if not.\r\n */","meta":{"range":[9073,9324],"filename":"ShoukakuPlayer.js","lineno":237,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100002330","name":"ShoukakuPlayer#seekTo","type":"MethodDefinition","paramnames":["position"]},"vars":{"":null}},"description":"

Seeks your player to the time you want

","params":[{"type":{"names":["number"]},"description":"

position in MS you want to seek to.

","name":"position"}],"memberof":"ShoukakuPlayer","returns":[{"type":{"names":["Promise."]},"description":"

true if successful false if not.

"}],"name":"seekTo","longname":"ShoukakuPlayer#seekTo","kind":"function","scope":"instance","async":true,"$longname":"ShoukakuPlayer#seekTo","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#seekTo"},{"comment":"/**\r\n * Sets the equalizer of your lavalink player\r\n * @param {Array} bands An array of Lavalink bands.\r\n * @memberOf ShoukakuPlayer\r\n * @returns {Promise} true if successful false if not.\r\n */","meta":{"range":[7843,8207],"filename":"ShoukakuPlayer.js","lineno":203,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100002211","name":"ShoukakuPlayer#setEqualizer","type":"MethodDefinition","paramnames":["bands"]},"vars":{"":null}},"description":"

Sets the equalizer of your lavalink player

","params":[{"type":{"names":["Array"]},"description":"

An array of Lavalink bands.

","name":"bands"}],"memberof":"ShoukakuPlayer","returns":[{"type":{"names":["Promise."]},"description":"

true if successful false if not.

"}],"name":"setEqualizer","longname":"ShoukakuPlayer#setEqualizer","kind":"function","scope":"instance","async":true,"$longname":"ShoukakuPlayer#setEqualizer","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#setEqualizer"},{"comment":"/**\r\n * Pauses / Unpauses the player\r\n * @param {boolean} [pause=true] true to pause, false to unpause\r\n * @memberOf ShoukakuPlayer\r\n * @returns {Promise} true if successful false if not.\r\n */","meta":{"range":[7284,7609],"filename":"ShoukakuPlayer.js","lineno":187,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100002161","name":"ShoukakuPlayer#setPaused","type":"MethodDefinition","paramnames":["pause"]},"vars":{"":null}},"description":"

Pauses / Unpauses the player

","params":[{"type":{"names":["boolean"]},"optional":true,"defaultvalue":true,"description":"

true to pause, false to unpause

","name":"pause"}],"memberof":"ShoukakuPlayer","returns":[{"type":{"names":["Promise."]},"description":"

true if successful false if not.

"}],"name":"setPaused","longname":"ShoukakuPlayer#setPaused","kind":"function","scope":"instance","async":true,"$longname":"ShoukakuPlayer#setPaused","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#setPaused"},{"comment":"/**\r\n * Sets the playback volume of your lavalink player\r\n * @param {number} volume The new volume you want to set on the player.\r\n * @memberOf ShoukakuPlayer\r\n * @returns {Promise} true if successful false if not.\r\n */","meta":{"range":[8467,8831],"filename":"ShoukakuPlayer.js","lineno":220,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100002271","name":"ShoukakuPlayer#setVolume","type":"MethodDefinition","paramnames":["volume"]},"vars":{"":null}},"description":"

Sets the playback volume of your lavalink player

","params":[{"type":{"names":["number"]},"description":"

The new volume you want to set on the player.

","name":"volume"}],"memberof":"ShoukakuPlayer","returns":[{"type":{"names":["Promise."]},"description":"

true if successful false if not.

"}],"name":"setVolume","longname":"ShoukakuPlayer#setVolume","kind":"function","scope":"instance","async":true,"$longname":"ShoukakuPlayer#setVolume","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#setVolume"},{"comment":"/**\r\n * Stops the player from playing.\r\n * @memberOf ShoukakuPlayer\r\n * @returns {Promise} true if successful false if not.\r\n */","meta":{"range":[6810,7051],"filename":"ShoukakuPlayer.js","lineno":172,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100002124","name":"ShoukakuPlayer#stopTrack","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"

Stops the player from playing.

","memberof":"ShoukakuPlayer","returns":[{"type":{"names":["Promise."]},"description":"

true if successful false if not.

"}],"name":"stopTrack","longname":"ShoukakuPlayer#stopTrack","kind":"function","scope":"instance","params":[],"async":true,"$longname":"ShoukakuPlayer#stopTrack","$kind":"method","$docmaLink":"?api#ShoukakuPlayer#stopTrack"},{"comment":"/**\r\n * The current equalizer bands set in this player.\r\n * @type {Array}\r\n */","meta":{"range":[1521,1536],"filename":"ShoukakuPlayer.js","lineno":44,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001888","name":"this.bands","type":"ArrayExpression","value":"[]","paramnames":[]}},"description":"

The current equalizer bands set in this player.

","type":{"names":["Array"]},"name":"bands","longname":"ShoukakuPlayer#bands","kind":"member","memberof":"ShoukakuPlayer","scope":"instance","$longname":"ShoukakuPlayer#bands","$kind":"property","$docmaLink":"?api#ShoukakuPlayer#bands"},{"comment":"/**\r\n * If this player is currently paused.\r\n * @type {boolean}\r\n */","meta":{"range":[1252,1271],"filename":"ShoukakuPlayer.js","lineno":34,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001876","name":"this.paused","type":"Literal","value":false,"paramnames":[]}},"description":"

If this player is currently paused.

","type":{"names":["boolean"]},"name":"paused","longname":"ShoukakuPlayer#paused","kind":"member","memberof":"ShoukakuPlayer","scope":"instance","$longname":"ShoukakuPlayer#paused","$kind":"property","$docmaLink":"?api#ShoukakuPlayer#paused"},{"comment":"/**\r\n * The current postion in ms of this player\r\n * @type {number}\r\n */","meta":{"range":[1653,1670],"filename":"ShoukakuPlayer.js","lineno":49,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001894","name":"this.position","type":"Literal","value":0,"paramnames":[]}},"description":"

The current postion in ms of this player

","type":{"names":["number"]},"name":"position","longname":"ShoukakuPlayer#position","kind":"member","memberof":"ShoukakuPlayer","scope":"instance","$longname":"ShoukakuPlayer#position","$kind":"property","$docmaLink":"?api#ShoukakuPlayer#position"},{"comment":"/**\r\n * The Track that is currently being played by this player.\r\n * @type {?string}\r\n */","meta":{"range":[1122,1139],"filename":"ShoukakuPlayer.js","lineno":29,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001870","name":"this.track","type":"Literal","value":null,"paramnames":[]}},"description":"

The Track that is currently being played by this player.

","type":{"names":["string"]},"nullable":true,"name":"track","longname":"ShoukakuPlayer#track","kind":"member","memberof":"ShoukakuPlayer","scope":"instance","$longname":"ShoukakuPlayer#track","$kind":"property","$docmaLink":"?api#ShoukakuPlayer#track"},{"comment":"/**\r\n * The Voice Connection of this Player.\r\n * @type {ShoukakuLink}\r\n */","meta":{"range":[930,988],"filename":"ShoukakuPlayer.js","lineno":24,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001860","name":"this.voiceConnection","type":"NewExpression","value":"","paramnames":[]}},"description":"

The Voice Connection of this Player.

","type":{"names":["ShoukakuLink"]},"name":"voiceConnection","longname":"ShoukakuPlayer#voiceConnection","kind":"member","memberof":"ShoukakuPlayer","scope":"instance","$longname":"ShoukakuPlayer#voiceConnection","$kind":"property","$docmaLink":"?api#ShoukakuPlayer#voiceConnection"},{"comment":"/**\r\n * The current volume of this player\r\n * @type {number}\r\n */","meta":{"range":[1381,1398],"filename":"ShoukakuPlayer.js","lineno":39,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001882","name":"this.volume","type":"Literal","value":100,"paramnames":[]}},"description":"

The current volume of this player

","type":{"names":["number"]},"name":"volume","longname":"ShoukakuPlayer#volume","kind":"member","memberof":"ShoukakuPlayer","scope":"instance","$longname":"ShoukakuPlayer#volume","$kind":"property","$docmaLink":"?api#ShoukakuPlayer#volume"},{"comment":"/**\r\n * Emitted when the voiceConnection got closed.\r\n * @event ShoukakuPlayer#closed\r\n * @param {Object} reason\r\n * @memberOf ShoukakuPlayer\r\n * @example\r\n * // is your ShoukakuPlayer instance\r\n * .on('closed', (reason) => {\r\n * .disconnect();\r\n * })\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":58,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

Emitted when the voiceConnection got closed.

","kind":"event","name":"closed","params":[{"type":{"names":["Object"]},"name":"reason"}],"memberof":"ShoukakuPlayer","examples":["// is your ShoukakuPlayer instance\r.on('closed', (reason) => {\r .disconnect();\r})"],"longname":"ShoukakuPlayer#event:closed","scope":"instance","$longname":"ShoukakuPlayer#event:closed","$kind":"event","$docmaLink":"?api#ShoukakuPlayer#event:closed"},{"comment":"/**\r\n * Emitted when the Lavalink Player emits a TrackEnd or TrackStuck event.\r\n * @event ShoukakuPlayer#end\r\n * @param {Object} reason\r\n * @memberOf ShoukakuPlayer\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":52,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

Emitted when the Lavalink Player emits a TrackEnd or TrackStuck event.

","kind":"event","name":"end","params":[{"type":{"names":["Object"]},"name":"reason"}],"memberof":"ShoukakuPlayer","longname":"ShoukakuPlayer#event:end","scope":"instance","$longname":"ShoukakuPlayer#event:end","$kind":"event","$docmaLink":"?api#ShoukakuPlayer#event:end"},{"comment":"/**\r\n * Emitted when this library encounters an error in ShoukakuPlayer or ShoukakuLink class. MUST BE HANDLED.\r\n * @event ShoukakuPlayer#error\r\n * @param {Error} error The error encountered.\r\n * @memberOf ShoukakuPlayer\r\n * @example\r\n * // is your ShoukakuPlayer instance\r\n * .on('error', (error) => {\r\n * console.error(error);\r\n * .disconnect();\r\n * })\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":69,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

Emitted when this library encounters an error in ShoukakuPlayer or ShoukakuLink class. MUST BE HANDLED.

","kind":"event","name":"error","params":[{"type":{"names":["Error"]},"description":"

The error encountered.

","name":"error"}],"memberof":"ShoukakuPlayer","examples":["// is your ShoukakuPlayer instance\r.on('error', (error) => {\r console.error(error);\r .disconnect();\r})"],"longname":"ShoukakuPlayer#event:error","scope":"instance","$longname":"ShoukakuPlayer#event:error","$kind":"event","$docmaLink":"?api#ShoukakuPlayer#event:error"},{"comment":"/**\r\n * Emitted when this player's node was disconnected. MUST BE HANDLED.\r\n * @event ShoukakuPlayer#nodeDisconnect\r\n * @param {string} name The name of the node that disconnected.\r\n * @memberOf ShoukakuPlayer\r\n * @example\r\n * // is your ShoukakuPlayer instance\r\n * .on('nodeDisconnect', (name) => {\r\n * console.log(`Node ${name} which governs this player disconnected.`);\r\n * .disconnect();\r\n * })\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":81,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

Emitted when this player's node was disconnected. MUST BE HANDLED.

","kind":"event","name":"nodeDisconnect","params":[{"type":{"names":["string"]},"description":"

The name of the node that disconnected.

","name":"name"}],"memberof":"ShoukakuPlayer","examples":["// is your ShoukakuPlayer instance\r.on('nodeDisconnect', (name) => {\r console.log(`Node ${name} which governs this player disconnected.`);\r .disconnect();\r})"],"longname":"ShoukakuPlayer#event:nodeDisconnect","scope":"instance","$longname":"ShoukakuPlayer#event:nodeDisconnect","$kind":"event","$docmaLink":"?api#ShoukakuPlayer#event:nodeDisconnect"},{"comment":"/**\r\n * Emitted when Lavalink gives a Player Update event. Optional.\r\n * @event ShoukakuPlayer#playerUpdate\r\n * @param {Object} data\r\n * @memberOf ShoukakuPlayer\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":110,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

Emitted when Lavalink gives a Player Update event. Optional.

","kind":"event","name":"playerUpdate","params":[{"type":{"names":["Object"]},"name":"data"}],"memberof":"ShoukakuPlayer","longname":"ShoukakuPlayer#event:playerUpdate","scope":"instance","$longname":"ShoukakuPlayer#event:playerUpdate","$kind":"event","$docmaLink":"?api#ShoukakuPlayer#event:playerUpdate"},{"comment":"/**\r\n * Emitted when the Shoukaku Player resumes the session by resending the playing data. Optional.\r\n * @event ShoukakuPlayer#resumed\r\n * @memberOf ShoukakuPlayer\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":105,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

Emitted when the Shoukaku Player resumes the session by resending the playing data. Optional.

","kind":"event","name":"resumed","memberof":"ShoukakuPlayer","longname":"ShoukakuPlayer#event:resumed","scope":"instance","$longname":"ShoukakuPlayer#event:resumed","$kind":"event","$docmaLink":"?api#ShoukakuPlayer#event:resumed"},{"comment":"/**\r\n * Emitted when the Lavalink Player emits a TrackStartEvent event. Optional.\r\n * @event ShoukakuPlayer#start\r\n * @param {Object} data\r\n * @memberOf ShoukakuPlayer\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":93,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

Emitted when the Lavalink Player emits a TrackStartEvent event. Optional.

","kind":"event","name":"start","params":[{"type":{"names":["Object"]},"name":"data"}],"memberof":"ShoukakuPlayer","longname":"ShoukakuPlayer#event:start","scope":"instance","$longname":"ShoukakuPlayer#event:start","$kind":"event","$docmaLink":"?api#ShoukakuPlayer#event:start"},{"comment":"/**\r\n * Emitted when Lavalink encounters an error on playing the song. Optional.\r\n * @event ShoukakuPlayer#trackException\r\n * @param {Object} reason\r\n * @memberOf ShoukakuPlayer\r\n */","meta":{"filename":"ShoukakuPlayer.js","lineno":99,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{}},"description":"

Emitted when Lavalink encounters an error on playing the song. Optional.

","kind":"event","name":"trackException","params":[{"type":{"names":["Object"]},"name":"reason"}],"memberof":"ShoukakuPlayer","longname":"ShoukakuPlayer#event:trackException","scope":"instance","$longname":"ShoukakuPlayer#event:trackException","$kind":"event","$docmaLink":"?api#ShoukakuPlayer#event:trackException"}],"$constructor":{"comment":"/**\r\n * @param {ShoukakuSocket} node The node that governs this player.\r\n * @param {external:Guild} guild A Discord.JS Guild Object.\r\n */","meta":{"range":[768,1678],"filename":"ShoukakuPlayer.js","lineno":18,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\guild","code":{"id":"astnode100001850","name":"ShoukakuPlayer","type":"MethodDefinition","paramnames":["node","guild"]},"vars":{"":null}},"params":[{"type":{"names":["ShoukakuSocket"]},"description":"

The node that governs this player.

","name":"node"},{"type":{"names":["external:Guild"]},"description":"

A Discord.JS Guild Object.

","name":"guild"}],"name":"ShoukakuPlayer","longname":"ShoukakuPlayer","kind":"class","scope":"global","$longname":"ShoukakuPlayer","$kind":"constructor","$docmaLink":"?api#ShoukakuPlayer"}},{"comment":"/**\n * ShoukakuRest, provides access to Lavalink REST API.\n * @class ShoukakuRest\n */","meta":{"filename":"ShoukakuRest.js","lineno":10,"columnno":0,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{}},"description":"

ShoukakuRest, provides access to Lavalink REST API.

","kind":"class","name":"ShoukakuRest","longname":"ShoukakuRest","scope":"global","$longname":"ShoukakuRest","$kind":"class","$docmaLink":"?api#ShoukakuRest","$members":[{"comment":"/**\n * Decodes the given base64 encoded track from lavalink.\n * @param {base64} track Base64 Encoded Track you got from the Lavalink API.\n * @memberof ShoukakuRest\n * @returns {Promise} The Lavalink Track details.\n */","meta":{"range":[2655,2849],"filename":"ShoukakuRest.js","lineno":69,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{"id":"astnode100003815","name":"ShoukakuRest#decode","type":"MethodDefinition","paramnames":["track"]},"vars":{"":null}},"description":"

Decodes the given base64 encoded track from lavalink.

","params":[{"type":{"names":["base64"]},"description":"

Base64 Encoded Track you got from the Lavalink API.

","name":"track"}],"memberof":"ShoukakuRest","returns":[{"type":{"names":["Promise."]},"description":"

The Lavalink Track details.

"}],"name":"decode","longname":"ShoukakuRest#decode","kind":"function","scope":"instance","$longname":"ShoukakuRest#decode","$kind":"method","$docmaLink":"?api#ShoukakuRest#decode"},{"comment":"/**\n * Gets the status of the \"RoutePlanner API\" for this Lavalink node.\n * @memberof ShoukakuRest\n * @returns {Promise} Refer to `https://github.com/Frederikam/Lavalink/blob/master/IMPLEMENTATION.md#routeplanner-api`\n */","meta":{"range":[3102,3188],"filename":"ShoukakuRest.js","lineno":79,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{"id":"astnode100003843","name":"ShoukakuRest#getRoutePlannerStatus","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"

Gets the status of the "RoutePlanner API" for this Lavalink node.

","memberof":"ShoukakuRest","returns":[{"type":{"names":["Promise."]},"description":"

Refer to https://github.com/Frederikam/Lavalink/blob/master/IMPLEMENTATION.md#routeplanner-api

"}],"name":"getRoutePlannerStatus","longname":"ShoukakuRest#getRoutePlannerStatus","kind":"function","scope":"instance","params":[],"$longname":"ShoukakuRest#getRoutePlannerStatus","$kind":"method","$docmaLink":"?api#ShoukakuRest#getRoutePlannerStatus"},{"comment":"/**\n * Resolves a identifier into a lavalink track.\n * @param {string} identifier Anything you want for lavalink to search for\n * @param {string} search Either `youtube` or `soundcloud`. If specified, resolve will return search results.\n * @memberof ShoukakuRest\n * @returns {Promise} The Lavalink Track Object.\n */","meta":{"range":[1573,2400],"filename":"ShoukakuRest.js","lineno":42,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{"id":"astnode100003702","name":"ShoukakuRest#resolve","type":"MethodDefinition","paramnames":["identifier","search"]},"vars":{"":null}},"description":"

Resolves a identifier into a lavalink track.

","params":[{"type":{"names":["string"]},"description":"

Anything you want for lavalink to search for

","name":"identifier"},{"type":{"names":["string"]},"description":"

Either youtube or soundcloud. If specified, resolve will return search results.

","name":"search"}],"memberof":"ShoukakuRest","returns":[{"type":{"names":["Promise."]},"description":"

The Lavalink Track Object.

"}],"name":"resolve","longname":"ShoukakuRest#resolve","kind":"function","scope":"instance","async":true,"$longname":"ShoukakuRest#resolve","$kind":"method","$docmaLink":"?api#ShoukakuRest#resolve"},{"comment":"/**\n * Unmarks all the failed IP(s) in the \"RoutePlanner API\" on this Lavalink node.\n * @memberof ShoukakuRest\n * @returns {Promise} Request status code\n */","meta":{"range":[3738,3828],"filename":"ShoukakuRest.js","lineno":96,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{"id":"astnode100003867","name":"ShoukakuRest#unmarkAllFailedAddress","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"

Unmarks all the failed IP(s) in the "RoutePlanner API" on this Lavalink node.

","memberof":"ShoukakuRest","returns":[{"type":{"names":["Promise."]},"description":"

Request status code

"}],"name":"unmarkAllFailedAddress","longname":"ShoukakuRest#unmarkAllFailedAddress","kind":"function","scope":"instance","params":[],"$longname":"ShoukakuRest#unmarkAllFailedAddress","$kind":"method","$docmaLink":"?api#ShoukakuRest#unmarkAllFailedAddress"},{"comment":"/**\n * Unmarks a failed IP in the \"RoutePlanner API\" on this Lavalink node.\n * @param {string} address The IP you want to unmark as failed.\n * @memberof ShoukakuRest\n * @returns {Promise} Request status code\n */","meta":{"range":[3437,3548],"filename":"ShoukakuRest.js","lineno":88,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{"id":"astnode100003853","name":"ShoukakuRest#unmarkFailedAddress","type":"MethodDefinition","paramnames":["address"]},"vars":{"":null}},"description":"

Unmarks a failed IP in the "RoutePlanner API" on this Lavalink node.

","params":[{"type":{"names":["string"]},"description":"

The IP you want to unmark as failed.

","name":"address"}],"memberof":"ShoukakuRest","returns":[{"type":{"names":["Promise."]},"description":"

Request status code

"}],"name":"unmarkFailedAddress","longname":"ShoukakuRest#unmarkFailedAddress","kind":"function","scope":"instance","$longname":"ShoukakuRest#unmarkFailedAddress","$kind":"method","$docmaLink":"?api#ShoukakuRest#unmarkFailedAddress"},{"comment":"/**\n * This Resolver Timeout before it decides to cancel the request.\n * @type {number}\n */","meta":{"range":[1121,1152],"filename":"ShoukakuRest.js","lineno":31,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{"id":"astnode100003685","name":"this.timeout","type":"LogicalExpression","value":"","paramnames":[]}},"description":"

This Resolver Timeout before it decides to cancel the request.

","type":{"names":["number"]},"name":"timeout","longname":"ShoukakuRest#timeout","kind":"member","memberof":"ShoukakuRest","scope":"instance","$longname":"ShoukakuRest#timeout","$kind":"property","$docmaLink":"?api#ShoukakuRest#timeout"},{"comment":"/**\n * URL of the host used by this resolver instance.\n * @type {string}\n */","meta":{"range":[951,987],"filename":"ShoukakuRest.js","lineno":26,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{"id":"astnode100003674","name":"this.url","type":"TemplateLiteral","value":"","paramnames":[]}},"description":"

URL of the host used by this resolver instance.

","type":{"names":["string"]},"name":"url","longname":"ShoukakuRest#url","kind":"member","memberof":"ShoukakuRest","scope":"instance","$longname":"ShoukakuRest#url","$kind":"property","$docmaLink":"?api#ShoukakuRest#url"}],"$constructor":{"comment":"/**\n * @param {string} host Your node host / ip address of where the lavalink is hosted.\n * @param {string} port The Port Number of your lavalink instance.\n * @param {string} auth The authentication key you set on your lavalink config.\n * @param {number} timeout Timeout before a request times out.\n */","meta":{"range":[796,1222],"filename":"ShoukakuRest.js","lineno":21,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\rest","code":{"id":"astnode100003665","name":"ShoukakuRest","type":"MethodDefinition","paramnames":["host","port","auth","timeout"]},"vars":{"":null}},"params":[{"type":{"names":["string"]},"description":"

Your node host / ip address of where the lavalink is hosted.

","name":"host"},{"type":{"names":["string"]},"description":"

The Port Number of your lavalink instance.

","name":"port"},{"type":{"names":["string"]},"description":"

The authentication key you set on your lavalink config.

","name":"auth"},{"type":{"names":["number"]},"description":"

Timeout before a request times out.

","name":"timeout"}],"name":"ShoukakuRest","longname":"ShoukakuRest","kind":"class","scope":"global","$longname":"ShoukakuRest","$kind":"constructor","$docmaLink":"?api#ShoukakuRest"}},{"comment":"/**\r\n * ShoukakuSocket, manages a single Lavalink WS connection.\r\n * @class ShoukakuSocket\r\n */","meta":{"filename":"ShoukakuSocket.js","lineno":9,"columnno":0,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{}},"description":"

ShoukakuSocket, manages a single Lavalink WS connection.

","kind":"class","name":"ShoukakuSocket","longname":"ShoukakuSocket","scope":"global","$longname":"ShoukakuSocket","$kind":"class","$docmaLink":"?api#ShoukakuSocket","$members":[{"comment":"/**\r\n * Connects this Socket.\r\n * @param {string} id Your Bot's / Client user id.\r\n * @param {number} shardCount Your Bot's / Client shard count.\r\n * @param {boolean|string} resumable Determines if we should try to resume the connection.\r\n * @memberof ShoukakuSocket\r\n * @returns {void}\r\n */","meta":{"range":[3790,4737],"filename":"ShoukakuSocket.js","lineno":100,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002857","name":"ShoukakuSocket#connect","type":"MethodDefinition","paramnames":["id","shardCount","resumable"]},"vars":{"":null}},"description":"

Connects this Socket.

","params":[{"type":{"names":["string"]},"description":"

Your Bot's / Client user id.

","name":"id"},{"type":{"names":["number"]},"description":"

Your Bot's / Client shard count.

","name":"shardCount"},{"type":{"names":["boolean","string"]},"description":"

Determines if we should try to resume the connection.

","name":"resumable"}],"memberof":"ShoukakuSocket","returns":[{"type":{"names":["void"]}}],"name":"connect","longname":"ShoukakuSocket#connect","kind":"function","scope":"instance","$longname":"ShoukakuSocket#connect","$kind":"method","$docmaLink":"?api#ShoukakuSocket#connect"},{"comment":"/**\r\n * Creates a player and connects your bot to the specified guild's voice channel\r\n * @param {ShoukakuConstants#ShoukakuJoinOptions} options Join data to send.\r\n * @memberof ShoukakuSocket\r\n * @returns {Promise}\r\n * @example\r\n * .joinVoiceChannel({\r\n * guildID: 'guild_id',\r\n * voiceChannelID: 'voice_channel_id'\r\n * }).then((player) => player.playTrack('lavalink_track'));\r\n */","meta":{"range":[5211,6496],"filename":"ShoukakuSocket.js","lineno":127,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100003031","name":"ShoukakuSocket#joinVoiceChannel","type":"MethodDefinition","paramnames":["options"]},"vars":{"":null}},"description":"

Creates a player and connects your bot to the specified guild's voice channel

","params":[{"type":{"names":["ShoukakuConstants#ShoukakuJoinOptions"]},"description":"

Join data to send.

","name":"options"}],"memberof":"ShoukakuSocket","returns":[{"type":{"names":["Promise."]}}],"examples":[".joinVoiceChannel({\r guildID: 'guild_id',\r voiceChannelID: 'voice_channel_id'\r}).then((player) => player.playTrack('lavalink_track'));"],"name":"joinVoiceChannel","longname":"ShoukakuSocket#joinVoiceChannel","kind":"function","scope":"instance","$longname":"ShoukakuSocket#joinVoiceChannel","$kind":"method","$docmaLink":"?api#ShoukakuSocket#joinVoiceChannel"},{"comment":"/**\r\n * Eventually Disconnects the VoiceConnection & Removes the Player from a Guild.\r\n * @param {string} guildID The guild id of the player you want to remove.\r\n * @memberOf ShoukakuSocket\r\n * @returns {void}\r\n */","meta":{"range":[6742,6888],"filename":"ShoukakuSocket.js","lineno":162,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100003184","name":"ShoukakuSocket#leaveVoiceChannel","type":"MethodDefinition","paramnames":["guildID"]},"vars":{"":null}},"description":"

Eventually Disconnects the VoiceConnection & Removes the Player from a Guild.

","params":[{"type":{"names":["string"]},"description":"

The guild id of the player you want to remove.

","name":"guildID"}],"memberof":"ShoukakuSocket","returns":[{"type":{"names":["void"]}}],"name":"leaveVoiceChannel","longname":"ShoukakuSocket#leaveVoiceChannel","kind":"function","scope":"instance","$longname":"ShoukakuSocket#leaveVoiceChannel","$kind":"method","$docmaLink":"?api#ShoukakuSocket#leaveVoiceChannel"},{"comment":"/**\r\n * Name of this Socket that you can use on .getNode() method of Shoukaku.\r\n * @type {string}\r\n */","meta":{"range":[2101,2122],"filename":"ShoukakuSocket.js","lineno":55,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002659","name":"this.name","type":"MemberExpression","value":"node.name","paramnames":[]}},"description":"

Name of this Socket that you can use on .getNode() method of Shoukaku.

","type":{"names":["string"]},"name":"name","longname":"ShoukakuSocket#name","kind":"member","memberof":"ShoukakuSocket","scope":"instance","$longname":"ShoukakuSocket#name","$kind":"property","$docmaLink":"?api#ShoukakuSocket#name"},{"comment":"/**\r\n * Penalties of this Socket. The higher the return number, the more loaded the server is.\r\n * @type {number}\r\n * @memberof ShoukakuSocket\r\n */","meta":{"range":[3086,3466],"filename":"ShoukakuSocket.js","lineno":82,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002785","name":"ShoukakuSocket#penalties","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"

Penalties of this Socket. The higher the return number, the more loaded the server is.

","type":{"names":["number"]},"memberof":"ShoukakuSocket","name":"penalties","longname":"ShoukakuSocket#penalties","kind":"member","scope":"instance","params":[],"$longname":"ShoukakuSocket#penalties","$kind":"property","$docmaLink":"?api#ShoukakuSocket#penalties"},{"comment":"/**\r\n * The active players in this socket/node.\r\n * @type {external:Map}\r\n */","meta":{"range":[1144,1168],"filename":"ShoukakuSocket.js","lineno":30,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002611","name":"this.players","type":"NewExpression","value":"","paramnames":[]}},"description":"

The active players in this socket/node.

","type":{"names":["external:Map"]},"name":"players","longname":"ShoukakuSocket#players","kind":"member","memberof":"ShoukakuSocket","scope":"instance","$longname":"ShoukakuSocket#players","$kind":"property","$docmaLink":"?api#ShoukakuSocket#players"},{"comment":"/**\r\n * Attempted reconnects of this Socket. Resets to 0 when the socket opens properly.\r\n * @type {number}\r\n */","meta":{"range":[1931,1957],"filename":"ShoukakuSocket.js","lineno":50,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002653","name":"this.reconnectAttempts","type":"Literal","value":0,"paramnames":[]}},"description":"

Attempted reconnects of this Socket. Resets to 0 when the socket opens properly.

","type":{"names":["number"]},"name":"reconnectAttempts","longname":"ShoukakuSocket#reconnectAttempts","kind":"member","memberof":"ShoukakuSocket","scope":"instance","$longname":"ShoukakuSocket#reconnectAttempts","$kind":"property","$docmaLink":"?api#ShoukakuSocket#reconnectAttempts"},{"comment":"/**\r\n * The REST API of this Socket, mostly to load balance your REST requests instead of relying on a single node.\r\n * @type {ShoukakuRest}\r\n */","meta":{"range":[1355,1446],"filename":"ShoukakuSocket.js","lineno":35,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002618","name":"this.rest","type":"NewExpression","value":"","paramnames":[]}},"description":"

The REST API of this Socket, mostly to load balance your REST requests instead of relying on a single node.

","type":{"names":["ShoukakuRest"]},"name":"rest","longname":"ShoukakuSocket#rest","kind":"member","memberof":"ShoukakuSocket","scope":"instance","$longname":"ShoukakuSocket#rest","$kind":"property","$docmaLink":"?api#ShoukakuSocket#rest"},{"comment":"/**\r\n * The Instance of Shoukaku where this node initialization is called.\r\n * @type {Shoukaku}\r\n */","meta":{"range":[1001,1025],"filename":"ShoukakuSocket.js","lineno":25,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002605","name":"this.shoukaku","type":"Identifier","value":"shoukaku","paramnames":[]}},"description":"

The Instance of Shoukaku where this node initialization is called.

","type":{"names":["Shoukaku"]},"name":"shoukaku","longname":"ShoukakuSocket#shoukaku","kind":"member","memberof":"ShoukakuSocket","scope":"instance","$longname":"ShoukakuSocket#shoukaku","$kind":"property","$docmaLink":"?api#ShoukakuSocket#shoukaku"},{"comment":"/**\r\n * The state of this Socket.\r\n * @type {ShoukakuConstants#ShoukakuStatus}\r\n */","meta":{"range":[1571,1611],"filename":"ShoukakuSocket.js","lineno":40,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002639","name":"this.state","type":"MemberExpression","value":"ShoukakuStatus.DISCONNECTED","paramnames":[]}},"description":"

The state of this Socket.

","type":{"names":["ShoukakuConstants#ShoukakuStatus"]},"name":"state","longname":"ShoukakuSocket#state","kind":"member","memberof":"ShoukakuSocket","scope":"instance","$longname":"ShoukakuSocket#state","$kind":"property","$docmaLink":"?api#ShoukakuSocket#state"},{"comment":"/**\r\n * The current stats of this Socket.\r\n * @type {ShoukakuConstants#ShoukakuNodeStats}\r\n */","meta":{"range":[1747,1777],"filename":"ShoukakuSocket.js","lineno":45,"columnno":8,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002647","name":"this.stats","type":"Identifier","value":"ShoukakuNodeStats","paramnames":[]}},"description":"

The current stats of this Socket.

","type":{"names":["ShoukakuConstants#ShoukakuNodeStats"]},"name":"stats","longname":"ShoukakuSocket#stats","kind":"member","memberof":"ShoukakuSocket","scope":"instance","$longname":"ShoukakuSocket#stats","$kind":"property","$docmaLink":"?api#ShoukakuSocket#stats"}],"$constructor":{"comment":"/**\r\n * @extends {external:EventEmitter}\r\n * @param {Shoukaku} shoukaku Your Shoukaku Instance\r\n * @param {ShoukakuOptions} node ShoukakuNodeOptions Options to initialize Shoukaku with\r\n */","meta":{"range":[813,2642],"filename":"ShoukakuSocket.js","lineno":19,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\node","code":{"id":"astnode100002595","name":"ShoukakuSocket","type":"MethodDefinition","paramnames":["shoukaku","node"]},"vars":{"":null}},"augments":["external:EventEmitter"],"params":[{"type":{"names":["Shoukaku"]},"description":"

Your Shoukaku Instance

","name":"shoukaku"},{"type":{"names":["ShoukakuOptions"]},"description":"

ShoukakuNodeOptions Options to initialize Shoukaku with

","name":"node"}],"name":"ShoukakuSocket","longname":"ShoukakuSocket","kind":"class","scope":"global","$longname":"ShoukakuSocket","$kind":"constructor","$docmaLink":"?api#ShoukakuSocket"}},{"comment":"/**\n * ShoukakuTimeout, Timeout Error class of Shoukaku.\n * @class ShoukakuTimeout\n * @extends {Error}\n */","meta":{"filename":"ShoukakuTimeout.js","lineno":1,"columnno":0,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{}},"description":"

ShoukakuTimeout, Timeout Error class of Shoukaku.

","kind":"class","name":"ShoukakuTimeout","augments":["Error"],"longname":"ShoukakuTimeout","scope":"global","$longname":"ShoukakuTimeout","$kind":"class","$docmaLink":"?api#ShoukakuTimeout","$constructor":{"comment":"/**\n * @param message The Error Message\n */","meta":{"range":[209,300],"filename":"ShoukakuTimeout.js","lineno":10,"columnno":4,"path":"C:\\Users\\Deivu\\Desktop\\Shoukaku\\src\\constants","code":{"id":"astnode100000982","name":"ShoukakuTimeout","type":"MethodDefinition","paramnames":["message"]},"vars":{"":null}},"params":[{"description":"

The Error Message

","name":"message"}],"name":"ShoukakuTimeout","longname":"ShoukakuTimeout","kind":"class","scope":"global","$longname":"ShoukakuTimeout","$kind":"constructor","$docmaLink":"?api#ShoukakuTimeout"}}],"symbols":["Shoukaku","Shoukaku#addNode","Shoukaku#client","Shoukaku#event:close","Shoukaku#event:debug","Shoukaku#event:disconnected","Shoukaku#event:error","Shoukaku#event:ready","Shoukaku#getNode","Shoukaku#getPlayer","Shoukaku#id","Shoukaku#nodes","Shoukaku#players","Shoukaku#removeNode","Shoukaku#shardCount","Shoukaku#totalPlayers","ShoukakuConstants","ShoukakuConstants#ShoukakuJoinOptions","ShoukakuConstants#ShoukakuNodeOptions","ShoukakuConstants#ShoukakuNodes","ShoukakuConstants#ShoukakuNodeStats","ShoukakuConstants#ShoukakuOptions","ShoukakuConstants#ShoukakuPlayOptions","ShoukakuConstants#ShoukakuStatus","ShoukakuError","ShoukakuLink","ShoukakuLink#attemptReconnect","ShoukakuLink#guildID","ShoukakuLink#node","ShoukakuLink#player","ShoukakuLink#selfDeaf","ShoukakuLink#selfMute","ShoukakuLink#sessionID","ShoukakuLink#shardID","ShoukakuLink#state","ShoukakuLink#userID","ShoukakuLink#voiceChannelID","ShoukakuPlayer","ShoukakuPlayer#bands","ShoukakuPlayer#connect","ShoukakuPlayer#disconnect","ShoukakuPlayer#event:closed","ShoukakuPlayer#event:end","ShoukakuPlayer#event:error","ShoukakuPlayer#event:nodeDisconnect","ShoukakuPlayer#event:playerUpdate","ShoukakuPlayer#event:resumed","ShoukakuPlayer#event:start","ShoukakuPlayer#event:trackException","ShoukakuPlayer#moveToNode","ShoukakuPlayer#paused","ShoukakuPlayer#playTrack","ShoukakuPlayer#position","ShoukakuPlayer#seekTo","ShoukakuPlayer#setEqualizer","ShoukakuPlayer#setPaused","ShoukakuPlayer#setVolume","ShoukakuPlayer#stopTrack","ShoukakuPlayer#track","ShoukakuPlayer#voiceConnection","ShoukakuPlayer#volume","ShoukakuRest","ShoukakuRest#decode","ShoukakuRest#getRoutePlannerStatus","ShoukakuRest#resolve","ShoukakuRest#timeout","ShoukakuRest#unmarkAllFailedAddress","ShoukakuRest#unmarkFailedAddress","ShoukakuRest#url","ShoukakuSocket","ShoukakuSocket#connect","ShoukakuSocket#joinVoiceChannel","ShoukakuSocket#leaveVoiceChannel","ShoukakuSocket#name","ShoukakuSocket#penalties","ShoukakuSocket#players","ShoukakuSocket#reconnectAttempts","ShoukakuSocket#rest","ShoukakuSocket#shoukaku","ShoukakuSocket#state","ShoukakuSocket#stats","ShoukakuTimeout"]}},"app":{"title":"Shoukaku | A Lavalink Library for Discord.JS v12","routing":{"method":"query","caseSensitive":true},"entrance":"content:readme","base":"/Shoukaku/","meta":null,"server":"static","favicon":""},"template":{"name":"docma-template-zebra","description":"Zebra - Default template for Docma. https://github.com/onury/docma","version":"2.3.1","supportedDocmaVersion":">=2.0.0","author":"Onur Yıldırım","license":"MIT","mainHTML":"index.html","options":{"title":{"label":"Shoukaku","href":"."},"navbar":{"menu":[{"label":"Readme","href":"."},{"label":"Documentation","href":"?api"},{"label":"GitHub","href":"https://github.com/Deivu/Shoukaku"}],"enabled":true,"fixed":true,"dark":false,"animations":true},"logo":null,"sidebar":{"enabled":true,"outline":"tree","collapsed":false,"toolbar":true,"itemsFolded":false,"itemsOverflow":"crop","badges":true,"search":true,"animations":true},"symbols":{"autoLink":true,"params":"list","enums":"list","props":"list","meta":false},"contentView":{"bookmarks":false,"faVersion":"5.5.0","faLibs":"all"}}},"partials":{"api":"docma-api","content":"docma-content","notFound":"docma-404"},"elementID":"docma-main","contentElementID":"docma-content","defaultApiName":"_def_","logsEnabled":false})); !function(){"use strict";var c="path"===docma.app.routing.method;function n(a){return(a.params[1]||"").replace(/\/$/,"")}function a(a,e){var o=n(a)||docma._.defaultApiName,t=docma.createRoute(o,DocmaWeb.Route.Type.API);if(!t||!t.exists())return e();t.apply()}docma.app.base&&page.base(docma.app.base),page.redirect("(/)?"+docma.template.main,""),c&&(page("(/)?api/(.+)",a),page("(/)?api(/)?",a),page("(/)?(.*)",function(a,e){var o=n(a),t=docma.createRoute(o,DocmaWeb.Route.Type.CONTENT);if(!t||!t.exists())return e();t.apply()})),page("(/)?",function(t,n){!function(){if(c){var a=sessionStorage.getItem("redirectPath")||null;if(a)return sessionStorage.removeItem("redirectPath"),docma.info("Redirecting to:",a),page.redirect(a),!0}return!1}()&&setTimeout(function(){var a,e=function(a){var e=a||window.location.search;return/^[?&]/.test(e)&&(e=e.slice(1)),e||null}(t.querystring);if(c){if(e)return n();a=docma._.appEntranceRI}else docma.log("Query-string:",e),a=e?docma.createRouteFromQuery(e):docma._.appEntranceRI;if(!a||!a.exists())return n();function o(){docma._trigger(DocmaWeb.Event.Navigate,[a])}a.isCurrent()?o():a.apply(function(a){200===a&&o()})},100)}),page("*",function(a){docma.warn("Unknown Route:",a.path),docma.log("context:",a),docma.createRoute(null).apply()}),docma.info("Docma SPA Configuration:"),docma.info("App Title: ",docma.app.title),docma.info("Routing Method: ",docma.app.routing.method),docma.info("App Server: ",docma.app.server),docma.info("Base Path: ",docma.app.base),docma.info("Entrance Route ID: ",docma.app.entrance),window.onload=function(){docma._.initialLoad=!0,docma._.appEntranceRI=docma.createRouteFromID(docma.app.entrance),page.start({click:!0,popstate:!0,dispatch:!0,hashbang:!1,decodeURLComponents:!0}),docma.info("Docma SPA loaded!")}}(); \ No newline at end of file diff --git a/src/guild/ShoukakuPlayer.js b/src/guild/ShoukakuPlayer.js index 10349196..8ebb3de1 100644 --- a/src/guild/ShoukakuPlayer.js +++ b/src/guild/ShoukakuPlayer.js @@ -49,12 +49,6 @@ class ShoukakuPlayer extends EventEmitter { this.position = 0; } - /** - * Emitted when the Lavalink Player emits a TrackEnd or TrackStuck event. - * @event ShoukakuPlayer#start - * @param {Object} data - * @memberOf ShoukakuPlayer - */ /** * Emitted when the Lavalink Player emits a TrackEnd or TrackStuck event. * @event ShoukakuPlayer#end @@ -96,6 +90,12 @@ class ShoukakuPlayer extends EventEmitter { * .disconnect(); * }) */ + /** + * Emitted when the Lavalink Player emits a TrackStartEvent event. Optional. + * @event ShoukakuPlayer#start + * @param {Object} data + * @memberOf ShoukakuPlayer + */ /** * Emitted when Lavalink encounters an error on playing the song. Optional. * @event ShoukakuPlayer#trackException From 5a0fc78b469557e5a71851948451b4050065077d Mon Sep 17 00:00:00 2001 From: Deivu Date: Wed, 1 Apr 2020 23:53:22 +0800 Subject: [PATCH 2/2] chore, update deps --- package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 8e1ad5a3..b1031e5b 100644 --- a/package.json +++ b/package.json @@ -27,10 +27,10 @@ "dependencies": { "abort-controller": "^3.0.0", "node-fetch": "^2.6.0", - "ws": "^7.1.2" + "ws": "^7.2.3" }, "devDependencies": { - "discord.js": "github:discordjs/discord.js", + "discord.js": ">=12.0.0 <13.0.0", "typescript": "^3.8.3" } }