Function ImageApiFp

Returns {
    deleteCustomSplashscreen(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    deleteItemImage(
        itemId: string,
        imageType: ImageType,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    deleteItemImageByIndex(
        itemId: string,
        imageType: ImageType,
        imageIndex: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    deleteUserImage(
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    getArtistImage(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    getGenreImage(
        name: string,
        imageType: ImageType,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    getGenreImageByIndex(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    getItemImage(
        itemId: string,
        imageType: ImageType,
        maxWidth?: number,
        maxHeight?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        tag?: string,
        format?: ImageFormat,
        percentPlayed?: number,
        unplayedCount?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    getItemImage2(
        itemId: string,
        imageType: ImageType,
        maxWidth: number,
        maxHeight: number,
        tag: string,
        format: ImageFormat,
        percentPlayed: number,
        unplayedCount: number,
        imageIndex: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    getItemImageByIndex(
        itemId: string,
        imageType: ImageType,
        imageIndex: number,
        maxWidth?: number,
        maxHeight?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        tag?: string,
        format?: ImageFormat,
        percentPlayed?: number,
        unplayedCount?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    getItemImageInfos(
        itemId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageInfo[]>,
    >;
    getMusicGenreImage(
        name: string,
        imageType: ImageType,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    getMusicGenreImageByIndex(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    getPersonImage(
        name: string,
        imageType: ImageType,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    getPersonImageByIndex(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    getSplashscreen(
        tag?: string,
        format?: ImageFormat,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    getStudioImage(
        name: string,
        imageType: ImageType,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    getStudioImageByIndex(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    getUserImage(
        userId?: string,
        tag?: string,
        format?: ImageFormat,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    headArtistImage(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    headGenreImage(
        name: string,
        imageType: ImageType,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    headGenreImageByIndex(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    headItemImage(
        itemId: string,
        imageType: ImageType,
        maxWidth?: number,
        maxHeight?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        tag?: string,
        format?: ImageFormat,
        percentPlayed?: number,
        unplayedCount?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    headItemImage2(
        itemId: string,
        imageType: ImageType,
        maxWidth: number,
        maxHeight: number,
        tag: string,
        format: ImageFormat,
        percentPlayed: number,
        unplayedCount: number,
        imageIndex: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    headItemImageByIndex(
        itemId: string,
        imageType: ImageType,
        imageIndex: number,
        maxWidth?: number,
        maxHeight?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        tag?: string,
        format?: ImageFormat,
        percentPlayed?: number,
        unplayedCount?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    headMusicGenreImage(
        name: string,
        imageType: ImageType,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    headMusicGenreImageByIndex(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    headPersonImage(
        name: string,
        imageType: ImageType,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    headPersonImageByIndex(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    headStudioImage(
        name: string,
        imageType: ImageType,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    headStudioImageByIndex(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    headUserImage(
        userId?: string,
        tag?: string,
        format?: ImageFormat,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    postUserImage(
        userId?: string,
        body?: File,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    setItemImage(
        itemId: string,
        imageType: ImageType,
        body?: File,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    setItemImageByIndex(
        itemId: string,
        imageType: ImageType,
        imageIndex: number,
        body?: File,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    updateItemImageIndex(
        itemId: string,
        imageType: ImageType,
        imageIndex: number,
        newIndex: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    uploadCustomSplashscreen(
        body?: File,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
}

• deleteCustomSplashscreen: function

  • deleteCustomSplashscreen(
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• deleteItemImage: function

  • deleteItemImage(
        itemId: string,
        imageType: ImageType,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • itemId: string

      Item id.

    • imageType: ImageType

      Image type.

    • OptionalimageIndex: number

      The image index.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• deleteItemImageByIndex: function

  • deleteItemImageByIndex(
        itemId: string,
        imageType: ImageType,
        imageIndex: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • itemId: string

      Item id.

    • imageType: ImageType

      Image type.

    • imageIndex: number

      The image index.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• deleteUserImage: function

  • deleteUserImage(
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • OptionaluserId: string

      User Id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getArtistImage: function

  • getArtistImage(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Artist name.

    • imageType: ImageType

      Image type.

    • imageIndex: number

      Image index.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getGenreImage: function

  • getGenreImage(
        name: string,
        imageType: ImageType,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Genre name.

    • imageType: ImageType

      Image type.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • OptionalimageIndex: number

      Image index.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getGenreImageByIndex: function

  • getGenreImageByIndex(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Genre name.

    • imageType: ImageType

      Image type.

    • imageIndex: number

      Image index.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getItemImage: function

  • getItemImage(
        itemId: string,
        imageType: ImageType,
        maxWidth?: number,
        maxHeight?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        tag?: string,
        format?: ImageFormat,
        percentPlayed?: number,
        unplayedCount?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • itemId: string

      Item id.

    • imageType: ImageType

      Image type.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • OptionalimageIndex: number

      Image index.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getItemImage2: function

  • getItemImage2(
        itemId: string,
        imageType: ImageType,
        maxWidth: number,
        maxHeight: number,
        tag: string,
        format: ImageFormat,
        percentPlayed: number,
        unplayedCount: number,
        imageIndex: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • itemId: string

      Item id.

    • imageType: ImageType

      Image type.

    • maxWidth: number

      The maximum image width to return.

    • maxHeight: number

      The maximum image height to return.

    • tag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • format: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • percentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • unplayedCount: number

      Optional. Unplayed count overlay to render.

    • imageIndex: number

      Image index.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getItemImageByIndex: function

  • getItemImageByIndex(
        itemId: string,
        imageType: ImageType,
        imageIndex: number,
        maxWidth?: number,
        maxHeight?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        tag?: string,
        format?: ImageFormat,
        percentPlayed?: number,
        unplayedCount?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • itemId: string

      Item id.

    • imageType: ImageType

      Image type.

    • imageIndex: number

      Image index.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getItemImageInfos: function

  • getItemImageInfos(
        itemId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageInfo[]>,
    >

    Parameters

    • itemId: string

      Item id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageInfo[]>>

    Throws

• getMusicGenreImage: function

  • getMusicGenreImage(
        name: string,
        imageType: ImageType,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Music genre name.

    • imageType: ImageType

      Image type.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • OptionalimageIndex: number

      Image index.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getMusicGenreImageByIndex: function

  • getMusicGenreImageByIndex(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Music genre name.

    • imageType: ImageType

      Image type.

    • imageIndex: number

      Image index.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getPersonImage: function

  • getPersonImage(
        name: string,
        imageType: ImageType,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Person name.

    • imageType: ImageType

      Image type.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • OptionalimageIndex: number

      Image index.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getPersonImageByIndex: function

  • getPersonImageByIndex(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Person name.

    • imageType: ImageType

      Image type.

    • imageIndex: number

      Image index.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getSplashscreen: function

  • getSplashscreen(
        tag?: string,
        format?: ImageFormat,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • Optionaltag: string

      Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getStudioImage: function

  • getStudioImage(
        name: string,
        imageType: ImageType,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Studio name.

    • imageType: ImageType

      Image type.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • OptionalimageIndex: number

      Image index.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getStudioImageByIndex: function

  • getStudioImageByIndex(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Studio name.

    • imageType: ImageType

      Image type.

    • imageIndex: number

      Image index.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getUserImage: function

  • getUserImage(
        userId?: string,
        tag?: string,
        format?: ImageFormat,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • OptionaluserId: string

      User id.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• headArtistImage: function

  • headArtistImage(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Artist name.

    • imageType: ImageType

      Image type.

    • imageIndex: number

      Image index.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• headGenreImage: function

  • headGenreImage(
        name: string,
        imageType: ImageType,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Genre name.

    • imageType: ImageType

      Image type.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • OptionalimageIndex: number

      Image index.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• headGenreImageByIndex: function

  • headGenreImageByIndex(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Genre name.

    • imageType: ImageType

      Image type.

    • imageIndex: number

      Image index.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• headItemImage: function

  • headItemImage(
        itemId: string,
        imageType: ImageType,
        maxWidth?: number,
        maxHeight?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        tag?: string,
        format?: ImageFormat,
        percentPlayed?: number,
        unplayedCount?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • itemId: string

      Item id.

    • imageType: ImageType

      Image type.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • OptionalimageIndex: number

      Image index.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• headItemImage2: function

  • headItemImage2(
        itemId: string,
        imageType: ImageType,
        maxWidth: number,
        maxHeight: number,
        tag: string,
        format: ImageFormat,
        percentPlayed: number,
        unplayedCount: number,
        imageIndex: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • itemId: string

      Item id.

    • imageType: ImageType

      Image type.

    • maxWidth: number

      The maximum image width to return.

    • maxHeight: number

      The maximum image height to return.

    • tag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • format: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • percentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • unplayedCount: number

      Optional. Unplayed count overlay to render.

    • imageIndex: number

      Image index.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• headItemImageByIndex: function

  • headItemImageByIndex(
        itemId: string,
        imageType: ImageType,
        imageIndex: number,
        maxWidth?: number,
        maxHeight?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        tag?: string,
        format?: ImageFormat,
        percentPlayed?: number,
        unplayedCount?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • itemId: string

      Item id.

    • imageType: ImageType

      Image type.

    • imageIndex: number

      Image index.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• headMusicGenreImage: function

  • headMusicGenreImage(
        name: string,
        imageType: ImageType,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Music genre name.

    • imageType: ImageType

      Image type.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • OptionalimageIndex: number

      Image index.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• headMusicGenreImageByIndex: function

  • headMusicGenreImageByIndex(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Music genre name.

    • imageType: ImageType

      Image type.

    • imageIndex: number

      Image index.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• headPersonImage: function

  • headPersonImage(
        name: string,
        imageType: ImageType,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Person name.

    • imageType: ImageType

      Image type.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • OptionalimageIndex: number

      Image index.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• headPersonImageByIndex: function

  • headPersonImageByIndex(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Person name.

    • imageType: ImageType

      Image type.

    • imageIndex: number

      Image index.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• headStudioImage: function

  • headStudioImage(
        name: string,
        imageType: ImageType,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        imageIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Studio name.

    • imageType: ImageType

      Image type.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • OptionalimageIndex: number

      Image index.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• headStudioImageByIndex: function

  • headStudioImageByIndex(
        name: string,
        imageType: ImageType,
        imageIndex: number,
        tag?: string,
        format?: ImageFormat,
        maxWidth?: number,
        maxHeight?: number,
        percentPlayed?: number,
        unplayedCount?: number,
        width?: number,
        height?: number,
        quality?: number,
        fillWidth?: number,
        fillHeight?: number,
        blur?: number,
        backgroundColor?: string,
        foregroundLayer?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • name: string

      Studio name.

    • imageType: ImageType

      Image type.

    • imageIndex: number

      Image index.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • OptionalmaxWidth: number

      The maximum image width to return.

    • OptionalmaxHeight: number

      The maximum image height to return.

    • OptionalpercentPlayed: number

      Optional. Percent to render for the percent played overlay.

    • OptionalunplayedCount: number

      Optional. Unplayed count overlay to render.

    • Optionalwidth: number

      The fixed image width to return.

    • Optionalheight: number

      The fixed image height to return.

    • Optionalquality: number

      Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.

    • OptionalfillWidth: number

      Width of box to fill.

    • OptionalfillHeight: number

      Height of box to fill.

    • Optionalblur: number

      Optional. Blur image.

    • OptionalbackgroundColor: string

      Optional. Apply a background color for transparent images.

    • OptionalforegroundLayer: string

      Optional. Apply a foreground layer on top of the image.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• headUserImage: function

  • headUserImage(
        userId?: string,
        tag?: string,
        format?: ImageFormat,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Parameters

    • OptionaluserId: string

      User id.

    • Optionaltag: string

      Optional. Supply the cache tag from the item object to receive strong caching headers.

    • Optionalformat: ImageFormat

      Determines the output format of the image - original,gif,jpg,png.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• postUserImage: function

  • postUserImage(
        userId?: string,
        body?: File,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • OptionaluserId: string

      User Id.

    • Optionalbody: File
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• setItemImage: function

  • setItemImage(
        itemId: string,
        imageType: ImageType,
        body?: File,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • itemId: string

      Item id.

    • imageType: ImageType

      Image type.

    • Optionalbody: File
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• setItemImageByIndex: function

  • setItemImageByIndex(
        itemId: string,
        imageType: ImageType,
        imageIndex: number,
        body?: File,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • itemId: string

      Item id.

    • imageType: ImageType

      Image type.

    • imageIndex: number

      (Unused) Image index.

    • Optionalbody: File
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• updateItemImageIndex: function

  • updateItemImageIndex(
        itemId: string,
        imageType: ImageType,
        imageIndex: number,
        newIndex: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • itemId: string

      Item id.

    • imageType: ImageType

      Image type.

    • imageIndex: number

      Old image index.

    • newIndex: number

      New image index.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• uploadCustomSplashscreen: function

  • uploadCustomSplashscreen(
        body?: File,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • Optionalbody: File
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws