Queue
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new Queue()
Defined in
Properties
tracks
• tracks: (default
| default
)[]
Defined in
Accessors
duration
• get
duration(): number
獲取隊列的持續時間,以毫秒為單位
Returns
number
Defined in
size
• get
size(): number
獲取隊列的大小
Returns
number
Defined in
Methods
add
▸ add(track
): void
[內部使用] 將音軌添加到隊列中。外部使用者應使用 Player.addTracks() 方法代替
Parameters
Name | Type | Description |
---|---|---|
track | default | default | 要添加到隊列的歌曲 |
Returns
void
Defined in
clear
▸ clear(): void
清空隊列
Returns
void
Defined in
poll
▸ poll(): null
| default
| default
從隊列中取出下一首歌曲
Returns
null
| default
| default
隊列中的下一個歌曲,如果隊列為空則返回 null
Defined in
remove
▸ remove(): boolean
移除隊列中的第一首歌曲
Returns
boolean
如果歌曲成功移除則返回 true,否則返回 false
Defined in
▸ remove(index
): boolean
移除指定位置的歌曲
Parameters
Name | Type | Description |
---|---|---|
index | number | 要移除的歌曲的索引 |
Returns
boolean
如果歌曲成功移除則返回 true,否則返回 false
Defined in
▸ remove(start
, end
): boolean
移除指定範圍內的歌曲
Parameters
Name | Type | Description |
---|---|---|
start | number | 範圍的開始索引 |
end | number | 範圍的結束索引 |
Returns
boolean
如果歌曲成功移除則返回 true,否則返回 false
Defined in
shuffle
▸ shuffle(): void
隨機洗牌隊列
Returns
void
Defined in
skipNTracks
▸ skipNTracks(n
): void
從隊列中移除 n 首歌曲
Parameters
Name | Type | Description |
---|---|---|
n | number | 要跳過的歌曲數量 |
Returns
void