Очередь

class yandex_music._client.queue.QueueMixin

Очередь.

Миксин для методов, связанных с очередью прослушивания.

queues_list(device=None, *args, **kwargs)

Получение всех очередей треков с разных устройств для синхронизации между ними.

Note

Именно к device привязывается очередь. На одном устройстве может быть создана одна очередь.

Аргумент device имеет следующий формат: ключ=значение; ключ2=значение2. Обязательные паля указы в значении по умолчанию.

Parameters:

  • device (str, optional) – Содержит информацию об устройстве с которого выполняется запрос.

  • *args – Произвольные аргументы (будут переданы в запрос).

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Элементы очереди всех устройств.

Return type:

list из yandex_music.QueueItem

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

queue(queue_id, *args, **kwargs)

Получение информации об очереди треков и самих треков в ней.

Parameters:

  • queue_id (str) – Уникальный идентификатор очереди.

  • *args – Произвольные аргументы (будут переданы в запрос).

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Очередь или None.

Return type:

yandex_music.Queue

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

queue_update_position(queue_id, current_index, device=None, **kwargs)

Установка текущего индекса проигрываемого трека в очереди треков.

Note

Изменить можно только у той очереди, которая была создана с переданного device!

Parameters:

  • queue_id (str) – Уникальный идентификатор очереди.

  • current_index (int) – Текущий индекс.

  • device (str, optional) – Содержит информацию об устройстве с которого выполняется запрос.

  • *args – Произвольные аргументы (будут переданы в запрос).

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

queue_create(queue, device=None, *args, **kwargs)

Создание новой очереди треков.

Parameters:

  • queue (yandex_music.Queue | str) – Объект очереди или JSON строка с этим объектом.

  • device (str, optional) – Содержит информацию об устройстве с которого выполняется запрос.

  • *args – Произвольные аргументы (будут переданы в запрос).

  • **kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Вернёт уникальный идентификатор созданной очереди, иначе None.

Return type:

str

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.