Module: QueueManager

Source: components/manager/QueueManager.bs, line 1

Methods

(static) clear() → {void}

Clear all content from play queue

Source: components/manager/QueueManager.bs, line 15

Returns:

Type:: void

(static) clearHold() → {void}

Clear all hold content

Source: components/manager/QueueManager.bs, line 22

Returns:

Type:: void

(static) deleteAtIndex(index) → {void}

Delete item from play queue at passed index

Parameters:

Name	Type	Description
`index`	dynamic

Source: components/manager/QueueManager.bs, line 30

Returns:

Type:: void

(static) getCount() → {dynamic}

Return the number of items in the play queue

Source: components/manager/QueueManager.bs, line 37

Returns:

Type:: dynamic

(static) getCurrentItem() → {dynamic}

Return the item currently in focus from the play queue

Source: components/manager/QueueManager.bs, line 44

Returns:

Type:: dynamic

(static) getHold() → {dynamic}

Return the items in the hold

Source: components/manager/QueueManager.bs, line 51

Returns:

Type:: dynamic

(static) getIsShuffled() → {dynamic}

Return whether or not shuffle is enabled

Source: components/manager/QueueManager.bs, line 58

Returns:

Type:: dynamic

(static) getItemByIndex(index) → {dynamic}

Return the item in the passed index from the play queue

Parameters:

Name	Type	Description
`index`	dynamic

Source: components/manager/QueueManager.bs, line 66

Returns:

Type:: dynamic

(static) getItemType(item) → {string}

Parameters:

Name	Type	Description
`item`	dynamic

Source: components/manager/QueueManager.bs, line 233

Returns:

Type:: string

(static) getPosition() → {dynamic}

Returns current playback position within the queue

Source: components/manager/QueueManager.bs, line 73

Returns:

Type:: dynamic

(static) getQueue() → {dynamic}

Return the current play queue

Source: components/manager/QueueManager.bs, line 102

Returns:

Type:: dynamic

(static) getQueueTypes() → {dynamic}

Return the types of items in current play queue

Source: components/manager/QueueManager.bs, line 109

Returns:

Type:: dynamic

(static) getQueueUniqueTypes() → {dynamic}

Return the unique types of items in current play queue

Source: components/manager/QueueManager.bs, line 116

Returns:

Type:: dynamic

(static) getUnshuffledQueue() → {dynamic}

Return original, unshuffled queue

Source: components/manager/QueueManager.bs, line 196

Returns:

Type:: dynamic

(static) hold(newItem) → {void}

Hold an item

Parameters:

Name	Type	Description
`newItem`	dynamic

Source: components/manager/QueueManager.bs, line 81

Returns:

Type:: void

(static) init() → {void}

Source: components/manager/QueueManager.bs, line 8

Returns:

Type:: void

(static) isPrerollActive() → {boolean}

Return isPrerollActive status

Source: components/manager/QueueManager.bs, line 144

Returns:

Type:: boolean

(static) moveBack() → {void}

Move queue position back one

Source: components/manager/QueueManager.bs, line 88

Returns:

Type:: void

(static) moveForward() → {void}

Move queue position ahead one

Source: components/manager/QueueManager.bs, line 95

Returns:

Type:: void

(static) peek() → {dynamic}

Return item at end of play queue without removing

Source: components/manager/QueueManager.bs, line 123

Returns:

Type:: dynamic

(static) playQueue() → {void}

Play items in queue

Source: components/manager/QueueManager.bs, line 130

Returns:

Type:: void

(static) pop() → {void}

Remove item at end of play queue

Source: components/manager/QueueManager.bs, line 137

Returns:

Type:: void

(static) push(newItem) → {void}

Push new items to the play queue

Parameters:

Name	Type	Description
`newItem`	dynamic

Source: components/manager/QueueManager.bs, line 160

Returns:

Type:: void

(static) resetQueueItemOrder() → {void}

Reset queue items back to original, unshuffled order

Source: components/manager/QueueManager.bs, line 189

Returns:

Type:: void

(static) resetShuffle() → {void}

Reset shuffle to off state

Source: components/manager/QueueManager.bs, line 175

Returns:

Type:: void

(static) set(items) → {void}

Replace play queue with passed array

Parameters:

Name	Type	Description
`items`	dynamic

Source: components/manager/QueueManager.bs, line 218

Returns:

Type:: void

(static) setPosition(newPosition) → {void}

Set the queue position

Parameters:

Name	Type	Description
`newPosition`	dynamic

Source: components/manager/QueueManager.bs, line 168

Returns:

Type:: void

(static) setPrerollStatus(newStatus) → {void}

Set prerollActive status

Parameters:

Name	Type	Description
`newStatus`	boolean

Source: components/manager/QueueManager.bs, line 152

Returns:

Type:: void

(static) setTopStartingPoint(positionTicks) → {void}

Set starting point for top item in the queue

Parameters:

Name	Type	Description
`positionTicks`	dynamic

Source: components/manager/QueueManager.bs, line 226

Returns:

Type:: void

(static) shuffleQueueItems() → {void}

Save a copy of the original queue and randomize order of queue items

Source: components/manager/QueueManager.bs, line 203

Returns:

Type:: void

(static) toggleShuffle() → {void}

Toggle shuffleEnabled state

Source: components/manager/QueueManager.bs, line 182

Returns:

Type:: void

(static) top() → {dynamic}

Return the fitst item in the play queue

Source: components/manager/QueueManager.bs, line 210

Returns:

Type:: dynamic