@twilio/voice-sdk
    Preparing search index...

    Interface Report

    Represents the report generated from a PreflightTest.

    interface Report {
        callQuality?: CallQuality;
        callSid: undefined | string;
        edge?: string;
        iceCandidateStats: any[];
        isTurnRequired?: boolean;
        networkTiming: NetworkTiming;
        samples: RTCSample[];
        selectedEdge?: string;
        selectedIceCandidatePairStats?: RTCSelectedIceCandidatePairStats;
        stats?: RTCStats;
        testTiming: TimeMeasurement;
        totals?: RTCSampleTotals;
        warnings: Warning[];
    }
    Index

    Properties

    callQuality? callSid edge? iceCandidateStats isTurnRequired? networkTiming samples selectedEdge? selectedIceCandidatePairStats? stats? testTiming totals? warnings

    Properties

    callQuality?: CallQuality

    The quality of the call determined by different mos ranges.

    callSid: undefined | string

    CallSid generaged during the test.

    edge?: string

    The edge that the test call was connected to.

    iceCandidateStats: any[]

    An array of WebRTC stats for the ICE candidates gathered when connecting to media.

    isTurnRequired?: boolean

    Whether a TURN server is required to connect to media. This is dependent on the selected ICE candidates, and will be true if either is of type "relay", false if both are of another type, or undefined if there are no selected ICE candidates. See PreflightTest.Options.iceServers for more details.

    networkTiming: NetworkTiming

    Network related time measurements.

    samples: RTCSample[]

    WebRTC samples collected during the test.

    selectedEdge?: string

    The edge passed to Device.runPreflight.

    selectedIceCandidatePairStats?: RTCSelectedIceCandidatePairStats

    A WebRTC stats for the ICE candidate pair used to connect to media, if candidates were selected.

    stats?: RTCStats

    RTC related stats captured during the test.

    testTiming: TimeMeasurement

    Time measurements of test run time.

    totals?: RTCSampleTotals

    Calculated totals in RTC statistics samples.

    warnings: Warning[]

    List of warning names and warning data detected during this test.

    Settings

    Member Visibility

    On This Page

    Properties