@unityevolv/ofiskit-realtime-client 0.1.0

package/dist/rtc/adapter.d.ts

@@ -0,0 +1,238 @@
+import type { IceServer, SignalMessage } from '@unityevolv/ofiskit-realtime-core/protocol';
+import type { ShareOptions } from './screen.js';
+/**
+ * The RTC provider interface, client half.
+ *
+ * The other half is the server plugin in the core, and **both must exist** for a
+ * provider to be usable. This is the one the controls bar, the tiles and the
+ * indicators actually talk to: none of them imports a provider SDK, they consume
+ * the events below in one shape whichever provider is behind them.
+ *
+ * The built-in mesh adapter is the reference implementation and arrives with the
+ * signalling story. An external provider's adapter wraps that provider's SDK and
+ * talks to their servers; our socket carries only call state, never their media
+ * or signalling.
+ *
+ * No DOM anywhere except the media types, which React Native shims — which is
+ * why this lives in the platform-agnostic package and the tiles do not.
+ */
+/** One thing that happened in the call, in the shape every provider reports. */
+export type RtcEvent = {
+    type: 'participant.joined';
+    deviceId: string;
+    userId: string;
+    displayName: string;
+} | {
+    type: 'participant.left';
+    deviceId: string;
+}
+/**
+ * A stream arrived from a peer.
+ *
+ * `source` separates a camera from a screen share, because they are laid out
+ * completely differently and a share that arrives as a camera tile is useless.
+ */
+ | {
+    type: 'track';
+    deviceId: string;
+    stream: MediaStream;
+    source: 'camera' | 'screen' | 'audio';
+} | {
+    type: 'track.ended';
+    deviceId: string;
+    source: 'camera' | 'screen' | 'audio';
+}
+/** Your own microphone level, a few times a second and only while it changes. */
+ | {
+    type: 'speaking';
+    speaking: boolean;
+    level: number;
+} | {
+    type: 'quality';
+    deviceId: string;
+    relayed: boolean;
+    packetLoss: number;
+    roundTripMs: number;
+}
+/** What you are publishing, reported after the adapter actually did it. */
+ | {
+    type: 'state';
+    muted: boolean;
+    cameraOn: boolean;
+    sharing: boolean;
+}
+/**
+ * A connection failed.
+ *
+ * `deviceId` present means one peer is unreachable and the rest of the call is
+ * fine, which is worth saying precisely: a three-way call with one unreachable
+ * person is not a total failure and must not be reported as one.
+ */
+ | {
+    type: 'failed';
+    deviceId?: string;
+    reason: string;
+}
+/** Your own video was reduced, so nobody has to wonder why they look blurry. */
+ | {
+    type: 'degraded';
+    videoDropped: boolean;
+    reason: string;
+} | {
+    type: 'local';
+    stream: MediaStream | null;
+    source: 'camera' | 'screen';
+};
+export type RtcHandler = (event: RtcEvent) => void;
+export interface JoinOptions {
+    callId: string;
+    /** Who this client is, as a call leg. A leg is a device, not a person. */
+    deviceId: string;
+    /** Whatever the server plugin issued. The adapter is the only thing that reads it. */
+    credentials: unknown;
+    iceServers: IceServer[];
+    /** Who is already here, so a new peer knows who to connect to. */
+    participants: Array<{
+        userId: string;
+        deviceId: string;
+        displayName: string;
+    }>;
+    audio: boolean;
+    video: boolean;
+    /** Chosen devices, from the device picker. */
+    audioDeviceId?: string;
+    videoDeviceId?: string;
+}
+/**
+ * How the adapter reaches the other side.
+ *
+ * Injected rather than imported, so the adapter does not know whether it is
+ * talking over our socket or a provider's own channel. The built-in adapter uses
+ * our socket; an external one would not need this at all.
+ */
+export interface Signaller {
+    send(message: SignalMessage): void;
+    receive(handler: (message: SignalMessage & {
+        from: string;
+    }) => void): () => void;
+}
+export interface RtcClientAdapter {
+    join(options: JoinOptions): Promise<void>;
+    leave(): Promise<void>;
+    setMicrophone(on: boolean): Promise<void>;
+    setCamera(on: boolean): Promise<void>;
+    /**
+     * Start sharing, and say whether it started.
+     *
+     * False covers both the person closing the picker and a capture that failed, and
+     * the difference is not the caller's business: a failure has already been
+     * reported as a `failed` event, and a cancellation is not a failure at all.
+     *
+     * With no options the browser's own picker chooses what to share. A `sourceId`
+     * means the host drew the picker — a desktop app, where the browser has none —
+     * and the person has already chosen.
+     */
+    startScreenShare(options?: ShareOptions): Promise<boolean>;
+    stopScreenShare(): Promise<void>;
+    /**
+     * Which peers should send video.
+     *
+     * Only the visible tiles receive video; everybody else is audio-only. Paging
+     * the tile strip changes this set, and that is what bounds what each person
+     * downloads however big the call gets.
+     */
+    setVideoSubscriptions(deviceIds: string[]): void;
+    /** Swap microphone or camera mid-call, from the device picker. */
+    useDevices(devices: {
+        audioDeviceId?: string;
+        videoDeviceId?: string;
+    }): Promise<void>;
+    on(handler: RtcHandler): () => void;
+}
+/**
+ * Ceilings per stream, so four cameras plus a share stay inside what a home
+ * connection can upload.
+ *
+ * A mesh cannot use simulcast: the sender uploads a separate copy to every peer,
+ * so the **sender** has to do the adapting. These are the steps it moves between.
+ */
+export declare const VIDEO_STEPS: readonly [{
+    readonly height: 720;
+    readonly maxBitrate: 1200000;
+    readonly maxFramerate: 30;
+}, {
+    readonly height: 480;
+    readonly maxBitrate: 600000;
+    readonly maxFramerate: 30;
+}, {
+    readonly height: 360;
+    readonly maxBitrate: 300000;
+    readonly maxFramerate: 24;
+}, {
+    readonly height: 180;
+    readonly maxBitrate: 120000;
+    readonly maxFramerate: 15;
+}];
+/**
+ * The screen share's ceiling.
+ *
+ * Resolution is favoured over frame rate, because text has to stay readable and a
+ * slightly jerky slide is far better than a sharp one nobody can read.
+ */
+export declare const SCREEN_CEILING: {
+    readonly maxBitrate: 1500000;
+    readonly maxFramerate: 8;
+};
+/** Audio is protected and never steps down. Video degrades first, always. */
+export declare const AUDIO_BITRATE = 32000;
+/**
+ * What counts as talking, and how long it goes on counting.
+ *
+ * The level is the root mean square of the waveform, which is volume — not the
+ * average across the frequency bins, which is volume divided by however much of
+ * the spectrum happens to be empty. A voice puts almost all of its energy below
+ * two kilohertz, so averaging it across twenty-four kilohertz of mostly silence
+ * gives a number an order of magnitude smaller than the sound actually is, and a
+ * threshold picked against that number is a threshold nobody normal crosses.
+ *
+ * `SPEAKING_HOLD_MS` is what stops the ring strobing. Speech is not continuous:
+ * there is a gap between every word and a longer one between sentences, and an
+ * indicator that follows the waveform exactly flickers all the way through a
+ * sentence. Holding it briefly after the level drops reads as "this is the person
+ * talking" rather than as a light fault, and it cuts what goes over the socket,
+ * because only a change is sent.
+ */
+export declare const SPEAKING_LEVEL = 0.05;
+export declare const SPEAKING_HOLD_MS = 1000;
+/** How often the level is measured. Five times a second is under the eye's notice. */
+export declare const LEVEL_INTERVAL_MS = 200;
+/**
+ * How loud the waveform is, between 0 and 1.
+ *
+ * Takes the bytes an `AnalyserNode` gives for the time domain, where 128 is
+ * silence and the distance either side of it is the amplitude. Pure and exported
+ * so the one number the speaking indicator depends on can be tested without a
+ * browser, an audio context or a microphone.
+ */
+export declare function rmsLevel(samples: Uint8Array): number;
+/**
+ * Whether this device counts as talking, now.
+ *
+ * `loudAt` is when the level was last above the threshold. Muting wins over the
+ * hold: a muted microphone is silent, and an indicator that says otherwise for a
+ * second afterwards is the one mistake this indicator must never make.
+ */
+export declare function speakingNow(state: {
+    muted: boolean;
+    loudAt: number;
+    now: number;
+}): boolean;
+/**
+ * How long to try before giving up.
+ *
+ * Bounded on purpose. Some networks block UDP and the relay ports outright, and
+ * on those the connection is never going to happen; an indefinite spinner just
+ * makes somebody wait longer to find that out.
+ */
+export declare const CONNECT_TIMEOUT_MS = 15000;
+//# sourceMappingURL=adapter.d.ts.map

