Vertex Viewer SDK
    Preparing search index...

    Interface FrameDeliverySettings

    Settings to configure the delivery of images over the websocket connection.

    interface FrameDeliverySettings {
        historyMaxSize?: number;
        packetLossThreshold?: number;
        rateLimitingEnabled?: boolean;
        timeout?: string;
        timeoutRatioThreshold?: number;
    }
    Index
    historyMaxSize? packetLossThreshold? rateLimitingEnabled? timeout? timeoutRatioThreshold?
    historyMaxSize?: number

    The maximum number of latencies to record. Higher numbers could result in more delay before packet loss is detected. Lower numbers could result in packet loss not being detected.

    packetLossThreshold?: number

    Enables rate limiting when the variation coefficient of frame latencies exceeds this threshold. The variation coefficient is defined by the standard deviation of latencies over the average of recorded latencies.

    Lower numbers will increase the aggressiveness of packet loss detection, but may trigger unexpected delivery rate limiting.

    rateLimitingEnabled?: boolean

    Indicates if the rate limiting of frame delivery is enabled based on detected internet throughput.

    timeout?: string

    The duration at which point a frame will be considered failed if the server has not received an acknowledgement.

    timeoutRatioThreshold?: number

    Enables rate limiting when the number of frames that failed to receive an acknowledgement within the timeout window exceeds this ratio.

    Settings
    Member Visibility

    On This Page
    Properties