Class CoffeeQueue

The player's queue, the current property is the currently playing track, think of the rest as the up-coming tracks

Hierarchy

Array<CoffeeTrack | UnresolvedTrack>
- CoffeeQueue

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CoffeeQueue(arrayLength: number): CoffeeQueue
new CoffeeQueue(...items: (CoffeeTrack | UnresolvedTrack)[]): CoffeeQueue

Inherited from Array<CoffeeTrack | UnresolvedTrack>.constructor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1406
Parameters
- arrayLength: number
Returns CoffeeQueue
Inherited from Array<CoffeeTrack | UnresolvedTrack>.constructor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1407
Parameters
- Rest ...items: (CoffeeTrack | UnresolvedTrack)[]
Returns CoffeeQueue

Properties

Optional current

current?: CoffeeTrack | UnresolvedTrack

The current track

Optional previous

previous?: CoffeeTrack | UnresolvedTrack

The previous track

Accessors

duration

get duration(): number

- Defined in src/structures/CoffeeQueue.ts:12
The total duration of the queue

Returns number

size

get size(): number

- Defined in src/structures/CoffeeQueue.ts:23
The size of the tracks in the queue

Returns number

totalSize

get totalSize(): number

- Defined in src/structures/CoffeeQueue.ts:18
The total size of tracks in the queue including the current track

Returns number

Methods

add

add(tracks: CoffeeTrack | UnresolvedTrack | (CoffeeTrack | UnresolvedTrack)[], offset?: number): void

- Defined in src/structures/CoffeeQueue.ts:29
Add some track to the queue

Parameters
- tracks: CoffeeTrack | UnresolvedTrack | (CoffeeTrack | UnresolvedTrack)[]
- Optional offset: number
Returns void

clear

clear(): void

- Defined in src/structures/CoffeeQueue.ts:51
Clear the queue

Returns void

progress

progress(): undefined | CoffeeTrack | UnresolvedTrack

- Defined in src/structures/CoffeeQueue.ts:64
Progress to next song

Returns undefined | CoffeeTrack | UnresolvedTrack

remove

remove(start: number, end?: number): (CoffeeTrack | UnresolvedTrack)[]

- Defined in src/structures/CoffeeQueue.ts:45
Removes an amount of tracks using a exclusive start and end exclusive index, returning the removed tracks, EXCLUDING THE current TRACK

Parameters
- start: number
- Optional end: number
Returns (CoffeeTrack | UnresolvedTrack)[]

shuffle

shuffle(): void

- Defined in src/structures/CoffeeQueue.ts:56
Shuffle the queue

Returns void

Generated using TypeDoc