package/dist/rtc/adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/rtc/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,4CAA4C,CAAA;AAE1F,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE/C;;;;;;;;;;;;;;;GAeG;AAEH,gFAAgF;AAChF,MAAM,MAAM,QAAQ,GAChB;IAAE,IAAI,EAAE,oBAAoB,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,GACrF;IAAE,IAAI,EAAE,kBAAkB,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE;AAChD;;;;;GAKG;GACD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,WAAW,CAAC;IAAC,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAA;CAAE,GAC/F;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAA;CAAE;AAClF,iFAAiF;GAC/E;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACtD;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE;AAClG,2EAA2E;GACzE;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE;AACxE;;;;;;GAMG;GACD;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE;AACvD,gFAAgF;GAC9E;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,YAAY,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC3D;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC;IAAC,MAAM,EAAE,QAAQ,GAAG,QAAQ,CAAA;CAAE,CAAA;AAE9E,MAAM,MAAM,UAAU,GAAG,CAAC,KAAK,EAAE,QAAQ,KAAK,IAAI,CAAA;AAElD,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,0EAA0E;IAC1E,QAAQ,EAAE,MAAM,CAAA;IAChB,sFAAsF;IACtF,WAAW,EAAE,OAAO,CAAA;IACpB,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,kEAAkE;IAClE,YAAY,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAC9E,KAAK,EAAE,OAAO,CAAA;IACd,KAAK,EAAE,OAAO,CAAA;IACd,8CAA8C;IAC9C,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAA;IAClC,OAAO,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,aAAa,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,GAAG,MAAM,IAAI,CAAA;CAClF;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtB,aAAa,CAAC,EAAE,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzC,SAAS,CAAC,EAAE,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACrC;;;;;;;;;;OAUG;IACH,gBAAgB,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC1D,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhC;;;;;;OAMG;IACH,qBAAqB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IAEhD,kEAAkE;IAClE,UAAU,CAAC,OAAO,EAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtF,EAAE,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM,IAAI,CAAA;CACpC;AAED;;;;;;GAMG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;EAKd,CAAA;AAEV;;;;;GAKG;AACH,eAAO,MAAM,cAAc;;;CAAsD,CAAA;AAEjF,6EAA6E;AAC7E,eAAO,MAAM,aAAa,QAAS,CAAA;AAEnC;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,cAAc,OAAO,CAAA;AAClC,eAAO,MAAM,gBAAgB,OAAQ,CAAA;AACrC,sFAAsF;AACtF,eAAO,MAAM,iBAAiB,MAAM,CAAA;AAEpC;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM,CAQpD;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAE3F;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,QAAS,CAAA"}

