TwitchApi.Music.GetSoundtrackPlaylists (TwitchApi v0.1.3) View Source
⛔ This module is autogenerated please do not modify manually.
Example request from twitch api docs:
descriptions:
Gets all playlists. Gets a single playlist.
requests:
curl -X GET 'https://api.twitch.tv/helix/soundtrack/playlists?id=B0912YMKSL'
-H'Authorization: Bearer 4a4x78f5wqvkybms7mxfist3jmzul'
-H'Client-Id: t214nt8z1rdtbj69hyarjvh5mi6fh'
curl -X GET 'https://api.twitch.tv/helix/soundtrack/playlists'
-H'Authorization: Bearer 4a4x78f5wqvkybms7mxfist3jmzul'
-H'Client-Id: t214nt8z1rdtbj69hyarjvh5mi6fh'
Example response from twitch api docs:
descriptions:
responses:
{"data":[{"title":"Night Shift","id":"B0912YMKSL","image_url":"https://m.media-amazon.com/images/I/41UoIaB4VaL.jpg","description":"R&B to ride out to."}],"pagination":{}} {"data":[{"title":"Label Spotlight: Radio Juicy","id":"B08P3N4ZPD","image_url":"https://m.media-amazon.com/images/I/517kGzeaRhL.jpg","description":"Journey through boom-bap, lo-fi, trap and ambient sounds, courtesy of esteemed label Radio Juicy."},{"title":"Fall Days","id":"B09LVX24K7","image_url":"https://m.media-amazon.com/images/I/41w3M-1KfXL.jpg","description":"Turn a new leaf with these chill pop & indie tunes."},{"title":"Release Spotlight: JVNA","id":"B09M7H78YL","image_url":"https://m.media-amazon.com/images/I/419V2D2OlML.jpg","description":"Twitch streamer, singer-songwriter and producer JVNA presents her debut album "Hope in Chaos"."},{"title":"Among Us","id":"B08ZDWR371","image_url":"https://m.media-amazon.com/images/I/414O3CYQguL.jpg","description":"Traverse space, do tasks, and eject the Impostors in this official Among Us playlist!"}],"pagination":{"cursor":"eyJiIjpudWxsLCJhIjp7Ik9mZnNldCI6MjB9fQ"}}
Link to this section Summary
Types
The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read more.
The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 50 items per page. The default is 20.
The ID of the Soundtrack playlist to get. Specify an ID only if you want to get a single playlist instead of all playlists.
Link to this section Types
Specs
after_query_param() :: %{after_query_param: String.t()}
The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read more.
Specs
first() :: %{first: integer()}
The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 50 items per page. The default is 20.
Specs
id() :: %{id: String.t()}
The ID of the Soundtrack playlist to get. Specify an ID only if you want to get a single playlist instead of all playlists.
Link to this section Functions
Specs
call(id() | first() | after_query_param()) :: {:ok, Finch.Response.t()} | {:error, Exception.t()}
Description:
BETA Gets a list of Soundtrack playlists.
Required authentication:
Required authorization:
Requires an App access token or User access token.