Hiyve Components - v1.0.0
    Preparing search index...

    Interface CollectConnectionDiagnosticsOptions

    Options for collectConnectionDiagnostics.

    interface CollectConnectionDiagnosticsOptions {
        classifyDevices?: boolean;
        includeDeviceLabels?: boolean;
        timeoutMs?: number;
    }
    Index

    Properties

    classifyDevices?: boolean

    Enumerate devices to classify the selected inputs. Defaults to true. Set false to skip the enumeration (the kinds come back 'unknown').

    includeDeviceLabels?: boolean

    Also return the selected devices' labels (audioInputLabel, videoInputLabel, audioOutputLabel). Defaults to false. Labels are user-set and can be personal ("Karl's AirPods"); opt in only where the reader is entitled to them, such as a support conversation the user started.

    timeoutMs?: number

    Upper bound on the whole collection, in milliseconds. Defaults to 1500. When it elapses the snapshot resolves with whatever has been gathered so far — a stalled call can never hold up the caller.