package/dist/rtc/adapter.js

@@ -0,0 +1,80 @@
+/**
+ * Ceilings per stream, so four cameras plus a share stay inside what a home
+ * connection can upload.
+ *
+ * A mesh cannot use simulcast: the sender uploads a separate copy to every peer,
+ * so the **sender** has to do the adapting. These are the steps it moves between.
+ */
+export const VIDEO_STEPS = [
+    { height: 720, maxBitrate: 1_200_000, maxFramerate: 30 },
+    { height: 480, maxBitrate: 600_000, maxFramerate: 30 },
+    { height: 360, maxBitrate: 300_000, maxFramerate: 24 },
+    { height: 180, maxBitrate: 120_000, maxFramerate: 15 },
+];
+/**
+ * The screen share's ceiling.
+ *
+ * Resolution is favoured over frame rate, because text has to stay readable and a
+ * slightly jerky slide is far better than a sharp one nobody can read.
+ */
+export const SCREEN_CEILING = { maxBitrate: 1_500_000, maxFramerate: 8 };
+/** Audio is protected and never steps down. Video degrades first, always. */
+export const AUDIO_BITRATE = 32_000;
+/**
+ * What counts as talking, and how long it goes on counting.
+ *
+ * The level is the root mean square of the waveform, which is volume — not the
+ * average across the frequency bins, which is volume divided by however much of
+ * the spectrum happens to be empty. A voice puts almost all of its energy below
+ * two kilohertz, so averaging it across twenty-four kilohertz of mostly silence
+ * gives a number an order of magnitude smaller than the sound actually is, and a
+ * threshold picked against that number is a threshold nobody normal crosses.
+ *
+ * `SPEAKING_HOLD_MS` is what stops the ring strobing. Speech is not continuous:
+ * there is a gap between every word and a longer one between sentences, and an
+ * indicator that follows the waveform exactly flickers all the way through a
+ * sentence. Holding it briefly after the level drops reads as "this is the person
+ * talking" rather than as a light fault, and it cuts what goes over the socket,
+ * because only a change is sent.
+ */
+export const SPEAKING_LEVEL = 0.05;
+export const SPEAKING_HOLD_MS = 1_000;
+/** How often the level is measured. Five times a second is under the eye's notice. */
+export const LEVEL_INTERVAL_MS = 200;
+/**
+ * How loud the waveform is, between 0 and 1.
+ *
+ * Takes the bytes an `AnalyserNode` gives for the time domain, where 128 is
+ * silence and the distance either side of it is the amplitude. Pure and exported
+ * so the one number the speaking indicator depends on can be tested without a
+ * browser, an audio context or a microphone.
+ */
+export function rmsLevel(samples) {
+    if (samples.length === 0)
+        return 0;
+    let total = 0;
+    for (const sample of samples) {
+        const amplitude = (sample - 128) / 128;
+        total += amplitude * amplitude;
+    }
+    return Math.sqrt(total / samples.length);
+}
+/**
+ * Whether this device counts as talking, now.
+ *
+ * `loudAt` is when the level was last above the threshold. Muting wins over the
+ * hold: a muted microphone is silent, and an indicator that says otherwise for a
+ * second afterwards is the one mistake this indicator must never make.
+ */
+export function speakingNow(state) {
+    return !state.muted && state.now - state.loudAt < SPEAKING_HOLD_MS;
+}
+/**
+ * How long to try before giving up.
+ *
+ * Bounded on purpose. Some networks block UDP and the relay ports outright, and
+ * on those the connection is never going to happen; an indefinite spinner just
+ * makes somebody wait longer to find that out.
+ */
+export const CONNECT_TIMEOUT_MS = 15_000;
+//# sourceMappingURL=adapter.js.map

