@gmessier/nitro-speech 0.1.2 → 0.2.0

package/src/index.ts

@@ -1,4 +1,3 @@
-/* eslint-disable react-hooks/exhaustive-deps */
 import React from 'react'
 import { NitroModules } from 'react-native-nitro-modules'
 import type {
@@ -23,6 +22,7 @@ type RecognizerCallbacks = Pick<
   | 'onAutoFinishProgress'
   | 'onError'
   | 'onPermissionDenied'
+  | 'onVolumeChange'
 >
 
 type RecognizerHandlers = Pick<
@@ -31,6 +31,7 @@ type RecognizerHandlers = Pick<
   | 'stopListening'
   | 'addAutoFinishTime'
   | 'updateAutoFinishTime'
+  | 'getIsActive'
 >
 
 const recognizerStartListening = (params: SpeechToTextParams) => {
@@ -52,6 +53,51 @@ const recognizerUpdateAutoFinishTime = (
   RecognizerSession.updateAutoFinishTime(newTimeMs, withRefresh)
 }
 
+const recognizerGetIsActive = () => {
+  return RecognizerSession.getIsActive()
+}
+
+const subscribers = new Set<RecognizerSpec['onVolumeChange']>()
+let currentVolume = 0
+
+/**
+ * Subscription to the voice input volume changes
+ *
+ * Updates with arbitrary frequency (many times per second) while audio recording is active.
+ *
+ * @returns The current voice input volume normalized to a range of 0 to 1.
+ */
+export const useVoiceInputVolume = () => {
+  return React.useSyncExternalStore(
+    (subscriber) => {
+      subscribers.add(subscriber)
+      return () => subscribers.delete(subscriber)
+    },
+    () => currentVolume
+  )
+}
+
+const handleVolumeChange: RecognizerSpec['onVolumeChange'] = (normVolume) => {
+  if (normVolume === currentVolume) return
+  currentVolume = normVolume
+  subscribers.forEach((subscriber) => subscriber?.(normVolume))
+}
+
+/**
+ * Unsafe access to default Recognizer Session's volume change handler.
+ *
+ * In case you use static Recognizer Session:
+ *
+ * ```typescript
+ * import { unsafe_onVolumeChange } from '@gmessier/nitro-speech'
+ *
+ * RecognizerSession.onVolumeChange = unsafe_onVolumeChange
+ * ... // do something
+ * RecognizerSession.startListening({ locale: 'en-US' })
+ * ```
+ */
+export const unsafe_onVolumeChange = handleVolumeChange
+
 /**
  * Safe, lifecycle-aware hook to use the recognizer.
  *
@@ -70,6 +116,13 @@ export const useRecognizer = (
   destroyDeps: React.DependencyList = []
 ): RecognizerHandlers => {
   React.useEffect(() => {
+    if (callbacks.onVolumeChange) {
+      RecognizerSession.onVolumeChange = (normVolume: number) => {
+        callbacks.onVolumeChange?.(normVolume)
+      }
+    } else {
+      RecognizerSession.onVolumeChange = handleVolumeChange
+    }
     RecognizerSession.onReadyForSpeech = () => {
       callbacks.onReadyForSpeech?.()
     }
@@ -95,6 +148,7 @@ export const useRecognizer = (
       RecognizerSession.onAutoFinishProgress = undefined
       RecognizerSession.onError = undefined
       RecognizerSession.onPermissionDenied = undefined
+      RecognizerSession.onVolumeChange = undefined
     }
   }, [callbacks])
 
@@ -102,6 +156,7 @@ export const useRecognizer = (
     return () => {
       RecognizerSession.stopListening()
     }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [...destroyDeps])
 
   return {
@@ -109,17 +164,19 @@ export const useRecognizer = (
     stopListening: recognizerStopListening,
     addAutoFinishTime: recognizerAddAutoFinishTime,
     updateAutoFinishTime: recognizerUpdateAutoFinishTime,
+    getIsActive: recognizerGetIsActive,
   }
 }
 
 /**
  * Safe reference to the Recognizer methods.
  */
-export const RecognizerRef = {
+export const RecognizerRef: RecognizerHandlers = {
   startListening: recognizerStartListening,
   stopListening: recognizerStopListening,
   addAutoFinishTime: recognizerAddAutoFinishTime,
   updateAutoFinishTime: recognizerUpdateAutoFinishTime,
+  getIsActive: recognizerGetIsActive,
 }
 
 export type { RecognizerCallbacks, RecognizerHandlers, SpeechToTextParams }

package/src/specs/NitroSpeech.nitro.ts

@@ -1,18 +1,12 @@
 import { type HybridObject } from 'react-native-nitro-modules'
 
 interface ParamsAndroid {
-  /**
-   * Default - false
-   *
-   * Min Android 13
-   */
-  androidMaskOffensiveWords?: boolean
   /**
    * Default - false
    *
    * Prefer quality over latency (may break autofinish timing, depends on engine)
    *
-   * Min Android 13
+   * Android 13+
    */
   androidFormattingPreferQuality?: boolean
   /**
@@ -39,12 +33,12 @@ interface ParamsIOS {
    *
    * Adds punctuation to speech recognition results
    *
-   * Min iOS 16
+   * iOS 16+
    */
   iosAddPunctuation?: boolean
 }
 
-type HapticFeedbackStyle = 'light' | 'medium' | 'heavy'
+type HapticFeedbackStyle = 'light' | 'medium' | 'heavy' | 'none'
 
 export interface SpeechToTextParams extends ParamsAndroid, ParamsIOS {
   /**
@@ -68,17 +62,25 @@ export interface SpeechToTextParams extends ParamsAndroid, ParamsIOS {
    */
   contextualStrings?: string[]
   /**
-   * Default - null
+   * Default - "medium"
    *
    * Haptic feedback style when microphone starts recording.
    */
   startHapticFeedbackStyle?: HapticFeedbackStyle
   /**
-   * Default - null
+   * Default - "medium"
    *
    * Haptic feedback style when microphone stops recording.
    */
   stopHapticFeedbackStyle?: HapticFeedbackStyle
+  /**
+   * Default - false
+   *
+   * Android 13+
+   *
+   * iOS 26+ (iOS <26: always `false`)
+   */
+  maskOffensiveWords?: boolean
 }
 
 export interface Recognizer extends HybridObject<{
@@ -119,12 +121,17 @@ export interface Recognizer extends HybridObject<{
    */
   updateAutoFinishTime(newTimeMs: number, withRefresh?: boolean): void
 
+  /**
+   * Returns true if the speech recognition is active.
+   */
+  getIsActive(): boolean
+
   /**
    * The speech recognition has started.
    */
   onReadyForSpeech?: () => void
   /**
-   * Audio recording has stopped. (may be called multiple times for one recording)
+   * Audio recording has stopped.
    */
   onRecordingStopped?: () => void
   /**
@@ -147,6 +154,12 @@ export interface Recognizer extends HybridObject<{
    * Permission to record audio has been denied.
    */
   onPermissionDenied?: () => void
+  /**
+   * Called with arbitrary frequency (many times per second) while audio recording is active.
+   *
+   * Voice input volume normalized to a range of 0 to 1.
+   */
+  onVolumeChange?: (normVolume: number) => void
 }
 
 export interface NitroSpeech extends HybridObject<{