RuvyriasOptions

ruvyrias

---

ruvyrias / RuvyriasOptions

Interface: RuvyriasOptions

Defined in: src/Ruvyrias.ts:108

Options for configuring the Ruvyrias instance.

Properties

autoResume?

optional autoResume: boolean

Defined in: src/Ruvyrias.ts:112

Whether to automatically resume playback after a disconnect.

---

clientId?

optional clientId: null | string

Defined in: src/Ruvyrias.ts:124

The client ID associated with the Ruvyrias instance.

---

defaultPlatform?

optional defaultPlatform: SupportedPlatforms

Defined in: src/Ruvyrias.ts:116

The default platform for resolving tracks if not specified.

---

isInitialized?

optional isInitialized: boolean

Defined in: src/Ruvyrias.ts:126

Indicates whether the Ruvyrias instance is activated or not.

---

library

library: SupportedLibraries

Defined in: src/Ruvyrias.ts:114

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

---

plugins?

optional plugins: Plugin[]

Defined in: src/Ruvyrias.ts:110

An array of plugins to be used with Ruvyrias.

---

reconnectTimeout?

optional reconnectTimeout: null | number

Defined in: src/Ruvyrias.ts:120

Timeout duration in milliseconds for attempting reconnection to nodes.

---

reconnectTries?

optional reconnectTries: null | number

Defined in: src/Ruvyrias.ts:122

Number of reconnection attempts allowed before giving up.

---

resumeTimeout?

optional resumeTimeout: number

Defined in: src/Ruvyrias.ts:118

Timeout duration in milliseconds for automatic resuming of playback.

---

send?

optional send: null | Function

Defined in: src/Ruvyrias.ts:128

A function used for sending packets to the communication library.