package/dist/rtc/adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../../src/rtc/adapter.ts"],"names":[],"mappings":"AAmHA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,EAAE;IACxD,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE;IACtD,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE;IACtD,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE;CAC9C,CAAA;AAEV;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,EAAW,CAAA;AAEjF,6EAA6E;AAC7E,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAA;AAEnC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,CAAA;AAClC,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,CAAA;AACrC,sFAAsF;AACtF,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,CAAA;AAEpC;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CAAC,OAAmB;IAC1C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IAClC,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,SAAS,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,GAAG,GAAG,CAAA;QACtC,KAAK,IAAI,SAAS,GAAG,SAAS,CAAA;IAChC,CAAC;IACD,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;AAC1C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,KAAsD;IAChF,OAAO,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,MAAM,GAAG,gBAAgB,CAAA;AACpE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAA"}

package/dist/rtc/devices.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Choosing a microphone, a camera and a speaker, and coping when the browser
+ * says no.
+ *
+ * Almost all of the value here is in the failure cases. Picking a device is
+ * easy; telling somebody the difference between "you denied permission" and
+ * "Zoom still has your camera" is what stops a support ticket, and the browser
+ * will not do it for you.
+ */
+export interface Devices {
+    microphones: MediaDeviceInfo[];
+    cameras: MediaDeviceInfo[];
+    speakers: MediaDeviceInfo[];
+}
+export interface DeviceChoice {
+    audioDeviceId?: string;
+    videoDeviceId?: string;
+    /** Output routing, so a call can go to headphones while alerts stay on speakers. */
+    speakerDeviceId?: string;
+}
+/**
+ * Where a choice is remembered.
+ *
+ * Injected rather than reached for, because this package has to run on a phone
+ * and `localStorage` does not exist there. The web app passes an adapter over
+ * localStorage; React Native would pass one over its own storage.
+ */
+export interface DeviceStorage {
+    read(): DeviceChoice;
+    write(choice: DeviceChoice): void;
+}
+export declare function memoryDeviceStorage(initial?: DeviceChoice): DeviceStorage;
+/**
+ * What is plugged in.
+ *
+ * Labels are empty until permission has been granted at least once, which is
+ * why the pre-join panel asks for permission before showing the list: a picker
+ * offering "Microphone 1" and "Microphone 2" is no use to anybody.
+ */
+export declare function listDevices(): Promise<Devices>;
+export interface PermissionOutcome {
+    granted: boolean;
+    /** Present when it failed: what happened, and what to do about it. */
+    problem?: string;
+    /** True when permission was granted but the device was unusable. */
+    inUseElsewhere?: boolean;
+}
+/**
+ * Ask for permission, and find out what actually happened.
+ *
+ * The awkward case this exists for: on some platforms a camera held by another
+ * application grants permission and then hands back a stream with no data in it
+ * at all. That looks identical to a working camera until somebody says they
+ * cannot see you, so a black stream is checked for explicitly and reported as
+ * the different problem it is.
+ */
+export declare function requestPermission(want: {
+    audio: boolean;
+    video: boolean;
+}, deviceChoice?: DeviceChoice): Promise<PermissionOutcome & {
+    stream?: MediaStream;
+}>;
+/**
+ * Watch for devices arriving and leaving.
+ *
+ * Unplugging a headset mid-call should switch to the built-in microphone and
+ * say so. A silent switch is worse than no switch: somebody carries on talking
+ * into a headset that is no longer connected.
+ */
+export declare function watchDevices(onChange: (devices: Devices) => void): () => void;
+/**
+ * Whether a remembered choice is still available.
+ *
+ * A USB headset that is unplugged should fall back to the operating system's
+ * default rather than failing with a constraint error nobody can interpret.
+ */
+export declare function stillAvailable(choice: DeviceChoice, devices: Devices): DeviceChoice;
+/** The name to show for a device that has lost its label. */
+export declare function labelFor(device: MediaDeviceInfo, index: number): string;
+//# sourceMappingURL=devices.d.ts.map

