Playlist

class yandex_music.playlist.playlist.Playlist

Класс, представляющий плейлист.

Note

Под полями с заглушками понимаются поля, которые доступны у умных плейлистов тогда, когда у сервиса мало данных для генерации плейлиста.

Известные значения visibility: public - публичный плейлист, private - приватный плейлист.

Известные значения generated_playlist_type: playlistOfTheDay - Плейлист дня, recentTracks - Премьера, neverHeard - Дежавю, podcasts - Подкасты недели, missedLikes - Тайник, origin - Плейлист с Алисой.

Известные значения type: missedLikes, recentTracks.

owner

Владелец плейлиста.

Type:: yandex_music.User, optional

cover

Обложка альбома.

Type:: yandex_music.Cover, optional

made_for

Пользователь для которого был создан плейлист. Присутствует только у персональных плейлистов.

Type:: yandex_music.MadeFor, optional

play_counter

Счётчик дней. Присутствует только у плейлиста дня.

Type:: yandex_music.PlayCounter, optional

playlist_absence

Причина отсутствия плейлиста.

Type:: yandex_music.PlaylistAbsence, optional

uid

Идентификатор владельца плейлиста.

Type:: int, optional

kind

Идентификатор плейлиста.

Type:: int, optional

title

Название плейлиста.

Type:: str, optional

track_count

Количество треков.

Type:: int, optional

tags

Список тегов плейлиста.

Type:: list, optional

revision

Актуальность данных TODO.

Type:: int, optional

snapshot

Версия плейлиста. Увеличивается на 1 при каждом изменении.

Type:: int, optional

visibility

Видимость плейлиста.

Type:: str, optional

collective

Есть ли у плейлиста соавторы.

Type:: bool, optional

url_part

Часть ссылки на плейлист (‘daily`).

Type:: str, optional

created

Дата создания в формате ISO 8601.

Type:: str, optional

modified

Дата последнего изменения в формате ISO 8601.

Type:: str, optional

available

Доступен TODO.

Type:: bool, optional

is_banner

Является ли банером TODO.

Type:: bool, optional

is_premiere

Является ли премьерой TODO.

Type:: bool, optional

duration_ms

Длительность в миллисекундах.

Type:: int, optional

og_image

Ссылка на превью Open Graph.

Type:: str, optional

og_title

Заголовок Open Graph.

Type:: str, optional

og_description

Описание Open Graph.

Type:: str, optional

image

Изображение TODO.

Type:: str, optional

cover_without_text

Обложка без текста.

Type:: yandex_music.Cover, optional

contest

Контест TODO.

Type:: yandex_music.Contest, optional

background_color

Цвет заднего фона TODO.

Type:: str, optional

text_color

Цвет текста TODO.

Type:: str, optional

id_for_from

Откуда пришло событие (уникальный идентификатор объекта) TODO.

Type:: str, optional

dummy_description

Описание-заглушка плейлиста.

Type:: str, optional

dummy_page_description

Описание-заглушка страницы.

Type:: str, optional

dummy_cover

Обложка-заглушка.

Type:: str, optional

dummy_rollover_cover

Обложка-заглушка TODO.

Type:: str, optional

og_data

Данные для OpenGraph.

Type:: yandex_music.OpenGraphData, optional

branding

Бренд.

Type:: yandex_music.Brand

metrika_id

Уникальный идентификатор счётчика на Яндекс.Метрика.

Type:: int, optional

coauthors

Перечень ID аккаунтов соавторов плейлиста.

Type:: list из int, optional

top_artist

Топ артистов TODO.

Type:: list из yandex_music.Artist, optional

recent_tracks

Список ID недавних треков.

Type:: list из yandex_music.TrackId, optional

tracks

Список треков.

Type:: list из yandex_music.TrackShort, optional

prerolls

Прерол, проигрываемый перед плейлистом. Присутствует только у персональных плейлистов.

Type:: list, optional

likes_count

Количество лайков.

Type:: int, optional

similar_playlists

Похожие плейлисты.

Type:: list из yandex_music.Playlist, optional

last_owner_playlists

Последние плейлисты владельца.

Type:: list из yandex_music.Playlist, optional

generated_playlist_type

Тип генерируемого плейлиста.

Type:: str, optional

animated_cover_uri

Ссылка на анимированную обложку.

Type:: str, optional

ever_played

Играл ли этот плейлист. Присутствует только у персональных плейлистов. TODO

Type:: str, optional

description

Описание плейлиста с разметкой Markdown.

Type:: str, optional

description_formatted

Описание плейлиста. Только текст, без разметки.

Type:: str, optional

playlist_uuid

TODO.

Type:: str, optional

type

TODO.

Type:: str, optional

ready

Готовность TODO.

Type:: bool, optional

is_for_from

TODO.

Type:: Any

regions

Регион TODO.

Type:: Any

custom_wave (: obj:’yandex_music.CustomWave`, optional): Описание плейлиста. TODO.

pager

Пагинатор.

Type:: yandex_music.Pager, optional

has_trailer

Есть ли у плейлиста трейлер.

Type:: bool, optional

trailer

Доступность трейлера плейлиста.

Type:: yandex_music.PlaylistAvailability, optional

