Queue

class pomice.queue.Queue(max_size: int | None = None, *, overflow: bool = True)

Bases: Iterable[Track]

Queue for Pomice. This queue takes pomice.Track as an input and includes looping and shuffling.

clear() → None

Remove all items from the queue.

clear_track_filters() → None

Clears all filters applied to tracks

copy() → Queue

Create a copy of the current queue including it’s members.

property count: int

Returns queue member count.

disable_loop() → None

Disables loop mode if set. Raises QueueException if loop mode is already None.

extend(iterable: Iterable[Track], *, atomic: bool = True) → None

Add the members of the given iterable to the end of the queue. If atomic is set to True, no tracks will be added upon any exceptions. If atomic is set to False, as many tracks will be added as possible. When overflow is enabled for the queue, atomic=True won’t prevent dropped items.

find_position(item: Track) → int

Find the position a given item within the queue. Raises ValueError if item is not in queue.

get() → Track

Return next immediately available item in queue if any. Raises QueueEmpty if no items in queue.

get_queue() → List

Returns the queue as a List

property is_empty: bool

Returns True if queue has no members.

property is_full: bool

Returns True if queue item count has reached max_size.

property is_looping: bool

Returns True if the queue is looping either a track or the queue

jump(item: Track) → None

Jumps to the item specified in the queue.

If the queue is not looping, the queue will be mutated. Otherwise, the current item will be adjusted to the item before the specified track.

The queue is adjusted so that the next item that is retrieved is the track that is specified, effectively ‘jumping’ the queue.

property loop_mode: LoopMode | None

Returns the LoopMode enum set in the queue object

max_size: int | None

pop() → Track

Return item from the right end side of the queue. Raises QueueEmpty if no items in queue.

put(item: Track) → None

Put the given item into the back of the queue.

put_at_front(item: Track) → None

Put the given item into the front of the queue.

put_at_index(index: int, item: Track) → None

Put the given item into the queue at the specified index.

remove(item: Track) → None

Removes a item within the queue. Raises ValueError if item is not in queue.

set_loop_mode(mode: LoopMode) → None

Sets the loop mode of the queue. Takes the LoopMode enum as an argument.

shuffle() → None

Shuffles the queue.

property size: int

Returns the amount of items in the queue