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, maxWidth?: number, maxHeight?: number, width?: number, height?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, quality?: number, 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, 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>)>;
    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, 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>)>;
    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?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Summary

    Delete a custom splashscreen.

    Throws

• deleteItemImage:function

  • deleteItemImage(itemId, imageType, imageIndex?, options?): 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>)>

    Summary

    Delete an item's image.

    Throws

• deleteItemImageByIndex:function

  • deleteItemImageByIndex(itemId, imageType, imageIndex, options?): 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>)>

    Summary

    Delete an item's image.

    Throws

• deleteUserImage:function

  • deleteUserImage(userId?, options?): 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>)>

    Summary

    Delete the user's image.

    Throws

• getArtistImage:function

  • getArtistImage(name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): 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>)>

    Summary

    Get artist image by name.

    Throws

• getGenreImage:function

  • getGenreImage(name, imageType, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): 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>)>

    Summary

    Get genre image by name.

    Throws

• getGenreImageByIndex:function

  • getGenreImageByIndex(name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): 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>)>

    Summary

    Get genre image by name.

    Throws

• getItemImage:function

  • getItemImage(itemId, imageType, maxWidth?, maxHeight?, width?, height?, quality?, fillWidth?, fillHeight?, tag?, format?, percentPlayed?, unplayedCount?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): 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>)>

    Summary

    Gets the item's image.

    Throws

• getItemImage2:function

  • getItemImage2(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): 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>)>

    Summary

    Gets the item's image.

    Throws

• getItemImageByIndex:function

  • getItemImageByIndex(itemId, imageType, imageIndex, maxWidth?, maxHeight?, width?, height?, quality?, fillWidth?, fillHeight?, tag?, format?, percentPlayed?, unplayedCount?, blur?, backgroundColor?, foregroundLayer?, options?): 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>)>

    Summary

    Gets the item's image.

    Throws

• getItemImageInfos:function

  • getItemImageInfos(itemId, options?): 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[]>)>

    Summary

    Get item image infos.

    Throws

• getMusicGenreImage:function

  • getMusicGenreImage(name, imageType, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): 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>)>

    Summary

    Get music genre image by name.

    Throws

• getMusicGenreImageByIndex:function

  • getMusicGenreImageByIndex(name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): 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>)>

    Summary

    Get music genre image by name.

    Throws

• getPersonImage:function

  • getPersonImage(name, imageType, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): 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>)>

    Summary

    Get person image by name.

    Throws

• getPersonImageByIndex:function

  • getPersonImageByIndex(name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): 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>)>

    Summary

    Get person image by name.

    Throws

• getSplashscreen:function

  • getSplashscreen(tag?, format?, maxWidth?, maxHeight?, width?, height?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, quality?, options?): 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.
    • 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.
    • OptionalfillWidth: number

      Width of box to fill.
    • OptionalfillHeight: number

      Height of box to fill.
    • Optionalblur: number

      Blur image.
    • OptionalbackgroundColor: string

      Apply a background color for transparent images.
    • OptionalforegroundLayer: string

      Apply a foreground layer on top of the image.
    • Optionalquality: number

      Quality setting, from 0-100.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Summary

    Generates or gets the splashscreen.

    Throws

• getStudioImage:function

  • getStudioImage(name, imageType, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): 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>)>

    Summary

    Get studio image by name.

    Throws

• getStudioImageByIndex:function

  • getStudioImageByIndex(name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): 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>)>

    Summary

    Get studio image by name.

    Throws

• getUserImage:function

  • getUserImage(userId?, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): 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.
    • 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>)>

    Summary

    Get user profile image.

    Throws

• headArtistImage:function

  • headArtistImage(name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): 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>)>

    Summary

    Get artist image by name.

    Throws

• headGenreImage:function

  • headGenreImage(name, imageType, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): 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>)>

    Summary

    Get genre image by name.

    Throws

• headGenreImageByIndex:function

  • headGenreImageByIndex(name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): 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>)>

    Summary

    Get genre image by name.

    Throws

• headItemImage:function

  • headItemImage(itemId, imageType, maxWidth?, maxHeight?, width?, height?, quality?, fillWidth?, fillHeight?, tag?, format?, percentPlayed?, unplayedCount?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): 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>)>

    Summary

    Gets the item's image.

    Throws

• headItemImage2:function

  • headItemImage2(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): 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>)>

    Summary

    Gets the item's image.

    Throws

• headItemImageByIndex:function

  • headItemImageByIndex(itemId, imageType, imageIndex, maxWidth?, maxHeight?, width?, height?, quality?, fillWidth?, fillHeight?, tag?, format?, percentPlayed?, unplayedCount?, blur?, backgroundColor?, foregroundLayer?, options?): 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>)>

    Summary

    Gets the item's image.

    Throws

• headMusicGenreImage:function

  • headMusicGenreImage(name, imageType, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): 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>)>

    Summary

    Get music genre image by name.

    Throws

• headMusicGenreImageByIndex:function

  • headMusicGenreImageByIndex(name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): 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>)>

    Summary

    Get music genre image by name.

    Throws

• headPersonImage:function

  • headPersonImage(name, imageType, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): 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>)>

    Summary

    Get person image by name.

    Throws

• headPersonImageByIndex:function

  • headPersonImageByIndex(name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): 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>)>

    Summary

    Get person image by name.

    Throws

• headStudioImage:function

  • headStudioImage(name, imageType, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): 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>)>

    Summary

    Get studio image by name.

    Throws

• headStudioImageByIndex:function

  • headStudioImageByIndex(name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): 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>)>

    Summary

    Get studio image by name.

    Throws

• headUserImage:function

  • headUserImage(userId?, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): 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.
    • 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>)>

    Summary

    Get user profile image.

    Throws

• postUserImage:function

  • postUserImage(userId?, body?, options?): 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>)>

    Summary

    Sets the user image.

    Throws

• setItemImage:function

  • setItemImage(itemId, imageType, body?, options?): 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>)>

    Summary

    Set item image.

    Throws

• setItemImageByIndex:function

  • setItemImageByIndex(itemId, imageType, imageIndex, body?, options?): 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>)>

    Summary

    Set item image.

    Throws

• updateItemImageIndex:function

  • updateItemImageIndex(itemId, imageType, imageIndex, newIndex, options?): 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>)>

    Summary

    Updates the index for an item image.

    Throws

• uploadCustomSplashscreen:function

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

  • Parameters

    • Optionalbody: File
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Summary

    Uploads a custom splashscreen. The body is expected to the image contents base64 encoded.

    Throws