yandex_music.Client

class yandex_music.Client(token: str = None, fetch_account_status: bool = True, base_url: str = None, oauth_url: str = None, request: yandex_music.utils.request.Request = None)
Базовые классы: yandex_music.base.YandexMusicObject

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

Примечание

При fetch_account_status = False многие сокращения перестанут работать в связи с тем, что неоткуда будет взять uid аккаунта для отправки запроса. Так же в большинстве методов придётся передавать uid явно.

logger

Объект логера.

Type:logging.Logger
token

Уникальный ключ для аутентификации.

Type:str
base_url

Ссылка на API Yandex Music.

Type:str
oauth_url

Ссылка на OAuth Yandex Music.

Type:str
me

Объект класса yandex_music.Status представляющего основную информацию об аккаунте.

Type:yandex_music.Status
Параметры:
  • token (str, optional) – Уникальный ключ для аутентификации.
  • fetch_account_status (bool, optional) – Получить ли информацию об аккаунте при инициализации объекта.
  • base_url (str, optional) – Ссылка на API Yandex Music.
  • oauth_url (str, optional) – Ссылка на OAuth Yandex Music.
  • request (yandex_music.utils.request.Request, optional) – Пре-инициализация yandex_music.utils.request.Request.
accountExperiments(timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.experiments.Experiments]

Псевдоним для account_experiments

accountStatus(timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.account.status.Status]

Псевдоним для account_status

account_experiments(timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.experiments.Experiments]

Получение значений экспериментальных функций аккаунта.

Параметры:
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.Experiments представляющий состояния экспериментальных функций, иначе None.

Тип результата:

yandex_music.Experiments

Raises:

yandex_music.YandexMusicError

account_settings(timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.account.user_settings.UserSettings]

Получение настроек текущего пользователя.

Параметры:
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.UserSettings представляющий настройки пользователя, иначе None.

Тип результата:

yandex_music.UserSettings

Raises:

yandex_music.YandexMusicError

account_settings_set(param: str = None, value: Union[str, int, bool] = None, data: Dict[str, Union[str, int, bool]] = None, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.account.user_settings.UserSettings]

Изменение настроек текущего пользователя.

Примечание

Доступные названия параметров есть поля в классе yandex_music.UserSettings, только в CamelCase.

Параметры:
  • param (str) – Название параметра для изменения.
  • value (str | int | bool) – Значение параметра.
  • data (dict) – Словарь параметров и значений для множественного изменения.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.UserSettings представляющий настройки пользователя, иначе None.

Тип результата:

yandex_music.UserSettings

Raises:

yandex_music.YandexMusicError

account_status(timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.account.status.Status]

Получение статуса аккаунта. Нет обязательных параметров.

Параметры:
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.Status представляющий информацию об аккаунте если валиден, иначе None.

Тип результата:

yandex_music.Status

Raises:

yandex_music.YandexMusicError

afterTrack(next_track_id: Union[str, int], context_item: str, prev_track_id: Union[str, int] = None, context: str = 'playlist', types: str = 'shot', from_: str = 'mobile-landing-origin-default', timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.shot.shot_event.ShotEvent]

Псевдоним для after_track

after_track(next_track_id: Union[str, int], context_item: str, prev_track_id: Union[str, int] = None, context: str = 'playlist', types: str = 'shot', from_: str = 'mobile-landing-origin-default', timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.shot.shot_event.ShotEvent]

Получение рекламы или шота от Алисы после трека.

Примечание

При получения шота от Алисы prev_track_id можно не указывать.

Если context = „playlist“, то в context_item необходимо передать {OWNER_PLAYLIST}:{ID_PLAYLIST}. Плейлист с Алисой имеет владельца с id = 940441070.

ID плейлиста можно получить из блоков landing’a. Получить шот чужого плейлиста нельзя.

Известные значения context: playlist.

Известные значения types: shot, ad.

Параметры:
  • prev_track_id (str | int) – Уникальный идентификатор предыдущего трека.
  • next_track_id (str | int) – Уникальный идентификатор следующего трека.
  • context_item (str) – Уникальный идентификатор контекста.
  • context (str, optional) – Место, откуда было вызвано получение.
  • types (str, optional) – Тип того, что вернуть после трека.
  • from (str, optional) – Место, с которого попали в контекст.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.ShotEvent представляющий шоты от Алисы, иначе None.

