jellyfin-roku api docs

Module: QueueManager

Source:

Methods

<static> clear()

Clear all content from play queue

Source:
Returns:
Type
void

<static> clearHold()

Clear all hold content

Source:
Returns:
Type
void

<static> deleteAtIndex(index)

Delete item from play queue at passed index

Parameters:
Name Type Description
index dynamic
Source:
Returns:
Type
void

<static> getCount()

Return the number of items in the play queue

Source:
Returns:
Type
dynamic

<static> getCurrentItem()

Return the item currently in focus from the play queue

Source:
Returns:
Type
dynamic

<static> getHold()

Return the items in the hold

Source:
Returns:
Type
dynamic

<static> getIsShuffled()

Return whether or not shuffle is enabled

Source:
Returns:
Type
dynamic

<static> getItemByIndex(index)

Return the item in the passed index from the play queue

Parameters:
Name Type Description
index dynamic
Source:
Returns:
Type
dynamic

<static> getItemType(item)

Parameters:
Name Type Description
item dynamic
Source:
Returns:
Type
string

<static> getPosition()

Returns current playback position within the queue

Source:
Returns:
Type
dynamic

<static> getQueue()

Return the current play queue

Source:
Returns:
Type
dynamic

<static> getQueueTypes()

Return the types of items in current play queue

Source:
Returns:
Type
dynamic

<static> getQueueUniqueTypes()

Return the unique types of items in current play queue

Source:
Returns:
Type
dynamic

<static> getUnshuffledQueue()

Return original, unshuffled queue

Source:
Returns:
Type
dynamic

<static> hold(newItem)

Hold an item

Parameters:
Name Type Description
newItem dynamic
Source:
Returns:
Type
void

<static> init()

Source:
Returns:
Type
void

<static> isPrerollActive()

Return isPrerollActive status

Source:
Returns:
Type
boolean

<static> moveBack()

Move queue position back one

Source:
Returns:
Type
void

<static> moveForward()

Move queue position ahead one

Source:
Returns:
Type
void

<static> peek()

Return item at end of play queue without removing

Source:
Returns:
Type
dynamic

<static> playQueue()

Play items in queue

Source:
Returns:
Type
void

<static> pop()

Remove item at end of play queue

Source:
Returns:
Type
void

<static> push(newItem)

Push new items to the play queue

Parameters:
Name Type Description
newItem dynamic
Source:
Returns:
Type
void

<static> resetQueueItemOrder()

Reset queue items back to original, unshuffled order

Source:
Returns:
Type
void

<static> resetShuffle()

Reset shuffle to off state

Source:
Returns:
Type
void

<static> set(items)

Replace play queue with passed array

Parameters:
Name Type Description
items dynamic
Source:
Returns:
Type
void

<static> setPosition(newPosition)

Set the queue position

Parameters:
Name Type Description
newPosition dynamic
Source:
Returns:
Type
void

<static> setPrerollStatus(newStatus)

Set prerollActive status

Parameters:
Name Type Description
newStatus boolean
Source:
Returns:
Type
void

<static> setTopStartingPoint(positionTicks)

Set starting point for top item in the queue

Parameters:
Name Type Description
positionTicks dynamic
Source:
Returns:
Type
void

<static> shuffleQueueItems()

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

Source:
Returns:
Type
void

<static> toggleShuffle()

Toggle shuffleEnabled state

Source:
Returns:
Type
void

<static> top()

Return the fitst item in the play queue

Source:
Returns:
Type
dynamic