Function ImageApiAxiosParamCreator

Returns {
    deleteCustomSplashscreen: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    deleteItemImage: ((itemId: string, imageType: ImageType, imageIndex?: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    deleteItemImageByIndex: ((itemId: string, imageType: ImageType, imageIndex: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    deleteUserImage: ((userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    getItemImageInfos: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    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<RequestArgs>);
    postUserImage: ((userId?: string, body?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    setItemImage: ((itemId: string, imageType: ImageType, body?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    setItemImageByIndex: ((itemId: string, imageType: ImageType, imageIndex: number, body?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    updateItemImageIndex: ((itemId: string, imageType: ImageType, imageIndex: number, newIndex: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    uploadCustomSplashscreen: ((body?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
}

• deleteCustomSplashscreen: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Delete a custom splashscreen.

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• deleteItemImage: ((itemId: string, imageType: ImageType, imageIndex?: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Delete an item's image.

  Throws

  • • (itemId, imageType, imageIndex?, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        Item id.
      • imageType: ImageType

        Image type.
      • OptionalimageIndex: number

        The image index.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• deleteItemImageByIndex: ((itemId: string, imageType: ImageType, imageIndex: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Delete an item's image.

  Throws

  • • (itemId, imageType, imageIndex, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        Item id.
      • imageType: ImageType

        Image type.
      • imageIndex: number

        The image index.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• deleteUserImage: ((userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Delete the user's image.

  Throws

  • • (userId?, options?): Promise<RequestArgs>

    • Parameters

      • OptionaluserId: string

        User Id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get artist image by name.

  Throws

  • • (name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get genre image by name.

  Throws

  • • (name, imageType, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get genre image by name.

  Throws

  • • (name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Gets the item's image.

  Throws

  • • (itemId, imageType, maxWidth?, maxHeight?, width?, height?, quality?, fillWidth?, fillHeight?, tag?, format?, percentPlayed?, unplayedCount?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Gets the item's image.

  Throws

  • • (itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Gets the item's image.

  Throws

  • • (itemId, imageType, imageIndex, maxWidth?, maxHeight?, width?, height?, quality?, fillWidth?, fillHeight?, tag?, format?, percentPlayed?, unplayedCount?, blur?, backgroundColor?, foregroundLayer?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getItemImageInfos: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Get item image infos.

  Throws

  • • (itemId, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        Item id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get music genre image by name.

  Throws

  • • (name, imageType, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get music genre image by name.

  Throws

  • • (name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get person image by name.

  Throws

  • • (name, imageType, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get person image by name.

  Throws

  • • (name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Generates or gets the splashscreen.

  Throws

  • • (tag?, format?, maxWidth?, maxHeight?, width?, height?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, quality?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get studio image by name.

  Throws

  • • (name, imageType, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get studio image by name.

  Throws

  • • (name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get user profile image.

  Throws

  • • (userId?, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get artist image by name.

  Throws

  • • (name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get genre image by name.

  Throws

  • • (name, imageType, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get genre image by name.

  Throws

  • • (name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Gets the item's image.

  Throws

  • • (itemId, imageType, maxWidth?, maxHeight?, width?, height?, quality?, fillWidth?, fillHeight?, tag?, format?, percentPlayed?, unplayedCount?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Gets the item's image.

  Throws

  • • (itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Gets the item's image.

  Throws

  • • (itemId, imageType, imageIndex, maxWidth?, maxHeight?, width?, height?, quality?, fillWidth?, fillHeight?, tag?, format?, percentPlayed?, unplayedCount?, blur?, backgroundColor?, foregroundLayer?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get music genre image by name.

  Throws

  • • (name, imageType, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get music genre image by name.

  Throws

  • • (name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get person image by name.

  Throws

  • • (name, imageType, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get person image by name.

  Throws

  • • (name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get studio image by name.

  Throws

  • • (name, imageType, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get studio image by name.

  Throws

  • • (name, imageType, imageIndex, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• 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<RequestArgs>)

  Summary

  Get user profile image.

  Throws

  • • (userId?, tag?, format?, maxWidth?, maxHeight?, percentPlayed?, unplayedCount?, width?, height?, quality?, fillWidth?, fillHeight?, blur?, backgroundColor?, foregroundLayer?, imageIndex?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• postUserImage: ((userId?: string, body?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Sets the user image.

  Throws

  • • (userId?, body?, options?): Promise<RequestArgs>

    • Parameters

      • OptionaluserId: string

        User Id.
      • Optionalbody: File
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• setItemImage: ((itemId: string, imageType: ImageType, body?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Set item image.

  Throws

  • • (itemId, imageType, body?, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        Item id.
      • imageType: ImageType

        Image type.
      • Optionalbody: File
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• setItemImageByIndex: ((itemId: string, imageType: ImageType, imageIndex: number, body?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Set item image.

  Throws

  • • (itemId, imageType, imageIndex, body?, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        Item id.
      • imageType: ImageType

        Image type.
      • imageIndex: number

        (Unused) Image index.
      • Optionalbody: File
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• updateItemImageIndex: ((itemId: string, imageType: ImageType, imageIndex: number, newIndex: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Updates the index for an item image.

  Throws

  • • (itemId, imageType, imageIndex, newIndex, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• uploadCustomSplashscreen: ((body?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

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

  Throws

  • • (body?, options?): Promise<RequestArgs>

    • Parameters

      • Optionalbody: File
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>