Тип результата:

yandex_music.ShotEvent

Raises:

yandex_music.YandexMusicError

albums(album_ids: Union[List[Union[str, int]], int, str], timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.album.album.Album]
albumsWithTracks(album_id: Union[str, int], timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.album.album.Album]

Псевдоним для albums_with_tracks

albums_with_tracks(album_id: Union[str, int], timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.album.album.Album]

Получение альбома по его уникальному идентификатору вместе с треками.

Параметры:
  • album_id (str | int) – Уникальный идентификатор альбома.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объект класса yandex_music.Album представляющий альбом, иначе None.

Тип результата:

list из yandex_music.Album

Raises:

yandex_music.YandexMusicError

artists(artist_ids: Union[List[Union[str, int]], int, str], timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.artist.artist.Artist]
artistsBriefInfo(artist_id: Union[str, int], timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.artist.brief_info.BriefInfo]

Псевдоним для artists_brief_info

artistsDirectAlbums(artist_id: Union[str, int], page: int = 0, page_size: int = 20, sort_by: str = 'year', timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.artist.artist_albums.ArtistAlbums]

Псевдоним для artists_direct_albums

artistsTracks(artist_id: Union[str, int], page: int = 0, page_size: int = 20, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.artist.artist_tracks.ArtistTracks]

Псевдоним для artists_tracks

artists_brief_info(artist_id: Union[str, int], timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.artist.brief_info.BriefInfo]
artists_direct_albums(artist_id: Union[str, int], page: int = 0, page_size: int = 20, sort_by: str = 'year', timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.artist.artist_albums.ArtistAlbums]

Получение альбомов артиста.

Примечание

Известные значения для sort_by: year, rating.

Параметры:
  • artist_id (str | int) – Уникальный идентификатор артиста.
  • page (int, optional) – Номер страницы.
  • page_size (int, optional) – Количество альбомов на странице.
  • sort_by (str, optional) – Параметр для сортировки.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.ArtistsTracks представляющий страницу списка альбомов артиста, иначе None.

Тип результата:

yandex_music.ArtistAlbums

Raises:

yandex_music.YandexMusicError

artists_tracks(artist_id: Union[str, int], page: int = 0, page_size: int = 20, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.artist.artist_tracks.ArtistTracks]

Получение треков артиста.

Параметры:
  • artist_id (str | int) – Уникальный идентификатор артиста.
  • page (int, optional) – Номер страницы.
  • page_size (int, optional) – Количество треков на странице.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.ArtistsTracks представляющий страницу списка треков артиста, иначе None.

Тип результата:

yandex_music.ArtistsTracks

Raises:

yandex_music.YandexMusicError

consumePromoCode(code: str, language: str = 'en', timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.promo_code_status.PromoCodeStatus]

Псевдоним для consume_promo_code

consume_promo_code(code: str, language: str = 'en', timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.promo_code_status.PromoCodeStatus]

Активация промо-кода.

Параметры:
  • code (str) – Промо-код.
  • language (str, optional) – Язык ответа API в ISO 639-1.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.PromoCodeStatus представляющий информацию об активации промо-кода, иначе None.

Тип результата:

yandex_music.PromoCodeStatus

Raises:

yandex_music.YandexMusicError

feed(timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.feed.feed.Feed]

Получение потока информации (фида) подобранного под пользователя. Содержит умные плейлисты.

Параметры:
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.Feed представляющий умные плейлисты пользователя, иначе None.

Тип результата:

yandex_music.Feed

Raises:

yandex_music.YandexMusicError

