diff --git a/docs/source/faq.rst b/docs/source/faq.rst new file mode 100644 index 00000000..011cb0b5 --- /dev/null +++ b/docs/source/faq.rst @@ -0,0 +1,74 @@ +FAQ +===== + +Frequently asked questions for ``ytmusicapi``. Contributions are welcome, please +`submit a PR `_. + +Setup +------------ + +My library results are empty even though I set up my cookie correctly. +*********************************************************************** +Please make sure that you don't have multiple Google accounts. ``ytmusicapi`` might be returning +results from a different account which is currently empty. You can set your account using ``X-Goog-AuthUser`` +in your headers file (numeric index) or by providing the id of a brand account with ``ytmusic = YTMusic(headers, "1234..")``. +For more details see the :doc:`reference`. + +Usage +----------------------- + +How do I add a song, album, artist or playlist to my library? +*********************************************************************** +- **songs**: `edit_song_library_status `__ . + Liking a song using `rate_song `__ + does *not* add it to your library, only to your liked songs playlist. +- **albums, playlists**: `rate_playlist `__ +- **artists**: `subscribe_artists `__ . + This will add the artist to your Subscriptions tab. The Artists tab is determined by the songs/albums you have + added to your library. + + + +How can I get the radio playlist for a song, video, playlist or album? +*********************************************************************** +- **songs, videos**: ``RDAMVM`` + ``videoId`` +- **playlists, albums**: ``RDAMPL`` + ``playlistId`` + + +How can I get the shuffle playlist for a playlist or album? +*********************************************************************** +Use `get_watch_playlist_shuffle `__ +with the ``playlistId`` or ``audioPlaylistId`` (albums). + +How can I get all my public playlists in a single request? +*********************************************************************** +Call `get_user_playlists `__ +with your own ``channelId``. + +Can I download songs? +*********************************************************************** +You can use `youtube-dl `_ for this purpose. + + +YouTube Music API Internals +------------------------------ + +Is there a difference between songs and videos? +*********************************************************************** +Yes. Videos are regular videos from YouTube, which can be uploaded by any user. Songs are actual songs uploaded by artists. + +You can also add songs to your library, while you can't add videos. + +Is there a rate limit? +*********************************************************************** +There most certainly is, although you shouldn't run into it during normal usage. +See related issues: + +- `Creating playlists `_ +- `Uploads `_ + + +What is a browseId? +*********************************************************************** +A ``browseId`` is an internal, globally unique identifier used by YouTube Music for browsable content. + diff --git a/docs/source/index.rst b/docs/source/index.rst index c5c35df5..ef8fcb6f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -32,3 +32,4 @@ Contents setup usage reference + faq