TwitchLib.Api.Helix.Soundtrack Class Reference

Soundtrack related APIs More...

Inheritance diagram for TwitchLib.Api.Helix.Soundtrack:

Public Member Functions
	Soundtrack (IApiSettings settings, IRateLimiter rateLimiter, IHttpCallHandler http)
Task< GetCurrentTrackResponse >	GetCurrentTrackAsync (string broadcasterId, string accessToken=null)
	[BETA] - Gets the Soundtrack track that the broadcaster is playing. More...
Task< GetPlaylistResponse >	GetPlaylistAsync (string id, int first=20, string after=null, string accessToken=null)
	[BETA] - Gets the tracks of a Soundtrack playlist. More...
Task< GetPlaylistsResponse >	GetPlaylistsAsync (string id=null, int first=20, string after=null, string accessToken=null)
	[BETA] - Gets a list of Soundtrack playlists. More...
Public Member Functions inherited from TwitchLib.Api.Core.ApiBase
	ApiBase (IApiSettings settings, IRateLimiter rateLimiter, IHttpCallHandler http)
async ValueTask< string >	GetAccessTokenAsync (string accessToken=null)

Additional Inherited Members
Protected Member Functions inherited from TwitchLib.Api.Core.ApiBase
async Task< string >	TwitchGetAsync (string resource, ApiVersion api, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< T >	TwitchGetGenericAsync< T > (string resource, ApiVersion api, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< T >	TwitchPatchGenericAsync< T > (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< string >	TwitchPatchAsync (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< KeyValuePair< int, string > >	TwitchDeleteAsync (string resource, ApiVersion api, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< T >	TwitchPostGenericAsync< T > (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< T >	TwitchPostGenericModelAsync< T > (string resource, ApiVersion api, RequestModel model, string accessToken=null, string clientId=null, string customBase=null)
async Task< T >	TwitchDeleteGenericAsync< T > (string resource, ApiVersion api, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< T >	TwitchPutGenericAsync< T > (string resource, ApiVersion api, string payload=null, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< string >	TwitchPutAsync (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< KeyValuePair< int, string > >	TwitchPostAsync (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
Task	PutBytesAsync (string url, byte[] payload)
async Task< T >	GetGenericAsync< T > (string url, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, ApiVersion api=ApiVersion.Helix, string clientId=null)
Protected Attributes inherited from TwitchLib.Api.Core.ApiBase
readonly IApiSettings	Settings

Detailed Description

Soundtrack related APIs

Constructor & Destructor Documentation

Soundtrack()

TwitchLib.Api.Helix.Soundtrack.Soundtrack	(	IApiSettings	settings,
		IRateLimiter	rateLimiter,
		IHttpCallHandler	http
	)

Member Function Documentation

GetCurrentTrackAsync()

Task< GetCurrentTrackResponse > TwitchLib.Api.Helix.Soundtrack.GetCurrentTrackAsync	(	string	broadcasterId,
		string	accessToken = null
	)

[BETA] - Gets the Soundtrack track that the broadcaster is playing.

Parameters

broadcasterId	The ID of the broadcaster that’s playing a Soundtrack track.
accessToken	optional access token to override the use of the stored one in the TwitchAPI instance

Returns

Exceptions

BadParameterException

GetPlaylistAsync()

Task< GetPlaylistResponse > TwitchLib.Api.Helix.Soundtrack.GetPlaylistAsync	(	string	id,
		int	first = 20,
		string	after = null,
		string	accessToken = null
	)

[BETA] - Gets the tracks of a Soundtrack playlist.

Parameters

id	[Required] The ID of the Soundtrack playlist to get.
first	The maximum number of tracks to return for this playlist in the response. Maximum: 50. Default: 20.
after	The cursor used to get the next page of tracks for this playlist.
accessToken	optional access token to override the use of the stored one in the TwitchAPI instance

Returns

The tracks of a Soundtrack playlist

GetPlaylistsAsync()

Task< GetPlaylistsResponse > TwitchLib.Api.Helix.Soundtrack.GetPlaylistsAsync	(	string	id = null,
		int	first = 20,
		string	after = null,
		string	accessToken = null
	)

[BETA] - Gets a list of Soundtrack playlists.

Parameters

id	The ID of the Soundtrack playlist to get. Specify an ID only if you want to get a single playlist instead of all playlists.
first	The maximum number of playlists to return in the response. Maximum: 50. Default: 20.
after	The cursor used to get the next page of playlists.
accessToken	optional access token to override the use of the stored one in the TwitchAPI instance

Returns

---

The documentation for this class was generated from the following file:

• TwitchLib.Api/TwitchLib.Api.Helix/Soundtrack.cs