跳至主要内容
版本:v2.0.0

Queue

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new Queue()

Defined in

Queue.ts:8

Properties

tracks

tracks: (default | default)[]

Defined in

lib/queue/Queue.ts:6

Accessors

duration

get duration(): number

獲取隊列的持續時間,以毫秒為單位

Returns

number

Defined in

lib/queue/Queue.ts:22


size

get size(): number

獲取隊列的大小

Returns

number

Defined in

lib/queue/Queue.ts:15

Methods

add

add(track): void

[內部使用] 將音軌添加到隊列中。外部使用者應使用 Player.addTracks() 方法代替

Parameters

NameTypeDescription
trackdefaultdefault

Returns

void

Defined in

lib/queue/Queue.ts:30


clear

clear(): void

清空隊列

Returns

void

Defined in

lib/queue/Queue.ts:66


poll

poll(): null | default | default

從隊列中取出下一首歌曲

Returns

null | default | default

隊列中的下一個歌曲,如果隊列為空則返回 null

Defined in

lib/queue/Queue.ts:38


remove

remove(): boolean

移除隊列中的第一首歌曲

Returns

boolean

如果歌曲成功移除則返回 true,否則返回 false

Defined in

lib/queue/Queue.ts:74

remove(index): boolean

移除指定位置的歌曲

Parameters

NameTypeDescription
indexnumber要移除的歌曲的索引

Returns

boolean

如果歌曲成功移除則返回 true,否則返回 false

Defined in

lib/queue/Queue.ts:80

remove(start, end): boolean

移除指定範圍內的歌曲

Parameters

NameTypeDescription
startnumber範圍的開始索引
endnumber範圍的結束索引

Returns

boolean

如果歌曲成功移除則返回 true,否則返回 false

Defined in

lib/queue/Queue.ts:87


shuffle

shuffle(): void

隨機洗牌隊列

Returns

void

Defined in

lib/queue/Queue.ts:53


skipNTracks

skipNTracks(n): void

從隊列中移除 n 首歌曲

Parameters

NameTypeDescription
nnumber要跳過的歌曲數量

Returns

void

Defined in

lib/queue/Queue.ts:46