feedWizardIsPassed(timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для feed_wizard_is_passed

feed_wizard_is_passed(timeout: Union[int, float] = None, *args, **kwargs) → bool
classmethod fromCredentials(username: str, password: str, x_captcha_answer: str = None, x_captcha_key: str = None, captcha_callback: Callable[[yandex_music.exceptions.Captcha], str] = None, *args, **kwargs) → yandex_music.client.Client

Псевдоним для from_credentials

classmethod fromToken(token: str, *args, **kwargs) → yandex_music.client.Client

Псевдоним для from_token

classmethod from_credentials(username: str, password: str, x_captcha_answer: str = None, x_captcha_key: str = None, captcha_callback: Callable[[yandex_music.exceptions.Captcha], str] = None, *args, **kwargs) → yandex_music.client.Client

Инициализция клиента по логину и паролю.

Примечание

Данный метод получает токен каждый раз при вызове. Рекомендуется сгенерировать его самостоятельно, сохранить и использовать при следующих инициализациях клиента. Не храните логины и пароли!

Параметры:
  • username (str) – Логин клиента (идентификатор).
  • password (str) – Пароль клиента (аутентификатор).
  • x_captcha_answer (str, optional) – Ответ на капчу (цифры с картинки).
  • x_captcha_key (str, optional) – Уникальный ключ капчи.
  • captcha_callback (function, optional) – Функция обратного вызова для обработки капчи, должна принимать объект класса yandex_music.exceptions.Captcha и возвращать проверочный код.
  • **kwargs (dict, optional) – Аргументы для конструктора клиента.
Результат:

yandex_music.Client.

Raises:

yandex_music.YandexMusicError

classmethod from_token(token: str, *args, **kwargs) → yandex_music.client.Client

Инициализция клиента по токену.

Примечание

Ничем не отличается от Client(token). Так исторически сложилось.

Параметры:
  • token (str, optional) – Уникальный ключ для аутентификации.
  • **kwargs (dict, optional) – Аргументы для конструктора клиента.
Результат:

yandex_music.Client.

generateTokenByUsernameAndPassword(username: str, password: str, grant_type: str = 'password', x_captcha_answer: str = None, x_captcha_key: str = None, timeout: Union[int, float] = None, *args, **kwargs) → str

Псевдоним для generate_token_by_username_and_password

generate_token_by_username_and_password(username: str, password: str, grant_type: str = 'password', x_captcha_answer: str = None, x_captcha_key: str = None, timeout: Union[int, float] = None, *args, **kwargs) → str

Метод получения OAuth токена по логину и паролю.

Параметры:
  • username (str) – Логин клиента (идентификатор).
  • password (str) – Пароль клиента (аутентификатор).
  • grant_type (str, optional) – Тип разрешения OAuth.
  • x_captcha_answer (str, optional) – Ответ на капчу (цифры с картинки).
  • x_captcha_key (str, optional) – Уникальный ключ капчи.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

OAuth токен.

Тип результата:

str

Raises:

yandex_music.YandexMusicError

genres(timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.genre.genre.Genre]

Получение жанров музыки.

Параметры:
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Список объектов класса yandex_music.Genre представляющих жанры музыки, иначе None.

Тип результата:

list из yandex_music.Genre

Raises:

yandex_music.YandexMusicError

landing(blocks: Union[str, List[str]], timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.landing.landing.Landing]

Получение лендинг-страницы содержащий блоки с новыми релизами, чартами, плейлистами с новинками и т.д.

Примечание

Поддерживаемые типы блоков: personalplaylists, promotions, new-releases, new-playlists, mixes, chart, artists, albums, playlists, play_contexts.

Параметры:
  • blocks (str | list из str) – Блок или список блоков необходимых для выдачи.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.Landing представляющий лендинг-страницу, иначе None.

Тип результата:

yandex_music.Landing

Raises:

yandex_music.YandexMusicError

permissionAlerts(timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.permission_alerts.PermissionAlerts]

Псевдоним для permission_alerts

permission_alerts(timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.permission_alerts.PermissionAlerts]

Получение оповещений. Нет обязательных параметров.

Параметры:
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.PermissionAlerts представляющий оповещения, иначе None.

Тип результата:

yandex_music.PermissionAlerts

Raises:

yandex_music.YandexMusicError

playAudio(track_id: Union[str, int], from_: str, album_id: Union[str, int], playlist_id: str = None, from_cache: bool = False, play_id: str = None, uid: int = None, timestamp: str = None, track_length_seconds: int = 0, total_played_seconds: int = 0, end_position_seconds: int = 0, client_now: str = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для play_audio

play_audio(track_id: Union[str, int], from_: str, album_id: Union[str, int], playlist_id: str = None, from_cache: bool = False, play_id: str = None, uid: int = None, timestamp: str = None, track_length_seconds: int = 0, total_played_seconds: int = 0, end_position_seconds: int = 0, client_now: str = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Метод для отправки текущего состояния прослушиваемого трека.

Параметры:
  • track_id (str | int) – Уникальный идентификатор трека.
  • from (str) – Наименования клиента с которого происходит прослушивание.
  • album_id (str | int) – Уникальный идентификатор альбома.
  • playlist_id (str, optional) – Уникальный идентификатор плейлиста, если таковой прослушивается.
  • from_cache (bool, optional) – Проигрывается ли трек с кеша.
  • play_id (str, optional) – Уникальный идентификатор проигрывания.
  • uid (int, optional) – Уникальный идентификатор пользователя.
  • timestamp (str, optional) – Текущая дата и время в ISO.
  • track_length_seconds (int, optional) – Продолжительность трека в секундах.
  • total_played_seconds (int, optional) – Сколько было всего воспроизведено трека в секундах.
  • end_position_seconds (int, optional) – Окончательное значение воспроизведенных секунд.
  • client_now (str, optional) – Текущая дата и время клиента в ISO.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

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

Тип результата:

bool

Raises:

yandex_music.YandexMusicError

playlistsList(playlist_ids: Union[List[Union[str, int]], int, str], timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.playlist.playlist.Playlist]

Псевдоним для playlists_list

playlists_list(playlist_ids: Union[List[Union[str, int]], int, str], timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.playlist.playlist.Playlist]
request

Объект вспомогательного класса для отправки запросов.

Type:yandex_music.utils.request.Request
rotorAccountStatus(timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.account.status.Status]

Псевдоним для rotor_account_status

rotorStationFeedback(station: str, type_: str, timestamp: Union[str, float, int] = None, from_: str = None, batch_id: str = None, total_played_seconds: Union[int, float] = None, track_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для rotor_station_feedback

rotorStationFeedbackRadioStarted(station: str, from_: str, batch_id: str = None, timestamp: Union[str, float, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для rotor_station_feedback_radio_started

rotorStationFeedbackSkip(station: str, track_id: Union[str, int], total_played_seconds: float, batch_id: str = None, timestamp: Union[str, float, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для rotor_station_feedback_skip

rotorStationFeedbackTrackFinished(station: str, track_id: Union[str, int], total_played_seconds: float, batch_id: str = None, timestamp: Union[str, float, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для rotor_station_feedback_track_finished

rotorStationFeedbackTrackStarted(station: str, track_id: Union[str, int], batch_id: str = None, timestamp: Union[str, float, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для rotor_station_feedback_track_started

rotorStationInfo(station: str, timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.rotor.station_result.StationResult]

Псевдоним для rotor_station_info

rotorStationSettings2(station: str, mood_energy: str, diversity: str, language: str = 'not-russian', timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для rotor_station_settings2

rotorStationTracks(station: str, settings2: bool = True, queue: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.rotor.station_tracks_result.StationTracksResult]

Псевдоним для rotor_station_tracks

rotorStationsDashboard(timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.rotor.dashboard.Dashboard]

Псевдоним для rotor_stations_dashboard

rotorStationsList(language: str = 'ru', timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.rotor.station_result.StationResult]

Псевдоним для rotor_stations_list

rotor_account_status(timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.account.status.Status]

Получение статуса пользователя с дополнителньыми полями.

Примечание

Данный статус отличается от обычного наличием дополнительных полей, например, skips_per_hour.

Параметры:
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.Status представляющий статус пользователя с дополнительными полями от радио, иначе None.

Тип результата:

yandex_music.Status

Raises:

yandex_music.YandexMusicError

rotor_station_feedback(station: str, type_: str, timestamp: Union[str, float, int] = None, from_: str = None, batch_id: str = None, total_played_seconds: Union[int, float] = None, track_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Отправка ответной реакции на происходящее при прослушивании радио.

Примечание

Сообщения о начале прослушивания радио, начале и конце трека, его пропуска.

Известные типы фидбека: radioStarted, trackStarted, trackFinished, skip.

Пример station: user:onyourwave, genre:allrock.

Пример from_: mobile-radio-user-123456789.

Параметры:
  • station (str) – Станция.
  • type (str) – Тип отправляемого фидбека.
  • timestamp (str | float | int, optional) – Текущее время и дата.
  • from (str, optional) – Откуда начато воспроизведение радио.
  • batch_id (str, optional) – Уникальный идентификатор партии треков. Возвращается при получении треков.
  • total_played_seconds (int |float, optional) – Сколько было проиграно секунд трека перед действием.
  • track_id (int | str, optional) – Уникальной идентификатор трека.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

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

Тип результата:

bool

Raises:

yandex_music.YandexMusicError

rotor_station_feedback_radio_started(station: str, from_: str, batch_id: str = None, timestamp: Union[str, float, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

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

client.rotor_station_feedback(station, 'radioStarted', timestamp, from, *args, **kwargs)
Результат:True при успешном выполнении запроса, иначе False.
Тип результата:bool
Raises:yandex_music.YandexMusicError
rotor_station_feedback_skip(station: str, track_id: Union[str, int], total_played_seconds: float, batch_id: str = None, timestamp: Union[str, float, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

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

client.rotor_station_feedback(station, 'skip', timestamp, track_id, total_played_seconds,
*args, **kwargs)
Результат:True при успешном выполнении запроса, иначе False.
Тип результата:bool
Raises:yandex_music.YandexMusicError
rotor_station_feedback_track_finished(station: str, track_id: Union[str, int], total_played_seconds: float, batch_id: str = None, timestamp: Union[str, float, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

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

client.rotor_station_feedback(station, 'trackFinished', timestamp, track_id, total_played_seconds,
*args, **kwargs)
Результат:True при успешном выполнении запроса, иначе False.
Тип результата:bool
Raises:yandex_music.YandexMusicError
rotor_station_feedback_track_started(station: str, track_id: Union[str, int], batch_id: str = None, timestamp: Union[str, float, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

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

client.rotor_station_feedback(station, 'trackStarted', timestamp, track_id, *args, **kwargs)
Результат:True при успешном выполнении запроса, иначе False.
Тип результата:bool
Raises:yandex_music.YandexMusicError
rotor_station_info(station: str, timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.rotor.station_result.StationResult]

Получение информации о станции и пользовательских настроек на неё.

Параметры:
  • station (str) – Станция.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Список из одного объекта класса yandex_music.StationResult представляющего информацию о станции, иначе None.

Тип результата:

list из yandex_music.StationResult

Raises:

yandex_music.YandexMusicError

rotor_station_settings2(station: str, mood_energy: str, diversity: str, language: str = 'not-russian', timeout: Union[int, float] = None, *args, **kwargs) → bool

Изменение настроек определённой станции.

Примечание

Доступные значения для mood_energy: fun, active, calm, sad, all.

Доступные значения для diversity: favorite, popular, discover, default.

Доступные значения для language: not-russian, russian, any.

У станций в restrictions есть Enum’ы, а в них possible_values - доступные значения для поля.

Параметры:
  • station (str) – Станция.
  • mood_energy (str) – Настроение.
  • diversity (str) – Треки.
  • language (str) – Язык.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

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

Тип результата:

bool

Raises:

yandex_music.YandexMusicError

rotor_station_tracks(station: str, settings2: bool = True, queue: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.rotor.station_tracks_result.StationTracksResult]

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

Примечание

Для продолжения цепочки треков необходимо:

  1. Передавать ID трека, что был до этого (первый в цепочки).
  2. Отправить фидбек о конче или скипе трека, что был передан в queue.
  3. Отправить фидбек о начале следующего трека (второй в цепочки).
  4. Выполнить запрос получения треков. В ответе придёт новые треки или произойдёт сдвиг цепочки на 1 элемент.

Проход по цепочке до коцна не изучен. Часто встречаются дубликаты.

Все официальные клиенты выполняют запросы с settings2 = True.

Параметры:
  • station (str) – Станция.
  • settings2 (bool, optional) – Использовать ли второй набор настроек.
  • queue (str | int , optional) – Уникальной идентификатор трека, который только что был.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.StationTracksResult представляющий последовательность треков станции, иначе None.

Тип результата:

yandex_music.StationTracksResult

Raises:

yandex_music.YandexMusicError

rotor_stations_dashboard(timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.rotor.dashboard.Dashboard]

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

Параметры:
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.Dashboard представляющий рекомендованные станции, иначе None.

Тип результата:

yandex_music.Dashboard

Raises:

yandex_music.YandexMusicError

rotor_stations_list(language: str = 'ru', timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.rotor.station_result.StationResult]

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

Примечание

Чтобы определить что за тип станции (жанры, настроения, занятие и т.д.) необходимо смотреть в поле id_for_from.

Параметры:
  • language (str) – Язык, на котором будет информация о станциях.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Список объектов класса yandex_music.StationResult представляющих станцию, иначе None.

Тип результата:

list из yandex_music.StationResult

Raises:

yandex_music.YandexMusicError

search(text: str, nocorrect: bool = False, type_: str = 'all', page: int = 0, playlist_in_best: bool = True, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.search.search.Search]

Осуществление поиска по запросу и типу, получение результатов.

Параметры:
  • text (str) – Текст запроса.
  • nocorrect (bool) – Без исправлений ли TODO.
  • type (str) – Среди какого типа искать (трек, плейлист, альбом, исполнитель).
  • page (int) – Номер страницы.
  • playlist_in_best (bool) – Выдавать ли плейлисты лучшим вариантом поиска.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.Search представляющий результаты поиска, иначе None.

Тип результата:

yandex_music.Search

Raises:

yandex_music.YandexMusicError

searchSuggest(part: str, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.search.suggestions.Suggestions]

Псевдоним для search_suggest

search_suggest(part: str, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.search.suggestions.Suggestions]

Получение подсказок по введенной части поискового запроса.

Параметры:
  • part (str) – Часть поискового запроса.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.Suggestions представляющий подсказки для запроса, иначе None.

Тип результата:

yandex_music.Suggestions

Raises:

yandex_music.YandexMusicError

settings(timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.settings.Settings]

Получение предложений по покупке. Нет обязательных параметров.

Параметры:
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.Settings представляющий информацию о предлагаемых продуктах, иначе None.

Тип результата:

yandex_music.Settings

Raises:

yandex_music.YandexMusicError

trackSupplement(track_id: Union[str, int], timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.supplement.supplement.Supplement]

Псевдоним для track_supplement

track_supplement(track_id: Union[str, int], timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.supplement.supplement.Supplement]

Получение дополнительной информации о треке.

Параметры:
  • track_id (str) – Уникальный идентификатор трека.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объект класса yandex_music.Supplement представляющий дополнительную информацию о треке.

Тип результата:

yandex_music.Supplement

Raises:

yandex_music.YandexMusicError

tracks(track_ids: Union[List[Union[str, int]], int, str], with_positions: bool = True, timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.track.track.Track]
tracksDownloadInfo(track_id: Union[str, int], get_direct_links: bool = False, timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.download_info.DownloadInfo]

Псевдоним для tracks_download_info

tracksSimilar(track_id: Union[str, int], timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.track.tracks_similar.SimilarTracks]

Псевдоним для tracks_similar

tracks_download_info(track_id: Union[str, int], get_direct_links: bool = False, timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.download_info.DownloadInfo]

Получение информации о доступных вариантах загрузки трека.

Параметры:
  • track_id (str | list из str) – Уникальный идентификатор трека или треков.
  • get_direct_links (bool, optional) – Получить ли при вызове метода прямую ссылку на загрузку.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Список объектов класса yandex_music.DownloadInfo представляющих варианты загрузки трека, иначе None.

Тип результата:

list из yandex_music.DownloadInfo

Raises:

yandex_music.YandexMusicError

tracks_similar(track_id: Union[str, int], timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.track.tracks_similar.SimilarTracks]

Получение похожих треков.

Параметры:
  • track_id (str) – Уникальный идентификатор трека.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объект класса yandex_music.SimilarTracks представляющий список похожих треков на другой трек.

Тип результата:

yandex_music.SimilarTracks

Raises:

yandex_music.YandexMusicError

usersDislikesTracks(user_id: Union[str, int] = None, if_modified_since_revision: int = 0, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.tracks_list.TracksList]

Псевдоним для users_dislikes_tracks

usersDislikesTracksAdd(track_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для users_dislikes_tracks_add

usersDislikesTracksRemove(track_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для users_dislikes_tracks_remove

usersLikesAlbums(user_id: Union[str, int] = None, rich: bool = True, timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.like.Like]

Псевдоним для users_likes_albums

usersLikesAlbumsAdd(album_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для users_likes_albums_add

usersLikesAlbumsRemove(album_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для users_likes_albums_remove

usersLikesArtists(user_id: Union[str, int] = None, with_timestamps: bool = True, timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.like.Like]

Псевдоним для users_likes_artists

usersLikesArtistsAdd(artist_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для users_likes_artists_add

usersLikesArtistsRemove(artist_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для users_likes_artists_remove

usersLikesPlaylists(user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.like.Like]

Псевдоним для users_likes_playlists

usersLikesPlaylistsAdd(playlist_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для users_likes_playlists_add

usersLikesPlaylistsRemove(playlist_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для users_likes_playlists_remove

usersLikesTracks(user_id: Union[str, int] = None, if_modified_since_revision: int = 0, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.tracks_list.TracksList]

Псевдоним для users_likes_tracks

usersLikesTracksAdd(track_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для users_likes_tracks_add

usersLikesTracksRemove(track_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для users_likes_tracks_remove

usersPlaylists(kind: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.playlist.playlist.Playlist]

Псевдоним для users_playlists

usersPlaylistsChange(kind: Union[str, int], diff: str, revision: int = 1, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.playlist.playlist.Playlist]

Псевдоним для users_playlists_change

usersPlaylistsCreate(title: str, visibility: str = 'public', user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.playlist.playlist.Playlist]

Псевдоним для users_playlists_create

usersPlaylistsDelete(kind: Union[str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Псевдоним для users_playlists_delete

usersPlaylistsDeleteTrack(kind: Union[str, int], from_: int, to: int, revision: int = 1, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.playlist.playlist.Playlist]

Псевдоним для users_playlists_delete_track

usersPlaylistsInsertTrack(kind: Union[str, int], track_id: Union[str, int], album_id: Union[str, int], at: int = 0, revision: int = 1, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.playlist.playlist.Playlist]

Псевдоним для users_playlists_insert_track

usersPlaylistsList(user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.playlist.playlist.Playlist]

Псевдоним для users_playlists_list

usersPlaylistsName(kind: Union[str, int], name: str, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.playlist.playlist.Playlist]

Псевдоним для users_playlists_name

usersPlaylistsVisibility(kind: Union[str, int], visibility: str, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.playlist.playlist.Playlist]

Псевдоним для users_playlists_visibility

users_dislikes_tracks(user_id: Union[str, int] = None, if_modified_since_revision: int = 0, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.tracks_list.TracksList]
users_dislikes_tracks_add(track_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool
users_dislikes_tracks_remove(track_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool
users_likes_albums(user_id: Union[str, int] = None, rich: bool = True, timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.like.Like]
users_likes_albums_add(album_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool
users_likes_albums_remove(album_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool
users_likes_artists(user_id: Union[str, int] = None, with_timestamps: bool = True, timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.like.Like]
users_likes_artists_add(artist_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool
users_likes_artists_remove(artist_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool
users_likes_playlists(user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.like.Like]
users_likes_playlists_add(playlist_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool
users_likes_playlists_remove(playlist_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool
users_likes_tracks(user_id: Union[str, int] = None, if_modified_since_revision: int = 0, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.tracks_list.TracksList]
users_likes_tracks_add(track_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool
users_likes_tracks_remove(track_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool
users_playlists(kind: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.playlist.playlist.Playlist]

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

Параметры:
  • kind (str | int | list из str | int) – Уникальный идентификатор плейлиста или их список.
  • user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Список объектов класса yandex_music.Playlist представляющих плейлист, иначе None.

Тип результата:

list из yandex_music.Playlist

Raises:

yandex_music.YandexMusicError

users_playlists_change(kind: Union[str, int], diff: str, revision: int = 1, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.playlist.playlist.Playlist]

Изменение плейлиста.

Примечание

Для получения отличий есть вспомогательный класс yandex_music.utils.difference.Difference.

Так же существуют уже готовые методы-обёртки над операциями.

Параметры:
  • kind (str | int) – Уникальный идентификатор плейлиста.
  • revision (int) – TODO.
  • diff (str) – JSON представления отличий старого и нового плейлиста.
  • user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.Playlist представляющий изменённый плейлист, иначе None.

Тип результата:

yandex_music.Playlist

Raises:

yandex_music.YandexMusicError

users_playlists_create(title: str, visibility: str = 'public', user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.playlist.playlist.Playlist]

Создание плейлиста.

Параметры:
  • title (str) – Название.
  • visibility (str, optional) – Модификатор доступа.
  • user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.Playlist представляющий созданный плейлист, иначе None.

Тип результата:

yandex_music.Playlist

Raises:

yandex_music.YandexMusicError

users_playlists_delete(kind: Union[str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → bool

Удаление плейлиста.

Параметры:
  • kind (str | int) – Уникальный идентификатор плейлиста.
  • user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

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

Тип результата:

bool

Raises:

yandex_music.YandexMusicError

users_playlists_delete_track(kind: Union[str, int], from_: int, to: int, revision: int = 1, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.playlist.playlist.Playlist]

Удаление треков из плейлиста.

Примечание

Для удаление необходимо указать границы с какого по какой элемент (трек) удалить.

Параметры:
  • kind (str | int) – Уникальный идентификатор плейлиста.
  • from (int) – С какого индекса.
  • to (int) – По какой индекс.
  • revision (int) – TODO.
  • user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.Playlist представляющий изменённый плейлист, иначе None.

Тип результата:

yandex_music.Playlist

Raises:

yandex_music.YandexMusicError

users_playlists_insert_track(kind: Union[str, int], track_id: Union[str, int], album_id: Union[str, int], at: int = 0, revision: int = 1, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.playlist.playlist.Playlist]

Добавление трека в плейлист.

Примечание

Трек можно вставить с любое место плейлиста задав индекс вставки (аргумент at).

Параметры:
  • kind (str | int) – Уникальный идентификатор плейлиста.
  • track_id (str | int) – Уникальный идентификатор трека.
  • album_id (str | int) – Уникальный идентификатор альбома.
  • at (int) – Индекс для вставки.
  • revision (int) – TODO.
  • user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.Playlist представляющий изменённый плейлист, иначе None.

Тип результата:

yandex_music.Playlist

Raises:

yandex_music.YandexMusicError

users_playlists_list(user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → List[yandex_music.playlist.playlist.Playlist]
users_playlists_name(kind: Union[str, int], name: str, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.playlist.playlist.Playlist]

Изменение названия плейлиста.

Параметры:
  • kind (str | int) – Уникальный идентификатор плейлиста.
  • name (str) – Новое название.
  • user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.Playlist представляющий изменённый плейлист, иначе None.

Тип результата:

yandex_music.Playlist

Raises:

yandex_music.YandexMusicError

users_playlists_visibility(kind: Union[str, int], visibility: str, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.playlist.playlist.Playlist]

Изменение видимости плейлиста.

Примечание

Видимость (visibility) может быть задана только одним из двух значений: private, public.

Параметры:
  • kind (str | int) – Уникальный идентификатор плейлиста.
  • visibility (str) – Новое название.
  • user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.Playlist представляющий изменённый плейлист, иначе None.

Тип результата:

yandex_music.Playlist

Raises:

yandex_music.YandexMusicError

users_settings(user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) → Optional[yandex_music.account.user_settings.UserSettings]

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

Примечание

Для получения настроек пользователя нужно быть авторизованным или владеть user_id.

Параметры:
  • user_id (str | int, optional) – Уникальный идентификатор пользователя чьи настройки хотим получить.
  • timeout (int | float, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.
  • **kwargs (dict, optional) – Произвольные аргументы (будут переданы в запрос).
Результат:

Объекта класса yandex_music.UserSettings представляющий настройки пользователя, иначе None.

Тип результата:

yandex_music.UserSettings

Raises:

yandex_music.YandexMusicError