package/dist/rtc/devices.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"devices.d.ts","sourceRoot":"","sources":["../../src/rtc/devices.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AAEH,MAAM,WAAW,OAAO;IACtB,WAAW,EAAE,eAAe,EAAE,CAAA;IAC9B,OAAO,EAAE,eAAe,EAAE,CAAA;IAC1B,QAAQ,EAAE,eAAe,EAAE,CAAA;CAC5B;AAED,MAAM,WAAW,YAAY;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,oFAAoF;IACpF,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,IAAI,YAAY,CAAA;IACpB,KAAK,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;CAClC;AAED,wBAAgB,mBAAmB,CAAC,OAAO,GAAE,YAAiB,GAAG,aAAa,CAQ7E;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,CAOpD;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,OAAO,CAAA;IAChB,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,oEAAoE;IACpE,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED;;;;;;;;GAQG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,EACxC,YAAY,GAAE,YAAiB,GAC9B,OAAO,CAAC,iBAAiB,GAAG;IAAE,MAAM,CAAC,EAAE,WAAW,CAAA;CAAE,CAAC,CAmCvD;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,GAAG,MAAM,IAAI,CAM7E;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,GAAG,YAAY,CAWnF;AAED,6DAA6D;AAC7D,wBAAgB,QAAQ,CAAC,MAAM,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAKvE"}

package/dist/rtc/devices.js

