RuvyriasOptions

ruvyrias

---

ruvyrias / RuvyriasOptions

Interface: RuvyriasOptions

Defined in: types/Ruvyrias.ts:99

Options for configuring the Ruvyrias instance.

Extended by

• Extras

Properties

autoResume?

optional autoResume: boolean

Defined in: types/Ruvyrias.ts:103

Whether to automatically resume playback after a player disconnect.

---

clientId?

optional clientId: null | string

Defined in: types/Ruvyrias.ts:117

The client ID associated with the Ruvyrias instance.

---

defaultPlatform?

optional defaultPlatform: PlatformsType

Defined in: types/Ruvyrias.ts:109

The default platform for resolving tracks if not specified.

---

isInitialized?

optional isInitialized: boolean

Defined in: types/Ruvyrias.ts:119

Indicates whether the Ruvyrias instance is activated or not.

---

library

library: LibrariesType

Defined in: types/Ruvyrias.ts:107

The library used for communication (e.g., 'discord.js', 'eris', etc.).

---

plugins?

optional plugins: Plugin[]

Defined in: types/Ruvyrias.ts:101

An array of plugins to be used with Ruvyrias.

---

resume?

optional resume: boolean

Defined in: types/Ruvyrias.ts:105

Whether to automatically resume playback after a node disconnect.

---

resumeTimeout?

optional resumeTimeout: number

Defined in: types/Ruvyrias.ts:111

Timeout duration in milliseconds for automatic resuming of playback.

---

retryAmount?

optional retryAmount: null | number

Defined in: types/Ruvyrias.ts:115

Number of reconnection attempts allowed before giving up.

---

retryDelay?

optional retryDelay: null | number

Defined in: types/Ruvyrias.ts:113

Timeout duration in milliseconds for attempting reconnection to nodes.

---

sendPayload?

optional sendPayload: null | Function

Defined in: types/Ruvyrias.ts:121

A function used for sending packets to the communication library.