Interface CreateQueueOptions<Context>

Options for creating a queue via manager

interface CreateQueueOptions<
    Context extends Record<string, unknown> = QueueContext,
> {
    guildId: string;
    voiceId: string;
    node?: string;
    context?: Context;
    filters?: Filters<CommonPluginFilters>;
    volume?: number;
}

Type Parameters

Context extends Record<string, unknown> = QueueContext

Hierarchy (View Summary)

Pick<PlayerUpdateRequestBody, "filters" | "volume">
- CreateQueueOptions
  - PlayOptions

Index

Properties

guildId voiceId node? context? filters? volume?

Properties

guildId

guildId: string

voiceId

voiceId: string

`Optional`node

node?: string

`Optional`context

context?: Context

`Optional`filters

filters?: Filters<CommonPluginFilters>

The new filters to apply. This will override all previously applied filters

`Optional`volume

volume?: number

The player volume, in percentage, from 0 to 1000