Function InstantMixApiFp

Returns {
    getInstantMixFromAlbum(itemId: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getInstantMixFromArtists(itemId: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getInstantMixFromArtists2(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getInstantMixFromItem(itemId: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getInstantMixFromMusicGenreById(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getInstantMixFromMusicGenreByName(name: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getInstantMixFromPlaylist(itemId: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
    getInstantMixFromSong(itemId: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>;
}

• getInstantMixFromAlbum:function

  • getInstantMixFromAlbum(itemId, userId?, limit?, fields?, enableImages?, enableUserData?, imageTypeLimit?, enableImageTypes?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • itemId: string

      The item id.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output.
    • OptionalenableImages: boolean

      Optional. Include image information in output.
    • OptionalenableUserData: boolean

      Optional. Include user data.
    • OptionalimageTypeLimit: number

      Optional. The max number of images to return, per image type.
    • OptionalenableImageTypes: ImageType[]

      Optional. The image types to include in the output.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Creates an instant playlist based on a given album.

    Throws

• getInstantMixFromArtists:function

  • getInstantMixFromArtists(itemId, userId?, limit?, fields?, enableImages?, enableUserData?, imageTypeLimit?, enableImageTypes?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • itemId: string

      The item id.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output.
    • OptionalenableImages: boolean

      Optional. Include image information in output.
    • OptionalenableUserData: boolean

      Optional. Include user data.
    • OptionalimageTypeLimit: number

      Optional. The max number of images to return, per image type.
    • OptionalenableImageTypes: ImageType[]

      Optional. The image types to include in the output.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Creates an instant playlist based on a given artist.

    Throws

• getInstantMixFromArtists2:function

  • getInstantMixFromArtists2(id, userId?, limit?, fields?, enableImages?, enableUserData?, imageTypeLimit?, enableImageTypes?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • id: string

      The item id.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output.
    • OptionalenableImages: boolean

      Optional. Include image information in output.
    • OptionalenableUserData: boolean

      Optional. Include user data.
    • OptionalimageTypeLimit: number

      Optional. The max number of images to return, per image type.
    • OptionalenableImageTypes: ImageType[]

      Optional. The image types to include in the output.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Creates an instant playlist based on a given artist.

    Deprecated

    Throws

• getInstantMixFromItem:function

  • getInstantMixFromItem(itemId, userId?, limit?, fields?, enableImages?, enableUserData?, imageTypeLimit?, enableImageTypes?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • itemId: string

      The item id.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output.
    • OptionalenableImages: boolean

      Optional. Include image information in output.
    • OptionalenableUserData: boolean

      Optional. Include user data.
    • OptionalimageTypeLimit: number

      Optional. The max number of images to return, per image type.
    • OptionalenableImageTypes: ImageType[]

      Optional. The image types to include in the output.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Creates an instant playlist based on a given item.

    Throws

• getInstantMixFromMusicGenreById:function

  • getInstantMixFromMusicGenreById(id, userId?, limit?, fields?, enableImages?, enableUserData?, imageTypeLimit?, enableImageTypes?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • id: string

      The item id.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output.
    • OptionalenableImages: boolean

      Optional. Include image information in output.
    • OptionalenableUserData: boolean

      Optional. Include user data.
    • OptionalimageTypeLimit: number

      Optional. The max number of images to return, per image type.
    • OptionalenableImageTypes: ImageType[]

      Optional. The image types to include in the output.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Creates an instant playlist based on a given genre.

    Throws

• getInstantMixFromMusicGenreByName:function

  • getInstantMixFromMusicGenreByName(name, userId?, limit?, fields?, enableImages?, enableUserData?, imageTypeLimit?, enableImageTypes?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • name: string

      The genre name.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output.
    • OptionalenableImages: boolean

      Optional. Include image information in output.
    • OptionalenableUserData: boolean

      Optional. Include user data.
    • OptionalimageTypeLimit: number

      Optional. The max number of images to return, per image type.
    • OptionalenableImageTypes: ImageType[]

      Optional. The image types to include in the output.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Creates an instant playlist based on a given genre.

    Throws

• getInstantMixFromPlaylist:function

  • getInstantMixFromPlaylist(itemId, userId?, limit?, fields?, enableImages?, enableUserData?, imageTypeLimit?, enableImageTypes?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • itemId: string

      The item id.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output.
    • OptionalenableImages: boolean

      Optional. Include image information in output.
    • OptionalenableUserData: boolean

      Optional. Include user data.
    • OptionalimageTypeLimit: number

      Optional. The max number of images to return, per image type.
    • OptionalenableImageTypes: ImageType[]

      Optional. The image types to include in the output.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Creates an instant playlist based on a given playlist.

    Throws

• getInstantMixFromSong:function

  • getInstantMixFromSong(itemId, userId?, limit?, fields?, enableImages?, enableUserData?, imageTypeLimit?, enableImageTypes?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

  • Parameters

    • itemId: string

      The item id.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • Optionallimit: number

      Optional. The maximum number of records to return.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output.
    • OptionalenableImages: boolean

      Optional. Include image information in output.
    • OptionalenableUserData: boolean

      Optional. Include user data.
    • OptionalimageTypeLimit: number

      Optional. The max number of images to return, per image type.
    • OptionalenableImageTypes: ImageType[]

      Optional. The image types to include in the output.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>)>

    Summary

    Creates an instant playlist based on a given song.

    Throws