@gmessier/nitro-speech 0.4.0 → 0.4.2

package/src/index.ts

@@ -1,6 +1,20 @@
-export * from './Recognizer/useRecognizer'
-export * from './Recognizer/useVoiceInputVolume'
-export * from './Recognizer/SpeechRecognizer'
-export * from './Recognizer/RecognizerRef'
-export * from './Recognizer/types'
-export * from './NitroSpeech'
+export { useRecognizer } from './Recognizer/useRecognizer'
+export {
+  useVoiceInputVolume,
+  speechRecognizerVolumeChangeHandler,
+} from './Recognizer/useVoiceInputVolume'
+export {
+  useRecognizerIsActive,
+  speechRecognizerActiveStateHandler,
+} from './Recognizer/useRecognizerIsActive'
+export { SpeechRecognizer } from './Recognizer/SpeechRecognizer'
+export { RecognizerRef } from './Recognizer/RecognizerRef'
+export { NitroSpeech } from './NitroSpeech'
+export {
+  type RecognizerSpec,
+  type SpeechRecognitionConfig,
+  type MutableSpeechRecognitionConfig,
+  type VolumeChangeEvent,
+  type RecognizerCallbacks,
+  type RecognizerMethods,
+} from './Recognizer/types'

package/src/specs/Recognizer.nitro.ts

@@ -12,9 +12,24 @@ export interface Recognizer extends HybridObject<{
   /**
    * Prepare the speech recognition engine and the model for the given parameters.
    *
-   * Omit the {@linkcode Promise} result if want to run synchronously.
+   * @notes
+   * - Not required, {@linkcode startListening} will prewarm automatically.
+   *
+   * - Omit the {@linkcode Promise} result if you want to run synchronously.
    * {@linkcode startListening} will start and resolve it automatically.
-   * Only `await` if run beforehand and want to react on the success
+   *
+   * - Only `await` if run beforehand and you want to react to the success
+   *
+   * @worklet **Do not** use `await` on Worklet or UI runtimes. It will not work properly.
+   *
+   * You can run it synchronously:
+   * ```typescript
+   *  scheduleOnRuntime(workletRuntime, () => {
+   *    RecognizerRef.prewarm({
+   *      // your config to prepare
+   *    });
+   *  });
+   * ```
    */
   prewarm(defaultParams?: SpeechRecognitionConfig): Promise<void>
 
@@ -30,9 +45,9 @@ export interface Recognizer extends HybridObject<{
   startListening(params?: SpeechRecognitionConfig): void
 
   /**
-   * Stops the speech recognition. if not started, does nothing.
+   * Stops the speech recognition. If not started, does nothing.
    *
-   * Not a sync operation for android, delay about 250ms to polish the result.
+   * Not a sync operation for Android, delay about 250ms to polish the result.
    *
    * Use {@linkcode onRecordingStopped} to handle the stop event.
    */
@@ -66,6 +81,11 @@ export interface Recognizer extends HybridObject<{
    */
   getIsActive(): boolean
 
+  /**
+   * Returns the current voice input volume.
+   */
+  getVoiceInputVolume(): VolumeChangeEvent
+
   /**
    * Returns a list of supported locales.
    *
@@ -82,15 +102,13 @@ export interface Recognizer extends HybridObject<{
    */
   onRecordingStopped?: () => void
   /**
-   * Called each time either a new batch has been added or the last batch has been updated.
+   * Fires each time either a new batch has been added or the last batch has been updated.
    */
   onResult?: (resultBatches: string[]) => void
   /**
-   * Called every {@linkcode SpeechRecognitionConfig.autoFinishProgressIntervalMs} or 1000ms
+   * Fires every {@linkcode SpeechRecognitionConfig.autoFinishProgressIntervalMs} or 1000ms
    *
    * Time left in milliseconds until the timer stops.
-   *
-   * @note not implemented for Android yet.
    */
   onAutoFinishProgress?: (timeLeftMs: number) => void
   /**
@@ -102,9 +120,7 @@ export interface Recognizer extends HybridObject<{
    */
   onPermissionDenied?: () => void
   /**
-   * Called with high and arbitrary frequency (many times per second) while audio recording is active.
-   *
-   * @warning overriding it will disable the built-in `useVoiceInputVolume` hook.
+   * Fires with high and arbitrary frequency (many times per second) while audio recording is active.
    */
   onVolumeChange?: (event: VolumeChangeEvent) => void
 }