Interface PlayOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional member

member?: GuildMember

Requested user

Optional message

message?: Message<boolean>

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

Optional metadata

metadata?: any

Metadata

Optional position

position?: number

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

Optional skip

skip?: boolean

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

Optional textChannel

textChannel?: GuildTextBasedChannel

The default text channel of the queue

Settings

Member Visibility

Theme

On This Page

membermessagemetadatapositionskiptextChannel