Vertex Viewer SDK
    Preparing search index...

    Interface AdaptiveRenderingSettings

    Settings to configure the adaptive rendering of images. If enabled, the performance of delivering images is analyzed, and will be adjusted to deliver frames quicker to the client.

    interface AdaptiveRenderingSettings {
        enabled?: boolean;
        imageMaxScale?: number;
        imageMinScale?: number;
        jpegMaxQuality?: number;
        jpegMinQuality?: number;
        method?:
            | "median"
            | "average"
            | "smoothed-median"
            | "median-of-smoothed-median"
            | "average-of-smoothed-median";
        windowSize?: number;
    }
    Index
    enabled? imageMaxScale? imageMinScale? jpegMaxQuality? jpegMinQuality? method? windowSize?
    enabled?: boolean

    Indicates if adaptive rendering is enabled.

    imageMaxScale?: number

    A number between 0 and 1 representing the maximum scale factor for rendered frames.

    imageMinScale?: number

    A number between 0 and 1 representing the minimum scale factor for rendered frames.

    jpegMaxQuality?: number

    A number between 1 and 100 representing the maximum JPEG quality for rendered frames.

    jpegMinQuality?: number

    A number between 1 and 100 representing the minimum JPEG quality for rendered frames.

    method?:
        | "median"
        | "average"
        | "smoothed-median"
        | "median-of-smoothed-median"
        | "average-of-smoothed-median"

    The adaptive rendering algorithm to use. Defaults to median.

    windowSize?: number

    The window size to use for smoothing based adaptive rendering methods. This applies to: smoothed-median, median-of-smoothed-median, average-of-smoothed-median. Higher window sizes will result in values that are more smoothed, and have less "wave" like behavior to image quality. However, higher window sizes will take longer to respond to changes in network conditions.

    Settings
    Member Visibility

    On This Page
    Properties