Methods
(static) clear() → {void}
Clear all content from play queue
- Type:
- void
(static) clearHold() → {void}
Clear all hold content
- Type:
- void
(static) deleteAtIndex(index) → {void}
Delete item from play queue at passed index
| Name | Type | Description |
|---|---|---|
index | dynamic |
- Type:
- void
(static) getCount() → {dynamic}
Return the number of items in the play queue
- Type:
- dynamic
(static) getCurrentItem() → {dynamic}
Return the item currently in focus from the play queue
- Type:
- dynamic
(static) getHold() → {dynamic}
Return the items in the hold
- Type:
- dynamic
(static) getIsShuffled() → {dynamic}
Return whether or not shuffle is enabled
- Type:
- dynamic
(static) getItemByIndex(index) → {dynamic}
Return the item in the passed index from the play queue
| Name | Type | Description |
|---|---|---|
index | dynamic |
- Type:
- dynamic
(static) getItemType(item) → {string}
| Name | Type | Description |
|---|---|---|
item | dynamic |
- Type:
- string
(static) getPosition() → {dynamic}
Returns current playback position within the queue
- Type:
- dynamic
(static) getQueue() → {dynamic}
Return the current play queue
- Type:
- dynamic
(static) getQueueTypes() → {dynamic}
Return the types of items in current play queue
- Type:
- dynamic
(static) getQueueUniqueTypes() → {dynamic}
Return the unique types of items in current play queue
- Type:
- dynamic
(static) getUnshuffledQueue() → {dynamic}
Return original, unshuffled queue
- Type:
- dynamic
(static) hold(newItem) → {void}
Hold an item
| Name | Type | Description |
|---|---|---|
newItem | dynamic |
- Type:
- void
(static) init() → {void}
- Type:
- void
(static) isPrerollActive() → {boolean}
Return isPrerollActive status
- Type:
- boolean
(static) moveBack() → {void}
Move queue position back one
- Type:
- void
(static) moveForward() → {void}
Move queue position ahead one
- Type:
- void
(static) peek() → {dynamic}
Return item at end of play queue without removing
- Type:
- dynamic
(static) playQueue() → {void}
Play items in queue
- Type:
- void
(static) pop() → {void}
Remove item at end of play queue
- Type:
- void
(static) push(newItem) → {void}
Push new items to the play queue
| Name | Type | Description |
|---|---|---|
newItem | dynamic |
- Type:
- void
(static) resetQueueItemOrder() → {void}
Reset queue items back to original, unshuffled order
- Type:
- void
(static) resetShuffle() → {void}
Reset shuffle to off state
- Type:
- void
(static) set(items) → {void}
Replace play queue with passed array
| Name | Type | Description |
|---|---|---|
items | dynamic |
- Type:
- void
(static) setPosition(newPosition) → {void}
Set the queue position
| Name | Type | Description |
|---|---|---|
newPosition | dynamic |
- Type:
- void
(static) setPrerollStatus(newStatus) → {void}
Set prerollActive status
| Name | Type | Description |
|---|---|---|
newStatus | boolean |
- Type:
- void
(static) setTopStartingPoint(positionTicks) → {void}
Set starting point for top item in the queue
| Name | Type | Description |
|---|---|---|
positionTicks | dynamic |
- Type:
- void
(static) shuffleQueueItems() → {void}
Save a copy of the original queue and randomize order of queue items
- Type:
- void
(static) toggleShuffle() → {void}
Toggle shuffleEnabled state
- Type:
- void
(static) top() → {dynamic}
Return the fitst item in the play queue
- Type:
- dynamic