background_video_url

Ссылка на фоновое видео.

Type:: str, optional

background_video_id

Идентификатор фонового видео.

Type:: str, optional

background_image_url

Ссылка на фоновое изображение.

Type:: str, optional

client

Клиент Yandex Music.

Type:: yandex_music.Client, optional

property is_mine: Является ли плейлист моим.

property playlist_id: Полный ID плейлиста.

get_recommendations(*args, **kwargs)

Сокращение.

Сокращение для:

client.users_playlists_recommendations(playlist.kind, playlist.owner.uid, *args, **kwargs)

async get_recommendations_async(*args, **kwargs)

Сокращение.

Сокращение для:

await client.users_playlists_recommendations(playlist.kind, playlist.owner.uid, *args, **kwargs)

get_animated_cover_url(size='300x300')

Возвращает URL анимированной обложки.

Parameters:: size (str, optional) – Размер анимированной обложки.
Returns:: URL анимированной обложки.
Return type:: str

get_og_image_url(size='300x300')

Возвращает URL обложки.

Parameters:: size (str, optional) – Размер обложки.
Returns:: URL обложки.
Return type:: str

download_animated_cover(filename, size='200x200')

Загрузка анимированной обложки.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением (GIF).
size (str, optional) – Размер анимированной обложки.

async download_animated_cover_async(filename, size='200x200')

Загрузка анимированной обложки.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением (GIF).
size (str, optional) – Размер анимированной обложки.

download_og_image(filename, size='200x200')

Загрузка обложки.

Используйте это только когда нет self.cover!

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

async download_og_image_async(filename, size='200x200')

Загрузка обложки.

Используйте это только когда нет self.cover!

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

download_animated_cover_bytes(size='200x200')

Загрузка анимированной обложки и возврат в виде байтов.

Parameters:: size (str, optional) – Размер анимированной обложки.
Returns:: Анимированная обложка в виде байтов.
Return type:: bytes

async download_animated_cover_bytes_async(size='200x200')

Загрузка анимированной обложки и возврат в виде байтов.

Parameters:: size (str, optional) – Размер анимированной обложки.
Returns:: Анимированная обложка в виде байтов.
Return type:: bytes

download_og_image_bytes(size='200x200')

Загрузка обложки и возврат в виде байтов.

Используйте это только когда нет self.cover!

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов.
Return type:: bytes

async download_og_image_bytes_async(size='200x200')

Загрузка обложки и возврат в виде байтов.

Используйте это только когда нет self.cover!

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов.
Return type:: bytes

rename(name, *args, **kwargs)

Сокращение.

Сокращение для:

client.users_playlists_name(playlist.kind, name, *args, **kwargs)

async rename_async(name, *args, **kwargs)

Сокращение.

Сокращение для:

client.users_playlists_name(playlist.kind, name, *args, **kwargs)

like(*args, **kwargs)

Сокращение.

Сокращение для:

client.users_likes_playlists_add(playlist.playlist_id, user.id, *args, **kwargs)

async like_async(*args, **kwargs)

Сокращение.

Сокращение для:

await client.users_likes_playlists_add(playlist.playlist_id, user.id, *args, **kwargs)

dislike(*args, **kwargs)

Сокращение.

Сокращение для:

client.users_likes_playlists_remove(playlist.playlist_id, user.id, *args, **kwargs)

async dislike_async(*args, **kwargs)

Сокращение.

Сокращение для:

await client.users_likes_playlists_remove(playlist.playlist_id, user.id, *args, **kwargs)

fetch_tracks(*args, **kwargs)

Сокращение.

Сокращение для:

client.users_playlists(playlist.kind, playlist.owner.id, *args, **kwargs).tracks

async fetch_tracks_async(*args, **kwargs)

Сокращение.

Сокращение для:

await client.users_playlists(playlist.kind, playlist.owner.id, *args, **kwargs).tracks

insert_track(track_id, album_id, **kwargs)

Сокращение.

Сокращение для:

client.users_playlists_insert_track(
    self.kind, track_id, album_id,
    user_id=self.owner.uid, revision=self.revision,
    *args, **kwargs,
)

async insert_track_async(track_id, album_id, **kwargs)

Сокращение.

Сокращение для:

await client.users_playlists_insert_track(
    self.kind, track_id, album_id,
    user_id=self.owner.uid, revision=self.revision,
    *args, **kwargs,
)

delete_tracks(from_, to, *args, **kwargs)

Сокращение.

Сокращение для:

client.users_playlists_delete_track(self.kind, from_, to, self.revision, self.owner.uid, *args, **kwargs)

async delete_tracks_async(from_, to, *args, **kwargs)

Сокращение.

Сокращение для:

await client.users_playlists_delete_track(
    self.kind, from_, to, self.revision, self.owner.uid, *args, **kwargs,
)

delete(*args, **kwargs)

Сокращение.

Сокращение для:

client.users_playlists_delete(self.kind, self.owner.uid)

async delete_async(*args, **kwargs)

Сокращение.

Сокращение для:

await client.users_playlists_delete(self.kind, self.owner.uid)

classmethod de_json(data, client)

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Плейлист.

Return type:

yandex_music.Playlist