@@ -0,0 +1,107 @@
+import { describeMediaError } from './mesh.js';
+export function memoryDeviceStorage(initial = {}) {
+    let held = initial;
+    return {
+        read: () => held,
+        write: (choice) => {
+            held = choice;
+        },
+    };
+}
+/**
+ * What is plugged in.
+ *
+ * Labels are empty until permission has been granted at least once, which is
+ * why the pre-join panel asks for permission before showing the list: a picker
+ * offering "Microphone 1" and "Microphone 2" is no use to anybody.
+ */
+export async function listDevices() {
+    const all = await navigator.mediaDevices.enumerateDevices();
+    return {
+        microphones: all.filter((device) => device.kind === 'audioinput'),
+        cameras: all.filter((device) => device.kind === 'videoinput'),
+        speakers: all.filter((device) => device.kind === 'audiooutput'),
+    };
+}
+/**
+ * Ask for permission, and find out what actually happened.
+ *
+ * The awkward case this exists for: on some platforms a camera held by another
+ * application grants permission and then hands back a stream with no data in it
+ * at all. That looks identical to a working camera until somebody says they
+ * cannot see you, so a black stream is checked for explicitly and reported as
+ * the different problem it is.
+ */
+export async function requestPermission(want, deviceChoice = {}) {
+    try {
+        const stream = await navigator.mediaDevices.getUserMedia({
+            audio: want.audio
+                ? {
+                    ...(deviceChoice.audioDeviceId ? { deviceId: { exact: deviceChoice.audioDeviceId } } : {}),
+                    echoCancellation: true,
+                    noiseSuppression: true,
+                }
+                : false,
+            video: want.video
+                ? deviceChoice.videoDeviceId
+                    ? { deviceId: { exact: deviceChoice.videoDeviceId } }
+                    : true
+                : false,
+        });
+        const dead = stream.getTracks().filter((track) => track.readyState === 'ended' || track.muted);
+        if (dead.length > 0 && dead.length === stream.getTracks().length) {
+            for (const track of stream.getTracks())
+                track.stop();
+            return {
+                granted: true,
+                inUseElsewhere: true,
+                problem: 'Your camera or microphone is open in another app. Close it and try again — the permission is fine, the device is just busy.',
+            };
+        }
+        return { granted: true, stream };
+    }
+    catch (cause) {
+        return {
+            granted: false,
+            problem: describeMediaError(cause, want.video ? 'camera' : 'microphone'),
+        };
+    }
+}
+/**
+ * Watch for devices arriving and leaving.
+ *
+ * Unplugging a headset mid-call should switch to the built-in microphone and
+ * say so. A silent switch is worse than no switch: somebody carries on talking
+ * into a headset that is no longer connected.
+ */
+export function watchDevices(onChange) {
+    const handler = () => {
+        void listDevices().then(onChange);
+    };
+    navigator.mediaDevices.addEventListener('devicechange', handler);
+    return () => navigator.mediaDevices.removeEventListener('devicechange', handler);
+}
+/**
+ * Whether a remembered choice is still available.
+ *
+ * A USB headset that is unplugged should fall back to the operating system's
+ * default rather than failing with a constraint error nobody can interpret.
+ */
+export function stillAvailable(choice, devices) {
+    const has = (list, id) => id !== undefined && list.some((device) => device.deviceId === id);
+    return {
+        ...(has(devices.microphones, choice.audioDeviceId) ? { audioDeviceId: choice.audioDeviceId } : {}),
+        ...(has(devices.cameras, choice.videoDeviceId) ? { videoDeviceId: choice.videoDeviceId } : {}),
+        ...(has(devices.speakers, choice.speakerDeviceId)
+            ? { speakerDeviceId: choice.speakerDeviceId }
+            : {}),
+    };
+}
+/** The name to show for a device that has lost its label. */
+export function labelFor(device, index) {
+    if (device.label)
+        return device.label;
+    const kind = device.kind === 'audioinput' ? 'Microphone' : device.kind === 'videoinput' ? 'Camera' : 'Speaker';
+    return `${kind} ${index + 1}`;
+}
+//# sourceMappingURL=devices.js.map

