Interface PlayOptions<T>

interface PlayOptions<T = unknown> {
    member?: GuildMember;
    message?: Message<boolean>;
    metadata?: T;
    position?: number;
    skip?: boolean;
    textChannel?: GuildTextBasedChannel;
}

Type Parameters

  • T = unknown

Hierarchy (View Summary)

Properties

member? message? metadata? position? skip? textChannel?

Properties

Optionalmember

member?: GuildMember

Requested user

Optionalmessage

message?: Message<boolean>

Called message (For built-in search events. If this is a falsy value, it will play the first result instead)

Optionalmetadata

metadata?: T

Metadata

Optionalposition

position?: number

[Default: 0] Position of the song/playlist to add to the queue, <= 0 to add to the end of the queue

Optionalskip

skip?: boolean

[Default: false] Skip the playing song (if exists) and play the added playlist instantly

OptionaltextChannel

textChannel?: GuildTextBasedChannel

The default text channel of the queue

Settings

Member Visibility

On This Page

Properties