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

    Interface ConnectionDiagnostics

    The snapshot. Every field is present; unavailable values are null or 'unknown'.

    interface ConnectionDiagnostics {
        audio: RtpRollup | null;
        audioInputKind: InputDeviceKind;
        audioInputLabel: string | null;
        audioInputSelected: boolean;
        audioLevel: number | null;
        audioOutputLabel: string | null;
        audioProducerPaused: boolean | null;
        audioTrackEnabled: boolean | null;
        audioTrackMuted: boolean | null;
        audioTrackState: "live" | "ended" | null;
        camPermission: MediaPermissionState;
        icePath: "relay" | "direct" | null;
        iceProtocol: "udp" | "tcp" | null;
        micPermission: MediaPermissionState;
        packetsLost: number | null;
        receiveTransportState: string | null;
        roundTripMs: number | null;
        sendTransportState: string | null;
        video: RtpRollup | null;
        videoInputKind: InputDeviceKind;
        videoInputLabel: string | null;
        videoInputSelected: boolean;
        videoProducerPaused: boolean | null;
        videoTrackEnabled: boolean | null;
        videoTrackMuted: boolean | null;
        videoTrackState: "live" | "ended" | null;
    }
    Index

    Properties

    audio audioInputKind audioInputLabel audioInputSelected audioLevel audioOutputLabel audioProducerPaused audioTrackEnabled audioTrackMuted audioTrackState camPermission icePath iceProtocol micPermission packetsLost receiveTransportState roundTripMs sendTransportState video videoInputKind videoInputLabel videoInputSelected videoProducerPaused videoTrackEnabled videoTrackMuted videoTrackState

    Properties

    audio: RtpRollup | null

    Per-kind RTP rollups, both directions combined. null when no stream of that kind exists.

    audioInputKind: InputDeviceKind
    audioInputLabel: string | null

    The selected devices' labels as the browser reports them. null unless includeDeviceLabels was set — labels are user-set and can be personal, so they are only included on request.

    audioInputSelected: boolean

    Whether a microphone / camera is currently selected, and its category.

    audioLevel: number | null

    Outgoing audio level, 0–1, from the send transport's media source. null when not reported.

    audioOutputLabel: string | null
    audioProducerPaused: boolean | null

    Whether the outgoing audio producer is paused (the user's own mute).

    audioTrackEnabled: boolean | null

    Application-side enabled flag of the microphone track.

    audioTrackMuted: boolean | null

    Browser-side muted flag of the microphone track (the OS or hardware stopped delivering samples).

    audioTrackState: "live" | "ended" | null

    'live' while the microphone track is producing, 'ended' once it has stopped, null without a track.

    camPermission: MediaPermissionState

    Camera permission as the browser reports it.

    icePath: "relay" | "direct" | null

    'relay' when the selected ICE pair goes through a TURN relay, 'direct' otherwise.

    iceProtocol: "udp" | "tcp" | null

    Transport protocol of the selected ICE pair (TURN over TLS counts as 'tcp').

    micPermission: MediaPermissionState

    Microphone permission as the browser reports it.

    packetsLost: number | null

    Packets lost across the outgoing and incoming RTP streams, summed.

    receiveTransportState: string | null

    Receive transport state, or null before a room is joined.

    roundTripMs: number | null

    Round-trip time to the media server in milliseconds.

    sendTransportState: string | null

    Send transport state ('new', 'connecting', 'connected', 'failed', …) or null before a room is joined.

    video: RtpRollup | null
    videoInputKind: InputDeviceKind
    videoInputLabel: string | null
    videoInputSelected: boolean
    videoProducerPaused: boolean | null
    videoTrackEnabled: boolean | null
    videoTrackMuted: boolean | null
    videoTrackState: "live" | "ended" | null

    Same four for the camera.

    Settings

    Member Visibility

    On This Page

    Properties