Class queue

Hierarchy

queue

Index

Constructors

Properties

destroyed discordClient guildId player

Accessors

current paused playing previousTrack previousTracks timeStamp tracks type voiceConnection volume working

Methods

back clear destroy mute pause play setVolume shuffle skip stop unmute unpause

Constructors

constructor

new queue(guildId: string | number, options: Options, player: player): queue
Parameters
- guildId: string | number
- options: Options
- player: player
Returns queue
- Defined in typings/index.d.ts:200

Properties

`Readonly` destroyed

destroyed: boolean

`Readonly` discordClient

discordClient: Client<boolean>

`Readonly` guildId

guildId: string | number

`Readonly` player

player: player

Accessors

current

get current(): Track
Returns Track
- Defined in typings/index.d.ts:214

paused

get paused(): Boolean
Returns Boolean
- Defined in typings/index.d.ts:213

playing

get playing(): Boolean
Returns Boolean
- Defined in typings/index.d.ts:212

previousTrack

get previousTrack(): Track
Returns Track
- Defined in typings/index.d.ts:216

previousTracks

get previousTracks(): Track[]
Returns Track[]
- Defined in typings/index.d.ts:217

timeStamp

get timeStamp(): TimeStamp
Returns TimeStamp
- Defined in typings/index.d.ts:219

tracks

get tracks(): Track[]
Returns Track[]
- Defined in typings/index.d.ts:215

type

get type(): string
Returns string
- Defined in typings/index.d.ts:209

voiceConnection

get voiceConnection(): VoiceConnection
Returns VoiceConnection
- Defined in typings/index.d.ts:218

volume

get volume(): Number
Returns Number
- Defined in typings/index.d.ts:210

working

get working(): Boolean
Returns Boolean
- Defined in typings/index.d.ts:211

Methods

back

back(tracksCount?: Number | 1): Promise<Boolean>
Parameters
- Optional tracksCount: Number | 1
Returns Promise<Boolean>
- Defined in typings/index.d.ts:242

clear

clear(tracksCount?: Number): Boolean
Parameters
- Optional tracksCount: Number
Returns Boolean
- Defined in typings/index.d.ts:240

destroy

destroy(delayVoiceTimeout?: 0 | Number, destroyConnection?: false | Boolean): Promise<Boolean>
Parameters
- Optional delayVoiceTimeout: 0 | Number
- Optional destroyConnection: false | Boolean
Returns Promise<Boolean>
- Defined in typings/index.d.ts:231

mute

mute(): Promise<Boolean>
Returns Promise<Boolean>
- Defined in typings/index.d.ts:238

pause

pause(): Boolean
Returns Boolean
- Defined in typings/index.d.ts:235

play

play(rawQuery: string, voiceSnowflake: string | number | VoiceChannel | StageChannel | Message<boolean>, requestedBy: string | number | User | GuildMember, options?: Options): Promise<Boolean>
Parameters
- rawQuery: string
- voiceSnowflake: string | number | VoiceChannel | StageChannel | Message<boolean>
- requestedBy: string | number | User | GuildMember
- Optional options: Options
Returns Promise<Boolean>
- Defined in typings/index.d.ts:220

setVolume

setVolume(volume?: Number): Number
Parameters
- Optional volume: Number
Returns Number
- Defined in typings/index.d.ts:237

shuffle

shuffle(): Boolean
Returns Boolean
- Defined in typings/index.d.ts:241

skip

skip(forceSkip?: true | Boolean, trackCount?: Number | 1): Promise<Boolean>
Parameters
- Optional forceSkip: true | Boolean
- Optional trackCount: Number | 1
Returns Promise<Boolean>
- Defined in typings/index.d.ts:226

stop

stop(forceStop?: true | Boolean): Promise<Boolean>
Parameters
- Optional forceStop: true | Boolean
Returns Promise<Boolean>
- Defined in typings/index.d.ts:230

unmute

unmute(): Promise<Boolean>
Returns Promise<Boolean>
- Defined in typings/index.d.ts:239

unpause

unpause(): Boolean
Returns Boolean
- Defined in typings/index.d.ts:236

Generated using TypeDoc