Skip to main content

ruvyrias / Exports / RuvyriasOptions

Interface: RuvyriasOptions

Options for configuring the Ruvyrias instance.

Table of contents​

Properties​

Properties​

autoResume​

• Optional autoResume: boolean

Whether to automatically resume playback after a disconnect.

Defined in​

src/Ruvyrias.ts:112

clientId​

• Optional clientId: null | string

The client ID associated with the Ruvyrias instance.

Defined in​

src/Ruvyrias.ts:126

clientName​

• Optional clientName: string

The name of the client using Ruvyrias.

Defined in​

src/Ruvyrias.ts:124

clientVersion​

• Optional clientVersion: number

The version number of the client using Ruvyrias.

Defined in​

src/Ruvyrias.ts:128

defaultPlatform​

• Optional defaultPlatform: SupportedPlatforms

The default platform for resolving tracks if not specified.

Defined in​

src/Ruvyrias.ts:116

isActivated​

• Optional isActivated: boolean

Indicates whether the Ruvyrias instance is activated or not.

Defined in​

src/Ruvyrias.ts:130

library​

• library: SupportedLibraries

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

Defined in​

src/Ruvyrias.ts:114

plugins​

• Optional plugins: Plugin[]

An array of plugins to be used with Ruvyrias.

Defined in​

src/Ruvyrias.ts:110

reconnectTimeout​

• Optional reconnectTimeout: null | number

Timeout duration in milliseconds for attempting reconnection to nodes.

Defined in​

src/Ruvyrias.ts:120

reconnectTries​

• Optional reconnectTries: null | number

Number of reconnection attempts allowed before giving up.

Defined in​

src/Ruvyrias.ts:122

resumeTimeout​

• Optional resumeTimeout: number

Timeout duration in milliseconds for automatic resuming of playback.

Defined in​

src/Ruvyrias.ts:118

send​

• Optional send: null | Function

A function used for sending packets to the communication library.

Defined in​

src/Ruvyrias.ts:132