@jellyfin/sdk
    Preparing search index...

    Interface ImageApiGetItemImageByIndexRequest

    Request parameters for getItemImageByIndex operation in ImageApi.

    ImageApiGetItemImageByIndexRequest

    interface ImageApiGetItemImageByIndexRequest {
        backgroundColor?: string;
        blur?: number;
        fillHeight?: number;
        fillWidth?: number;
        foregroundLayer?: string;
        format?: ImageFormat;
        height?: number;
        imageIndex: number;
        imageType: ImageType;
        itemId: string;
        maxHeight?: number;
        maxWidth?: number;
        percentPlayed?: number;
        quality?: number;
        tag?: string;
        unplayedCount?: number;
        width?: number;
    }
    Index

    Properties

    backgroundColor? blur? fillHeight? fillWidth? foregroundLayer? format? height? imageIndex imageType itemId maxHeight? maxWidth? percentPlayed? quality? tag? unplayedCount? width?

    Properties

    backgroundColor?: string

    Optional. Apply a background color for transparent images.

    ImageApiGetItemImageByIndex

    blur?: number

    Optional. Blur image.

    ImageApiGetItemImageByIndex

    fillHeight?: number

    Height of box to fill.

    ImageApiGetItemImageByIndex

    fillWidth?: number

    Width of box to fill.

    ImageApiGetItemImageByIndex

    foregroundLayer?: string

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

    ImageApiGetItemImageByIndex

    format?: ImageFormat

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

    ImageApiGetItemImageByIndex

    height?: number

    The fixed image height to return.

    ImageApiGetItemImageByIndex

    imageIndex: number

    Image index.

    ImageApiGetItemImageByIndex

    imageType: ImageType

    Image type.

    ImageApiGetItemImageByIndex

    itemId: string

    Item id.

    ImageApiGetItemImageByIndex

    maxHeight?: number

    The maximum image height to return.

    ImageApiGetItemImageByIndex

    maxWidth?: number

    The maximum image width to return.

    ImageApiGetItemImageByIndex

    percentPlayed?: number

    Optional. Percent to render for the percent played overlay.

    ImageApiGetItemImageByIndex

    quality?: number

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

    ImageApiGetItemImageByIndex

    tag?: string

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

    ImageApiGetItemImageByIndex

    unplayedCount?: number

    Optional. Unplayed count overlay to render.

    ImageApiGetItemImageByIndex

    width?: number

    The fixed image width to return.

    ImageApiGetItemImageByIndex

    Settings

    Member Visibility

    On This Page

    Properties