diff --git a/apps/website/docusaurus.config.js b/apps/website/docusaurus.config.js index ac12fea..6db7174 100644 --- a/apps/website/docusaurus.config.js +++ b/apps/website/docusaurus.config.js @@ -6,7 +6,7 @@ const fs = require('fs'); const lightCodeTheme = require('prism-react-renderer/themes/github'); const darkCodeTheme = require('prism-react-renderer/themes/dracula'); -const lastVersion = '1.1.1'; +const lastVersion = '1.2.0'; /** @type {import('@docusaurus/types').Config} */ @@ -60,12 +60,15 @@ const config = { // Remove this to remove the "edit this page" links. editUrl: 'https://github.com/hmes98318/LavaShark/blob/main/apps/website/', - lastVersion: '1.1.1', + lastVersion: lastVersion, // onlyIncludeVersions: JSON.parse(fs.readFileSync('./versions.json', 'utf-8')), versions: { "1.1.1": { label: `v1.1.1` }, + "1.2.0": { + label: `v1.2.0` + }, }, }, blog: { diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/FAQ.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/FAQ.md new file mode 100644 index 0000000..0250d0d --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/FAQ.md @@ -0,0 +1,19 @@ +--- +sidebar_position: 4 +--- + +# FAQ 常見問題 + +### 節點無法連接 +如果你的節點無法連接，請檢查你的 Lavalink 節點版本 +**LavaShark v1** 不支持不帶有 **REST API** 的 **Lavalink v3** 節點 +僅對版本 **3.7.x** 的 Lavalink 節點兼容 + + +### 機器人加入頻道但沒有任何聲音播出 +檢查你是否註冊了 [`GuildVoiceStates`](https://discord-api-types.dev/api/discord-api-types-v10/enum/GatewayIntentBits) 的網關意圖， +以及是否在 discord 的 client 上註冊 `raw` 事件。 + +```js +client.on('raw', (packet) => client.lavashark.handleVoiceUpdate(packet)); +``` \ No newline at end of file diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/README.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/README.md new file mode 100644 index 0000000..0a78449 --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/README.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 1 +--- + +# LavaShark + +使用 Node.js 構建的輕量級 Lavalink 客戶端。 + +### 特點 +* 穩定 + +* 物件導向 + +* 快速高效 + +:::caution +僅對支持 REST API（版本 3.7.x）的 Lavalink 節點兼容。 +::: + +## Installation + +:::tip +需要 Node.js 16.9 或更高版本。 +* 你需要至少一個 [Lavalink 伺服器](https://github.com/lavalink-devs/Lavalink)節點才能運行。請參考「[伺服器配置](./server-config.md)」部分進行配置設置。 +::: + +```bash +$ npm install lavashark +# or +$ yarn add lavashark +``` + + +## 其他資源 +* [Github repository](https://github.com/hmes98318/LavaShark) +* [NPM page](https://www.npmjs.com/package/lavashark) +* [Discord server](https://discord.gg/7rQEx7SPGr) + diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/Filters.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/Filters.md new file mode 100644 index 0000000..7073fb6 --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/Filters.md @@ -0,0 +1,382 @@ +# Filters + +## Table of contents + +### Constructors + +- [constructor](Filters.md#constructor) + +### Accessors + +- [active](Filters.md#active) +- [enabled](Filters.md#enabled) + +### Methods + +- [apply](Filters.md#apply) +- [clear](Filters.md#clear) +- [set](Filters.md#set) +- [setChannelMix](Filters.md#setchannelmix) +- [setDistortion](Filters.md#setdistortion) +- [setEqualizer](Filters.md#setequalizer) +- [setKaraoke](Filters.md#setkaraoke) +- [setLowPass](Filters.md#setlowpass) +- [setRotation](Filters.md#setrotation) +- [setTimescale](Filters.md#settimescale) +- [setTremolo](Filters.md#settremolo) +- [setVibrato](Filters.md#setvibrato) +- [setVolume](Filters.md#setvolume) + +## Constructors + +### constructor + +• **new Filters**(`player`) + +創建一個 Filters 實例 + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `player` | [`Player`](Player.md) | + +#### Defined in + +[lib/Filters.ts:25](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L25) + +## Accessors + +### active + +• `get` **active**(): [`FilterOptions`](../types/Filter.types.md#filteroptions) + +獲取活動 Filters 物件的副本 + +#### Returns + +[`FilterOptions`](../types/Filter.types.md#filteroptions) + +#### Defined in + +[lib/Filters.ts:36](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L36) + +___ + +### enabled + +• `get` **enabled**(): `boolean` + +檢查某個 Filters 是否已啟用 + +#### Returns + +`boolean` + +#### Defined in + +[lib/Filters.ts:31](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L31) + +## Methods + +### apply + +▸ **apply**(): `void` + +將 Filters 設置傳送到 Lavalink 節點 + +#### Returns + +`void` + +#### Defined in + +[lib/Filters.ts:245](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L245) + +___ + +### clear + +▸ **clear**(): `void` + +清除所有活動的 Filters + +#### Returns + +`void` + +#### Defined in + +[lib/Filters.ts:238](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L238) + +___ + +### set + +▸ **set**(`filters`): `void` + +設置所有 Filters + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `filters` | [`FilterOptions`](../types/Filter.types.md#filteroptions) | + +#### Returns + +`void` + +#### Defined in + +[lib/Filters.ts:224](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L224) + +___ + +### setChannelMix + +▸ **setChannelMix**(`options`, `apply?`): [`Filters`](Filters.md) + +設置 ChannelMix Filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| [`ChannelMixOptions`](../types/Filter.types.md#channelmixoptions) | `undefined` | channel mix 選項 | +| `apply` | `boolean` | `true` | 是否將 Filter 設置傳送到 Lavalink 節點 | + +#### Returns + +[`Filters`](Filters.md) + +Filter 實例，用於鏈式呼叫 + +#### Defined in + +[lib/Filters.ts:50](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L50) + +___ + +### setDistortion + +▸ **setDistortion**(`options`, `apply?`): [`Filters`](Filters.md) + +設置 Distortion Filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| [`DistortionOptions`](../types/Filter.types.md#distortionoptions) | `undefined` | distortion 選項 | +| `apply` | `boolean` | `true` | 是否將 Filter 設置傳送到 Lavalink 節點 | + +#### Returns + +[`Filters`](Filters.md) + +Filter 實例，用於鏈式呼叫 + +#### Defined in + +[lib/Filters.ts:73](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L73) + +___ + +### setEqualizer + +▸ **setEqualizer**(`options`, `apply?`): [`Filters`](Filters.md) + +設置 Equalizer Filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| `number`[] | `undefined` | 等化器陣列 | +| `apply` | `boolean` | `true` | 是否將 Filter 設置傳送到 Lavalink 節點 | + +#### Returns + +[`Filters`](Filters.md) + +Filter 實例，用於鏈式呼叫 + +#### Defined in + +[lib/Filters.ts:88](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L88) + +___ + +### setKaraoke + +▸ **setKaraoke**(`options`, `apply?`): [`Filters`](Filters.md) + +設置 Karaoke Filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| [`KaraokeOptions`](../types/Filter.types.md#karaokeoptions) | `undefined` | karaoke 選項 | +| `apply` | `boolean` | `true` | 是否將 Filter 設置傳送到 Lavalink 節點 | + +#### Returns + +[`Filters`](Filters.md) + +Filter 實例，用於鏈式呼叫 + +#### Defined in + +[lib/Filters.ts:114](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L114) + +___ + +### setLowPass + +▸ **setLowPass**(`options`, `apply?`): [`Filters`](Filters.md) + +設置 LowPass Filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| [`LowPassOptions`](../types/Filter.types.md#lowpassoptions) | `undefined` | lowpass 選項 | +| `apply` | `boolean` | `true` | 是否將 Filter 設置傳送到 Lavalink 節點 | + +#### Returns + +[`Filters`](Filters.md) + +Filter 實例，用於鏈式呼叫 + +#### Defined in + +[lib/Filters.ts:130](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L130) + +___ + +### setRotation + +▸ **setRotation**(`options`, `apply?`): [`Filters`](Filters.md) + +設置 Rotation Filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| [`RotationOptions`](../types/Filter.types.md#rotationoptions) | `undefined` | rotation 選項 | +| `apply` | `boolean` | `true` | 是否將 Filter 設置傳送到 Lavalink 節點 | + +#### Returns + +[`Filters`](Filters.md) + +Filter 實例，用於鏈式呼叫 + +#### Defined in + +[lib/Filters.ts:146](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L146) + +___ + +### setTimescale + +▸ **setTimescale**(`options`, `apply?`): [`Filters`](Filters.md) + +設置 Timescale Filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| [`TimescaleOptions`](../types/Filter.types.md#timescaleoptions) | `undefined` | timescale 選項 | +| `apply` | `boolean` | `true` | 是否將 Filter 設置傳送到 Lavalink 節點 | + +#### Returns + +[`Filters`](Filters.md) + +Filter 實例，用於鏈式呼叫 + +#### Defined in + +[lib/Filters.ts:164](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L164) + +___ + +### setTremolo + +▸ **setTremolo**(`options`, `apply?`): [`Filters`](Filters.md) + +設置 Tremolo filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| [`TremoloOptions`](../types/Filter.types.md#tremolooptions) | `undefined` | tremolo 選項 | +| `apply` | `boolean` | `true` | 是否將 Filter 設置傳送到 Lavalink 節點 | + +#### Returns + +[`Filters`](Filters.md) + +Filter 實例，用於鏈式呼叫 + +#### Defined in + +[lib/Filters.ts:181](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L181) + +___ + +### setVibrato + +▸ **setVibrato**(`options`, `apply?`): [`Filters`](Filters.md) + +設置 Vibrato filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| [`VibratoOptions`](../types/Filter.types.md#vibratooptions) | `undefined` | vibrato 選項 | +| `apply` | `boolean` | `true` | 是否將 Filter 設置傳送到 Lavalink 節點 | + +#### Returns + +[`Filters`](Filters.md) + +Filter 實例，用於鏈式呼叫 + +#### Defined in + +[lib/Filters.ts:198](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L198) + +___ + +### setVolume + +▸ **setVolume**(`vol`, `apply?`): [`Filters`](Filters.md) + +設置音量 + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `vol` | `number` | `undefined` | 要設置的音量 [0,500] | +| `apply` | `boolean` | `true` | 是否將 Filter 設置傳送到 Lavalink 節點 | + +#### Returns + +[`Filters`](Filters.md) + +Filter 實例，用於鏈式呼叫 + +#### Defined in + +[lib/Filters.ts:213](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L213) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/LavaShark.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/LavaShark.md new file mode 100644 index 0000000..22cb3d3 --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/LavaShark.md @@ -0,0 +1,384 @@ +# LavaShark + +## Table of contents + +### Constructors + +- [constructor](LavaShark.md#constructor) + +### Properties + +- [clientId](LavaShark.md#clientid) +- [nodes](LavaShark.md#nodes) +- [on](LavaShark.md#on) +- [once](LavaShark.md#once) +- [players](LavaShark.md#players) +- [sendWS](LavaShark.md#sendws) +- [unresolvedSearchSource](LavaShark.md#unresolvedsearchsource) +- [useISRC](LavaShark.md#useisrc) + +### Methods + +- [addExternalSource](LavaShark.md#addexternalsource) +- [bestNode](LavaShark.md#bestnode) +- [createPlayer](LavaShark.md#createplayer) +- [decodeTrack](LavaShark.md#decodetrack) +- [decodeTracks](LavaShark.md#decodetracks) +- [getPlayer](LavaShark.md#getplayer) +- [handleVoiceUpdate](LavaShark.md#handlevoiceupdate) +- [nodesPing](LavaShark.md#nodesping) +- [search](LavaShark.md#search) +- [start](LavaShark.md#start) +- [checkOptions](LavaShark.md#checkoptions) + +## Constructors + +### constructor + +• **new LavaShark**(`options`) + +創建一個 LavaShark 實例 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `options` | [`LavaSharkOptions`](../types/LavaShark.types.md#lavasharkoptions) | LavaShark 選項 | + +#### Defined in + +[lib/LavaShark.ts:114](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L114) + +## Properties + +### clientId + +• **clientId**: `string` + +#### Defined in + +[lib/LavaShark.ts:31](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L31) + +___ + +### nodes + +• **nodes**: [`Node`](Node.md)[] + +#### Defined in + +[lib/LavaShark.ts:32](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L32) + +___ + +### on + +• **on**: [`EventListeners`](../types/LavaShark.types.md#eventlisteners)<[`LavaShark`](LavaShark.md)\> + +#### Defined in + +[lib/LavaShark.ts:27](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L27) + +___ + +### once + +• **once**: [`EventListeners`](../types/LavaShark.types.md#eventlisteners)<[`LavaShark`](LavaShark.md)\> + +#### Defined in + +[lib/LavaShark.ts:26](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L26) + +___ + +### players + +• **players**: `Map`<`string`, [`Player`](Player.md)\> + + + +#### Defined in + +[lib/LavaShark.ts:41](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L41) + +___ + +### sendWS + +• `Readonly` **sendWS**: (`guildId`: `string`, `payload`: [`OutgoingDiscordPayload`](../types/LavaShark.types.md#outgoingdiscordpayload)) => `void` + +#### Type declaration + +▸ (`guildId`, `payload`): `void` + +**`Example`** + +```ts +sendWS: (guildId, payload) => { + client.guilds.cache.get(guildId)?.shard.send(payload); +} +``` + +##### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `guildId` | `string` | guildId | +| `payload` | [`OutgoingDiscordPayload`](../types/LavaShark.types.md#outgoingdiscordpayload) | payload | + +##### Returns + +`void` + +#### Defined in + +[lib/LavaShark.ts:56](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L56) + +___ + +### unresolvedSearchSource + +• `Readonly` **unresolvedSearchSource**: [`SEARCH_SOURCE`](../types/LavaShark.types.md#search_source) + +#### Defined in + +[lib/LavaShark.ts:35](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L35) + +___ + +### useISRC + +• `Readonly` **useISRC**: `boolean` + +#### Defined in + +[lib/LavaShark.ts:36](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L36) + +## Methods + +### addExternalSource + +▸ **addExternalSource**(`extSource`): `void` + +添加一個外部來源，生成帶有 UnresolvedTracks 的 SearchResult + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `extSource` | `AbstractExternalSource` | 外部來源 | + +#### Returns + +`void` + +#### Defined in + +[lib/LavaShark.ts:181](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L181) + +___ + +### bestNode + +▸ **bestNode**(): `Promise`<[`Node`](Node.md)\> + +#### Returns + +`Promise`<[`Node`](Node.md)\> + +#### Defined in + +[lib/LavaShark.ts:151](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L151) + +___ + +### createPlayer + +▸ **createPlayer**(`options`): [`Player`](Player.md) + +創建一個新的 Player 或返回一個現有的 Player + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `options` | [`PlayerOptions`](../types/Player.types.md#playeroptions) | Player 選項 | + +#### Returns + +[`Player`](Player.md) + +#### Defined in + +[lib/LavaShark.ts:224](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L224) + +___ + +### decodeTrack + +▸ **decodeTrack**(`encodedTrack`): `Promise`<[`Track`](Track.md)\> + +Decodes a track by its base64 string + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encodedTrack` | `string` | The base64 encoded track | + +#### Returns + +`Promise`<[`Track`](Track.md)\> + +#### Defined in + +[lib/LavaShark.ts:194](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L194) + +___ + +### decodeTracks + +▸ **decodeTracks**(`encodedTracks`): `Promise`<[`Track`](Track.md)[]\> + +Decodes multiple tracks by their base64 string + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encodedTracks` | `string`[] | The base64 encoded tracks | + +#### Returns + +`Promise`<[`Track`](Track.md)[]\> + +#### Defined in + +[lib/LavaShark.ts:206](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L206) + +___ + +### getPlayer + +▸ **getPlayer**(`guildId`): ``null`` \| [`Player`](Player.md) + +使用 guild ID 檢索現有的 Player + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `guildId` | `string` | 該 Player 所屬的 guild ID | + +#### Returns + +``null`` \| [`Player`](Player.md) + +#### Defined in + +[lib/LavaShark.ts:242](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L242) + +___ + +### handleVoiceUpdate + +▸ **handleVoiceUpdate**(`payload`): `void` + +處理語音狀態和語音伺服器更新封包 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | [`IncomingDiscordPayload`](../types/LavaShark.types.md#incomingdiscordpayload) | 語音封包 | + +#### Returns + +`void` + +#### Defined in + +[lib/LavaShark.ts:323](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L323) + +___ + +### nodesPing + +▸ **nodesPing**(): `Promise`<`number`[]\> + +獲取所有節點的 ping 值 + +#### Returns + +`Promise`<`number`[]\> + +- 所有節點的延遲，以毫秒為單位 + +#### Defined in + +[lib/LavaShark.ts:377](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L377) + +___ + +### search + +▸ **search**(`query`, `source?`): `Promise`<[`SearchResult`](../types/REST.types.md#searchresult)\> + +通過歌曲名稱進行搜索或使用歌曲連結 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `query` | `string` | 要搜索的內容 | +| `source?` | [`SEARCH_SOURCE`](../types/LavaShark.types.md#search_source) | 搜尋來源 | + +#### Returns + +`Promise`<[`SearchResult`](../types/REST.types.md#searchresult)\> + +#### Defined in + +[lib/LavaShark.ts:263](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L263) + +___ + +### start + +▸ **start**(`clientId`): `void` + +連接到所有 Lavalink 節點 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `clientId` | `string` | client ID (BOT) | + +#### Returns + +`void` + +#### Defined in + +[lib/LavaShark.ts:307](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L307) + +___ + +### checkOptions + +▸ `Static` **checkOptions**(`options`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | [`LavaSharkOptions`](../types/LavaShark.types.md#lavasharkoptions) | + +#### Returns + +`void` + +#### Defined in + +[lib/LavaShark.ts:58](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L58) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/Node.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/Node.md new file mode 100644 index 0000000..8fb7e8e --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/Node.md @@ -0,0 +1,305 @@ +# Node + +## Table of contents + +### Constructors + +- [constructor](Node.md#constructor) + +### Properties + +- [options](Node.md#options) +- [rest](Node.md#rest) +- [retryAttempts](Node.md#retryattempts) +- [state](Node.md#state) +- [stats](Node.md#stats) +- [version](Node.md#version) + +### Accessors + +- [identifier](Node.md#identifier) +- [totalPenalties](Node.md#totalpenalties) + +### Methods + +- [connect](Node.md#connect) +- [disconnect](Node.md#disconnect) +- [getInfo](Node.md#getinfo) +- [getRoutePlannerStatus](Node.md#getrouteplannerstatus) +- [getStats](Node.md#getstats) +- [getVersion](Node.md#getversion) +- [unmarkAllFailedAddress](Node.md#unmarkallfailedaddress) +- [unmarkFailedAddress](Node.md#unmarkfailedaddress) +- [updateStats](Node.md#updatestats) +- [checkOptions](Node.md#checkoptions) + +## Constructors + +### constructor + +• **new Node**(`lavashark`, `options`) + +創建一個 Node 實例 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `lavashark` | [`LavaShark`](LavaShark.md) | LavaShark 實例 | +| `options` | [`NodeOptions`](../types/Node.types.md#nodeoptions) | Node 選項 | + +#### Defined in + +[lib/Node.ts:112](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L112) + +## Properties + +### options + +• `Readonly` **options**: [`NodeOptions`](../types/Node.types.md#nodeoptions) + +#### Defined in + +[lib/Node.ts:34](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L34) + +___ + +### rest + +• `Readonly` **rest**: `RESTController` + +#### Defined in + +[lib/Node.ts:41](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L41) + +___ + +### retryAttempts + +• **retryAttempts**: `number` + +#### Defined in + +[lib/Node.ts:43](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L43) + +___ + +### state + +• **state**: [`NodeState`](../types/enums/enums.NodeState.md) + +#### Defined in + +[lib/Node.ts:45](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L45) + +___ + +### stats + +• **stats**: [`NodeStats`](../types/Node.types.md#nodestats) + +#### Defined in + +[lib/Node.ts:46](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L46) + +___ + +### version + +• `Optional` **version**: `string` + +#### Defined in + +[lib/Node.ts:48](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L48) + +## Accessors + +### identifier + +• `get` **identifier**(): `string` + +#### Returns + +`string` + +#### Defined in + +[lib/Node.ts:149](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L149) + +___ + +### totalPenalties + +• `get` **totalPenalties**(): `number` + +#### Returns + +`number` + +#### Defined in + +[lib/Node.ts:153](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L153) + +## Methods + +### connect + +▸ **connect**(): `void` + +#### Returns + +`void` + +#### Defined in + +[lib/Node.ts:178](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L178) + +___ + +### disconnect + +▸ **disconnect**(): `void` + +#### Returns + +`void` + +#### Defined in + +[lib/Node.ts:207](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L207) + +___ + +### getInfo + +▸ **getInfo**(): `Promise`<[`Info`](../types/Node.types.md#info)\> + +獲取 Lavalink 節點資訊 + +#### Returns + +`Promise`<[`Info`](../types/Node.types.md#info)\> + +#### Defined in + +[lib/Node.ts:227](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L227) + +___ + +### getRoutePlannerStatus + +▸ **getRoutePlannerStatus**(): `Promise`<[`RoutePlannerStatus`](../types/Node.types.md#routeplannerstatus)\> + +獲取路徑規劃器狀態 + +#### Returns + +`Promise`<[`RoutePlannerStatus`](../types/Node.types.md#routeplannerstatus)\> + +#### Defined in + +[lib/Node.ts:246](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L246) + +___ + +### getStats + +▸ **getStats**(): `Promise`<[`NodeStats`](../types/Node.types.md#nodestats)\> + +獲取 Lavalink 節點統計信息 + +#### Returns + +`Promise`<[`NodeStats`](../types/Node.types.md#nodestats)\> + +#### Defined in + +[lib/Node.ts:236](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L236) + +___ + +### getVersion + +▸ **getVersion**(): `Promise`<`string`\> + +獲取 Lavalink 節點版本 + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[lib/Node.ts:217](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L217) + +___ + +### unmarkAllFailedAddress + +▸ **unmarkAllFailedAddress**(): `Promise`<`void`\> + +Unmarks all failed address + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Node.ts:261](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L261) + +___ + +### unmarkFailedAddress + +▸ **unmarkFailedAddress**(`address`): `Promise`<`void`\> + +Unmarks a failed address + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `address` | `string` | The address to unmark | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Node.ts:254](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L254) + +___ + +### updateStats + +▸ **updateStats**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Node.ts:489](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L489) + +___ + +### checkOptions + +▸ `Static` **checkOptions**(`options`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | [`NodeOptions`](../types/Node.types.md#nodeoptions) | + +#### Returns + +`void` + +#### Defined in + +[lib/Node.ts:50](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L50) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/Player.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/Player.md new file mode 100644 index 0000000..40a852f --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/Player.md @@ -0,0 +1,639 @@ +# Player + +## Table of contents + +### Constructors + +- [constructor](Player.md#constructor) + +### Properties + +- [current](Player.md#current) +- [filters](Player.md#filters) +- [guildId](Player.md#guildid) +- [moving](Player.md#moving) +- [node](Player.md#node) +- [paused](Player.md#paused) +- [playing](Player.md#playing) +- [position](Player.md#position) +- [queue](Player.md#queue) +- [repeatMode](Player.md#repeatmode) +- [selfDeaf](Player.md#selfdeaf) +- [selfMute](Player.md#selfmute) +- [state](Player.md#state) +- [textChannelId](Player.md#textchannelid) +- [voiceChannelId](Player.md#voicechannelid) +- [voiceState](Player.md#voicestate) + +### Accessors + +- [exactPosition](Player.md#exactposition) +- [queueDuration](Player.md#queueduration) +- [volume](Player.md#volume) + +### Methods + +- [addTracks](Player.md#addtracks) +- [connect](Player.md#connect) +- [destroy](Player.md#destroy) +- [disconnect](Player.md#disconnect) +- [moveNode](Player.md#movenode) +- [pause](Player.md#pause) +- [ping](Player.md#ping) +- [play](Player.md#play) +- [resume](Player.md#resume) +- [seek](Player.md#seek) +- [sendVoiceUpdate](Player.md#sendvoiceupdate) +- [setRepeatMode](Player.md#setrepeatmode) +- [setSelfDeaf](Player.md#setselfdeaf) +- [setSelfMute](Player.md#setselfmute) +- [setVoiceChannel](Player.md#setvoicechannel) +- [skip](Player.md#skip) +- [update](Player.md#update) +- [checkOptions](Player.md#checkoptions) + +## Constructors + +### constructor + +• **new Player**(`lavashark`, `options`) + +創建一個 Player 實例 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `lavashark` | [`LavaShark`](LavaShark.md) | LavaShark 實例 | +| `options` | [`PlayerOptions`](../types/Player.types.md#playeroptions) | Player 選項 | + +#### Defined in + +[lib/Player.ts:88](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L88) + +## Properties + +### current + +• **current**: ``null`` \| [`Track`](Track.md) + +#### Defined in + +[lib/Player.ts:50](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L50) + +___ + +### filters + +• `Readonly` **filters**: [`Filters`](Filters.md) + +#### Defined in + +[lib/Player.ts:40](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L40) + +___ + +### guildId + +• `Readonly` **guildId**: `string` + +#### Defined in + +[lib/Player.ts:38](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L38) + +___ + +### moving + +• **moving**: `boolean` + +#### Defined in + +[lib/Player.ts:64](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L64) + +___ + +### node + +• **node**: ``null`` \| [`Node`](Node.md) + +#### Defined in + +[lib/Player.ts:36](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L36) + +___ + +### paused + +• **paused**: `boolean` + +#### Defined in + +[lib/Player.ts:59](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L59) + +___ + +### playing + +• **playing**: `boolean` + +#### Defined in + +[lib/Player.ts:58](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L58) + +___ + +### position + +• **position**: `number` + +#### Defined in + +[lib/Player.ts:55](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L55) + +___ + +### queue + +• **queue**: `Queue` + +#### Defined in + +[lib/Player.ts:51](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L51) + +___ + +### repeatMode + +• **repeatMode**: [`RepeatMode`](../types/enums/enums.RepeatMode.md) + +#### Defined in + +[lib/Player.ts:53](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L53) + +___ + +### selfDeaf + +• `Optional` **selfDeaf**: `boolean` + +#### Defined in + +[lib/Player.ts:47](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L47) + +___ + +### selfMute + +• `Optional` **selfMute**: `boolean` + +#### Defined in + +[lib/Player.ts:48](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L48) + +___ + +### state + +• **state**: [`ConnectionState`](../types/enums/enums.ConnectionState.md) + +#### Defined in + +[lib/Player.ts:61](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L61) + +___ + +### textChannelId + +• `Optional` **textChannelId**: ``null`` \| `string` + +#### Defined in + +[lib/Player.ts:45](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L45) + +___ + +### voiceChannelId + +• **voiceChannelId**: `string` + +#### Defined in + +[lib/Player.ts:44](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L44) + +___ + +### voiceState + +• **voiceState**: [`VoiceState`](../types/Player.types.md#voicestate) + +#### Defined in + +[lib/Player.ts:62](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L62) + +## Accessors + +### exactPosition + +• `get` **exactPosition**(): `number` + +Gets the exact track position based on the last playerUpdate packet + +#### Returns + +`number` + +#### Defined in + +[lib/Player.ts:127](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L127) + +___ + +### queueDuration + +• `get` **queueDuration**(): `number` + +獲取隊列的持續時間，以毫秒為單位 + +**`Deprecated`** + +- Use `queue.duration` instead + +#### Returns + +`number` + +#### Defined in + +[lib/Player.ts:142](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L142) + +___ + +### volume + +• `get` **volume**(): `number` + +獲取播放器的音量 + +#### Returns + +`number` + +#### Defined in + +[lib/Player.ts:149](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L149) + +## Methods + +### addTracks + +▸ **addTracks**(`tracks`, `requester`): `void` + +將一個或多個歌曲添加到隊列 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `tracks` | `default` \| [`Track`](Track.md) \| (`default` \| [`Track`](Track.md))[] | 要添加到隊列的歌曲 | +| `requester` | `unknown` | 歌曲的請求者 | + +#### Returns + +`void` + +#### Defined in + +[lib/Player.ts:169](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L169) + +___ + +### connect + +▸ **connect**(): `Promise`<`void`\> + +連接到語音頻道 + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Player.ts:188](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L188) + +___ + +### destroy + +▸ **destroy**(): `Promise`<`void`\> + +摧毀 Player + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Player.ts:239](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L239) + +___ + +### disconnect + +▸ **disconnect**(): `void` + +與語音通道斷開連接 + +#### Returns + +`void` + +#### Defined in + +[lib/Player.ts:218](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L218) + +___ + +### moveNode + +▸ **moveNode**(`node`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `node` | [`Node`](Node.md) | 將 Player 移動到的目標節點 | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Player.ts:253](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L253) + +___ + +### pause + +▸ **pause**(`state?`): `Promise`<`boolean`\> + +暫停或取消暫停 Player + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `state?` | `boolean` | `true` | 是暫停還是取消暫停 Player | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[lib/Player.ts:353](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L353) + +___ + +### ping + +▸ **ping**(): `Promise`<`number`\> + +獲取 Lavalink 客戶端與節點之間的延遲 + +#### Returns + +`Promise`<`number`\> + +- 以毫秒為單位 + +#### Defined in + +[lib/Player.ts:292](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L292) + +___ + +### play + +▸ **play**(`options?`): `Promise`<`void`\> + +Plays a track + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `options?` | [`PlayOptions`](../types/Player.types.md#playoptions) | Play options | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Player.ts:314](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L314) + +___ + +### resume + +▸ **resume**(): `Promise`<`boolean`\> + +恢復播放 Player + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[lib/Player.ts:374](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L374) + +___ + +### seek + +▸ **seek**(`position`): `Promise`<`void`\> + +在音軌中跳轉到特定位置 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `position` | `number` | 要跳轉的位置，以毫秒為單位 | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Player.ts:410](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L410) + +___ + +### sendVoiceUpdate + +▸ **sendVoiceUpdate**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Player.ts:507](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L507) + +___ + +### setRepeatMode + +▸ **setRepeatMode**(`mode`): `void` + +為這個隊列設置重複模式 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `mode` | [`RepeatMode`](../types/enums/enums.RepeatMode.md) | 要使用的重複模式 | + +#### Returns + +`void` + +#### Defined in + +[lib/Player.ts:430](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L430) + +___ + +### setSelfDeaf + +▸ **setSelfDeaf**(`state`): `void` + +設置機器人的自身拒聽狀態 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `state` | `boolean` | 是將機器人自身拒聽還是取消自身拒聽 | + +#### Returns + +`void` + +#### Defined in + +[lib/Player.ts:472](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L472) + +___ + +### setSelfMute + +▸ **setSelfMute**(`state`): `void` + +設置機器人的自身靜音狀態 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `state` | `boolean` | 是將機器人自身靜音還是取消自身靜音 | + +#### Returns + +`void` + +#### Defined in + +[lib/Player.ts:485](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L485) + +___ + +### setVoiceChannel + +▸ **setVoiceChannel**(`channelId`): `void` + +設置 Player 的語音頻道 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `channelId` | `string` | 語音頻道 ID | + +#### Returns + +`void` + +#### Defined in + +[lib/Player.ts:498](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L498) + +___ + +### skip + +▸ **skip**(`amount?`): `Promise`<`boolean`\> + +跳過正在播放的歌曲 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `amount?` | `number` | 要跳過的歌曲數量 | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[lib/Player.ts:382](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L382) + +___ + +### update + +▸ **update**(`state`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `state` | [`PlayerState`](../types/Node.types.md#playerstate) | + +#### Returns + +`void` + +#### Defined in + +[lib/Player.ts:530](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L530) + +___ + +### checkOptions + +▸ `Static` **checkOptions**(`options`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | [`PlayerOptions`](../types/Player.types.md#playeroptions) | + +#### Returns + +`void` + +#### Defined in + +[lib/Player.ts:66](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L66) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/Queue.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/Queue.md new file mode 100644 index 0000000..2e85ad0 --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/Queue.md @@ -0,0 +1,230 @@ +# Queue + +## Table of contents + +### Constructors + +- [constructor](Queue.md#constructor) + +### Properties + +- [tracks](Queue.md#tracks) + +### Accessors + +- [duration](Queue.md#duration) +- [size](Queue.md#size) + +### Methods + +- [add](Queue.md#add) +- [clear](Queue.md#clear) +- [poll](Queue.md#poll) +- [remove](Queue.md#remove) +- [shuffle](Queue.md#shuffle) +- [skipNTracks](Queue.md#skipntracks) + +## Constructors + +### constructor + +• **new Queue**() + +#### Defined in + +[Queue.ts:8](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L8) + +## Properties + +### tracks + +• **tracks**: (`default` \| `default`)[] + +#### Defined in + +[Queue.ts:6](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L6) + +## Accessors + +### duration + +• `get` **duration**(): `number` + +獲取隊列的持續時間，以毫秒為單位 + +#### Returns + +`number` + +#### Defined in + +[Queue.ts:22](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L22) + +___ + +### size + +• `get` **size**(): `number` + +獲取隊列的大小 + +#### Returns + +`number` + +#### Defined in + +[Queue.ts:15](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L15) + +## Methods + +### add + +▸ **add**(`track`): `void` + +[內部使用] 將音軌添加到隊列中。外部使用者應使用 Player.addTracks() 方法代替 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `track` | `default` \| `default` | 要添加到隊列的歌曲 | + +#### Returns + +`void` + +#### Defined in + +[Queue.ts:30](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L30) + +___ + +### clear + +▸ **clear**(): `void` + +清空隊列 + +#### Returns + +`void` + +#### Defined in + +[Queue.ts:67](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L67) + +___ + +### poll + +▸ **poll**(): ``null`` \| `default` \| `default` + +從隊列中取出下一首歌曲 + +#### Returns + +``null`` \| `default` \| `default` + +隊列中的下一個歌曲，如果隊列為空則返回 null + +#### Defined in + +[Queue.ts:38](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L38) + +___ + +### remove + +▸ **remove**(): `boolean` + +移除隊列中的第一首歌曲 + +#### Returns + +`boolean` + +如果歌曲成功移除則返回 true，否則返回 false + +#### Defined in + +[Queue.ts:75](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L75) + +▸ **remove**(`index`): `boolean` + +移除指定位置的歌曲 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `index` | `number` | 要移除的歌曲的索引 | + +#### Returns + +`boolean` + +如果歌曲成功移除則返回 true，否則返回 false + +#### Defined in + +[Queue.ts:81](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L81) + +▸ **remove**(`start`, `end`): `boolean` + +移除指定範圍內的歌曲 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `start` | `number` | 範圍的開始索引 | +| `end` | `number` | 範圍的結束索引 | + +#### Returns + +`boolean` + +如果歌曲成功移除則返回 true，否則返回 false + +#### Defined in + +[Queue.ts:88](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L88) + +___ + +### shuffle + +▸ **shuffle**(): `void` + +隨機洗牌隊列 + +#### Returns + +`void` + +#### Defined in + +[Queue.ts:53](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L53) + +___ + +### skipNTracks + +▸ **skipNTracks**(`n`): `void` + +從隊列中移除 n 首歌曲 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `n` | `number` | 要跳過的歌曲數量 | + +#### Returns + +`void` + +#### Defined in + +[Queue.ts:46](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L46) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/Track.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/Track.md new file mode 100644 index 0000000..9f2494b --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/Track.md @@ -0,0 +1,200 @@ +# Track + +## Table of contents + +### Constructors + +- [constructor](Track.md#constructor) + +### Properties + +- [author](Track.md#author) +- [duration](Track.md#duration) +- [encodedTrack](Track.md#encodedtrack) +- [identifier](Track.md#identifier) +- [isSeekable](Track.md#isseekable) +- [isStream](Track.md#isstream) +- [metadata](Track.md#metadata) +- [position](Track.md#position) +- [requester](Track.md#requester) +- [source](Track.md#source) +- [title](Track.md#title) +- [uri](Track.md#uri) + +### Accessors + +- [thumbnail](Track.md#thumbnail) + +### Methods + +- [setRequester](Track.md#setrequester) + +## Constructors + +### constructor + +• **new Track**(`data`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`ITrack`](../types/interfaces/Track.types.ITrack.md) | + +#### Defined in + +[lib/queue/Track.ts:24](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L24) + +## Properties + +### author + +• `Readonly` **author**: `string` + +#### Defined in + +[lib/queue/Track.ts:10](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L10) + +___ + +### duration + +• `Readonly` **duration**: [`Timestamp`](../types/interfaces/Track.types.Timestamp.md) + +#### Defined in + +[lib/queue/Track.ts:11](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L11) + +___ + +### encodedTrack + +• **encodedTrack**: `string` + +#### Defined in + +[lib/queue/Track.ts:20](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L20) + +___ + +### identifier + +• `Readonly` **identifier**: `string` + +#### Defined in + +[lib/queue/Track.ts:7](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L7) + +___ + +### isSeekable + +• `Readonly` **isSeekable**: `boolean` + +#### Defined in + +[lib/queue/Track.ts:9](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L9) + +___ + +### isStream + +• `Readonly` **isStream**: `boolean` + +#### Defined in + +[lib/queue/Track.ts:12](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L12) + +___ + +### metadata + +• `Optional` **metadata**: [`Metadata`](../types/LavaShark.types.md#metadata) + +#### Defined in + +[lib/queue/Track.ts:18](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L18) + +___ + +### position + +• `Optional` **position**: `number` + +#### Defined in + +[lib/queue/Track.ts:14](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L14) + +___ + +### requester + +• **requester**: `unknown` + +#### Defined in + +[lib/queue/Track.ts:22](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L22) + +___ + +### source + +• `Readonly` **source**: `string` + +#### Defined in + +[lib/queue/Track.ts:13](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L13) + +___ + +### title + +• `Readonly` **title**: `string` + +#### Defined in + +[lib/queue/Track.ts:15](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L15) + +___ + +### uri + +• `Readonly` **uri**: `string` + +#### Defined in + +[lib/queue/Track.ts:16](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L16) + +## Accessors + +### thumbnail + +• `get` **thumbnail**(): ``null`` \| `string` + +#### Returns + +``null`` \| `string` + +#### Defined in + +[lib/queue/Track.ts:42](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L42) + +## Methods + +### setRequester + +▸ **setRequester**(`requester`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `requester` | `unknown` | + +#### Returns + +`void` + +#### Defined in + +[lib/queue/Track.ts:52](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L52) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/_category_.json b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/_category_.json new file mode 100644 index 0000000..ed28d4c --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/classes/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Classes", + "position": 5, + "link": { + "type": "generated-index", + "description": "Available classes." + } +} diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/getting-started.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/getting-started.md new file mode 100644 index 0000000..2d73530 --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/getting-started.md @@ -0,0 +1,145 @@ +--- +sidebar_position: 3 +--- + +# 入門 + +這裡有一個使用 discord.js v14 的示例教程。如果你使用的是較早版本，請更新它。[discord.js 指南](https://discordjs.guide/) 提供了資源來幫助你進行更新過程。 + +### 初始化 LavaShark 和 discord.js 函式庫 + +```js +const { Client, GatewayIntentBits } = require('discord.js'); +const { LavaShark } = require('lavashark'); + +const TOKEN = 'your_token'; // Discord 機器人 token +const prefix = '-'; // 文字命令前綴 + + +const client = new Client({ + intents: [ + GatewayIntentBits.Guilds, + GatewayIntentBits.GuildMessages, + GatewayIntentBits.MessageContent, + GatewayIntentBits.GuildVoiceStates, + ] +}); + +const lavashark = new LavaShark({ + nodes: [ + { + id: 'Node 1', + hostname: 'localhost', + port: 2333, + password: 'youshallnotpass' + } + ], + sendWS: (guildId, payload) => { client.guilds.cache.get(guildId)?.shard.send(payload); } +}); + +client.lavashark = lavashark; +client.login(TOKEN); +``` + +### 註冊事件 + +```js +// -- LavaShark 事件 -- + +// 當音軌開始播放時觸發 +client.lavashark.on('trackStart', (player, track) => { + const channel = client.channels.cache.get(player.textChannelId); + channel.send(`Now playing \`${track.title}\``); +}); + +// 當隊列結束時觸發 +client.lavashark.on('queueEnd', (player) => { + const channel = client.channels.cache.get(player.textChannelId); + channel.send(`Queue ended`); + player.destroy(); +}); + +// 此事件用於捕捉 LavaShark 上發生的任何錯誤 +client.lavashark.on('error', (node, err) => { + console.error('[LavaShark]', `Error on node ${node.identifier}`, err.message); +}); + + +// -- Client 事件 -- + +client.on('ready', () => { + console.log('Ready!'); + + // 啟動 LavaShark 並連接到所有 lavalink 節點 + client.lavashark.start(client.user.id); +}); + +// -- 必需的 -- +client.on('raw', (packet) => client.lavashark.handleVoiceUpdate(packet)); + +``` + +### 命令配置 + +```js +client.on('messageCreate', async message => { + if (message.author.bot) return; + if (message.content.indexOf(prefix) !== 0) return; + + + const args = message.content.slice(prefix.length).trim().split(/ +/g); + const command = args.shift().toLowerCase(); + + if (!message.member.voice.channel) + return message.reply('❌ | You are not connected to an audio channel.'); + + if (message.guild.members.me.voice.channel && message.member.voice.channelId !== message.guild.members.me.voice.channelId) + return message.reply('❌ | You are not on the same audio channel as me.'); + + + console.log('--', command); + + if (command === 'play') { + const track = args[0]; + + const res = await client.lavashark.search(track); + + if (res.loadType === "LOAD_FAILED") { + console.log(`Search Error: ${res.exception.message}`); + return message.reply('❌ | Not found music.'); + } + else if (res.loadType === "NO_MATCHES") { + console.log(`Search Error: NO_MATCHES`); + return message.reply('❌ | No matches.'); + } + + // 創建音頻播放器 + const player = client.lavashark.createPlayer({ + guildId: message.guild.id, + voiceChannelId: message.member.voice.channelId, + textChannelId: message.channel.id, + selfDeaf: true + }); + + try { + await player.connect(); // 連接到語音頻道 + } catch (error) { + console.log(error); + return message.reply({ content: `❌ | I can't join audio channel.`, allowedMentions: { repliedUser: false } }); + } + + if (res.loadType === 'PLAYLIST_LOADED') { + player.addTracks(res.tracks, message.author); + + message.reply(`Playlist \`${res.playlistInfo.name}\` loaded!`); + } + else { + const track = res.tracks[0]; + player.addTracks(res.tracks[0], message.author); + message.reply(`Added \`${track.title}\``); + } + + if (!player.playing) await player.play(); + } +}); +``` \ No newline at end of file diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/server-config.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/server-config.md new file mode 100644 index 0000000..47bfce5 --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/server-config.md @@ -0,0 +1,151 @@ +--- +sidebar_position: 2 +--- + +# 伺服器配置 + +您需要下載 Lavalink 節點 ([lavalink-devs/Lavalink](https://github.com/lavalink-devs/Lavalink)) 並運行它，或者使用其他公共節點。 + +如果你需要公共節點，可以參考以下存儲庫。 +* [DarrenOfficial/lavalink-list](https://github.com/DarrenOfficial/lavalink-list) + + +## 使用二進制部署 + +從[下載伺服器](https://repo.arbjerg.dev/artifacts/lavalink/)、[GitHub releases](https://github.com/lavalink-devs/Lavalink/releases) 或 [GitHub actions](https://github.com/lavalink-devs/Lavalink/actions) 下載二進制文件。 + +在您的工作目錄中放置一個 `application.yml` 文件。（[範例在這裡](https://github.com/lavalink-devs/Lavalink/blob/master/LavalinkServer/application.yml.example)） + +從相同目錄中運行 `java -jar Lavalink.jar` + + + +## 使用Docker部署 + +Docker 鏡像可以在[packages](https://github.com/lavalink-devs/Lavalink/pkgs/container/lavalink)中找到，`v3.7.4` 之前的舊版本可在 [Docker Hub](https://hub.docker.com/r/fredboat/lavalink/) 上獲取。 + +安裝 [Docker](https://docs.docker.com/engine/install/) & [Docker Compose](https://docs.docker.com/compose/install/) + +建立一個名為 `docker-compose.yml` 的檔案，並包含以下內容： + +```yml +version: "3.8" + +services: + lavalink: + image: ghcr.io/lavalink-devs/lavalink:3 # pin the image version to Lavalink v3 + container_name: lavalink + restart: unless-stopped + environment: + - _JAVA_OPTIONS=-Xmx6G # set Java options here + - SERVER_PORT=2333 # set lavalink server port + - LAVALINK_SERVER_PASSWORD=youshallnotpass # set password for lavalink + volumes: + - ./application.yml:/opt/Lavalink/application.yml # mount application.yml from the same directory or use environment variables + - ./plugins/:/opt/Lavalink/plugins/ # persist plugins between restarts, make sure to set the correct permissions (user: 322, group: 322) + networks: + - lavalink + expose: + - 2333 # lavalink exposes port 2333 to connect to for other containers (this is for documentation purposes only) + ports: + - 2333:2333 # you only need this if you want to make your lavalink accessible from outside of containers +networks: + lavalink: # create a lavalink network you can add other containers to, to give them access to Lavalink + name: lavalink +``` + +將 `application.yml` 與 `docker-compose.yml` 放在同一目錄中。 + +```yml +server: # REST and WS server + port: 2333 + address: 0.0.0.0 +plugins: +# name: # Name of the plugin +# some_key: some_value # Some key-value pair for the plugin +# another_key: another_value +lavalink: + plugins: +# - dependency: "group:artifact:version" +# repository: "repository" + server: + password: "youshallnotpass" + sources: + youtube: true + bandcamp: true + soundcloud: true + twitch: true + vimeo: true + http: true + local: false + filters: # All filters are enabled by default + volume: true + equalizer: true + karaoke: true + timescale: true + tremolo: true + vibrato: true + distortion: true + rotation: true + channelMix: true + lowPass: true + bufferDurationMs: 400 # The duration of the NAS buffer. Higher values fare better against longer GC pauses. Duration <= 0 to disable JDA-NAS. Minimum of 40ms, lower values may introduce pauses. + frameBufferDurationMs: 5000 # How many milliseconds of audio to keep buffered + opusEncodingQuality: 10 # Opus encoder quality. Valid values range from 0 to 10, where 10 is best quality but is the most expensive on the CPU. + resamplingQuality: LOW # Quality of resampling operations. Valid values are LOW, MEDIUM and HIGH, where HIGH uses the most CPU. + trackStuckThresholdMs: 10000 # The threshold for how long a track can be stuck. A track is stuck if does not return any audio data. + useSeekGhosting: true # Seek ghosting is the effect where whilst a seek is in progress, the audio buffer is read from until empty, or until seek is ready. + youtubePlaylistLoadLimit: 6 # Number of pages at 100 each + playerUpdateInterval: 5 # How frequently to send player updates to clients, in seconds + youtubeSearchEnabled: true + soundcloudSearchEnabled: true + gc-warnings: true + #ratelimit: + #ipBlocks: ["1.0.0.0/8", "..."] # list of ip blocks + #excludedIps: ["...", "..."] # ips which should be explicit excluded from usage by lavalink + #strategy: "RotateOnBan" # RotateOnBan | LoadBalance | NanoSwitch | RotatingNanoSwitch + #searchTriggersFail: true # Whether a search 429 should trigger marking the ip as failing + #retryLimit: -1 # -1 = use default lavaplayer value | 0 = infinity | >0 = retry will happen this numbers times + #youtubeConfig: # Required for avoiding all age restrictions by YouTube, some restricted videos still can be played without. + #email: "" # Email of Google account + #password: "" # Password of Google account + #httpConfig: # Useful for blocking bad-actors from ip-grabbing your music node and attacking it, this way only the http proxy will be attacked + #proxyHost: "localhost" # Hostname of the proxy, (ip or domain) + #proxyPort: 3128 # Proxy port, 3128 is the default for squidProxy + #proxyUser: "" # Optional user for basic authentication fields, leave blank if you don't use basic auth + #proxyPassword: "" # Password for basic authentication + +metrics: + prometheus: + enabled: false + endpoint: /metrics + +sentry: + dsn: "" + environment: "" +# tags: +# some_key: some_value +# another_key: another_value + +logging: + file: + path: ./logs/ + + level: + root: INFO + lavalink: INFO + + request: + enabled: true + includeClientInfo: true + includeHeaders: false + includeQueryString: true + includePayload: true + maxPayloadLength: 10000 + + + logback: + rollingpolicy: + max-file-size: 1GB + max-history: 30 +``` \ No newline at end of file diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/Filter.types.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/Filter.types.md new file mode 100644 index 0000000..e00394c --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/Filter.types.md @@ -0,0 +1,189 @@ +# @types/Filter + +## Table of contents + +### Type Aliases + +- [ChannelMixOptions](Filter.types.md#channelmixoptions) +- [DistortionOptions](Filter.types.md#distortionoptions) +- [FilterOptions](Filter.types.md#filteroptions) +- [KaraokeOptions](Filter.types.md#karaokeoptions) +- [LowPassOptions](Filter.types.md#lowpassoptions) +- [RotationOptions](Filter.types.md#rotationoptions) +- [TimescaleOptions](Filter.types.md#timescaleoptions) +- [TremoloOptions](Filter.types.md#tremolooptions) +- [VibratoOptions](Filter.types.md#vibratooptions) + +## Type Aliases + +### ChannelMixOptions + +Ƭ **ChannelMixOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `leftToLeft?` | `number` | +| `leftToRight?` | `number` | +| `rightToLeft?` | `number` | +| `rightToRight?` | `number` | + +#### Defined in + +[@types/Filter.types.ts:1](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L1) + +___ + +### DistortionOptions + +Ƭ **DistortionOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `cosOffset?` | `number` | +| `cosScale?` | `number` | +| `offset?` | `number` | +| `scale?` | `number` | +| `sinOffset?` | `number` | +| `sinScale?` | `number` | +| `tanOffset?` | `number` | +| `tanScale?` | `number` | + +#### Defined in + +[@types/Filter.types.ts:8](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L8) + +___ + +### FilterOptions + +Ƭ **FilterOptions**: `Object` + +#### Index signature + +▪ [key: `string`]: `unknown` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `channelMix?` | [`ChannelMixOptions`](Filter.types.md#channelmixoptions) | - | +| `distortion?` | [`DistortionOptions`](Filter.types.md#distortionoptions) | - | +| `equalizer?` | `number`[] | 15 bands [0-14] 25 Hz, 40 Hz, 63 Hz, 100 Hz, 160 Hz, 250 Hz, 400 Hz, 630 Hz, 1 kHz, 1.6 kHz, 2.5 kHz, 4 kHz, 6.3 kHz, 10 kHz, 16 kHz | +| `karaoke?` | [`KaraokeOptions`](Filter.types.md#karaokeoptions) | - | +| `lowPass?` | [`LowPassOptions`](Filter.types.md#lowpassoptions) | - | +| `rotation?` | [`RotationOptions`](Filter.types.md#rotationoptions) | - | +| `timescale?` | [`TimescaleOptions`](Filter.types.md#timescaleoptions) | - | +| `tremolo?` | [`TremoloOptions`](Filter.types.md#tremolooptions) | - | +| `vibrato?` | [`VibratoOptions`](Filter.types.md#vibratooptions) | - | +| `volume?` | `number` | - | + +#### Defined in + +[@types/Filter.types.ts:50](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L50) + +___ + +### KaraokeOptions + +Ƭ **KaraokeOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `filterBand?` | `number` | +| `filterWidth?` | `number` | +| `level?` | `number` | +| `monoLevel?` | `number` | + +#### Defined in + +[@types/Filter.types.ts:19](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L19) + +___ + +### LowPassOptions + +Ƭ **LowPassOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `smoothing?` | `number` | + +#### Defined in + +[@types/Filter.types.ts:26](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L26) + +___ + +### RotationOptions + +Ƭ **RotationOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `rotationHz?` | `number` | + +#### Defined in + +[@types/Filter.types.ts:30](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L30) + +___ + +### TimescaleOptions + +Ƭ **TimescaleOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `pitch?` | `number` | +| `rate?` | `number` | +| `speed?` | `number` | + +#### Defined in + +[@types/Filter.types.ts:34](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L34) + +___ + +### TremoloOptions + +Ƭ **TremoloOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `depth?` | `number` | +| `frequency?` | `number` | + +#### Defined in + +[@types/Filter.types.ts:40](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L40) + +___ + +### VibratoOptions + +Ƭ **VibratoOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `depth?` | `number` | +| `frequency?` | `number` | + +#### Defined in + +[@types/Filter.types.ts:45](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L45) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/LavaShark.types.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/LavaShark.types.md new file mode 100644 index 0000000..903aef2 --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/LavaShark.types.md @@ -0,0 +1,470 @@ +# @types/LavaShark + +## Table of contents + +### Type Aliases + +- [EventListeners](LavaShark.types.md#eventlisteners) +- [IncomingDiscordPayload](LavaShark.types.md#incomingdiscordpayload) +- [LavaSharkOptions](LavaShark.types.md#lavasharkoptions) +- [Metadata](LavaShark.types.md#metadata) +- [OutgoingDiscordPayload](LavaShark.types.md#outgoingdiscordpayload) +- [SEARCH\_SOURCE](LavaShark.types.md#search_source) +- [SpotifyConfig](LavaShark.types.md#spotifyconfig) +- [UNRESOLVED\_SOURCES](LavaShark.types.md#unresolved_sources) +- [VoiceServerUpdateData](LavaShark.types.md#voiceserverupdatedata) +- [VoiceServerUpdatePayload](LavaShark.types.md#voiceserverupdatepayload) +- [VoiceStateUpdatePayload](LavaShark.types.md#voicestateupdatepayload) + +## Type Aliases + +### EventListeners + +#### Type declaration +| Event | listener | +| :------ | :------ | +| `debug` | `message`: `string` | +| `raw` | `node`: [`Node`](../classes/Node.md), `payload`: `unknown` | +| `nodeConnect` | `node`: [`Node`](../classes/Node.md) | +| `nodeResume` | `node`: [`Node`](../classes/Node.md) | +| `nodeDisconnect` | `node`: [`Node`](../classes/Node.md), `code`: `number`, `reason`: `string` | +| `warn` | `node`: [`Node`](../classes/Node.md), `warn`: `string` | +| `error` | `node`: [`Node`](../classes/Node.md), `error`: `Error` | +| `trackAdd` | `player`: [`Player`](../classes/Player.md), `tracks`: [`Track`](../classes/Track.md) \| Array<[`Track`](../classes/Track.md)> | +| `trackStart` | `player`: [`Player`](../classes/Player.md), `track`: [`Track`](../classes/Track.md) | +| `trackEnd` | `player`: [`Player`](../classes/Player.md), `track`: [`Track`](../classes/Track.md), `reason`: [`TrackEndReason`](Node.types.md#trackendreason) | +| `trackStuck` | `player`: [`Player`](../classes/Player.md), `track`: [`Track`](../classes/Track.md), `thresholdMs`: `number` | +| `trackException` | `player`: [`Player`](../classes/Player.md), `track`: `default` \| [`Track`](../classes/Track.md), `exception`: [`LoadException`](REST.types.md#loadexception) & { `cause`: `string` } | +| `playerCreate` | `player`: [`Player`](../classes/Player.md) | +| `playerDestroy` | `player`: [`Player`](../classes/Player.md) | +| `playerDisconnect` | `player`: [`Player`](../classes/Player.md), `code`: `number`, `reason`: `string` | +| `queueEnd` | `player`: [`Player`](../classes/Player.md) | +| `pong` | `node`: [`Node`](../classes/Node.md), `ping?`: `number` | + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Type declaration + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"debug"`` | +| `listener` | (`message`: `string`) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"raw"`` | +| `listener` | (`node`: [`Node`](../classes/Node.md), `payload`: `unknown`) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"nodeConnect"`` | +| `listener` | (`node`: [`Node`](../classes/Node.md)) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"nodeResume"`` | +| `listener` | (`node`: [`Node`](../classes/Node.md)) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"nodeDisconnect"`` | +| `listener` | (`node`: [`Node`](../classes/Node.md), `code`: `number`, `reason`: `string`) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"warn"`` | +| `listener` | (`node`: [`Node`](../classes/Node.md), `warn`: `string`) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`node`: [`Node`](../classes/Node.md), `error`: `Error`) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"trackAdd"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md), `tracks`: [`Track`](../classes/Track.md) \| [`Track`](../classes/Track.md)[]) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"trackStart"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md), `track`: [`Track`](../classes/Track.md)) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"trackEnd"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md), `track`: [`Track`](../classes/Track.md), `reason`: [`TrackEndReason`](Node.types.md#trackendreason)) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"trackStuck"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md), `track`: [`Track`](../classes/Track.md), `thresholdMs`: `number`) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"trackException"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md), `track`: `default` \| [`Track`](../classes/Track.md), `exception`: [`LoadException`](REST.types.md#loadexception) & { `cause`: `string` }) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"playerConnect"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md)) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"playerCreate"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md)) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"playerDestroy"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md)) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"playerDisconnect"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md), `code`: `number`, `reason`: `string`) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"queueEnd"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md)) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pong"`` | +| `listener` | (`node`: [`Node`](../classes/Node.md), `ping?`: `number`) => `void` | + +##### Returns + +`T` + +#### Defined in + +[@types/LavaShark.types.ts:44](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L44) + +___ + +### IncomingDiscordPayload + +Ƭ **IncomingDiscordPayload**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `d?` | `unknown` | +| `op` | `number` | +| `s?` | `number` | +| `t?` | `string` | + +#### Defined in + +[@types/LavaShark.types.ts:9](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L9) + +___ + +### LavaSharkOptions + +Ƭ **LavaSharkOptions**: `Object` + +Main constructor options + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `defaultSearchSource?` | [`SEARCH_SOURCE`](LavaShark.types.md#search_source) | 搜索曲目的默認來源 | +| `disabledSources?` | [`UNRESOLVED_SOURCES`](LavaShark.types.md#unresolved_sources)[] | 禁用 Spotify、Apple Music 或 Deezer | +| `nodes` | [`NodeOptions`](Node.types.md#nodeoptions)[] | lavalink 節點陣列 | +| `sendWS` | (`guildId`: `string`, `payload`: [`OutgoingDiscordPayload`](LavaShark.types.md#outgoingdiscordpayload)) => `void` | 發送語音通道連接有效負載到不和諧的功能 | +| `spotify?` | [`SpotifyConfig`](LavaShark.types.md#spotifyconfig) | Spotify 憑證 | +| `unresolvedSearchSource?` | [`SEARCH_SOURCE`](LavaShark.types.md#search_source) | 搜索未解析曲目的默認來源 | +| `useISRC?` | `boolean` | 是否搜索ISRC來解析曲目 | + +#### Defined in + +[@types/LavaShark.types.ts:81](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L81) + +___ + +### Metadata + +Ƭ **Metadata**: `Pick`<[`TrackInfo`](Track.types.md#trackinfo), ``"title"`` \| ``"author"`` \| ``"uri"``\> & { `duration`: [`Timestamp`](./interfaces/Track.types.Timestamp.md) ; `isrc?`: `string` ; `source`: `string` } + +#### Defined in + +[@types/LavaShark.types.ts:37](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L37) + +___ + +### OutgoingDiscordPayload + +Ƭ **OutgoingDiscordPayload**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `d` | `Record`<`string`, `unknown`\> | +| `op` | `number` | + +#### Defined in + +[@types/LavaShark.types.ts:65](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L65) + +___ + +### SEARCH\_SOURCE + +Ƭ **SEARCH\_SOURCE**: ``"youtube"`` \| ``"youtubemusic"`` \| ``"soundcloud"`` + +#### Defined in + +[@types/LavaShark.types.ts:70](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L70) + +___ + +### SpotifyConfig + +Ƭ **SpotifyConfig**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `clientId` | `string` | +| `clientSecret` | `string` | +| `market?` | `string` | + +#### Defined in + +[@types/LavaShark.types.ts:74](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L74) + +___ + +### UNRESOLVED\_SOURCES + +Ƭ **UNRESOLVED\_SOURCES**: ``"APPLE_MUSIC"`` \| ``"DEEZER"`` \| ``"SPOTIFY"`` + +#### Defined in + +[@types/LavaShark.types.ts:72](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L72) + +___ + +### VoiceServerUpdateData + +Ƭ **VoiceServerUpdateData**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `endpoint` | `string` | +| `guild_id` | `string` | +| `token` | `string` | + +#### Defined in + +[@types/LavaShark.types.ts:26](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L26) + +___ + +### VoiceServerUpdatePayload + +Ƭ **VoiceServerUpdatePayload**: [`IncomingDiscordPayload`](LavaShark.types.md#incomingdiscordpayload) & { `d`: [`VoiceServerUpdateData`](LavaShark.types.md#voiceserverupdatedata) ; `t`: ``"VOICE_SERVER_UPDATE"`` } + +#### Defined in + +[@types/LavaShark.types.ts:32](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L32) + +___ + +### VoiceStateUpdatePayload + +Ƭ **VoiceStateUpdatePayload**: [`IncomingDiscordPayload`](LavaShark.types.md#incomingdiscordpayload) & { `d`: { `channel_id`: `string` \| ``null`` ; `guild_id`: `string` ; `session_id`: `string` ; `user_id`: `string` } ; `t`: ``"VOICE_STATE_UPDATE"`` } + +#### Defined in + +[@types/LavaShark.types.ts:16](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L16) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/Node.types.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/Node.types.md new file mode 100644 index 0000000..45ae61b --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/Node.types.md @@ -0,0 +1,196 @@ +# @types/Node + +## Table of contents + +### Interfaces + +- [PlayerEventPayload](./interfaces/Node.types.PlayerEventPayload.md) +- [TrackEndEvent](./interfaces/Node.types.TrackEndEvent.md) +- [TrackExceptionEvent](./interfaces/Node.types.TrackExceptionEvent.md) +- [TrackStartEvent](./interfaces/Node.types.TrackStartEvent.md) +- [TrackStuckEvent](./interfaces/Node.types.TrackStuckEvent.md) +- [WebSocketClosedEvent](./interfaces/Node.types.WebSocketClosedEvent.md) + +### Type Aliases + +- [Info](Node.types.md#info) +- [NodeOptions](Node.types.md#nodeoptions) +- [NodeStats](Node.types.md#nodestats) +- [PlayerState](Node.types.md#playerstate) +- [RoutePlannerDetails](Node.types.md#routeplannerdetails) +- [RoutePlannerStatus](Node.types.md#routeplannerstatus) +- [TrackEndReason](Node.types.md#trackendreason) +- [version](Node.types.md#version) + +## Type Aliases + +### Info + +Ƭ **Info**: `Object` + +Lavalink Info + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `buildTime` | `number` | +| `filters` | `string`[] | +| `git` | { `branch`: `string` ; `commit`: `string` ; `commitTime`: `number` } | +| `git.branch` | `string` | +| `git.commit` | `string` | +| `git.commitTime` | `number` | +| `jvm` | `string` | +| `lavaplayer` | `string` | +| `plugins` | { `name`: `string` ; `version`: `string` }[] | +| `sourceManagers` | `string`[] | +| `version` | { `major`: `number` ; `minor`: `number` ; `patch`: `number` ; `preRelease`: `string` \| ``null`` ; `semver`: `string` } | +| `version.major` | `number` | +| `version.minor` | `number` | +| `version.patch` | `number` | +| `version.preRelease` | `string` \| ``null`` | +| `version.semver` | `string` | + +#### Defined in + +[@types/Node.types.ts:81](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L81) + +___ + +### NodeOptions + +Ƭ **NodeOptions**: `Object` + +Lavalink node options + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `followRedirects?` | `boolean` | 是否遵循重定向（默認為 false） | +| `hostname` | `string` | 節點主機名 | +| `id?` | `string` | 節點標識符 | +| `maxRetryAttempts?` | `number` | 最大重試次數 | +| `password?` | `string` | 節點密碼 | +| `port` | `number` | 節點端口 | +| `resumeKey?` | `string` | 恢復密鑰 | +| `resumeTimeout?` | `number` | 恢復超時，以秒為單位 | +| `retryAttemptsInterval?` | `number` | 重試嘗試之間的間隔 | +| `secure?` | `boolean` | 是否使用SSL/TLS | + +#### Defined in + +[@types/Node.types.ts:5](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L5) + +___ + +### NodeStats + +Ƭ **NodeStats**: `Object` + +Lavalink node stats + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cpu` | { `cores`: `number` ; `lavalinkLoad`: `number` ; `systemLoad`: `number` } | CPU 統計信息, [0, 1] | +| `cpu.cores` | `number` | - | +| `cpu.lavalinkLoad` | `number` | - | +| `cpu.systemLoad` | `number` | - | +| `frameStats?` | { `deficit`: `number` ; `nulled`: `number` ; `sent`: `number` } | 音頻幀統計 | +| `frameStats.deficit` | `number` | - | +| `frameStats.nulled` | `number` | - | +| `frameStats.sent` | `number` | - | +| `memory` | { `allocated`: `number` ; `free`: `number` ; `reservable`: `number` ; `used`: `number` } | RAM 統計信息，以 byte 為單位 | +| `memory.allocated` | `number` | - | +| `memory.free` | `number` | - | +| `memory.reservable` | `number` | - | +| `memory.used` | `number` | - | +| `players` | `number` | 總共的 Player 數量 | +| `playingPlayers` | `number` | 正在播放的 Player 數量 | +| `uptime` | `number` | lavalink 節點正常運行時間，以秒為單位 | + +#### Defined in + +[@types/Node.types.ts:29](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L29) + +___ + +### PlayerState + +Ƭ **PlayerState**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `connected` | `boolean` | Player 是否已連接 discord 語音網關 | +| `position?` | `number` | Track 位置（以毫秒為單位） | +| `time` | `number` | 選取位置時的 Unix 時間戳 | + +#### Defined in + +[@types/Node.types.ts:145](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L145) + +___ + +### RoutePlannerDetails + +Ƭ **RoutePlannerDetails**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `blockIndex?` | `string` | +| `currentAddressIndex?` | `string` | +| `failingAddresses` | { `address`: `string` ; `failingTime`: `string` ; `failingTimestamp`: `number` }[] | +| `ipBlock` | { `size`: `string` ; `type`: `string` } | +| `ipBlock.size` | `string` | +| `ipBlock.type` | `string` | + +#### Defined in + +[@types/Node.types.ts:63](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L63) + +___ + +### RoutePlannerStatus + +Ƭ **RoutePlannerStatus**: `Object` + +Route planner API + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `class` | `string` \| ``null`` | +| `details` | [`RoutePlannerDetails`](Node.types.md#routeplannerdetails) \| ``null`` | + +#### Defined in + +[@types/Node.types.ts:58](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L58) + +___ + +### TrackEndReason + +Ƭ **TrackEndReason**: ``"FINISHED"`` \| ``"LOAD_FAILED"`` \| ``"STOPPED"`` \| ``"REPLACED"`` \| ``"CLEANUP"`` + +#### Defined in + +[@types/Node.types.ts:117](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L117) + +___ + +### version + +Ƭ **version**: `string` + +Lavalink version + +#### Defined in + +[@types/Node.types.ts:78](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L78) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/Player.types.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/Player.types.md new file mode 100644 index 0000000..6e87636 --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/Player.types.md @@ -0,0 +1,68 @@ +# @types/Player + +## Table of contents + +### Type Aliases + +- [PlayOptions](Player.types.md#playoptions) +- [PlayerOptions](Player.types.md#playeroptions) +- [VoiceState](Player.types.md#voicestate) + +## Type Aliases + +### PlayOptions + +Ƭ **PlayOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `endTime?` | `number` | +| `noReplace?` | `boolean` | +| `pause?` | `boolean` | +| `startTime?` | `number` | + +#### Defined in + +[@types/Player.types.ts:26](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Player.types.ts#L26) + +___ + +### PlayerOptions + +Ƭ **PlayerOptions**: `Object` + +Main constructor options + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `guildId` | `string` | Player 所屬的伺服器 ID | +| `queue?` | `Queue` | Player 將使用的隊列對象 | +| `selfDeaf?` | `boolean` |機器人是否自身拒聽加入語音頻道 | +| `selfMute?` | `boolean` | 機器人是否自身靜音加入語音頻道 | +| `textChannelId?` | `string` | 文字頻道 ID | +| `voiceChannelId` | `string` | 語音頻道 ID | + +#### Defined in + +[@types/Player.types.ts:6](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Player.types.ts#L6) + +___ + +### VoiceState + +Ƭ **VoiceState**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `event?` | [`VoiceServerUpdateData`](LavaShark.types.md#voiceserverupdatedata) | +| `sessionId?` | `string` | + +#### Defined in + +[@types/Player.types.ts:21](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Player.types.ts#L21) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/REST.types.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/REST.types.md new file mode 100644 index 0000000..a81429a --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/REST.types.md @@ -0,0 +1,134 @@ +# @types/REST + +## Table of contents + +### Type Aliases + +- [LavalinkRESTError](REST.types.md#lavalinkresterror) +- [LoadException](REST.types.md#loadexception) +- [LoadResultBase](REST.types.md#loadresultbase) +- [LoadTracksResult](REST.types.md#loadtracksresult) +- [RequestOptions](REST.types.md#requestoptions) +- [SearchResult](REST.types.md#searchresult) +- [UpdatePlayerOptions](REST.types.md#updateplayeroptions) + +## Type Aliases + +### LavalinkRESTError + +Ƭ **LavalinkRESTError**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `error` | `string` | +| `message` | `string` | +| `path` | `string` | +| `status` | `number` | +| `timestamp` | `number` | +| `trace?` | `string` | + +#### Defined in + +[@types/REST.types.ts:24](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/REST.types.ts#L24) + +___ + +### LoadException + +Ƭ **LoadException**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `severity` | ``"COMMON"`` \| ``"SUSPIOUS"`` \| ``"FAULT"`` | + +#### Defined in + +[@types/REST.types.ts:40](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/REST.types.ts#L40) + +___ + +### LoadResultBase + +Ƭ **LoadResultBase**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `exception?` | [`LoadException`](REST.types.md#loadexception) | +| `loadType` | ``"TRACK_LOADED"`` \| ``"PLAYLIST_LOADED"`` \| ``"SEARCH_RESULT"`` \| ``"NO_MATCHES"`` \| ``"LOAD_FAILED"`` | +| `playlistInfo` | [`PlaylistInfo`](Track.types.md#playlistinfo) | + +#### Defined in + +[@types/REST.types.ts:45](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/REST.types.ts#L45) + +___ + +### LoadTracksResult + +Ƭ **LoadTracksResult**: [`LoadResultBase`](REST.types.md#loadresultbase) & { `tracks`: [`ITrack`](./interfaces/Track.types.ITrack.md)[] } + +#### Defined in + +[@types/REST.types.ts:51](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/REST.types.ts#L51) + +___ + +### RequestOptions + +Ƭ **RequestOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `headers?` | `Record`<`string`, `string`\> | +| `json?` | `unknown` | +| `method` | `Dispatcher.HttpMethod` | +| `path` | `string` | + +#### Defined in + +[@types/REST.types.ts:33](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/REST.types.ts#L33) + +___ + +### SearchResult + +Ƭ **SearchResult**: [`LoadResultBase`](REST.types.md#loadresultbase) & { `tracks`: ([`Track`](../classes/Track.md) \| `UnresolvedTrack`)[] } + +#### Defined in + +[@types/REST.types.ts:55](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/REST.types.ts#L55) + +___ + +### UpdatePlayerOptions + +Ƭ **UpdatePlayerOptions**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encodedTrack?` | `string` \| ``null`` | - | +| `endTime?` | `number` | - | +| `filters?` | [`FilterOptions`](Filter.types.md#filteroptions) | - | +| `noReplace?` | `boolean` | - | +| `paused?` | `boolean` | - | +| `position?` | `number` | identifier?: string; | +| `voice?` | { `endpoint`: `string` ; `sessionId`: `string` ; `token`: `string` } | - | +| `voice.endpoint` | `string` | - | +| `voice.sessionId` | `string` | - | +| `voice.token` | `string` | - | +| `volume?` | `number` | - | + +#### Defined in + +[@types/REST.types.ts:8](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/REST.types.ts#L8) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/Track.types.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/Track.types.md new file mode 100644 index 0000000..7caa5e1 --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/Track.types.md @@ -0,0 +1,56 @@ +# @types/Track + +## Table of contents + +### Interfaces + +- [ITrack](./interfaces/Track.types.ITrack.md) +- [Timestamp](./interfaces/Track.types.Timestamp.md) + +### Type Aliases + +- [PlaylistInfo](Track.types.md#playlistinfo) +- [TrackInfo](Track.types.md#trackinfo) + +## Type Aliases + +### PlaylistInfo + +Ƭ **PlaylistInfo**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `duration` | `number` | +| `name` | `string` | +| `selectedTrack` | `number` | + +#### Defined in + +[@types/Track.types.ts:1](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Track.types.ts#L1) + +___ + +### TrackInfo + +Ƭ **TrackInfo**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `author` | `string` | +| `identifier` | `string` | +| `isSeekable` | `boolean` | +| `isStream` | `boolean` | +| `length` | `number` | +| `position` | `number` | +| `sourceName` | `string` \| ``null`` | +| `thumbnail?` | `string` | +| `title` | `string` | +| `uri` | `string` | + +#### Defined in + +[@types/Track.types.ts:7](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Track.types.ts#L7) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/_category_.json b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/_category_.json new file mode 100644 index 0000000..d4b3af7 --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "@types", + "position": 6, + "link": { + "type": "generated-index", + "description": "@types" + } +} diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/enums/enums.ConnectionState.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/enums/enums.ConnectionState.md new file mode 100644 index 0000000..b650d1d --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/enums/enums.ConnectionState.md @@ -0,0 +1,39 @@ +# enums/ConnectionState + +## Table of contents + +### Enumeration Members + +- [CONNECTED](enums.ConnectionState.md#connected) +- [CONNECTING](enums.ConnectionState.md#connecting) +- [DISCONNECTED](enums.ConnectionState.md#disconnected) + +## Enumeration Members + +### CONNECTED + +• **CONNECTED** = ``1`` + +#### Defined in + +[lib/Player.ts:18](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L18) + +___ + +### CONNECTING + +• **CONNECTING** = ``0`` + +#### Defined in + +[lib/Player.ts:17](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L17) + +___ + +### DISCONNECTED + +• **DISCONNECTED** = ``2`` + +#### Defined in + +[lib/Player.ts:19](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L19) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/enums/enums.NodeState.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/enums/enums.NodeState.md new file mode 100644 index 0000000..09e3697 --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/enums/enums.NodeState.md @@ -0,0 +1,39 @@ +# enums/NodeState + +## Table of contents + +### Enumeration Members + +- [CONNECTED](enums.NodeState.md#connected) +- [CONNECTING](enums.NodeState.md#connecting) +- [DISCONNECTED](enums.NodeState.md#disconnected) + +## Enumeration Members + +### CONNECTED + +• **CONNECTED** = ``1`` + +#### Defined in + +[lib/Node.ts:28](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L28) + +___ + +### CONNECTING + +• **CONNECTING** = ``0`` + +#### Defined in + +[lib/Node.ts:27](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L27) + +___ + +### DISCONNECTED + +• **DISCONNECTED** = ``2`` + +#### Defined in + +[lib/Node.ts:29](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L29) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/enums/enums.RepeatMode.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/enums/enums.RepeatMode.md new file mode 100644 index 0000000..6865ddf --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/enums/enums.RepeatMode.md @@ -0,0 +1,44 @@ +# enums/RepeatMode + +The queue repeat mode. This can be one of: +- OFF +- TRACK +- QUEUE + +## Table of contents + +### Enumeration Members + +- [OFF](enums.RepeatMode.md#off) +- [QUEUE](enums.RepeatMode.md#queue) +- [TRACK](enums.RepeatMode.md#track) + +## Enumeration Members + +### OFF + +• **OFF** = ``0`` + +#### Defined in + +[lib/Player.ts:29](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L29) + +___ + +### QUEUE + +• **QUEUE** = ``2`` + +#### Defined in + +[lib/Player.ts:31](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L31) + +___ + +### TRACK + +• **TRACK** = ``1`` + +#### Defined in + +[lib/Player.ts:30](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L30) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.PlayerEventPayload.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.PlayerEventPayload.md new file mode 100644 index 0000000..ed2f9f5 --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.PlayerEventPayload.md @@ -0,0 +1,57 @@ +# @types/Node.PlayerEventPayload + +[@types/Node.types](../Node.types.md).PlayerEventPayload + +Lavalink node incoming payloads + +## Hierarchy + +- **`PlayerEventPayload`** + + ↳ [`TrackStartEvent`](Node.types.TrackStartEvent.md) + + ↳ [`TrackEndEvent`](Node.types.TrackEndEvent.md) + + ↳ [`TrackExceptionEvent`](Node.types.TrackExceptionEvent.md) + + ↳ [`TrackStuckEvent`](Node.types.TrackStuckEvent.md) + + ↳ [`WebSocketClosedEvent`](Node.types.WebSocketClosedEvent.md) + +## Table of contents + +### Properties + +- [guildId](Node.types.PlayerEventPayload.md#guildid) +- [op](Node.types.PlayerEventPayload.md#op) +- [type](Node.types.PlayerEventPayload.md#type) + +## Properties + +### guildId + +• **guildId**: `string` + +#### Defined in + +[@types/Node.types.ts:109](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L109) + +___ + +### op + +• **op**: ``"event"`` + +#### Defined in + +[@types/Node.types.ts:107](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L107) + +___ + +### type + +• **type**: ``"TrackStartEvent"`` \| ``"TrackEndEvent"`` \| ``"TrackExceptionEvent"`` \| ``"TrackStuckEvent"`` \| ``"WebSocketClosedEvent"`` + +#### Defined in + +[@types/Node.types.ts:108](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L108) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.TrackEndEvent.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.TrackEndEvent.md new file mode 100644 index 0000000..c1e2ad3 --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.TrackEndEvent.md @@ -0,0 +1,81 @@ +# @types/Node.TrackEndEvent + +Lavalink node incoming payloads + +## Hierarchy + +- [`PlayerEventPayload`](Node.types.PlayerEventPayload.md) + + ↳ **`TrackEndEvent`** + +## Table of contents + +### Properties + +- [guildId](Node.types.TrackEndEvent.md#guildid) +- [op](Node.types.TrackEndEvent.md#op) +- [reason](Node.types.TrackEndEvent.md#reason) +- [track](Node.types.TrackEndEvent.md#track) +- [type](Node.types.TrackEndEvent.md#type) + +## Properties + +### guildId + +• **guildId**: `string` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[guildId](Node.types.PlayerEventPayload.md#guildid) + +#### Defined in + +[@types/Node.types.ts:109](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L109) + +___ + +### op + +• **op**: ``"event"`` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[op](Node.types.PlayerEventPayload.md#op) + +#### Defined in + +[@types/Node.types.ts:107](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L107) + +___ + +### reason + +• **reason**: [`TrackEndReason`](../Node.types.md#trackendreason) + +#### Defined in + +[@types/Node.types.ts:122](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L122) + +___ + +### track + +• **track**: `string` + +#### Defined in + +[@types/Node.types.ts:121](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L121) + +___ + +### type + +• **type**: ``"TrackEndEvent"`` + +#### Overrides + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[type](Node.types.PlayerEventPayload.md#type) + +#### Defined in + +[@types/Node.types.ts:120](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L120) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.TrackExceptionEvent.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.TrackExceptionEvent.md new file mode 100644 index 0000000..0da05a2 --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.TrackExceptionEvent.md @@ -0,0 +1,83 @@ +# @types/Node.TrackExceptionEvent + +[@types/Node.types](../Node.types.md).TrackExceptionEvent + +Lavalink node incoming payloads + +## Hierarchy + +- [`PlayerEventPayload`](Node.types.PlayerEventPayload.md) + + ↳ **`TrackExceptionEvent`** + +## Table of contents + +### Properties + +- [exception](Node.types.TrackExceptionEvent.md#exception) +- [guildId](Node.types.TrackExceptionEvent.md#guildid) +- [op](Node.types.TrackExceptionEvent.md#op) +- [track](Node.types.TrackExceptionEvent.md#track) +- [type](Node.types.TrackExceptionEvent.md#type) + +## Properties + +### exception + +• **exception**: [`LoadException`](../REST.types.md#loadexception) & { `cause`: `string` } + +#### Defined in + +[@types/Node.types.ts:128](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L128) + +___ + +### guildId + +• **guildId**: `string` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[guildId](Node.types.PlayerEventPayload.md#guildid) + +#### Defined in + +[@types/Node.types.ts:109](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L109) + +___ + +### op + +• **op**: ``"event"`` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[op](Node.types.PlayerEventPayload.md#op) + +#### Defined in + +[@types/Node.types.ts:107](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L107) + +___ + +### track + +• **track**: `string` + +#### Defined in + +[@types/Node.types.ts:127](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L127) + +___ + +### type + +• **type**: ``"TrackExceptionEvent"`` + +#### Overrides + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[type](Node.types.PlayerEventPayload.md#type) + +#### Defined in + +[@types/Node.types.ts:126](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L126) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.TrackStartEvent.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.TrackStartEvent.md new file mode 100644 index 0000000..b67b9b9 --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.TrackStartEvent.md @@ -0,0 +1,72 @@ +# @types/Node.TrackStartEvent + +[@types/Node.types](../Node.types.md).TrackStartEvent + +Lavalink node incoming payloads + +## Hierarchy + +- [`PlayerEventPayload`](Node.types.PlayerEventPayload.md) + + ↳ **`TrackStartEvent`** + +## Table of contents + +### Properties + +- [guildId](Node.types.TrackStartEvent.md#guildid) +- [op](Node.types.TrackStartEvent.md#op) +- [track](Node.types.TrackStartEvent.md#track) +- [type](Node.types.TrackStartEvent.md#type) + +## Properties + +### guildId + +• **guildId**: `string` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[guildId](Node.types.PlayerEventPayload.md#guildid) + +#### Defined in + +[@types/Node.types.ts:109](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L109) + +___ + +### op + +• **op**: ``"event"`` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[op](Node.types.PlayerEventPayload.md#op) + +#### Defined in + +[@types/Node.types.ts:107](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L107) + +___ + +### track + +• **track**: `string` + +#### Defined in + +[@types/Node.types.ts:114](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L114) + +___ + +### type + +• **type**: ``"TrackStartEvent"`` + +#### Overrides + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[type](Node.types.PlayerEventPayload.md#type) + +#### Defined in + +[@types/Node.types.ts:113](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L113) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.TrackStuckEvent.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.TrackStuckEvent.md new file mode 100644 index 0000000..e79d68e --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.TrackStuckEvent.md @@ -0,0 +1,83 @@ +# @types/Node.TrackStuckEvent + +[@types/Node.types](../Node.types.md).TrackStuckEvent + +Lavalink node incoming payloads + +## Hierarchy + +- [`PlayerEventPayload`](Node.types.PlayerEventPayload.md) + + ↳ **`TrackStuckEvent`** + +## Table of contents + +### Properties + +- [guildId](Node.types.TrackStuckEvent.md#guildid) +- [op](Node.types.TrackStuckEvent.md#op) +- [thresholdMs](Node.types.TrackStuckEvent.md#thresholdms) +- [track](Node.types.TrackStuckEvent.md#track) +- [type](Node.types.TrackStuckEvent.md#type) + +## Properties + +### guildId + +• **guildId**: `string` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[guildId](Node.types.PlayerEventPayload.md#guildid) + +#### Defined in + +[@types/Node.types.ts:109](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L109) + +___ + +### op + +• **op**: ``"event"`` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[op](Node.types.PlayerEventPayload.md#op) + +#### Defined in + +[@types/Node.types.ts:107](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L107) + +___ + +### thresholdMs + +• **thresholdMs**: `number` + +#### Defined in + +[@types/Node.types.ts:136](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L136) + +___ + +### track + +• **track**: `string` + +#### Defined in + +[@types/Node.types.ts:135](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L135) + +___ + +### type + +• **type**: ``"TrackStuckEvent"`` + +#### Overrides + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[type](Node.types.PlayerEventPayload.md#type) + +#### Defined in + +[@types/Node.types.ts:134](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L134) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.WebSocketClosedEvent.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.WebSocketClosedEvent.md new file mode 100644 index 0000000..935dca2 --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Node.types.WebSocketClosedEvent.md @@ -0,0 +1,94 @@ +# @types/Node.WebSocketClosedEvent + +[@types/Node.types](../Node.types.md).WebSocketClosedEvent + +Lavalink node incoming payloads + +## Hierarchy + +- [`PlayerEventPayload`](Node.types.PlayerEventPayload.md) + + ↳ **`WebSocketClosedEvent`** + +## Table of contents + +### Properties + +- [byRemote](Node.types.WebSocketClosedEvent.md#byremote) +- [code](Node.types.WebSocketClosedEvent.md#code) +- [guildId](Node.types.WebSocketClosedEvent.md#guildid) +- [op](Node.types.WebSocketClosedEvent.md#op) +- [reason](Node.types.WebSocketClosedEvent.md#reason) +- [type](Node.types.WebSocketClosedEvent.md#type) + +## Properties + +### byRemote + +• **byRemote**: `boolean` + +#### Defined in + +[@types/Node.types.ts:142](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L142) + +___ + +### code + +• **code**: `number` + +#### Defined in + +[@types/Node.types.ts:140](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L140) + +___ + +### guildId + +• **guildId**: `string` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[guildId](Node.types.PlayerEventPayload.md#guildid) + +#### Defined in + +[@types/Node.types.ts:109](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L109) + +___ + +### op + +• **op**: ``"event"`` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[op](Node.types.PlayerEventPayload.md#op) + +#### Defined in + +[@types/Node.types.ts:107](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L107) + +___ + +### reason + +• **reason**: `string` + +#### Defined in + +[@types/Node.types.ts:141](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L141) + +___ + +### type + +• **type**: ``"TrackStartEvent"`` \| ``"TrackEndEvent"`` \| ``"TrackExceptionEvent"`` \| ``"TrackStuckEvent"`` \| ``"WebSocketClosedEvent"`` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[type](Node.types.PlayerEventPayload.md#type) + +#### Defined in + +[@types/Node.types.ts:108](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L108) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Track.types.ITrack.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Track.types.ITrack.md new file mode 100644 index 0000000..adb5c48 --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Track.types.ITrack.md @@ -0,0 +1,30 @@ +# @types/Track.ITrack + +[@types/Track.types](../Track.types.md).ITrack + +## Table of contents + +### Properties + +- [info](Track.types.ITrack.md#info) +- [track](Track.types.ITrack.md#track) + +## Properties + +### info + +• **info**: [`TrackInfo`](../Track.types.md#trackinfo) + +#### Defined in + +[@types/Track.types.ts:22](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Track.types.ts#L22) + +___ + +### track + +• **track**: `string` + +#### Defined in + +[@types/Track.types.ts:21](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Track.types.ts#L21) diff --git a/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Track.types.Timestamp.md b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Track.types.Timestamp.md new file mode 100644 index 0000000..391fa7c --- /dev/null +++ b/apps/website/i18n/zh-TW/docusaurus-plugin-content-docs/version-1.2.0/types/interfaces/Track.types.Timestamp.md @@ -0,0 +1,30 @@ +# @types/Track.Timestamp + +[@types/Track.types](../Track.types.md).Timestamp + +## Table of contents + +### Properties + +- [label](Track.types.Timestamp.md#label) +- [value](Track.types.Timestamp.md#value) + +## Properties + +### label + +• **label**: `string` + +#### Defined in + +[@types/Track.types.ts:26](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Track.types.ts#L26) + +___ + +### value + +• **value**: `number` + +#### Defined in + +[@types/Track.types.ts:27](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Track.types.ts#L27) diff --git a/apps/website/versioned_docs/version-1.2.0/FAQ.md b/apps/website/versioned_docs/version-1.2.0/FAQ.md new file mode 100644 index 0000000..628588c --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/FAQ.md @@ -0,0 +1,19 @@ +--- +sidebar_position: 4 +--- + +# FAQ + +### Node can't connect +If your node is unable to connect, please check the version of your Lavalink node. +**LavaShark v1** does not support **Lavalink v3** nodes without **REST API**. +It is only compatible with Lavalink nodes of version **3.7.x**. + + +### The bot joined the voice channel, but there was no sound playing. +Check if you have registered the [`GuildVoiceStates`](https://discord-api-types.dev/api/discord-api-types-v10/enum/GatewayIntentBits) gateway intent +and if you have registered the `raw` event on the Discord client. + +```js +client.on('raw', (packet) => client.lavashark.handleVoiceUpdate(packet)); +``` \ No newline at end of file diff --git a/apps/website/versioned_docs/version-1.2.0/README.md b/apps/website/versioned_docs/version-1.2.0/README.md new file mode 100644 index 0000000..47c08c9 --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/README.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 1 +--- + +# LavaShark + +A lightweight Lavalink client built with Node.js. + +### Features +* Stable + +* Object-oriented + +* Speedy and efficient + +:::caution +Only compatible with Lavalink nodes that support **REST API** (version 3.7.x). +::: + +## Installation + +:::tip +Node.js **16.9** or higher is required. +* You need at least one [**Lavalink Server**](https://github.com/lavalink-devs/Lavalink) node to run. Please refer to the [**Server Configuration**](./server-config.md) section for setting up the configuration. +::: + +```bash +$ npm install lavashark +# or +$ yarn add lavashark +``` + + +## Other resources +* [Github repository](https://github.com/hmes98318/LavaShark) +* [NPM page](https://www.npmjs.com/package/lavashark) +* [Discord server](https://discord.gg/7rQEx7SPGr) + diff --git a/apps/website/versioned_docs/version-1.2.0/classes/Filters.md b/apps/website/versioned_docs/version-1.2.0/classes/Filters.md new file mode 100644 index 0000000..897bd4e --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/classes/Filters.md @@ -0,0 +1,382 @@ +# Filters + +## Table of contents + +### Constructors + +- [constructor](Filters.md#constructor) + +### Accessors + +- [active](Filters.md#active) +- [enabled](Filters.md#enabled) + +### Methods + +- [apply](Filters.md#apply) +- [clear](Filters.md#clear) +- [set](Filters.md#set) +- [setChannelMix](Filters.md#setchannelmix) +- [setDistortion](Filters.md#setdistortion) +- [setEqualizer](Filters.md#setequalizer) +- [setKaraoke](Filters.md#setkaraoke) +- [setLowPass](Filters.md#setlowpass) +- [setRotation](Filters.md#setrotation) +- [setTimescale](Filters.md#settimescale) +- [setTremolo](Filters.md#settremolo) +- [setVibrato](Filters.md#setvibrato) +- [setVolume](Filters.md#setvolume) + +## Constructors + +### constructor + +• **new Filters**(`player`) + +Creates an instance of filters + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `player` | [`Player`](Player.md) | + +#### Defined in + +[lib/Filters.ts:25](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L25) + +## Accessors + +### active + +• `get` **active**(): [`FilterOptions`](../types/Filter.types.md#filteroptions) + +Gets a copy of active filters object + +#### Returns + +[`FilterOptions`](../types/Filter.types.md#filteroptions) + +#### Defined in + +[lib/Filters.ts:36](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L36) + +___ + +### enabled + +• `get` **enabled**(): `boolean` + +Checks if some filter is enabled + +#### Returns + +`boolean` + +#### Defined in + +[lib/Filters.ts:31](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L31) + +## Methods + +### apply + +▸ **apply**(): `void` + +Sends filters payload to Lavalink Node + +#### Returns + +`void` + +#### Defined in + +[lib/Filters.ts:245](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L245) + +___ + +### clear + +▸ **clear**(): `void` + +Clears all active filters + +#### Returns + +`void` + +#### Defined in + +[lib/Filters.ts:238](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L238) + +___ + +### set + +▸ **set**(`filters`): `void` + +Sets all filters + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `filters` | [`FilterOptions`](../types/Filter.types.md#filteroptions) | + +#### Returns + +`void` + +#### Defined in + +[lib/Filters.ts:224](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L224) + +___ + +### setChannelMix + +▸ **setChannelMix**(`options`, `apply?`): [`Filters`](Filters.md) + +Sets ChannelMix filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| [`ChannelMixOptions`](../types/Filter.types.md#channelmixoptions) | `undefined` | The channel mix options | +| `apply` | `boolean` | `true` | Whether to send filter payload to Lavalink or not | + +#### Returns + +[`Filters`](Filters.md) + +The filters instance, for chaining calls + +#### Defined in + +[lib/Filters.ts:50](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L50) + +___ + +### setDistortion + +▸ **setDistortion**(`options`, `apply?`): [`Filters`](Filters.md) + +Sets Distortion filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| [`DistortionOptions`](../types/Filter.types.md#distortionoptions) | `undefined` | The distortion options | +| `apply` | `boolean` | `true` | Whether to send filter payload to Lavalink or not | + +#### Returns + +[`Filters`](Filters.md) + +The filters instance, for chaining calls + +#### Defined in + +[lib/Filters.ts:73](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L73) + +___ + +### setEqualizer + +▸ **setEqualizer**(`options`, `apply?`): [`Filters`](Filters.md) + +Sets Equalizer filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| `number`[] | `undefined` | The equalizer band array | +| `apply` | `boolean` | `true` | Whether to send filter payload to Lavalink or not | + +#### Returns + +[`Filters`](Filters.md) + +The filters instance, for chaining calls + +#### Defined in + +[lib/Filters.ts:88](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L88) + +___ + +### setKaraoke + +▸ **setKaraoke**(`options`, `apply?`): [`Filters`](Filters.md) + +Sets Karaoke filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| [`KaraokeOptions`](../types/Filter.types.md#karaokeoptions) | `undefined` | The karaoke options | +| `apply` | `boolean` | `true` | Whether to send filter payload to Lavalink or not | + +#### Returns + +[`Filters`](Filters.md) + +The filters instance, for chaining calls + +#### Defined in + +[lib/Filters.ts:114](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L114) + +___ + +### setLowPass + +▸ **setLowPass**(`options`, `apply?`): [`Filters`](Filters.md) + +Sets LowPass filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| [`LowPassOptions`](../types/Filter.types.md#lowpassoptions) | `undefined` | The lowpass options | +| `apply` | `boolean` | `true` | Whether to send filter payload to Lavalink or not | + +#### Returns + +[`Filters`](Filters.md) + +The filters instance, for chaining calls + +#### Defined in + +[lib/Filters.ts:130](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L130) + +___ + +### setRotation + +▸ **setRotation**(`options`, `apply?`): [`Filters`](Filters.md) + +Sets Rotation filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| [`RotationOptions`](../types/Filter.types.md#rotationoptions) | `undefined` | The rotation options | +| `apply` | `boolean` | `true` | Whether to send filter payload to Lavalink or not | + +#### Returns + +[`Filters`](Filters.md) + +The filters instance, for chaining calls + +#### Defined in + +[lib/Filters.ts:146](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L146) + +___ + +### setTimescale + +▸ **setTimescale**(`options`, `apply?`): [`Filters`](Filters.md) + +Sets Timescale filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| [`TimescaleOptions`](../types/Filter.types.md#timescaleoptions) | `undefined` | The timescale options | +| `apply` | `boolean` | `true` | Whether to send filter payload to Lavalink or not | + +#### Returns + +[`Filters`](Filters.md) + +The filters instance, for chaining calls + +#### Defined in + +[lib/Filters.ts:164](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L164) + +___ + +### setTremolo + +▸ **setTremolo**(`options`, `apply?`): [`Filters`](Filters.md) + +Sets Tremolo filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| [`TremoloOptions`](../types/Filter.types.md#tremolooptions) | `undefined` | The tremolo options | +| `apply` | `boolean` | `true` | Whether to send filter payload to Lavalink or not | + +#### Returns + +[`Filters`](Filters.md) + +The filters instance, for chaining calls + +#### Defined in + +[lib/Filters.ts:181](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L181) + +___ + +### setVibrato + +▸ **setVibrato**(`options`, `apply?`): [`Filters`](Filters.md) + +Sets Vibrato filter + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | ``null`` \| [`VibratoOptions`](../types/Filter.types.md#vibratooptions) | `undefined` | The vibrato options | +| `apply` | `boolean` | `true` | Whether to send filter payload to Lavalink or not | + +#### Returns + +[`Filters`](Filters.md) + +The filters instance, for chaining calls + +#### Defined in + +[lib/Filters.ts:198](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L198) + +___ + +### setVolume + +▸ **setVolume**(`vol`, `apply?`): [`Filters`](Filters.md) + +Sets the volume + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `vol` | `number` | `undefined` | The volume to set [0,500] | +| `apply` | `boolean` | `true` | Whether to send filter payload to Lavalink or not | + +#### Returns + +[`Filters`](Filters.md) + +The filters instance, for chaining calls + +#### Defined in + +[lib/Filters.ts:213](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Filters.ts#L213) diff --git a/apps/website/versioned_docs/version-1.2.0/classes/LavaShark.md b/apps/website/versioned_docs/version-1.2.0/classes/LavaShark.md new file mode 100644 index 0000000..ad6cda6 --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/classes/LavaShark.md @@ -0,0 +1,384 @@ +# LavaShark + +## Table of contents + +### Constructors + +- [constructor](LavaShark.md#constructor) + +### Properties + +- [clientId](LavaShark.md#clientid) +- [nodes](LavaShark.md#nodes) +- [on](LavaShark.md#on) +- [once](LavaShark.md#once) +- [players](LavaShark.md#players) +- [sendWS](LavaShark.md#sendws) +- [unresolvedSearchSource](LavaShark.md#unresolvedsearchsource) +- [useISRC](LavaShark.md#useisrc) + +### Methods + +- [addExternalSource](LavaShark.md#addexternalsource) +- [bestNode](LavaShark.md#bestnode) +- [createPlayer](LavaShark.md#createplayer) +- [decodeTrack](LavaShark.md#decodetrack) +- [decodeTracks](LavaShark.md#decodetracks) +- [getPlayer](LavaShark.md#getplayer) +- [handleVoiceUpdate](LavaShark.md#handlevoiceupdate) +- [nodesPing](LavaShark.md#nodesping) +- [search](LavaShark.md#search) +- [start](LavaShark.md#start) +- [checkOptions](LavaShark.md#checkoptions) + +## Constructors + +### constructor + +• **new LavaShark**(`options`) + +Create a new LavaShark instance + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `options` | [`LavaSharkOptions`](../types/LavaShark.types.md#lavasharkoptions) | The LavaShark options | + +#### Defined in + +[lib/LavaShark.ts:114](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L114) + +## Properties + +### clientId + +• **clientId**: `string` + +#### Defined in + +[lib/LavaShark.ts:31](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L31) + +___ + +### nodes + +• **nodes**: [`Node`](Node.md)[] + +#### Defined in + +[lib/LavaShark.ts:32](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L32) + +___ + +### on + +• **on**: [`EventListeners`](../types/LavaShark.types.md#eventlisteners)<[`LavaShark`](LavaShark.md)\> + +#### Defined in + +[lib/LavaShark.ts:27](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L27) + +___ + +### once + +• **once**: [`EventListeners`](../types/LavaShark.types.md#eventlisteners)<[`LavaShark`](LavaShark.md)\> + +#### Defined in + +[lib/LavaShark.ts:26](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L26) + +___ + +### players + +• **players**: `Map`<`string`, [`Player`](Player.md)\> + + + +#### Defined in + +[lib/LavaShark.ts:41](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L41) + +___ + +### sendWS + +• `Readonly` **sendWS**: (`guildId`: `string`, `payload`: [`OutgoingDiscordPayload`](../types/LavaShark.types.md#outgoingdiscordpayload)) => `void` + +#### Type declaration + +▸ (`guildId`, `payload`): `void` + +**`Example`** + +```ts +sendWS: (guildId, payload) => { + client.guilds.cache.get(guildId)?.shard.send(payload); +} +``` + +##### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `guildId` | `string` | guildId | +| `payload` | [`OutgoingDiscordPayload`](../types/LavaShark.types.md#outgoingdiscordpayload) | payload | + +##### Returns + +`void` + +#### Defined in + +[lib/LavaShark.ts:56](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L56) + +___ + +### unresolvedSearchSource + +• `Readonly` **unresolvedSearchSource**: [`SEARCH_SOURCE`](../types/LavaShark.types.md#search_source) + +#### Defined in + +[lib/LavaShark.ts:35](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L35) + +___ + +### useISRC + +• `Readonly` **useISRC**: `boolean` + +#### Defined in + +[lib/LavaShark.ts:36](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L36) + +## Methods + +### addExternalSource + +▸ **addExternalSource**(`extSource`): `void` + +Adds an external source that produces a SearchResult with UnresolvedTracks + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `extSource` | `AbstractExternalSource` | The external source | + +#### Returns + +`void` + +#### Defined in + +[lib/LavaShark.ts:181](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L181) + +___ + +### bestNode + +▸ **bestNode**(): `Promise`<[`Node`](Node.md)\> + +#### Returns + +`Promise`<[`Node`](Node.md)\> + +#### Defined in + +[lib/LavaShark.ts:151](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L151) + +___ + +### createPlayer + +▸ **createPlayer**(`options`): [`Player`](Player.md) + +Creates a new player or returns an existing one + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `options` | [`PlayerOptions`](../types/Player.types.md#playeroptions) | The player options | + +#### Returns + +[`Player`](Player.md) + +#### Defined in + +[lib/LavaShark.ts:224](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L224) + +___ + +### decodeTrack + +▸ **decodeTrack**(`encodedTrack`): `Promise`<[`Track`](Track.md)\> + +Decodes a track by its base64 string + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encodedTrack` | `string` | The base64 encoded track | + +#### Returns + +`Promise`<[`Track`](Track.md)\> + +#### Defined in + +[lib/LavaShark.ts:194](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L194) + +___ + +### decodeTracks + +▸ **decodeTracks**(`encodedTracks`): `Promise`<[`Track`](Track.md)[]\> + +Decodes multiple tracks by their base64 string + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encodedTracks` | `string`[] | The base64 encoded tracks | + +#### Returns + +`Promise`<[`Track`](Track.md)[]\> + +#### Defined in + +[lib/LavaShark.ts:206](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L206) + +___ + +### getPlayer + +▸ **getPlayer**(`guildId`): ``null`` \| [`Player`](Player.md) + +Retrieve an existing player using the guild id + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `guildId` | `string` | The guild id that player belongs to | + +#### Returns + +``null`` \| [`Player`](Player.md) + +#### Defined in + +[lib/LavaShark.ts:242](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L242) + +___ + +### handleVoiceUpdate + +▸ **handleVoiceUpdate**(`payload`): `void` + +Handles voice state & voice server update packets + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | [`IncomingDiscordPayload`](../types/LavaShark.types.md#incomingdiscordpayload) | The voice packet | + +#### Returns + +`void` + +#### Defined in + +[lib/LavaShark.ts:323](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L323) + +___ + +### nodesPing + +▸ **nodesPing**(): `Promise`<`number`[]\> + +Get the ping for all nodes + +#### Returns + +`Promise`<`number`[]\> + +- All node latency, in milliseconds + +#### Defined in + +[lib/LavaShark.ts:377](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L377) + +___ + +### search + +▸ **search**(`query`, `source?`): `Promise`<[`SearchResult`](../types/REST.types.md#searchresult)\> + +Search by song name or use music URL + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `query` | `string` | The query to search for | +| `source?` | [`SEARCH_SOURCE`](../types/LavaShark.types.md#search_source) | The search source | + +#### Returns + +`Promise`<[`SearchResult`](../types/REST.types.md#searchresult)\> + +#### Defined in + +[lib/LavaShark.ts:263](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L263) + +___ + +### start + +▸ **start**(`clientId`): `void` + +Connects to all lavalink nodes + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `clientId` | `string` | The client id (BOT) | + +#### Returns + +`void` + +#### Defined in + +[lib/LavaShark.ts:307](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L307) + +___ + +### checkOptions + +▸ `Static` **checkOptions**(`options`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | [`LavaSharkOptions`](../types/LavaShark.types.md#lavasharkoptions) | + +#### Returns + +`void` + +#### Defined in + +[lib/LavaShark.ts:58](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/LavaShark.ts#L58) diff --git a/apps/website/versioned_docs/version-1.2.0/classes/Node.md b/apps/website/versioned_docs/version-1.2.0/classes/Node.md new file mode 100644 index 0000000..6f54c0d --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/classes/Node.md @@ -0,0 +1,305 @@ +# Node + +## Table of contents + +### Constructors + +- [constructor](Node.md#constructor) + +### Properties + +- [options](Node.md#options) +- [rest](Node.md#rest) +- [retryAttempts](Node.md#retryattempts) +- [state](Node.md#state) +- [stats](Node.md#stats) +- [version](Node.md#version) + +### Accessors + +- [identifier](Node.md#identifier) +- [totalPenalties](Node.md#totalpenalties) + +### Methods + +- [connect](Node.md#connect) +- [disconnect](Node.md#disconnect) +- [getInfo](Node.md#getinfo) +- [getRoutePlannerStatus](Node.md#getrouteplannerstatus) +- [getStats](Node.md#getstats) +- [getVersion](Node.md#getversion) +- [unmarkAllFailedAddress](Node.md#unmarkallfailedaddress) +- [unmarkFailedAddress](Node.md#unmarkfailedaddress) +- [updateStats](Node.md#updatestats) +- [checkOptions](Node.md#checkoptions) + +## Constructors + +### constructor + +• **new Node**(`lavashark`, `options`) + +Create a new Node instance + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `lavashark` | [`LavaShark`](LavaShark.md) | The LavaShark instance | +| `options` | [`NodeOptions`](../types/Node.types.md#nodeoptions) | The node options | + +#### Defined in + +[lib/Node.ts:112](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L112) + +## Properties + +### options + +• `Readonly` **options**: [`NodeOptions`](../types/Node.types.md#nodeoptions) + +#### Defined in + +[lib/Node.ts:34](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L34) + +___ + +### rest + +• `Readonly` **rest**: `RESTController` + +#### Defined in + +[lib/Node.ts:41](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L41) + +___ + +### retryAttempts + +• **retryAttempts**: `number` + +#### Defined in + +[lib/Node.ts:43](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L43) + +___ + +### state + +• **state**: [`NodeState`](../types/enums/enums.NodeState.md) + +#### Defined in + +[lib/Node.ts:45](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L45) + +___ + +### stats + +• **stats**: [`NodeStats`](../types/Node.types.md#nodestats) + +#### Defined in + +[lib/Node.ts:46](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L46) + +___ + +### version + +• `Optional` **version**: `string` + +#### Defined in + +[lib/Node.ts:48](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L48) + +## Accessors + +### identifier + +• `get` **identifier**(): `string` + +#### Returns + +`string` + +#### Defined in + +[lib/Node.ts:149](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L149) + +___ + +### totalPenalties + +• `get` **totalPenalties**(): `number` + +#### Returns + +`number` + +#### Defined in + +[lib/Node.ts:153](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L153) + +## Methods + +### connect + +▸ **connect**(): `void` + +#### Returns + +`void` + +#### Defined in + +[lib/Node.ts:178](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L178) + +___ + +### disconnect + +▸ **disconnect**(): `void` + +#### Returns + +`void` + +#### Defined in + +[lib/Node.ts:207](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L207) + +___ + +### getInfo + +▸ **getInfo**(): `Promise`<[`Info`](../types/Node.types.md#info)\> + +Get the Lavalink Node information + +#### Returns + +`Promise`<[`Info`](../types/Node.types.md#info)\> + +#### Defined in + +[lib/Node.ts:227](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L227) + +___ + +### getRoutePlannerStatus + +▸ **getRoutePlannerStatus**(): `Promise`<[`RoutePlannerStatus`](../types/Node.types.md#routeplannerstatus)\> + +Gets the route planner status + +#### Returns + +`Promise`<[`RoutePlannerStatus`](../types/Node.types.md#routeplannerstatus)\> + +#### Defined in + +[lib/Node.ts:246](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L246) + +___ + +### getStats + +▸ **getStats**(): `Promise`<[`NodeStats`](../types/Node.types.md#nodestats)\> + +Get the Lavalink Node stats + +#### Returns + +`Promise`<[`NodeStats`](../types/Node.types.md#nodestats)\> + +#### Defined in + +[lib/Node.ts:236](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L236) + +___ + +### getVersion + +▸ **getVersion**(): `Promise`<`string`\> + +Get the Lavalink Node version + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[lib/Node.ts:217](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L217) + +___ + +### unmarkAllFailedAddress + +▸ **unmarkAllFailedAddress**(): `Promise`<`void`\> + +Unmarks all failed address + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Node.ts:261](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L261) + +___ + +### unmarkFailedAddress + +▸ **unmarkFailedAddress**(`address`): `Promise`<`void`\> + +Unmarks a failed address + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `address` | `string` | The address to unmark | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Node.ts:254](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L254) + +___ + +### updateStats + +▸ **updateStats**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Node.ts:489](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L489) + +___ + +### checkOptions + +▸ `Static` **checkOptions**(`options`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | [`NodeOptions`](../types/Node.types.md#nodeoptions) | + +#### Returns + +`void` + +#### Defined in + +[lib/Node.ts:50](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L50) diff --git a/apps/website/versioned_docs/version-1.2.0/classes/Player.md b/apps/website/versioned_docs/version-1.2.0/classes/Player.md new file mode 100644 index 0000000..a1ecf55 --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/classes/Player.md @@ -0,0 +1,639 @@ +# Player + +## Table of contents + +### Constructors + +- [constructor](Player.md#constructor) + +### Properties + +- [current](Player.md#current) +- [filters](Player.md#filters) +- [guildId](Player.md#guildid) +- [moving](Player.md#moving) +- [node](Player.md#node) +- [paused](Player.md#paused) +- [playing](Player.md#playing) +- [position](Player.md#position) +- [queue](Player.md#queue) +- [repeatMode](Player.md#repeatmode) +- [selfDeaf](Player.md#selfdeaf) +- [selfMute](Player.md#selfmute) +- [state](Player.md#state) +- [textChannelId](Player.md#textchannelid) +- [voiceChannelId](Player.md#voicechannelid) +- [voiceState](Player.md#voicestate) + +### Accessors + +- [exactPosition](Player.md#exactposition) +- [queueDuration](Player.md#queueduration) +- [volume](Player.md#volume) + +### Methods + +- [addTracks](Player.md#addtracks) +- [connect](Player.md#connect) +- [destroy](Player.md#destroy) +- [disconnect](Player.md#disconnect) +- [moveNode](Player.md#movenode) +- [pause](Player.md#pause) +- [ping](Player.md#ping) +- [play](Player.md#play) +- [resume](Player.md#resume) +- [seek](Player.md#seek) +- [sendVoiceUpdate](Player.md#sendvoiceupdate) +- [setRepeatMode](Player.md#setrepeatmode) +- [setSelfDeaf](Player.md#setselfdeaf) +- [setSelfMute](Player.md#setselfmute) +- [setVoiceChannel](Player.md#setvoicechannel) +- [skip](Player.md#skip) +- [update](Player.md#update) +- [checkOptions](Player.md#checkoptions) + +## Constructors + +### constructor + +• **new Player**(`lavashark`, `options`) + +Create a new Player instance + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `lavashark` | [`LavaShark`](LavaShark.md) | The lavashark instance | +| `options` | [`PlayerOptions`](../types/Player.types.md#playeroptions) | The player options | + +#### Defined in + +[lib/Player.ts:88](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L88) + +## Properties + +### current + +• **current**: ``null`` \| [`Track`](Track.md) + +#### Defined in + +[lib/Player.ts:50](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L50) + +___ + +### filters + +• `Readonly` **filters**: [`Filters`](Filters.md) + +#### Defined in + +[lib/Player.ts:40](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L40) + +___ + +### guildId + +• `Readonly` **guildId**: `string` + +#### Defined in + +[lib/Player.ts:38](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L38) + +___ + +### moving + +• **moving**: `boolean` + +#### Defined in + +[lib/Player.ts:64](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L64) + +___ + +### node + +• **node**: ``null`` \| [`Node`](Node.md) + +#### Defined in + +[lib/Player.ts:36](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L36) + +___ + +### paused + +• **paused**: `boolean` + +#### Defined in + +[lib/Player.ts:59](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L59) + +___ + +### playing + +• **playing**: `boolean` + +#### Defined in + +[lib/Player.ts:58](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L58) + +___ + +### position + +• **position**: `number` + +#### Defined in + +[lib/Player.ts:55](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L55) + +___ + +### queue + +• **queue**: `Queue` + +#### Defined in + +[lib/Player.ts:51](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L51) + +___ + +### repeatMode + +• **repeatMode**: [`RepeatMode`](../types/enums/enums.RepeatMode.md) + +#### Defined in + +[lib/Player.ts:53](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L53) + +___ + +### selfDeaf + +• `Optional` **selfDeaf**: `boolean` + +#### Defined in + +[lib/Player.ts:47](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L47) + +___ + +### selfMute + +• `Optional` **selfMute**: `boolean` + +#### Defined in + +[lib/Player.ts:48](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L48) + +___ + +### state + +• **state**: [`ConnectionState`](../types/enums/enums.ConnectionState.md) + +#### Defined in + +[lib/Player.ts:61](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L61) + +___ + +### textChannelId + +• `Optional` **textChannelId**: ``null`` \| `string` + +#### Defined in + +[lib/Player.ts:45](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L45) + +___ + +### voiceChannelId + +• **voiceChannelId**: `string` + +#### Defined in + +[lib/Player.ts:44](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L44) + +___ + +### voiceState + +• **voiceState**: [`VoiceState`](../types/Player.types.md#voicestate) + +#### Defined in + +[lib/Player.ts:62](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L62) + +## Accessors + +### exactPosition + +• `get` **exactPosition**(): `number` + +Gets the exact track position based on the last playerUpdate packet + +#### Returns + +`number` + +#### Defined in + +[lib/Player.ts:127](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L127) + +___ + +### queueDuration + +• `get` **queueDuration**(): `number` + +Gets the queue duration in milliseconds + +**`Deprecated`** + +- Use `queue.duration` instead + +#### Returns + +`number` + +#### Defined in + +[lib/Player.ts:142](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L142) + +___ + +### volume + +• `get` **volume**(): `number` + +Gets the volume of the player + +#### Returns + +`number` + +#### Defined in + +[lib/Player.ts:149](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L149) + +## Methods + +### addTracks + +▸ **addTracks**(`tracks`, `requester`): `void` + +Adds one or more tracks to the queue + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `tracks` | `default` \| [`Track`](Track.md) \| (`default` \| [`Track`](Track.md))[] | The track(s) to add to the queue | +| `requester` | `unknown` | The requester of the track(s) | + +#### Returns + +`void` + +#### Defined in + +[lib/Player.ts:169](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L169) + +___ + +### connect + +▸ **connect**(): `Promise`<`void`\> + +Connects to the voice channel + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Player.ts:188](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L188) + +___ + +### destroy + +▸ **destroy**(): `Promise`<`void`\> + +Destroys the player + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Player.ts:239](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L239) + +___ + +### disconnect + +▸ **disconnect**(): `void` + +Disconnects from the voice channel + +#### Returns + +`void` + +#### Defined in + +[lib/Player.ts:218](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L218) + +___ + +### moveNode + +▸ **moveNode**(`node`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `node` | [`Node`](Node.md) | The target node to move the player | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Player.ts:253](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L253) + +___ + +### pause + +▸ **pause**(`state?`): `Promise`<`boolean`\> + +Pause or unpause the player + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `state?` | `boolean` | `true` | Whether to pause or unpause the player | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[lib/Player.ts:353](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L353) + +___ + +### ping + +▸ **ping**(): `Promise`<`number`\> + +Gets the latency between lavalink client & node + +#### Returns + +`Promise`<`number`\> + +- In milliseconds + +#### Defined in + +[lib/Player.ts:292](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L292) + +___ + +### play + +▸ **play**(`options?`): `Promise`<`void`\> + +Plays a track + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `options?` | [`PlayOptions`](../types/Player.types.md#playoptions) | Play options | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Player.ts:314](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L314) + +___ + +### resume + +▸ **resume**(): `Promise`<`boolean`\> + +Resume the player + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[lib/Player.ts:374](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L374) + +___ + +### seek + +▸ **seek**(`position`): `Promise`<`void`\> + +Seek to a specific position in the track + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `position` | `number` | The position to seek, in milliseconds | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Player.ts:410](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L410) + +___ + +### sendVoiceUpdate + +▸ **sendVoiceUpdate**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[lib/Player.ts:507](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L507) + +___ + +### setRepeatMode + +▸ **setRepeatMode**(`mode`): `void` + +Set repeat mode for this queue + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `mode` | [`RepeatMode`](../types/enums/enums.RepeatMode.md) | The repeat mode to apply | + +#### Returns + +`void` + +#### Defined in + +[lib/Player.ts:430](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L430) + +___ + +### setSelfDeaf + +▸ **setSelfDeaf**(`state`): `void` + +Sets the bot's self deaf state + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `state` | `boolean` | Whether to self deaf or not | + +#### Returns + +`void` + +#### Defined in + +[lib/Player.ts:472](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L472) + +___ + +### setSelfMute + +▸ **setSelfMute**(`state`): `void` + +Sets the bot's self mute state + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `state` | `boolean` | Whether to self mute or not | + +#### Returns + +`void` + +#### Defined in + +[lib/Player.ts:485](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L485) + +___ + +### setVoiceChannel + +▸ **setVoiceChannel**(`channelId`): `void` + +Sets the player voice channel + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `channelId` | `string` | The voice channel id | + +#### Returns + +`void` + +#### Defined in + +[lib/Player.ts:498](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L498) + +___ + +### skip + +▸ **skip**(`amount?`): `Promise`<`boolean`\> + +Skips the current playing track + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `amount?` | `number` | The amount of tracks to skip | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[lib/Player.ts:382](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L382) + +___ + +### update + +▸ **update**(`state`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `state` | [`PlayerState`](../types/Node.types.md#playerstate) | + +#### Returns + +`void` + +#### Defined in + +[lib/Player.ts:530](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L530) + +___ + +### checkOptions + +▸ `Static` **checkOptions**(`options`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | [`PlayerOptions`](../types/Player.types.md#playeroptions) | + +#### Returns + +`void` + +#### Defined in + +[lib/Player.ts:66](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L66) diff --git a/apps/website/versioned_docs/version-1.2.0/classes/Queue.md b/apps/website/versioned_docs/version-1.2.0/classes/Queue.md new file mode 100644 index 0000000..8930b8c --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/classes/Queue.md @@ -0,0 +1,230 @@ +# Queue + +## Table of contents + +### Constructors + +- [constructor](Queue.md#constructor) + +### Properties + +- [tracks](Queue.md#tracks) + +### Accessors + +- [duration](Queue.md#duration) +- [size](Queue.md#size) + +### Methods + +- [add](Queue.md#add) +- [clear](Queue.md#clear) +- [poll](Queue.md#poll) +- [remove](Queue.md#remove) +- [shuffle](Queue.md#shuffle) +- [skipNTracks](Queue.md#skipntracks) + +## Constructors + +### constructor + +• **new Queue**() + +#### Defined in + +[Queue.ts:8](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L8) + +## Properties + +### tracks + +• **tracks**: (`default` \| `default`)[] + +#### Defined in + +[Queue.ts:6](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L6) + +## Accessors + +### duration + +• `get` **duration**(): `number` + +Gets the queue duration in milliseconds. + +#### Returns + +`number` + +#### Defined in + +[Queue.ts:22](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L22) + +___ + +### size + +• `get` **size**(): `number` + +Gets the queue size. + +#### Returns + +`number` + +#### Defined in + +[Queue.ts:15](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L15) + +## Methods + +### add + +▸ **add**(`track`): `void` + +[Internal] Adds a track to the queue. External users should use Player.addTracks() method instead. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `track` | `default` \| `default` | The track to add to the queue | + +#### Returns + +`void` + +#### Defined in + +[Queue.ts:30](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L30) + +___ + +### clear + +▸ **clear**(): `void` + +Clears the queue. + +#### Returns + +`void` + +#### Defined in + +[Queue.ts:67](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L67) + +___ + +### poll + +▸ **poll**(): ``null`` \| `default` \| `default` + +Polls the queue for the next track. + +#### Returns + +``null`` \| `default` \| `default` + +The next track in the queue or null if the queue is empty. + +#### Defined in + +[Queue.ts:38](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L38) + +___ + +### remove + +▸ **remove**(): `boolean` + +Removes the first track in the queue. + +#### Returns + +`boolean` + +Returns true if the track was successfully removed, false otherwise + +#### Defined in + +[Queue.ts:75](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L75) + +▸ **remove**(`index`): `boolean` + +Removes the track at the specified position. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `index` | `number` | The index of the track to remove. | + +#### Returns + +`boolean` + +Returns true if the track was successfully removed, false otherwise + +#### Defined in + +[Queue.ts:81](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L81) + +▸ **remove**(`start`, `end`): `boolean` + +Removes the tracks in the specified range. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `start` | `number` | The start index of the range. | +| `end` | `number` | The end index of the range. | + +#### Returns + +`boolean` + +Returns true if the tracks were successfully removed, false otherwise + +#### Defined in + +[Queue.ts:88](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L88) + +___ + +### shuffle + +▸ **shuffle**(): `void` + +Shuffles the queue + +#### Returns + +`void` + +#### Defined in + +[Queue.ts:53](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L53) + +___ + +### skipNTracks + +▸ **skipNTracks**(`n`): `void` + +Remove the next n tracks from the queue + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `n` | `number` | The number of tracks to skip | + +#### Returns + +`void` + +#### Defined in + +[Queue.ts:46](https://github.com/hmes98318/LavaShark/blob/cb14d9b/src/lib/queue/Queue.ts#L46) diff --git a/apps/website/versioned_docs/version-1.2.0/classes/Track.md b/apps/website/versioned_docs/version-1.2.0/classes/Track.md new file mode 100644 index 0000000..9f2494b --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/classes/Track.md @@ -0,0 +1,200 @@ +# Track + +## Table of contents + +### Constructors + +- [constructor](Track.md#constructor) + +### Properties + +- [author](Track.md#author) +- [duration](Track.md#duration) +- [encodedTrack](Track.md#encodedtrack) +- [identifier](Track.md#identifier) +- [isSeekable](Track.md#isseekable) +- [isStream](Track.md#isstream) +- [metadata](Track.md#metadata) +- [position](Track.md#position) +- [requester](Track.md#requester) +- [source](Track.md#source) +- [title](Track.md#title) +- [uri](Track.md#uri) + +### Accessors + +- [thumbnail](Track.md#thumbnail) + +### Methods + +- [setRequester](Track.md#setrequester) + +## Constructors + +### constructor + +• **new Track**(`data`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`ITrack`](../types/interfaces/Track.types.ITrack.md) | + +#### Defined in + +[lib/queue/Track.ts:24](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L24) + +## Properties + +### author + +• `Readonly` **author**: `string` + +#### Defined in + +[lib/queue/Track.ts:10](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L10) + +___ + +### duration + +• `Readonly` **duration**: [`Timestamp`](../types/interfaces/Track.types.Timestamp.md) + +#### Defined in + +[lib/queue/Track.ts:11](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L11) + +___ + +### encodedTrack + +• **encodedTrack**: `string` + +#### Defined in + +[lib/queue/Track.ts:20](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L20) + +___ + +### identifier + +• `Readonly` **identifier**: `string` + +#### Defined in + +[lib/queue/Track.ts:7](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L7) + +___ + +### isSeekable + +• `Readonly` **isSeekable**: `boolean` + +#### Defined in + +[lib/queue/Track.ts:9](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L9) + +___ + +### isStream + +• `Readonly` **isStream**: `boolean` + +#### Defined in + +[lib/queue/Track.ts:12](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L12) + +___ + +### metadata + +• `Optional` **metadata**: [`Metadata`](../types/LavaShark.types.md#metadata) + +#### Defined in + +[lib/queue/Track.ts:18](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L18) + +___ + +### position + +• `Optional` **position**: `number` + +#### Defined in + +[lib/queue/Track.ts:14](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L14) + +___ + +### requester + +• **requester**: `unknown` + +#### Defined in + +[lib/queue/Track.ts:22](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L22) + +___ + +### source + +• `Readonly` **source**: `string` + +#### Defined in + +[lib/queue/Track.ts:13](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L13) + +___ + +### title + +• `Readonly` **title**: `string` + +#### Defined in + +[lib/queue/Track.ts:15](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L15) + +___ + +### uri + +• `Readonly` **uri**: `string` + +#### Defined in + +[lib/queue/Track.ts:16](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L16) + +## Accessors + +### thumbnail + +• `get` **thumbnail**(): ``null`` \| `string` + +#### Returns + +``null`` \| `string` + +#### Defined in + +[lib/queue/Track.ts:42](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L42) + +## Methods + +### setRequester + +▸ **setRequester**(`requester`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `requester` | `unknown` | + +#### Returns + +`void` + +#### Defined in + +[lib/queue/Track.ts:52](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/queue/Track.ts#L52) diff --git a/apps/website/versioned_docs/version-1.2.0/classes/_category_.json b/apps/website/versioned_docs/version-1.2.0/classes/_category_.json new file mode 100644 index 0000000..ed28d4c --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/classes/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Classes", + "position": 5, + "link": { + "type": "generated-index", + "description": "Available classes." + } +} diff --git a/apps/website/versioned_docs/version-1.2.0/getting-started.md b/apps/website/versioned_docs/version-1.2.0/getting-started.md new file mode 100644 index 0000000..b64778a --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/getting-started.md @@ -0,0 +1,145 @@ +--- +sidebar_position: 3 +--- + +# Getting started + +Here is an example tutorial for using discord.js v14. If you're using an earlier version, please update it. The [discord.js Guide](https://discordjs.guide/) provides resources to help you with the update process. + +### Initializing the LavaShark and discord.js library + +```js +const { Client, GatewayIntentBits } = require('discord.js'); +const { LavaShark } = require('lavashark'); + +const TOKEN = 'your_token'; // Discord bot token +const prefix = '-'; // Command prefix + + +const client = new Client({ + intents: [ + GatewayIntentBits.Guilds, + GatewayIntentBits.GuildMessages, + GatewayIntentBits.MessageContent, + GatewayIntentBits.GuildVoiceStates, + ] +}); + +const lavashark = new LavaShark({ + nodes: [ + { + id: 'Node 1', + hostname: 'localhost', + port: 2333, + password: 'youshallnotpass' + } + ], + sendWS: (guildId, payload) => { client.guilds.cache.get(guildId)?.shard.send(payload); } +}); + +client.lavashark = lavashark; +client.login(TOKEN); +``` + +### Registering events + +```js +// -- LavaShark events -- + +// Fired when a track starts playing +client.lavashark.on('trackStart', (player, track) => { + const channel = client.channels.cache.get(player.textChannelId); + channel.send(`Now playing \`${track.title}\``); +}); + +// Fired when the queue ends +client.lavashark.on('queueEnd', (player) => { + const channel = client.channels.cache.get(player.textChannelId); + channel.send(`Queue ended`); + player.destroy(); +}); + +// This event is needed to catch any errors that occur on LavaShark +client.lavashark.on('error', (node, err) => { + console.error('[LavaShark]', `Error on node ${node.identifier}`, err.message); +}); + + +// -- Client events -- + +client.on('ready', () => { + console.log('Ready!'); + + // Starts the lavashark & connects to all lavalink nodes + client.lavashark.start(client.user.id); +}); + +// -- REQUIRED -- +client.on('raw', (packet) => client.lavashark.handleVoiceUpdate(packet)); + +``` + +### Command configuration + +```js +client.on('messageCreate', async message => { + if (message.author.bot) return; + if (message.content.indexOf(prefix) !== 0) return; + + + const args = message.content.slice(prefix.length).trim().split(/ +/g); + const command = args.shift().toLowerCase(); + + if (!message.member.voice.channel) + return message.reply('❌ | You are not connected to an audio channel.'); + + if (message.guild.members.me.voice.channel && message.member.voice.channelId !== message.guild.members.me.voice.channelId) + return message.reply('❌ | You are not on the same audio channel as me.'); + + + console.log('--', command); + + if (command === 'play') { + const track = args[0]; + + const res = await client.lavashark.search(track); + + if (res.loadType === "LOAD_FAILED") { + console.log(`Search Error: ${res.exception.message}`); + return message.reply('❌ | Not found music.'); + } + else if (res.loadType === "NO_MATCHES") { + console.log(`Search Error: NO_MATCHES`); + return message.reply('❌ | No matches.'); + } + + // Creates the audio player + const player = client.lavashark.createPlayer({ + guildId: message.guild.id, + voiceChannelId: message.member.voice.channelId, + textChannelId: message.channel.id, + selfDeaf: true + }); + + try { + await player.connect(); // Connects to the voice channel + } catch (error) { + console.log(error); + return message.reply({ content: `❌ | I can't join audio channel.`, allowedMentions: { repliedUser: false } }); + } + + if (res.loadType === 'PLAYLIST_LOADED') { + player.addTracks(res.tracks, message.author); + + message.reply(`Playlist \`${res.playlistInfo.name}\` loaded!`); + } + else { + const track = res.tracks[0]; + player.addTracks(res.tracks[0], message.author); + message.reply(`Added \`${track.title}\``); + } + + if (!player.playing) await player.play(); + } +}); +``` \ No newline at end of file diff --git a/apps/website/versioned_docs/version-1.2.0/server-config.md b/apps/website/versioned_docs/version-1.2.0/server-config.md new file mode 100644 index 0000000..126dc60 --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/server-config.md @@ -0,0 +1,150 @@ +--- +sidebar_position: 2 +--- + +# Server configuration + +you need to download the Lavalink node ([lavalink-devs/Lavalink](https://github.com/lavalink-devs/Lavalink)) and run it, or use other public nodes. + +If you need public nodes, you can refer to the following repository. +* [DarrenOfficial/lavalink-list](https://github.com/DarrenOfficial/lavalink-list) + + +## Deploying with Binary + +Download binaries from the [Download Server](https://repo.arbjerg.dev/artifacts/lavalink/), [GitHub releases](https://github.com/lavalink-devs/Lavalink/releases) or [GitHub actions](https://github.com/lavalink-devs/Lavalink/actions). + +Put an `application.yml` file in your working directory. ([Example here](https://github.com/lavalink-devs/Lavalink/blob/master/LavalinkServer/application.yml.example)) + +Run with `java -jar Lavalink.jar` from the same directory. + + +## Deploying with Docker + +Docker images can be found under [packages](https://github.com/lavalink-devs/Lavalink/pkgs/container/lavalink) with old builds prior to `v3.7.4` being available on [Docker Hub](https://hub.docker.com/r/fredboat/lavalink/). + +Install [Docker](https://docs.docker.com/engine/install/) & [Docker Compose](https://docs.docker.com/compose/install/) + +Create a `docker-compose.yml` with the following content: + +```yml +version: "3.8" + +services: + lavalink: + image: ghcr.io/lavalink-devs/lavalink:3 # pin the image version to Lavalink v3 + container_name: lavalink + restart: unless-stopped + environment: + - _JAVA_OPTIONS=-Xmx6G # set Java options here + - SERVER_PORT=2333 # set lavalink server port + - LAVALINK_SERVER_PASSWORD=youshallnotpass # set password for lavalink + volumes: + - ./application.yml:/opt/Lavalink/application.yml # mount application.yml from the same directory or use environment variables + - ./plugins/:/opt/Lavalink/plugins/ # persist plugins between restarts, make sure to set the correct permissions (user: 322, group: 322) + networks: + - lavalink + expose: + - 2333 # lavalink exposes port 2333 to connect to for other containers (this is for documentation purposes only) + ports: + - 2333:2333 # you only need this if you want to make your lavalink accessible from outside of containers +networks: + lavalink: # create a lavalink network you can add other containers to, to give them access to Lavalink + name: lavalink +``` + +Place the `application.yml` in the same directory as `docker-compose.yml`. + +```yml +server: # REST and WS server + port: 2333 + address: 0.0.0.0 +plugins: +# name: # Name of the plugin +# some_key: some_value # Some key-value pair for the plugin +# another_key: another_value +lavalink: + plugins: +# - dependency: "group:artifact:version" +# repository: "repository" + server: + password: "youshallnotpass" + sources: + youtube: true + bandcamp: true + soundcloud: true + twitch: true + vimeo: true + http: true + local: false + filters: # All filters are enabled by default + volume: true + equalizer: true + karaoke: true + timescale: true + tremolo: true + vibrato: true + distortion: true + rotation: true + channelMix: true + lowPass: true + bufferDurationMs: 400 # The duration of the NAS buffer. Higher values fare better against longer GC pauses. Duration <= 0 to disable JDA-NAS. Minimum of 40ms, lower values may introduce pauses. + frameBufferDurationMs: 5000 # How many milliseconds of audio to keep buffered + opusEncodingQuality: 10 # Opus encoder quality. Valid values range from 0 to 10, where 10 is best quality but is the most expensive on the CPU. + resamplingQuality: LOW # Quality of resampling operations. Valid values are LOW, MEDIUM and HIGH, where HIGH uses the most CPU. + trackStuckThresholdMs: 10000 # The threshold for how long a track can be stuck. A track is stuck if does not return any audio data. + useSeekGhosting: true # Seek ghosting is the effect where whilst a seek is in progress, the audio buffer is read from until empty, or until seek is ready. + youtubePlaylistLoadLimit: 6 # Number of pages at 100 each + playerUpdateInterval: 5 # How frequently to send player updates to clients, in seconds + youtubeSearchEnabled: true + soundcloudSearchEnabled: true + gc-warnings: true + #ratelimit: + #ipBlocks: ["1.0.0.0/8", "..."] # list of ip blocks + #excludedIps: ["...", "..."] # ips which should be explicit excluded from usage by lavalink + #strategy: "RotateOnBan" # RotateOnBan | LoadBalance | NanoSwitch | RotatingNanoSwitch + #searchTriggersFail: true # Whether a search 429 should trigger marking the ip as failing + #retryLimit: -1 # -1 = use default lavaplayer value | 0 = infinity | >0 = retry will happen this numbers times + #youtubeConfig: # Required for avoiding all age restrictions by YouTube, some restricted videos still can be played without. + #email: "" # Email of Google account + #password: "" # Password of Google account + #httpConfig: # Useful for blocking bad-actors from ip-grabbing your music node and attacking it, this way only the http proxy will be attacked + #proxyHost: "localhost" # Hostname of the proxy, (ip or domain) + #proxyPort: 3128 # Proxy port, 3128 is the default for squidProxy + #proxyUser: "" # Optional user for basic authentication fields, leave blank if you don't use basic auth + #proxyPassword: "" # Password for basic authentication + +metrics: + prometheus: + enabled: false + endpoint: /metrics + +sentry: + dsn: "" + environment: "" +# tags: +# some_key: some_value +# another_key: another_value + +logging: + file: + path: ./logs/ + + level: + root: INFO + lavalink: INFO + + request: + enabled: true + includeClientInfo: true + includeHeaders: false + includeQueryString: true + includePayload: true + maxPayloadLength: 10000 + + + logback: + rollingpolicy: + max-file-size: 1GB + max-history: 30 +``` \ No newline at end of file diff --git a/apps/website/versioned_docs/version-1.2.0/types/Filter.types.md b/apps/website/versioned_docs/version-1.2.0/types/Filter.types.md new file mode 100644 index 0000000..e00394c --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/Filter.types.md @@ -0,0 +1,189 @@ +# @types/Filter + +## Table of contents + +### Type Aliases + +- [ChannelMixOptions](Filter.types.md#channelmixoptions) +- [DistortionOptions](Filter.types.md#distortionoptions) +- [FilterOptions](Filter.types.md#filteroptions) +- [KaraokeOptions](Filter.types.md#karaokeoptions) +- [LowPassOptions](Filter.types.md#lowpassoptions) +- [RotationOptions](Filter.types.md#rotationoptions) +- [TimescaleOptions](Filter.types.md#timescaleoptions) +- [TremoloOptions](Filter.types.md#tremolooptions) +- [VibratoOptions](Filter.types.md#vibratooptions) + +## Type Aliases + +### ChannelMixOptions + +Ƭ **ChannelMixOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `leftToLeft?` | `number` | +| `leftToRight?` | `number` | +| `rightToLeft?` | `number` | +| `rightToRight?` | `number` | + +#### Defined in + +[@types/Filter.types.ts:1](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L1) + +___ + +### DistortionOptions + +Ƭ **DistortionOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `cosOffset?` | `number` | +| `cosScale?` | `number` | +| `offset?` | `number` | +| `scale?` | `number` | +| `sinOffset?` | `number` | +| `sinScale?` | `number` | +| `tanOffset?` | `number` | +| `tanScale?` | `number` | + +#### Defined in + +[@types/Filter.types.ts:8](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L8) + +___ + +### FilterOptions + +Ƭ **FilterOptions**: `Object` + +#### Index signature + +▪ [key: `string`]: `unknown` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `channelMix?` | [`ChannelMixOptions`](Filter.types.md#channelmixoptions) | - | +| `distortion?` | [`DistortionOptions`](Filter.types.md#distortionoptions) | - | +| `equalizer?` | `number`[] | 15 bands [0-14] 25 Hz, 40 Hz, 63 Hz, 100 Hz, 160 Hz, 250 Hz, 400 Hz, 630 Hz, 1 kHz, 1.6 kHz, 2.5 kHz, 4 kHz, 6.3 kHz, 10 kHz, 16 kHz | +| `karaoke?` | [`KaraokeOptions`](Filter.types.md#karaokeoptions) | - | +| `lowPass?` | [`LowPassOptions`](Filter.types.md#lowpassoptions) | - | +| `rotation?` | [`RotationOptions`](Filter.types.md#rotationoptions) | - | +| `timescale?` | [`TimescaleOptions`](Filter.types.md#timescaleoptions) | - | +| `tremolo?` | [`TremoloOptions`](Filter.types.md#tremolooptions) | - | +| `vibrato?` | [`VibratoOptions`](Filter.types.md#vibratooptions) | - | +| `volume?` | `number` | - | + +#### Defined in + +[@types/Filter.types.ts:50](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L50) + +___ + +### KaraokeOptions + +Ƭ **KaraokeOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `filterBand?` | `number` | +| `filterWidth?` | `number` | +| `level?` | `number` | +| `monoLevel?` | `number` | + +#### Defined in + +[@types/Filter.types.ts:19](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L19) + +___ + +### LowPassOptions + +Ƭ **LowPassOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `smoothing?` | `number` | + +#### Defined in + +[@types/Filter.types.ts:26](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L26) + +___ + +### RotationOptions + +Ƭ **RotationOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `rotationHz?` | `number` | + +#### Defined in + +[@types/Filter.types.ts:30](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L30) + +___ + +### TimescaleOptions + +Ƭ **TimescaleOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `pitch?` | `number` | +| `rate?` | `number` | +| `speed?` | `number` | + +#### Defined in + +[@types/Filter.types.ts:34](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L34) + +___ + +### TremoloOptions + +Ƭ **TremoloOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `depth?` | `number` | +| `frequency?` | `number` | + +#### Defined in + +[@types/Filter.types.ts:40](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L40) + +___ + +### VibratoOptions + +Ƭ **VibratoOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `depth?` | `number` | +| `frequency?` | `number` | + +#### Defined in + +[@types/Filter.types.ts:45](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Filter.types.ts#L45) diff --git a/apps/website/versioned_docs/version-1.2.0/types/LavaShark.types.md b/apps/website/versioned_docs/version-1.2.0/types/LavaShark.types.md new file mode 100644 index 0000000..dcc1f45 --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/LavaShark.types.md @@ -0,0 +1,470 @@ +# @types/LavaShark + +## Table of contents + +### Type Aliases + +- [EventListeners](LavaShark.types.md#eventlisteners) +- [IncomingDiscordPayload](LavaShark.types.md#incomingdiscordpayload) +- [LavaSharkOptions](LavaShark.types.md#lavasharkoptions) +- [Metadata](LavaShark.types.md#metadata) +- [OutgoingDiscordPayload](LavaShark.types.md#outgoingdiscordpayload) +- [SEARCH\_SOURCE](LavaShark.types.md#search_source) +- [SpotifyConfig](LavaShark.types.md#spotifyconfig) +- [UNRESOLVED\_SOURCES](LavaShark.types.md#unresolved_sources) +- [VoiceServerUpdateData](LavaShark.types.md#voiceserverupdatedata) +- [VoiceServerUpdatePayload](LavaShark.types.md#voiceserverupdatepayload) +- [VoiceStateUpdatePayload](LavaShark.types.md#voicestateupdatepayload) + +## Type Aliases + +### EventListeners + +#### Type declaration +| Event | listener | +| :------ | :------ | +| `debug` | `message`: `string` | +| `raw` | `node`: [`Node`](../classes/Node.md), `payload`: `unknown` | +| `nodeConnect` | `node`: [`Node`](../classes/Node.md) | +| `nodeResume` | `node`: [`Node`](../classes/Node.md) | +| `nodeDisconnect` | `node`: [`Node`](../classes/Node.md), `code`: `number`, `reason`: `string` | +| `warn` | `node`: [`Node`](../classes/Node.md), `warn`: `string` | +| `error` | `node`: [`Node`](../classes/Node.md), `error`: `Error` | +| `trackAdd` | `player`: [`Player`](../classes/Player.md), `tracks`: [`Track`](../classes/Track.md) \| Array<[`Track`](../classes/Track.md)> | +| `trackStart` | `player`: [`Player`](../classes/Player.md), `track`: [`Track`](../classes/Track.md) | +| `trackEnd` | `player`: [`Player`](../classes/Player.md), `track`: [`Track`](../classes/Track.md), `reason`: [`TrackEndReason`](Node.types.md#trackendreason) | +| `trackStuck` | `player`: [`Player`](../classes/Player.md), `track`: [`Track`](../classes/Track.md), `thresholdMs`: `number` | +| `trackException` | `player`: [`Player`](../classes/Player.md), `track`: `default` \| [`Track`](../classes/Track.md), `exception`: [`LoadException`](REST.types.md#loadexception) & { `cause`: `string` } | +| `playerCreate` | `player`: [`Player`](../classes/Player.md) | +| `playerDestroy` | `player`: [`Player`](../classes/Player.md) | +| `playerDisconnect` | `player`: [`Player`](../classes/Player.md), `code`: `number`, `reason`: `string` | +| `queueEnd` | `player`: [`Player`](../classes/Player.md) | +| `pong` | `node`: [`Node`](../classes/Node.md), `ping?`: `number` | + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Type declaration + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"debug"`` | +| `listener` | (`message`: `string`) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"raw"`` | +| `listener` | (`node`: [`Node`](../classes/Node.md), `payload`: `unknown`) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"nodeConnect"`` | +| `listener` | (`node`: [`Node`](../classes/Node.md)) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"nodeResume"`` | +| `listener` | (`node`: [`Node`](../classes/Node.md)) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"nodeDisconnect"`` | +| `listener` | (`node`: [`Node`](../classes/Node.md), `code`: `number`, `reason`: `string`) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"warn"`` | +| `listener` | (`node`: [`Node`](../classes/Node.md), `warn`: `string`) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`node`: [`Node`](../classes/Node.md), `error`: `Error`) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"trackAdd"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md), `tracks`: [`Track`](../classes/Track.md) \| [`Track`](../classes/Track.md)[]) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"trackStart"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md), `track`: [`Track`](../classes/Track.md)) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"trackEnd"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md), `track`: [`Track`](../classes/Track.md), `reason`: [`TrackEndReason`](Node.types.md#trackendreason)) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"trackStuck"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md), `track`: [`Track`](../classes/Track.md), `thresholdMs`: `number`) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"trackException"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md), `track`: `default` \| [`Track`](../classes/Track.md), `exception`: [`LoadException`](REST.types.md#loadexception) & { `cause`: `string` }) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"playerConnect"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md)) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"playerCreate"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md)) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"playerDestroy"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md)) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"playerDisconnect"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md), `code`: `number`, `reason`: `string`) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"queueEnd"`` | +| `listener` | (`player`: [`Player`](../classes/Player.md)) => `void` | + +##### Returns + +`T` + +▸ (`event`, `listener`): `T` + +LavaShark events + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pong"`` | +| `listener` | (`node`: [`Node`](../classes/Node.md), `ping?`: `number`) => `void` | + +##### Returns + +`T` + +#### Defined in + +[@types/LavaShark.types.ts:44](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L44) + +___ + +### IncomingDiscordPayload + +Ƭ **IncomingDiscordPayload**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `d?` | `unknown` | +| `op` | `number` | +| `s?` | `number` | +| `t?` | `string` | + +#### Defined in + +[@types/LavaShark.types.ts:9](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L9) + +___ + +### LavaSharkOptions + +Ƭ **LavaSharkOptions**: `Object` + +Main constructor options + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `defaultSearchSource?` | [`SEARCH_SOURCE`](LavaShark.types.md#search_source) | The default source to search for tracks | +| `disabledSources?` | [`UNRESOLVED_SOURCES`](LavaShark.types.md#unresolved_sources)[] | Disables spotify, apple music or deezer | +| `nodes` | [`NodeOptions`](Node.types.md#nodeoptions)[] | The array of lavalink nodes | +| `sendWS` | (`guildId`: `string`, `payload`: [`OutgoingDiscordPayload`](LavaShark.types.md#outgoingdiscordpayload)) => `void` | Function to send voice channel connect payloads to discord | +| `spotify?` | [`SpotifyConfig`](LavaShark.types.md#spotifyconfig) | The spotify credentials | +| `unresolvedSearchSource?` | [`SEARCH_SOURCE`](LavaShark.types.md#search_source) | The default source to search for unresolved tracks | +| `useISRC?` | `boolean` | Whether to search for ISRC to resolve tracks or not | + +#### Defined in + +[@types/LavaShark.types.ts:81](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L81) + +___ + +### Metadata + +Ƭ **Metadata**: `Pick`<[`TrackInfo`](Track.types.md#trackinfo), ``"title"`` \| ``"author"`` \| ``"uri"``\> & { `duration`: [`Timestamp`](./interfaces/Track.types.Timestamp.md) ; `isrc?`: `string` ; `source`: `string` } + +#### Defined in + +[@types/LavaShark.types.ts:37](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L37) + +___ + +### OutgoingDiscordPayload + +Ƭ **OutgoingDiscordPayload**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `d` | `Record`<`string`, `unknown`\> | +| `op` | `number` | + +#### Defined in + +[@types/LavaShark.types.ts:65](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L65) + +___ + +### SEARCH\_SOURCE + +Ƭ **SEARCH\_SOURCE**: ``"youtube"`` \| ``"youtubemusic"`` \| ``"soundcloud"`` + +#### Defined in + +[@types/LavaShark.types.ts:70](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L70) + +___ + +### SpotifyConfig + +Ƭ **SpotifyConfig**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `clientId` | `string` | +| `clientSecret` | `string` | +| `market?` | `string` | + +#### Defined in + +[@types/LavaShark.types.ts:74](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L74) + +___ + +### UNRESOLVED\_SOURCES + +Ƭ **UNRESOLVED\_SOURCES**: ``"APPLE_MUSIC"`` \| ``"DEEZER"`` \| ``"SPOTIFY"`` + +#### Defined in + +[@types/LavaShark.types.ts:72](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L72) + +___ + +### VoiceServerUpdateData + +Ƭ **VoiceServerUpdateData**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `endpoint` | `string` | +| `guild_id` | `string` | +| `token` | `string` | + +#### Defined in + +[@types/LavaShark.types.ts:26](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L26) + +___ + +### VoiceServerUpdatePayload + +Ƭ **VoiceServerUpdatePayload**: [`IncomingDiscordPayload`](LavaShark.types.md#incomingdiscordpayload) & { `d`: [`VoiceServerUpdateData`](LavaShark.types.md#voiceserverupdatedata) ; `t`: ``"VOICE_SERVER_UPDATE"`` } + +#### Defined in + +[@types/LavaShark.types.ts:32](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L32) + +___ + +### VoiceStateUpdatePayload + +Ƭ **VoiceStateUpdatePayload**: [`IncomingDiscordPayload`](LavaShark.types.md#incomingdiscordpayload) & { `d`: { `channel_id`: `string` \| ``null`` ; `guild_id`: `string` ; `session_id`: `string` ; `user_id`: `string` } ; `t`: ``"VOICE_STATE_UPDATE"`` } + +#### Defined in + +[@types/LavaShark.types.ts:16](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/LavaShark.types.ts#L16) diff --git a/apps/website/versioned_docs/version-1.2.0/types/Node.types.md b/apps/website/versioned_docs/version-1.2.0/types/Node.types.md new file mode 100644 index 0000000..dcf7eed --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/Node.types.md @@ -0,0 +1,196 @@ +# @types/Node + +## Table of contents + +### Interfaces + +- [PlayerEventPayload](./interfaces/Node.types.PlayerEventPayload.md) +- [TrackEndEvent](./interfaces/Node.types.TrackEndEvent.md) +- [TrackExceptionEvent](./interfaces/Node.types.TrackExceptionEvent.md) +- [TrackStartEvent](./interfaces/Node.types.TrackStartEvent.md) +- [TrackStuckEvent](./interfaces/Node.types.TrackStuckEvent.md) +- [WebSocketClosedEvent](./interfaces/Node.types.WebSocketClosedEvent.md) + +### Type Aliases + +- [Info](Node.types.md#info) +- [NodeOptions](Node.types.md#nodeoptions) +- [NodeStats](Node.types.md#nodestats) +- [PlayerState](Node.types.md#playerstate) +- [RoutePlannerDetails](Node.types.md#routeplannerdetails) +- [RoutePlannerStatus](Node.types.md#routeplannerstatus) +- [TrackEndReason](Node.types.md#trackendreason) +- [version](Node.types.md#version) + +## Type Aliases + +### Info + +Ƭ **Info**: `Object` + +Lavalink Info + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `buildTime` | `number` | +| `filters` | `string`[] | +| `git` | { `branch`: `string` ; `commit`: `string` ; `commitTime`: `number` } | +| `git.branch` | `string` | +| `git.commit` | `string` | +| `git.commitTime` | `number` | +| `jvm` | `string` | +| `lavaplayer` | `string` | +| `plugins` | { `name`: `string` ; `version`: `string` }[] | +| `sourceManagers` | `string`[] | +| `version` | { `major`: `number` ; `minor`: `number` ; `patch`: `number` ; `preRelease`: `string` \| ``null`` ; `semver`: `string` } | +| `version.major` | `number` | +| `version.minor` | `number` | +| `version.patch` | `number` | +| `version.preRelease` | `string` \| ``null`` | +| `version.semver` | `string` | + +#### Defined in + +[@types/Node.types.ts:81](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L81) + +___ + +### NodeOptions + +Ƭ **NodeOptions**: `Object` + +Lavalink node options + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `followRedirects?` | `boolean` | Whether to follow redirects or not (default is false) | +| `hostname` | `string` | The node hostname | +| `id?` | `string` | The node identifier | +| `maxRetryAttempts?` | `number` | The max number of retry attempts | +| `password?` | `string` | The node password | +| `port` | `number` | The node port | +| `resumeKey?` | `string` | The resume key | +| `resumeTimeout?` | `number` | The resume timeout, in seconds | +| `retryAttemptsInterval?` | `number` | The interval between retry attempts | +| `secure?` | `boolean` | Whether to use SSL/TLS or not | + +#### Defined in + +[@types/Node.types.ts:5](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L5) + +___ + +### NodeStats + +Ƭ **NodeStats**: `Object` + +Lavalink node stats + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cpu` | { `cores`: `number` ; `lavalinkLoad`: `number` ; `systemLoad`: `number` } | CPU stats, [0, 1] | +| `cpu.cores` | `number` | - | +| `cpu.lavalinkLoad` | `number` | - | +| `cpu.systemLoad` | `number` | - | +| `frameStats?` | { `deficit`: `number` ; `nulled`: `number` ; `sent`: `number` } | Audio frame stats | +| `frameStats.deficit` | `number` | - | +| `frameStats.nulled` | `number` | - | +| `frameStats.sent` | `number` | - | +| `memory` | { `allocated`: `number` ; `free`: `number` ; `reservable`: `number` ; `used`: `number` } | RAM stats, in bytes | +| `memory.allocated` | `number` | - | +| `memory.free` | `number` | - | +| `memory.reservable` | `number` | - | +| `memory.used` | `number` | - | +| `players` | `number` | The total player amount | +| `playingPlayers` | `number` | The amount of playing players | +| `uptime` | `number` | The lavalink node uptime, in seconds | + +#### Defined in + +[@types/Node.types.ts:29](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L29) + +___ + +### PlayerState + +Ƭ **PlayerState**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `connected` | `boolean` | Whether the player is connected to discord voice gateway | +| `position?` | `number` | Track position in ms | +| `time` | `number` | Unix timestamp when the position was picked | + +#### Defined in + +[@types/Node.types.ts:145](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L145) + +___ + +### RoutePlannerDetails + +Ƭ **RoutePlannerDetails**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `blockIndex?` | `string` | +| `currentAddressIndex?` | `string` | +| `failingAddresses` | { `address`: `string` ; `failingTime`: `string` ; `failingTimestamp`: `number` }[] | +| `ipBlock` | { `size`: `string` ; `type`: `string` } | +| `ipBlock.size` | `string` | +| `ipBlock.type` | `string` | + +#### Defined in + +[@types/Node.types.ts:63](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L63) + +___ + +### RoutePlannerStatus + +Ƭ **RoutePlannerStatus**: `Object` + +Route planner API + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `class` | `string` \| ``null`` | +| `details` | [`RoutePlannerDetails`](Node.types.md#routeplannerdetails) \| ``null`` | + +#### Defined in + +[@types/Node.types.ts:58](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L58) + +___ + +### TrackEndReason + +Ƭ **TrackEndReason**: ``"FINISHED"`` \| ``"LOAD_FAILED"`` \| ``"STOPPED"`` \| ``"REPLACED"`` \| ``"CLEANUP"`` + +#### Defined in + +[@types/Node.types.ts:117](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L117) + +___ + +### version + +Ƭ **version**: `string` + +Lavalink version + +#### Defined in + +[@types/Node.types.ts:78](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L78) diff --git a/apps/website/versioned_docs/version-1.2.0/types/Player.types.md b/apps/website/versioned_docs/version-1.2.0/types/Player.types.md new file mode 100644 index 0000000..a5b3eda --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/Player.types.md @@ -0,0 +1,68 @@ +# @types/Player + +## Table of contents + +### Type Aliases + +- [PlayOptions](Player.types.md#playoptions) +- [PlayerOptions](Player.types.md#playeroptions) +- [VoiceState](Player.types.md#voicestate) + +## Type Aliases + +### PlayOptions + +Ƭ **PlayOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `endTime?` | `number` | +| `noReplace?` | `boolean` | +| `pause?` | `boolean` | +| `startTime?` | `number` | + +#### Defined in + +[@types/Player.types.ts:26](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Player.types.ts#L26) + +___ + +### PlayerOptions + +Ƭ **PlayerOptions**: `Object` + +Main constructor options + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `guildId` | `string` | The guild id that player belongs to | +| `queue?` | `Queue` | The queue object that player will use | +| `selfDeaf?` | `boolean` | Whether the bot joins the voice channel deafened or not | +| `selfMute?` | `boolean` | Whether the bot joins the voice channel muted or not | +| `textChannelId?` | `string` | The text channel id | +| `voiceChannelId` | `string` | The voice channel id | + +#### Defined in + +[@types/Player.types.ts:6](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Player.types.ts#L6) + +___ + +### VoiceState + +Ƭ **VoiceState**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `event?` | [`VoiceServerUpdateData`](LavaShark.types.md#voiceserverupdatedata) | +| `sessionId?` | `string` | + +#### Defined in + +[@types/Player.types.ts:21](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Player.types.ts#L21) diff --git a/apps/website/versioned_docs/version-1.2.0/types/REST.types.md b/apps/website/versioned_docs/version-1.2.0/types/REST.types.md new file mode 100644 index 0000000..a81429a --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/REST.types.md @@ -0,0 +1,134 @@ +# @types/REST + +## Table of contents + +### Type Aliases + +- [LavalinkRESTError](REST.types.md#lavalinkresterror) +- [LoadException](REST.types.md#loadexception) +- [LoadResultBase](REST.types.md#loadresultbase) +- [LoadTracksResult](REST.types.md#loadtracksresult) +- [RequestOptions](REST.types.md#requestoptions) +- [SearchResult](REST.types.md#searchresult) +- [UpdatePlayerOptions](REST.types.md#updateplayeroptions) + +## Type Aliases + +### LavalinkRESTError + +Ƭ **LavalinkRESTError**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `error` | `string` | +| `message` | `string` | +| `path` | `string` | +| `status` | `number` | +| `timestamp` | `number` | +| `trace?` | `string` | + +#### Defined in + +[@types/REST.types.ts:24](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/REST.types.ts#L24) + +___ + +### LoadException + +Ƭ **LoadException**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `severity` | ``"COMMON"`` \| ``"SUSPIOUS"`` \| ``"FAULT"`` | + +#### Defined in + +[@types/REST.types.ts:40](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/REST.types.ts#L40) + +___ + +### LoadResultBase + +Ƭ **LoadResultBase**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `exception?` | [`LoadException`](REST.types.md#loadexception) | +| `loadType` | ``"TRACK_LOADED"`` \| ``"PLAYLIST_LOADED"`` \| ``"SEARCH_RESULT"`` \| ``"NO_MATCHES"`` \| ``"LOAD_FAILED"`` | +| `playlistInfo` | [`PlaylistInfo`](Track.types.md#playlistinfo) | + +#### Defined in + +[@types/REST.types.ts:45](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/REST.types.ts#L45) + +___ + +### LoadTracksResult + +Ƭ **LoadTracksResult**: [`LoadResultBase`](REST.types.md#loadresultbase) & { `tracks`: [`ITrack`](./interfaces/Track.types.ITrack.md)[] } + +#### Defined in + +[@types/REST.types.ts:51](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/REST.types.ts#L51) + +___ + +### RequestOptions + +Ƭ **RequestOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `headers?` | `Record`<`string`, `string`\> | +| `json?` | `unknown` | +| `method` | `Dispatcher.HttpMethod` | +| `path` | `string` | + +#### Defined in + +[@types/REST.types.ts:33](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/REST.types.ts#L33) + +___ + +### SearchResult + +Ƭ **SearchResult**: [`LoadResultBase`](REST.types.md#loadresultbase) & { `tracks`: ([`Track`](../classes/Track.md) \| `UnresolvedTrack`)[] } + +#### Defined in + +[@types/REST.types.ts:55](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/REST.types.ts#L55) + +___ + +### UpdatePlayerOptions + +Ƭ **UpdatePlayerOptions**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encodedTrack?` | `string` \| ``null`` | - | +| `endTime?` | `number` | - | +| `filters?` | [`FilterOptions`](Filter.types.md#filteroptions) | - | +| `noReplace?` | `boolean` | - | +| `paused?` | `boolean` | - | +| `position?` | `number` | identifier?: string; | +| `voice?` | { `endpoint`: `string` ; `sessionId`: `string` ; `token`: `string` } | - | +| `voice.endpoint` | `string` | - | +| `voice.sessionId` | `string` | - | +| `voice.token` | `string` | - | +| `volume?` | `number` | - | + +#### Defined in + +[@types/REST.types.ts:8](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/REST.types.ts#L8) diff --git a/apps/website/versioned_docs/version-1.2.0/types/Track.types.md b/apps/website/versioned_docs/version-1.2.0/types/Track.types.md new file mode 100644 index 0000000..7caa5e1 --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/Track.types.md @@ -0,0 +1,56 @@ +# @types/Track + +## Table of contents + +### Interfaces + +- [ITrack](./interfaces/Track.types.ITrack.md) +- [Timestamp](./interfaces/Track.types.Timestamp.md) + +### Type Aliases + +- [PlaylistInfo](Track.types.md#playlistinfo) +- [TrackInfo](Track.types.md#trackinfo) + +## Type Aliases + +### PlaylistInfo + +Ƭ **PlaylistInfo**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `duration` | `number` | +| `name` | `string` | +| `selectedTrack` | `number` | + +#### Defined in + +[@types/Track.types.ts:1](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Track.types.ts#L1) + +___ + +### TrackInfo + +Ƭ **TrackInfo**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `author` | `string` | +| `identifier` | `string` | +| `isSeekable` | `boolean` | +| `isStream` | `boolean` | +| `length` | `number` | +| `position` | `number` | +| `sourceName` | `string` \| ``null`` | +| `thumbnail?` | `string` | +| `title` | `string` | +| `uri` | `string` | + +#### Defined in + +[@types/Track.types.ts:7](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Track.types.ts#L7) diff --git a/apps/website/versioned_docs/version-1.2.0/types/_category_.json b/apps/website/versioned_docs/version-1.2.0/types/_category_.json new file mode 100644 index 0000000..d4b3af7 --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "@types", + "position": 6, + "link": { + "type": "generated-index", + "description": "@types" + } +} diff --git a/apps/website/versioned_docs/version-1.2.0/types/enums/enums.ConnectionState.md b/apps/website/versioned_docs/version-1.2.0/types/enums/enums.ConnectionState.md new file mode 100644 index 0000000..b650d1d --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/enums/enums.ConnectionState.md @@ -0,0 +1,39 @@ +# enums/ConnectionState + +## Table of contents + +### Enumeration Members + +- [CONNECTED](enums.ConnectionState.md#connected) +- [CONNECTING](enums.ConnectionState.md#connecting) +- [DISCONNECTED](enums.ConnectionState.md#disconnected) + +## Enumeration Members + +### CONNECTED + +• **CONNECTED** = ``1`` + +#### Defined in + +[lib/Player.ts:18](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L18) + +___ + +### CONNECTING + +• **CONNECTING** = ``0`` + +#### Defined in + +[lib/Player.ts:17](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L17) + +___ + +### DISCONNECTED + +• **DISCONNECTED** = ``2`` + +#### Defined in + +[lib/Player.ts:19](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L19) diff --git a/apps/website/versioned_docs/version-1.2.0/types/enums/enums.NodeState.md b/apps/website/versioned_docs/version-1.2.0/types/enums/enums.NodeState.md new file mode 100644 index 0000000..09e3697 --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/enums/enums.NodeState.md @@ -0,0 +1,39 @@ +# enums/NodeState + +## Table of contents + +### Enumeration Members + +- [CONNECTED](enums.NodeState.md#connected) +- [CONNECTING](enums.NodeState.md#connecting) +- [DISCONNECTED](enums.NodeState.md#disconnected) + +## Enumeration Members + +### CONNECTED + +• **CONNECTED** = ``1`` + +#### Defined in + +[lib/Node.ts:28](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L28) + +___ + +### CONNECTING + +• **CONNECTING** = ``0`` + +#### Defined in + +[lib/Node.ts:27](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L27) + +___ + +### DISCONNECTED + +• **DISCONNECTED** = ``2`` + +#### Defined in + +[lib/Node.ts:29](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Node.ts#L29) diff --git a/apps/website/versioned_docs/version-1.2.0/types/enums/enums.RepeatMode.md b/apps/website/versioned_docs/version-1.2.0/types/enums/enums.RepeatMode.md new file mode 100644 index 0000000..6865ddf --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/enums/enums.RepeatMode.md @@ -0,0 +1,44 @@ +# enums/RepeatMode + +The queue repeat mode. This can be one of: +- OFF +- TRACK +- QUEUE + +## Table of contents + +### Enumeration Members + +- [OFF](enums.RepeatMode.md#off) +- [QUEUE](enums.RepeatMode.md#queue) +- [TRACK](enums.RepeatMode.md#track) + +## Enumeration Members + +### OFF + +• **OFF** = ``0`` + +#### Defined in + +[lib/Player.ts:29](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L29) + +___ + +### QUEUE + +• **QUEUE** = ``2`` + +#### Defined in + +[lib/Player.ts:31](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L31) + +___ + +### TRACK + +• **TRACK** = ``1`` + +#### Defined in + +[lib/Player.ts:30](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/lib/Player.ts#L30) diff --git a/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.PlayerEventPayload.md b/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.PlayerEventPayload.md new file mode 100644 index 0000000..ed2f9f5 --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.PlayerEventPayload.md @@ -0,0 +1,57 @@ +# @types/Node.PlayerEventPayload + +[@types/Node.types](../Node.types.md).PlayerEventPayload + +Lavalink node incoming payloads + +## Hierarchy + +- **`PlayerEventPayload`** + + ↳ [`TrackStartEvent`](Node.types.TrackStartEvent.md) + + ↳ [`TrackEndEvent`](Node.types.TrackEndEvent.md) + + ↳ [`TrackExceptionEvent`](Node.types.TrackExceptionEvent.md) + + ↳ [`TrackStuckEvent`](Node.types.TrackStuckEvent.md) + + ↳ [`WebSocketClosedEvent`](Node.types.WebSocketClosedEvent.md) + +## Table of contents + +### Properties + +- [guildId](Node.types.PlayerEventPayload.md#guildid) +- [op](Node.types.PlayerEventPayload.md#op) +- [type](Node.types.PlayerEventPayload.md#type) + +## Properties + +### guildId + +• **guildId**: `string` + +#### Defined in + +[@types/Node.types.ts:109](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L109) + +___ + +### op + +• **op**: ``"event"`` + +#### Defined in + +[@types/Node.types.ts:107](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L107) + +___ + +### type + +• **type**: ``"TrackStartEvent"`` \| ``"TrackEndEvent"`` \| ``"TrackExceptionEvent"`` \| ``"TrackStuckEvent"`` \| ``"WebSocketClosedEvent"`` + +#### Defined in + +[@types/Node.types.ts:108](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L108) diff --git a/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.TrackEndEvent.md b/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.TrackEndEvent.md new file mode 100644 index 0000000..c1e2ad3 --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.TrackEndEvent.md @@ -0,0 +1,81 @@ +# @types/Node.TrackEndEvent + +Lavalink node incoming payloads + +## Hierarchy + +- [`PlayerEventPayload`](Node.types.PlayerEventPayload.md) + + ↳ **`TrackEndEvent`** + +## Table of contents + +### Properties + +- [guildId](Node.types.TrackEndEvent.md#guildid) +- [op](Node.types.TrackEndEvent.md#op) +- [reason](Node.types.TrackEndEvent.md#reason) +- [track](Node.types.TrackEndEvent.md#track) +- [type](Node.types.TrackEndEvent.md#type) + +## Properties + +### guildId + +• **guildId**: `string` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[guildId](Node.types.PlayerEventPayload.md#guildid) + +#### Defined in + +[@types/Node.types.ts:109](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L109) + +___ + +### op + +• **op**: ``"event"`` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[op](Node.types.PlayerEventPayload.md#op) + +#### Defined in + +[@types/Node.types.ts:107](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L107) + +___ + +### reason + +• **reason**: [`TrackEndReason`](../Node.types.md#trackendreason) + +#### Defined in + +[@types/Node.types.ts:122](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L122) + +___ + +### track + +• **track**: `string` + +#### Defined in + +[@types/Node.types.ts:121](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L121) + +___ + +### type + +• **type**: ``"TrackEndEvent"`` + +#### Overrides + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[type](Node.types.PlayerEventPayload.md#type) + +#### Defined in + +[@types/Node.types.ts:120](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L120) diff --git a/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.TrackExceptionEvent.md b/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.TrackExceptionEvent.md new file mode 100644 index 0000000..0da05a2 --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.TrackExceptionEvent.md @@ -0,0 +1,83 @@ +# @types/Node.TrackExceptionEvent + +[@types/Node.types](../Node.types.md).TrackExceptionEvent + +Lavalink node incoming payloads + +## Hierarchy + +- [`PlayerEventPayload`](Node.types.PlayerEventPayload.md) + + ↳ **`TrackExceptionEvent`** + +## Table of contents + +### Properties + +- [exception](Node.types.TrackExceptionEvent.md#exception) +- [guildId](Node.types.TrackExceptionEvent.md#guildid) +- [op](Node.types.TrackExceptionEvent.md#op) +- [track](Node.types.TrackExceptionEvent.md#track) +- [type](Node.types.TrackExceptionEvent.md#type) + +## Properties + +### exception + +• **exception**: [`LoadException`](../REST.types.md#loadexception) & { `cause`: `string` } + +#### Defined in + +[@types/Node.types.ts:128](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L128) + +___ + +### guildId + +• **guildId**: `string` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[guildId](Node.types.PlayerEventPayload.md#guildid) + +#### Defined in + +[@types/Node.types.ts:109](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L109) + +___ + +### op + +• **op**: ``"event"`` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[op](Node.types.PlayerEventPayload.md#op) + +#### Defined in + +[@types/Node.types.ts:107](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L107) + +___ + +### track + +• **track**: `string` + +#### Defined in + +[@types/Node.types.ts:127](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L127) + +___ + +### type + +• **type**: ``"TrackExceptionEvent"`` + +#### Overrides + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[type](Node.types.PlayerEventPayload.md#type) + +#### Defined in + +[@types/Node.types.ts:126](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L126) diff --git a/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.TrackStartEvent.md b/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.TrackStartEvent.md new file mode 100644 index 0000000..b67b9b9 --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.TrackStartEvent.md @@ -0,0 +1,72 @@ +# @types/Node.TrackStartEvent + +[@types/Node.types](../Node.types.md).TrackStartEvent + +Lavalink node incoming payloads + +## Hierarchy + +- [`PlayerEventPayload`](Node.types.PlayerEventPayload.md) + + ↳ **`TrackStartEvent`** + +## Table of contents + +### Properties + +- [guildId](Node.types.TrackStartEvent.md#guildid) +- [op](Node.types.TrackStartEvent.md#op) +- [track](Node.types.TrackStartEvent.md#track) +- [type](Node.types.TrackStartEvent.md#type) + +## Properties + +### guildId + +• **guildId**: `string` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[guildId](Node.types.PlayerEventPayload.md#guildid) + +#### Defined in + +[@types/Node.types.ts:109](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L109) + +___ + +### op + +• **op**: ``"event"`` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[op](Node.types.PlayerEventPayload.md#op) + +#### Defined in + +[@types/Node.types.ts:107](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L107) + +___ + +### track + +• **track**: `string` + +#### Defined in + +[@types/Node.types.ts:114](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L114) + +___ + +### type + +• **type**: ``"TrackStartEvent"`` + +#### Overrides + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[type](Node.types.PlayerEventPayload.md#type) + +#### Defined in + +[@types/Node.types.ts:113](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L113) diff --git a/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.TrackStuckEvent.md b/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.TrackStuckEvent.md new file mode 100644 index 0000000..e79d68e --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.TrackStuckEvent.md @@ -0,0 +1,83 @@ +# @types/Node.TrackStuckEvent + +[@types/Node.types](../Node.types.md).TrackStuckEvent + +Lavalink node incoming payloads + +## Hierarchy + +- [`PlayerEventPayload`](Node.types.PlayerEventPayload.md) + + ↳ **`TrackStuckEvent`** + +## Table of contents + +### Properties + +- [guildId](Node.types.TrackStuckEvent.md#guildid) +- [op](Node.types.TrackStuckEvent.md#op) +- [thresholdMs](Node.types.TrackStuckEvent.md#thresholdms) +- [track](Node.types.TrackStuckEvent.md#track) +- [type](Node.types.TrackStuckEvent.md#type) + +## Properties + +### guildId + +• **guildId**: `string` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[guildId](Node.types.PlayerEventPayload.md#guildid) + +#### Defined in + +[@types/Node.types.ts:109](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L109) + +___ + +### op + +• **op**: ``"event"`` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[op](Node.types.PlayerEventPayload.md#op) + +#### Defined in + +[@types/Node.types.ts:107](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L107) + +___ + +### thresholdMs + +• **thresholdMs**: `number` + +#### Defined in + +[@types/Node.types.ts:136](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L136) + +___ + +### track + +• **track**: `string` + +#### Defined in + +[@types/Node.types.ts:135](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L135) + +___ + +### type + +• **type**: ``"TrackStuckEvent"`` + +#### Overrides + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[type](Node.types.PlayerEventPayload.md#type) + +#### Defined in + +[@types/Node.types.ts:134](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L134) diff --git a/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.WebSocketClosedEvent.md b/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.WebSocketClosedEvent.md new file mode 100644 index 0000000..935dca2 --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/interfaces/Node.types.WebSocketClosedEvent.md @@ -0,0 +1,94 @@ +# @types/Node.WebSocketClosedEvent + +[@types/Node.types](../Node.types.md).WebSocketClosedEvent + +Lavalink node incoming payloads + +## Hierarchy + +- [`PlayerEventPayload`](Node.types.PlayerEventPayload.md) + + ↳ **`WebSocketClosedEvent`** + +## Table of contents + +### Properties + +- [byRemote](Node.types.WebSocketClosedEvent.md#byremote) +- [code](Node.types.WebSocketClosedEvent.md#code) +- [guildId](Node.types.WebSocketClosedEvent.md#guildid) +- [op](Node.types.WebSocketClosedEvent.md#op) +- [reason](Node.types.WebSocketClosedEvent.md#reason) +- [type](Node.types.WebSocketClosedEvent.md#type) + +## Properties + +### byRemote + +• **byRemote**: `boolean` + +#### Defined in + +[@types/Node.types.ts:142](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L142) + +___ + +### code + +• **code**: `number` + +#### Defined in + +[@types/Node.types.ts:140](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L140) + +___ + +### guildId + +• **guildId**: `string` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[guildId](Node.types.PlayerEventPayload.md#guildid) + +#### Defined in + +[@types/Node.types.ts:109](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L109) + +___ + +### op + +• **op**: ``"event"`` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[op](Node.types.PlayerEventPayload.md#op) + +#### Defined in + +[@types/Node.types.ts:107](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L107) + +___ + +### reason + +• **reason**: `string` + +#### Defined in + +[@types/Node.types.ts:141](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L141) + +___ + +### type + +• **type**: ``"TrackStartEvent"`` \| ``"TrackEndEvent"`` \| ``"TrackExceptionEvent"`` \| ``"TrackStuckEvent"`` \| ``"WebSocketClosedEvent"`` + +#### Inherited from + +[PlayerEventPayload](Node.types.PlayerEventPayload.md).[type](Node.types.PlayerEventPayload.md#type) + +#### Defined in + +[@types/Node.types.ts:108](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Node.types.ts#L108) diff --git a/apps/website/versioned_docs/version-1.2.0/types/interfaces/Track.types.ITrack.md b/apps/website/versioned_docs/version-1.2.0/types/interfaces/Track.types.ITrack.md new file mode 100644 index 0000000..adb5c48 --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/interfaces/Track.types.ITrack.md @@ -0,0 +1,30 @@ +# @types/Track.ITrack + +[@types/Track.types](../Track.types.md).ITrack + +## Table of contents + +### Properties + +- [info](Track.types.ITrack.md#info) +- [track](Track.types.ITrack.md#track) + +## Properties + +### info + +• **info**: [`TrackInfo`](../Track.types.md#trackinfo) + +#### Defined in + +[@types/Track.types.ts:22](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Track.types.ts#L22) + +___ + +### track + +• **track**: `string` + +#### Defined in + +[@types/Track.types.ts:21](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Track.types.ts#L21) diff --git a/apps/website/versioned_docs/version-1.2.0/types/interfaces/Track.types.Timestamp.md b/apps/website/versioned_docs/version-1.2.0/types/interfaces/Track.types.Timestamp.md new file mode 100644 index 0000000..391fa7c --- /dev/null +++ b/apps/website/versioned_docs/version-1.2.0/types/interfaces/Track.types.Timestamp.md @@ -0,0 +1,30 @@ +# @types/Track.Timestamp + +[@types/Track.types](../Track.types.md).Timestamp + +## Table of contents + +### Properties + +- [label](Track.types.Timestamp.md#label) +- [value](Track.types.Timestamp.md#value) + +## Properties + +### label + +• **label**: `string` + +#### Defined in + +[@types/Track.types.ts:26](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Track.types.ts#L26) + +___ + +### value + +• **value**: `number` + +#### Defined in + +[@types/Track.types.ts:27](https://github.com/hmes98318/LavaShark/blob/21c4e47/src/@types/Track.types.ts#L27) diff --git a/apps/website/versioned_sidebars/version-1.2.0-sidebars.json b/apps/website/versioned_sidebars/version-1.2.0-sidebars.json new file mode 100644 index 0000000..caea0c0 --- /dev/null +++ b/apps/website/versioned_sidebars/version-1.2.0-sidebars.json @@ -0,0 +1,8 @@ +{ + "tutorialSidebar": [ + { + "type": "autogenerated", + "dirName": "." + } + ] +} diff --git a/apps/website/versions.json b/apps/website/versions.json index 1cadd53..2c63fa5 100644 --- a/apps/website/versions.json +++ b/apps/website/versions.json @@ -1,3 +1,4 @@ [ + "1.2.0", "1.1.1" ]