Playlist

class yandex_music.playlist.playlist.Playlist

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

Note

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

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

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

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

cover: yandex_music.Coveroptional

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

owner: yandex_music.Useroptional

Владелец плейлиста. Не приходит у плейлистов артиста (yandex_music.Client.artists_brief_info()).

made_for: yandex_music.MadeForoptional

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

play_counter: yandex_music.PlayCounteroptional

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

playlist_absence: yandex_music.PlaylistAbsenceoptional

Причина отсутствия плейлиста. Не приходит в чарте (yandex_music.Client.chart()) и фиде (yandex_music.Client.feed()).

uid: intoptional

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

kind: intoptional

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

title: stroptional

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

track_count: intoptional

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

tags: list из dictoptional

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

revision: intoptional

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

snapshot: intoptional

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

visibility: stroptional

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

collective: booloptional

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

url_part: stroptional

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

created: stroptional

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

modified: stroptional

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

available: booloptional

Доступен TODO.

is_banner: booloptional

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

is_premiere: booloptional

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

duration_ms: intoptional

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

og_image: stroptional

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

og_title: stroptional

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

og_description: stroptional

Описание Open Graph.

image: stroptional

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

cover_without_text: yandex_music.Coveroptional

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

contest: yandex_music.Contestoptional

Контест TODO.

background_color: stroptional

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

text_color: stroptional

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

id_for_from: stroptional

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

dummy_description: stroptional

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

dummy_page_description: stroptional

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

dummy_cover: stroptional

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

dummy_rollover_cover: stroptional

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

og_data: yandex_music.OpenGraphDataoptional

Данные для OpenGraph.

branding: yandex_music.Brand

Бренд.

metrika_id: intoptional

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

coauthors: list из intoptional

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

top_artist: list из yandex_music.Artistoptional

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

recent_tracks: list из yandex_music.TrackIdoptional

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

tracks: list из yandex_music.TrackShortoptional

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

prerolls: listoptional

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

likes_count: intoptional

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

similar_playlists: list из yandex_music.Playlistoptional

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

last_owner_playlists: list из yandex_music.Playlistoptional

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

generated_playlist_type: stroptional

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

animated_cover_uri: stroptional

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

ever_played: stroptional

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

description: stroptional

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

description_formatted: stroptional

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

playlist_uuid: stroptional

TODO.

type: stroptional

TODO.

ready: booloptional

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

is_for_from: Any

TODO.

regions: Any

Регион TODO.

custom_wave (

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

pager: yandex_music.Pageroptional

Пагинатор.

has_trailer: booloptional

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

trailer: yandex_music.PlaylistAvailabilityoptional

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

background_video_url: stroptional

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

background_video_id: stroptional

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

background_image_url: stroptional

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

action_button: yandex_music.AlbumActionButtonoptional

Кнопка-действие для перехода по ссылке.

artist_playlist_type: stroptional

Тип плейлиста артиста (TOP, SIMILAR).

child_content: booloptional

Является ли плейлист детским контентом.

derived_colors: yandex_music.CoverDerivedColorsoptional

Производные цвета обложки плейлиста.

made_for_user: yandex_music.MadeForUseroptional

Признак персонального плейлиста.

client: yandex_music.Clientoptional

Клиент Yandex Music.

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