Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias GetItemImageData

    type GetItemImageData = {
        body?: never;
        path: {
            itemId: string;
            imageType:
                | "Primary"
                | "Art"
                | "Backdrop"
                | "Banner"
                | "Logo"
                | "Thumb"
                | "Disc"
                | "Box"
                | "Screenshot"
                | "Menu"
                | "Chapter"
                | "BoxRear"
                | "Profile";
        };
        query?: {
            maxWidth?: number;
            maxHeight?: number;
            width?: number;
            height?: number;
            quality?: number;
            fillWidth?: number;
            fillHeight?: number;
            tag?: string;
            format?: "Bmp"
            | "Gif"
            | "Jpg"
            | "Png"
            | "Webp"
            | "Svg";
            percentPlayed?: number;
            unplayedCount?: number;
            blur?: number;
            backgroundColor?: string;
            foregroundLayer?: string;
            imageIndex?: number;
        };
        url: "/Items/{itemId}/Images/{imageType}";
    }
    Index
    body? path query? url

    Optionalbody

    body?: never
    path: {
        itemId: string;
        imageType:
            | "Primary"
            | "Art"
            | "Backdrop"
            | "Banner"
            | "Logo"
            | "Thumb"
            | "Disc"
            | "Box"
            | "Screenshot"
            | "Menu"
            | "Chapter"
            | "BoxRear"
            | "Profile";
    }

    Type Declaration

    • itemId: string

      Item id.

    • imageType:
          | "Primary"
          | "Art"
          | "Backdrop"
          | "Banner"
          | "Logo"
          | "Thumb"
          | "Disc"
          | "Box"
          | "Screenshot"
          | "Menu"
          | "Chapter"
          | "BoxRear"
          | "Profile"

      Enum ImageType.

    query?: {
        maxWidth?: number;
        maxHeight?: number;
        width?: number;
        height?: number;
        quality?: number;
        fillWidth?: number;
        fillHeight?: number;
        tag?: string;
        format?: "Bmp" | "Gif" | "Jpg" | "Png" | "Webp" | "Svg";
        percentPlayed?: number;
        unplayedCount?: number;
        blur?: number;
        backgroundColor?: string;
        foregroundLayer?: string;
        imageIndex?: number;
    }

    Type Declaration

    • 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?: "Bmp" | "Gif" | "Jpg" | "Png" | "Webp" | "Svg"

      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.

    url: "/Items/{itemId}/Images/{imageType}"

    Settings
    Member Visibility

    On This Page
    Properties