Interface AudioListenOptions

Options for starting the audio listener.

interface AudioListenOptions {
    autoReconnect?: boolean;
    displayName?: string;
    guildId: string;
    initialDelayMs?: number;
    maxAttempts?: number;
    maxDelayMs?: number;
    nets?: number[];
}

Properties

autoReconnect? displayName? guildId initialDelayMs? maxAttempts? maxDelayMs? nets?

Properties

OptionalautoReconnect

autoReconnect?: boolean

Auto-reconnect on connection loss.

Default

true

OptionaldisplayName

displayName?: string

Display name shown in the shard roster for this listener.

Default

""

guildId

guildId: string

Discord guild ID to listen on.

OptionalinitialDelayMs

initialDelayMs?: number

Initial delay before first reconnect attempt in ms.

Default

2000

OptionalmaxAttempts

maxAttempts?: number

Maximum consecutive reconnect attempts.

Default

Infinity

OptionalmaxDelayMs

maxDelayMs?: number

Maximum delay between reconnect attempts in ms.

Default

30000

Optionalnets

nets?: number[]

Initial net IDs to receive audio from.

Settings

Member Visibility

On This Page

Properties