@jellyfin/sdk
    Preparing search index...

    Interface ImageApiGetSplashscreenRequest

    Request parameters for getSplashscreen operation in ImageApi.

    ImageApiGetSplashscreenRequest

    interface ImageApiGetSplashscreenRequest {
        backgroundColor?: string;
        blur?: number;
        fillHeight?: number;
        fillWidth?: number;
        foregroundLayer?: string;
        format?: ImageFormat;
        height?: number;
        maxHeight?: number;
        maxWidth?: number;
        quality?: number;
        tag?: string;
        width?: number;
    }
    Index

    Properties

    backgroundColor? blur? fillHeight? fillWidth? foregroundLayer? format? height? maxHeight? maxWidth? quality? tag? width?

    Properties

    backgroundColor?: string

    Apply a background color for transparent images.

    ImageApiGetSplashscreen

    blur?: number

    Blur image.

    ImageApiGetSplashscreen

    fillHeight?: number

    Height of box to fill.

    ImageApiGetSplashscreen

    fillWidth?: number

    Width of box to fill.

    ImageApiGetSplashscreen

    foregroundLayer?: string

    Apply a foreground layer on top of the image.

    ImageApiGetSplashscreen

    format?: ImageFormat

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

    ImageApiGetSplashscreen

    height?: number

    The fixed image height to return.

    ImageApiGetSplashscreen

    maxHeight?: number

    The maximum image height to return.

    ImageApiGetSplashscreen

    maxWidth?: number

    The maximum image width to return.

    ImageApiGetSplashscreen

    quality?: number

    Quality setting, from 0-100.

    ImageApiGetSplashscreen

    tag?: string

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

    ImageApiGetSplashscreen

    width?: number

    The fixed image width to return.

    ImageApiGetSplashscreen

    Settings

    Member Visibility

    On This Page

    Properties