package/dist/rtc/devices.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"devices.js","sourceRoot":"","sources":["../../src/rtc/devices.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAqC9C,MAAM,UAAU,mBAAmB,CAAC,UAAwB,EAAE;IAC5D,IAAI,IAAI,GAAG,OAAO,CAAA;IAClB,OAAO;QACL,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI;QAChB,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE;YAChB,IAAI,GAAG,MAAM,CAAA;QACf,CAAC;KACF,CAAA;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW;IAC/B,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,YAAY,CAAC,gBAAgB,EAAE,CAAA;IAC3D,OAAO;QACL,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,YAAY,CAAC;QACjE,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,YAAY,CAAC;QAC7D,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,aAAa,CAAC;KAChE,CAAA;AACH,CAAC;AAUD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,IAAwC,EACxC,eAA6B,EAAE;IAE/B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,YAAY,CAAC,YAAY,CAAC;YACvD,KAAK,EAAE,IAAI,CAAC,KAAK;gBACf,CAAC,CAAC;oBACE,GAAG,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,YAAY,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC1F,gBAAgB,EAAE,IAAI;oBACtB,gBAAgB,EAAE,IAAI;iBACvB;gBACH,CAAC,CAAC,KAAK;YACT,KAAK,EAAE,IAAI,CAAC,KAAK;gBACf,CAAC,CAAC,YAAY,CAAC,aAAa;oBAC1B,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,YAAY,CAAC,aAAa,EAAE,EAAE;oBACrD,CAAC,CAAC,IAAI;gBACR,CAAC,CAAC,KAAK;SACV,CAAC,CAAA;QAEF,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,KAAK,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,CAAA;QAC9F,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,CAAC;YACjE,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,SAAS,EAAE;gBAAE,KAAK,CAAC,IAAI,EAAE,CAAA;YACpD,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,cAAc,EAAE,IAAI;gBACpB,OAAO,EACL,6HAA6H;aAChI,CAAA;QACH,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAA;IAClC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC;SACzE,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,QAAoC;IAC/D,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,KAAK,WAAW,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IACnC,CAAC,CAAA;IACD,SAAS,CAAC,YAAY,CAAC,gBAAgB,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;IAChE,OAAO,GAAG,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,mBAAmB,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;AAClF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,MAAoB,EAAE,OAAgB;IACnE,MAAM,GAAG,GAAG,CAAC,IAAuB,EAAE,EAAW,EAAE,EAAE,CACnD,EAAE,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,KAAK,EAAE,CAAC,CAAA;IAEnE,OAAO;QACL,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClG,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9F,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,eAAe,CAAC;YAC/C,CAAC,CAAC,EAAE,eAAe,EAAE,MAAM,CAAC,eAAe,EAAE;YAC7C,CAAC,CAAC,EAAE,CAAC;KACR,CAAA;AACH,CAAC;AAED,6DAA6D;AAC7D,MAAM,UAAU,QAAQ,CAAC,MAAuB,EAAE,KAAa;IAC7D,IAAI,MAAM,CAAC,KAAK;QAAE,OAAO,MAAM,CAAC,KAAK,CAAA;IACrC,MAAM,IAAI,GACR,MAAM,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAA;IACnG,OAAO,GAAG,IAAI,IAAI,KAAK,GAAG,CAAC,EAAE,CAAA;AAC/B,CAAC"}

package/dist/rtc/mesh.d.ts

@@ -0,0 +1,13 @@
+import { type RtcClientAdapter, type Signaller } from './adapter.js';
+export declare function meshAdapter(signaller: Signaller): RtcClientAdapter;
+/**
+ * Turn a getUserMedia failure into something worth reading.
+ *
+ * Denied permission is the most common support question in any call product,
+ * and the browser's own message is no help at all. A device held by another app
+ * is a different problem with a different fix, and on some platforms it arrives
+ * as a silent black stream rather than an error, so the two must not be
+ * collapsed into "something went wrong".
+ */
+export declare function describeMediaError(cause: unknown, device: 'microphone' | 'camera'): string;
+//# sourceMappingURL=mesh.d.ts.map

package/dist/rtc/mesh.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mesh.d.ts","sourceRoot":"","sources":["../../src/rtc/mesh.ts"],"names":[],"mappings":"AAEA,OAAO,EAUL,KAAK,gBAAgB,EAGrB,KAAK,SAAS,EACf,MAAM,cAAc,CAAA;AA8DrB,wBAAgB,WAAW,CAAC,SAAS,EAAE,SAAS,GAAG,gBAAgB,CA2vBlE;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,GAAG,QAAQ,GAAG,MAAM,CAkB1F"}