@lumavox/react-native 0.9.0 → 0.10.0

package/README.md

@@ -54,7 +54,10 @@ function Talk({ agentId }: { agentId: string }) {
 - A call, Siri or another app pauses the reply and throws away a recording
   in progress — `interrupted`, `onAudioInterrupted`, `onAudioResumed`; so
   does leaving the screen: no background audio in this release.
-- Hands-free and background audio come with `react-native-audio-api` 1.0.
+- Hands-free (`agent.listen()`) runs on the web, where the browser cancels
+  echo; on a phone it is refused until `react-native-audio-api` 1.0 does —
+  `listen({ assumeNoEcho: true })` with headphones on. Background audio
+  comes with 1.0 too.
 
 The guide, with the bare React Native setup: the docs' **SDKs** tab,
 *React Native*.

package/dist/audio.native.d.ts

@@ -1,6 +1,8 @@
 import type { AudioOptions, CreateAudio, DeviceAudio, Output } from "./device-audio.js";
 /** Hz the microphone records at unless a rate the socket takes is asked. */
 export declare const RECORD_RATE = 16000;
+/** Why `handsFree` refuses on a phone. */
+export declare const PHONE_ECHO = "Hands-free needs echo cancellation, which comes with react-native-audio-api 1.0. Use push-to-talk, or assumeNoEcho with headphones on.";
 export declare class PhoneAudio implements DeviceAudio {
     interrupted: boolean;
     private context;
@@ -29,6 +31,7 @@ export declare class PhoneAudio implements DeviceAudio {
     stopCapture(): Promise<void>;
     resume(): Promise<void>;
     setOutput(output: Output): void;
+    handsFree(): ReturnType<DeviceAudio["handsFree"]>;
     onInterruption(fn: (interrupted: boolean) => void): () => void;
     dispose(): void;
     /** The queue for a reply at `rate`: this one, or a new context's. */

package/dist/audio.native.js

@@ -26,12 +26,17 @@
  *   thrown away (the hook discards the recording on the socket). The audio
  *   comes back on its own when the system says it may, else on `resume()`
  *   or the next press.
+ * - **No hands-free**: 0.13.6 cancels no echo, so a microphone left open
+ *   hears the agent (D12, D16). `handsFree` refuses until 1.0; with
+ *   headphones on, the app passes `assumeNoEcho`.
  */
 import { DEFAULT_SAMPLE_RATE, floatToPcm16, pcm16ToFloat, RECORDING_RATES, resample, } from "@lumavox/client";
 import { AudioContext, AudioRecorder, } from "react-native-audio-api";
 import * as session from "./session.js";
 /** Hz the microphone records at unless a rate the socket takes is asked. */
 export const RECORD_RATE = 16000;
+/** Why `handsFree` refuses on a phone. */
+export const PHONE_ECHO = "Hands-free needs echo cancellation, which comes with react-native-audio-api 1.0. Use push-to-talk, or assumeNoEcho with headphones on.";
 /** Seconds of microphone per buffer delivered: the recorder's own latency. */
 const RECORD_SECONDS = 0.1;
 export class PhoneAudio {
@@ -156,6 +161,9 @@ export class PhoneAudio {
     setOutput(output) {
         session.configure(output);
     }
+    async handsFree() {
+        return { ok: false, reason: PHONE_ECHO };
+    }
     onInterruption(fn) {
         this.interruptions.add(fn);
         return () => {
@@ -186,7 +194,11 @@ export class PhoneAudio {
                 this.tell(this.drained);
             }
         };
-        queue.start();
+        // Never `start()`: 0.13.6's wrapper defaults `offset` to -1 and then
+        // throws on its own default (`offset must be a finite non-negative
+        // number: -1`), which crashed the first reply on Android's emulator.
+        // The queue is empty here, so the native side ignores the 0.
+        queue.start(0, 0);
         // Made while the audio is taken: it waits, as the one it replaced did.
         if (this.interrupted)
             this.quiet(context);

package/dist/audio.web.js

@@ -29,6 +29,12 @@ class BrowserAudio {
         return this.web.prime();
     }
     setOutput(_output) { }
+    handsFree() {
+        return this.web.handsFree();
+    }
+    duck(on) {
+        this.web.duck(on);
+    }
     onInterruption(_fn) {
         return () => { };
     }

package/dist/device-audio.d.ts

@@ -34,6 +34,17 @@ export interface DeviceAudio extends AgentAudio {
     /** The loudspeaker or the earpiece, from now on (`AudioOptions.output`). */
     setOutput(output: Output): void;
     onInterruption(fn: (interrupted: boolean) => void): () => void;
+    /**
+     * Whether hands-free may run (`useAgent`'s `listen`): on the web where
+     * the browser cancels echo; on a phone not until `react-native-audio-api`
+     * 1.0 does — with headphones on, an app passes `assumeNoEcho`.
+     */
+    handsFree(): Promise<{
+        ok: true;
+    } | {
+        ok: false;
+        reason: string;
+    }>;
 }
 /** `createAudio`'s signature, which each platform's file implements. */
 export type CreateAudio = (options?: AudioOptions) => DeviceAudio;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lumavox/react-native",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "Voice conversations with Lumavox agents in a React Native app, on iOS, Android and the web: the client, the React hooks, and push-to-talk audio on react-native-audio-api.",
   "license": "MIT",
   "files": [
@@ -30,8 +30,8 @@
     "typecheck": "tsc --noEmit && tsc --noEmit -p test"
   },
   "dependencies": {
-    "@lumavox/client": "0.9.0",
-    "@lumavox/react": "0.9.0"
+    "@lumavox/client": "0.10.0",
+    "@lumavox/react": "0.10.0"
   },
   "peerDependencies": {
     "react": ">=18",