Class InstantMixApi

InstantMixApi - object-oriented interface

Export

InstantMixApi

Hierarchy

BaseAPI
- InstantMixApi

Index

Constructors

constructor

new InstantMixApi(configuration?, basePath?, axios?): InstantMixApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns InstantMixApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

getInstantMixFromAlbum

getInstantMixFromAlbum(requestParameters, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: InstantMixApiGetInstantMixFromAlbumRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Creates an instant playlist based on a given album.

Throws
Memberof
InstantMixApi
- Defined in generated-client/api/instant-mix-api.ts:1404

getInstantMixFromArtists

getInstantMixFromArtists(requestParameters, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: InstantMixApiGetInstantMixFromArtistsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Creates an instant playlist based on a given artist.

Throws
Memberof
InstantMixApi
- Defined in generated-client/api/instant-mix-api.ts:1416

getInstantMixFromArtists2

getInstantMixFromArtists2(requestParameters, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: InstantMixApiGetInstantMixFromArtists2Request
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Creates an instant playlist based on a given artist.

Deprecated
Throws
Memberof
InstantMixApi
- Defined in generated-client/api/instant-mix-api.ts:1429

getInstantMixFromItem

getInstantMixFromItem(requestParameters, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: InstantMixApiGetInstantMixFromItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Creates an instant playlist based on a given item.

Throws
Memberof
InstantMixApi
- Defined in generated-client/api/instant-mix-api.ts:1441

getInstantMixFromMusicGenreById

getInstantMixFromMusicGenreById(requestParameters, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: InstantMixApiGetInstantMixFromMusicGenreByIdRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Creates an instant playlist based on a given genre.

Throws
Memberof
InstantMixApi
- Defined in generated-client/api/instant-mix-api.ts:1453

getInstantMixFromMusicGenreByName

getInstantMixFromMusicGenreByName(requestParameters, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: InstantMixApiGetInstantMixFromMusicGenreByNameRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Creates an instant playlist based on a given genre.

Throws
Memberof
InstantMixApi
- Defined in generated-client/api/instant-mix-api.ts:1465

getInstantMixFromPlaylist

getInstantMixFromPlaylist(requestParameters, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: InstantMixApiGetInstantMixFromPlaylistRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Creates an instant playlist based on a given playlist.

Throws
Memberof
InstantMixApi
- Defined in generated-client/api/instant-mix-api.ts:1477

getInstantMixFromSong

getInstantMixFromSong(requestParameters, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: InstantMixApiGetInstantMixFromSongRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Creates an instant playlist based on a given song.

Throws
Memberof
InstantMixApi
- Defined in generated-client/api/instant-mix-api.ts:1489

Class InstantMixApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns InstantMixApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getInstantMixFromAlbum

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>

Summary

Throws

Memberof

getInstantMixFromArtists

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>

Summary

Throws

Memberof

getInstantMixFromArtists2

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>

Summary

Deprecated

Throws

Memberof

getInstantMixFromItem

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>

Summary

Throws

Memberof

getInstantMixFromMusicGenreById

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>

Summary

Throws

Memberof

getInstantMixFromMusicGenreByName

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>

Summary

Throws

Memberof

getInstantMixFromPlaylist

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>

Summary

Throws

Memberof

getInstantMixFromSong

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>

Summary

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration