Interface PlayOptions<Context, UserData>

Options for customizing a 'play' operation

interface PlayOptions<
    Context extends Record<string, unknown> = EmptyObject,
    UserData extends JsonObject = EmptyObject,
> {
    userData?: UserData;
    node?: string;
    prefix?: string;
    guildId: string;
    voiceId: string;
    context?: Context;
    volume?: number;
    filters?: Filters<EmptyObject>;
}

Type Parameters

Context extends Record<string, unknown> = EmptyObject
UserData extends JsonObject = EmptyObject

Hierarchy (View Summary)

SearchOptions
CreateQueueOptions<Context>
- PlayOptions

Index

Properties

userData? node? prefix? guildId voiceId context? volume? filters?

Properties

`Optional`userData

userData?: UserData

`Optional`node

node?: string

`Optional`prefix

prefix?: string

guildId

guildId: string

voiceId

voiceId: string

`Optional`context

context?: Context

`Optional`volume

volume?: number

The player volume, in percentage, from 0 to 1000

`Optional`filters

filters?: Filters<EmptyObject>

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