@iternio/react-native-auto-play 0.5.3 → 0.5.5

package/nitrogen/generated/ios/swift/HybridVoiceSpec_cxx.swift

@@ -156,7 +156,7 @@ open class HybridVoiceSpec_cxx {
   }
   
   @inline(__always)
-  public final func startVoiceInput(silenceThresholdMs: bridge.std__optional_double_, maxDurationMs: bridge.std__optional_double_, listeningText: bridge.std__optional_std__string_, preferSpeechToText: bridge.std__optional_bool_, onChunk: bridge.std__optional_std__function_void_const_VoiceInputChunk_____chunk______, language: bridge.std__optional_std__string_) -> bridge.Result_std__shared_ptr_Promise_VoiceInputResult___ {
+  public final func startVoiceInput(silenceThresholdMs: bridge.std__optional_double_, maxDurationMs: bridge.std__optional_double_, listeningText: bridge.std__optional_std__string_, listeningImage: bridge.std__optional_std__variant_GlyphImage__AssetImage__RemoteImage__, listeningImageRepeats: bridge.std__optional_bool_, preferSpeechToText: bridge.std__optional_bool_, onChunk: bridge.std__optional_std__function_void_const_VoiceInputChunk_____chunk______, language: bridge.std__optional_std__string_, startSoundUri: bridge.std__optional_std__string_, endSoundUri: bridge.std__optional_std__string_) -> bridge.Result_std__shared_ptr_Promise_VoiceInputResult___ {
     do {
       let __result = try self.__implementation.startVoiceInput(silenceThresholdMs: { () -> Double? in
         if bridge.has_value_std__optional_double_(silenceThresholdMs) {
@@ -179,6 +179,35 @@ open class HybridVoiceSpec_cxx {
         } else {
           return nil
         }
+      }(), listeningImage: { () -> Variant_GlyphImage_AssetImage_RemoteImage? in
+        if bridge.has_value_std__optional_std__variant_GlyphImage__AssetImage__RemoteImage__(listeningImage) {
+          let __unwrapped = bridge.get_std__optional_std__variant_GlyphImage__AssetImage__RemoteImage__(listeningImage)
+          return { () -> Variant_GlyphImage_AssetImage_RemoteImage in
+            let __variant = bridge.std__variant_GlyphImage__AssetImage__RemoteImage_(__unwrapped)
+            switch __variant.index() {
+              case 0:
+                let __actual = __variant.get_0()
+                return .first(__actual)
+              case 1:
+                let __actual = __variant.get_1()
+                return .second(__actual)
+              case 2:
+                let __actual = __variant.get_2()
+                return .third(__actual)
+              default:
+                fatalError("Variant can never have index \(__variant.index())!")
+            }
+          }()
+        } else {
+          return nil
+        }
+      }(), listeningImageRepeats: { () -> Bool? in
+        if bridge.has_value_std__optional_bool_(listeningImageRepeats) {
+          let __unwrapped = bridge.get_std__optional_bool_(listeningImageRepeats)
+          return __unwrapped
+        } else {
+          return nil
+        }
       }(), preferSpeechToText: { () -> Bool? in
         if bridge.has_value_std__optional_bool_(preferSpeechToText) {
           let __unwrapped = bridge.get_std__optional_bool_(preferSpeechToText)
@@ -205,6 +234,20 @@ open class HybridVoiceSpec_cxx {
         } else {
           return nil
         }
+      }(), startSoundUri: { () -> String? in
+        if bridge.has_value_std__optional_std__string_(startSoundUri) {
+          let __unwrapped = bridge.get_std__optional_std__string_(startSoundUri)
+          return String(__unwrapped)
+        } else {
+          return nil
+        }
+      }(), endSoundUri: { () -> String? in
+        if bridge.has_value_std__optional_std__string_(endSoundUri) {
+          let __unwrapped = bridge.get_std__optional_std__string_(endSoundUri)
+          return String(__unwrapped)
+        } else {
+          return nil
+        }
       }())
       let __resultCpp = { () -> bridge.std__shared_ptr_Promise_VoiceInputResult__ in
         let __promise = bridge.create_std__shared_ptr_Promise_VoiceInputResult__()

package/nitrogen/generated/shared/c++/HybridVoiceSpec.hpp

@@ -15,6 +15,12 @@
 
 // Forward declaration of `VoiceInputResult` to properly resolve imports.
 namespace margelo::nitro::swe::iternio::reactnativeautoplay { struct VoiceInputResult; }
+// Forward declaration of `GlyphImage` to properly resolve imports.
+namespace margelo::nitro::swe::iternio::reactnativeautoplay { struct GlyphImage; }
+// Forward declaration of `AssetImage` to properly resolve imports.
+namespace margelo::nitro::swe::iternio::reactnativeautoplay { struct AssetImage; }
+// Forward declaration of `RemoteImage` to properly resolve imports.
+namespace margelo::nitro::swe::iternio::reactnativeautoplay { struct RemoteImage; }
 // Forward declaration of `VoiceInputChunk` to properly resolve imports.
 namespace margelo::nitro::swe::iternio::reactnativeautoplay { struct VoiceInputChunk; }
 
@@ -22,6 +28,10 @@ namespace margelo::nitro::swe::iternio::reactnativeautoplay { struct VoiceInputC
 #include "VoiceInputResult.hpp"
 #include <optional>
 #include <string>
+#include "GlyphImage.hpp"
+#include "AssetImage.hpp"
+#include "RemoteImage.hpp"
+#include <variant>
 #include "VoiceInputChunk.hpp"
 #include <functional>
 
@@ -58,7 +68,7 @@ namespace margelo::nitro::swe::iternio::reactnativeautoplay {
       // Methods
       virtual bool hasVoiceInputPermission() = 0;
       virtual std::shared_ptr<Promise<bool>> requestVoiceInputPermission() = 0;
-      virtual std::shared_ptr<Promise<VoiceInputResult>> startVoiceInput(std::optional<double> silenceThresholdMs, std::optional<double> maxDurationMs, const std::optional<std::string>& listeningText, std::optional<bool> preferSpeechToText, const std::optional<std::function<void(const VoiceInputChunk& /* chunk */)>>& onChunk, const std::optional<std::string>& language) = 0;
+      virtual std::shared_ptr<Promise<VoiceInputResult>> startVoiceInput(std::optional<double> silenceThresholdMs, std::optional<double> maxDurationMs, const std::optional<std::string>& listeningText, const std::optional<std::variant<GlyphImage, AssetImage, RemoteImage>>& listeningImage, std::optional<bool> listeningImageRepeats, std::optional<bool> preferSpeechToText, const std::optional<std::function<void(const VoiceInputChunk& /* chunk */)>>& onChunk, const std::optional<std::string>& language, const std::optional<std::string>& startSoundUri, const std::optional<std::string>& endSoundUri) = 0;
       virtual void stopVoiceInput() = 0;
 
     protected:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iternio/react-native-auto-play",
-  "version": "0.5.3",
+  "version": "0.5.5",
   "description": "Android Auto and Apple CarPlay for react-native",
   "main": "lib/index",
   "module": "lib/index",

package/src/hybrid/HybridVoice.ts

@@ -1,6 +1,8 @@
+import { Image } from 'react-native';
 import { NitroModules } from 'react-native-nitro-modules';
 import type { Voice } from '../specs/Voice.nitro';
 import type { VoiceInputOptions, VoiceInputResult } from '../types/Voice';
+import { NitroImageUtil } from '../utils/NitroImage';
 
 const _native = NitroModules.createHybridObject<Voice>('Voice');
 
@@ -17,17 +19,30 @@ const startVoiceInput: StartVoiceInput = async (options?: VoiceInputOptions) =>
     silenceThresholdMs,
     maxDurationMs,
     listeningText,
+    listeningImage,
     preferSpeechToText,
     language,
+    startSound,
+    endSound,
   } = options ?? {};
 
+  const listeningImageRepeats =
+    listeningImage?.type === 'asset' ? listeningImage.repeats : undefined;
+
+  const startSoundUri = startSound != null ? Image.resolveAssetSource(startSound).uri : undefined;
+  const endSoundUri = endSound != null ? Image.resolveAssetSource(endSound).uri : undefined;
+
   return await _native.startVoiceInput(
     silenceThresholdMs,
     maxDurationMs,
     listeningText,
+    NitroImageUtil.convert(listeningImage),
+    listeningImageRepeats,
     preferSpeechToText,
     onChunk,
-    language
+    language,
+    startSoundUri,
+    endSoundUri
   );
 };
 

package/src/specs/Voice.nitro.ts

@@ -1,5 +1,6 @@
 import type { HybridObject } from 'react-native-nitro-modules';
 import type { VoiceInputChunk, VoiceInputResult } from '../types/Voice';
+import type { NitroImage } from '../utils/NitroImage';
 
 export interface Voice extends HybridObject<{ android: 'kotlin'; ios: 'swift' }> {
   hasVoiceInputPermission(): boolean;
@@ -8,9 +9,13 @@ export interface Voice extends HybridObject<{ android: 'kotlin'; ios: 'swift' }>
     silenceThresholdMs?: number,
     maxDurationMs?: number,
     listeningText?: string,
+    listeningImage?: NitroImage,
+    listeningImageRepeats?: boolean,
     preferSpeechToText?: boolean,
     onChunk?: (chunk: VoiceInputChunk) => void,
-    language?: string
+    language?: string,
+    startSoundUri?: string,
+    endSoundUri?: string
   ): Promise<VoiceInputResult>;
   stopVoiceInput(): void;
 }

package/src/templates/Template.ts

@@ -8,7 +8,7 @@ export type ActionButton<T> = ActionButtonAndroid<T> | ActionButtonIos<T>;
 
 export type HeaderActionsIos<T> = {
   /**
-   * @platform iOS - the back button can not be hidden or disabled, if you don't define it iOS will provide a default back button popping the template
+   * @namespace iOS - the back button can not be hidden or disabled, if you don't define it iOS will provide a default back button popping the template
    */
   backButton?: BackButton<T>;
   leadingNavigationBarButtons?: [ActionButtonIos<T>, ActionButtonIos<T>] | [ActionButtonIos<T>];

package/src/types/Image.ts

@@ -79,3 +79,22 @@ export type AutoImage =
       timeoutMs?: number;
       type: 'remote';
     };
+
+/**
+ * Image for the CarPlay voice control overlay. Animated GIF, APNG, and WebP all animate.
+ * `color` is ignored for animated assets — frames cannot be tinted individually. Static
+ * assets and glyphs are resized/capped to fit within 150×150pt (`fontScale` controls a
+ * glyph's relative size). CarPlay enforces a 0.3s–5s animation cycle duration: shorter
+ * source animations are stretched to 0.3s by the system, longer ones are capped to 5s.
+ * @namespace ios
+ */
+export type VoiceInputImage =
+  | AutoGlyph
+  | {
+      type: 'asset';
+      image: ImageSourcePropType;
+      /** Tints the image. Ignored for animated assets — frames cannot be tinted individually. */
+      color?: ThemedColor | string;
+      /** Whether the animation loops. Defaults to `true` for animated images, `false` for static. */
+      repeats?: boolean;
+    };

package/src/types/Voice.ts

@@ -1,3 +1,5 @@
+import type { VoiceInputImage } from './Image';
+
 export interface VoiceInputChunk {
   partial?: string;
   audio?: ArrayBuffer;
@@ -12,7 +14,15 @@ export interface VoiceInputOptions {
   silenceThresholdMs?: number;
   maxDurationMs?: number;
   listeningText?: string;
+  /** Image displayed in the CarPlay voice control overlay. See {@link VoiceInputImage}.
+   * @namespace ios
+   */
+  listeningImage?: VoiceInputImage;
   preferSpeechToText?: boolean;
   onChunk?: (chunk: VoiceInputChunk) => void;
   language?: string;
+  /** Sound played just before recording starts. Pass a Metro asset: `require('./beep_start.wav')`. */
+  startSound?: number;
+  /** Sound played just after recording stops. Pass a Metro asset: `require('./beep_end.wav')`. */
+  endSound?: number;
 }

package/src/utils/ErrorUtil.ts

@@ -1,4 +1,4 @@
-const isTemplateNotFoundError = (error: unknown): error is Error => {
+const isError = (error: unknown): error is { message: string } => {
   if (error == null) {
     return false;
   }
@@ -19,7 +19,23 @@ const isTemplateNotFoundError = (error: unknown): error is Error => {
     return false;
   }
 
-  return error.message.startsWith('templateNotFound');
+  return true;
+};
+
+const isTemplateNotFoundError = (error: unknown): error is Error => {
+  if (isError(error)) {
+    return error.message.startsWith('templateNotFound');
+  }
+
+  return false;
+};
+
+const isVoiceInputCanceledError = (error: unknown): error is Error => {
+  if (isError(error)) {
+    return error.message.startsWith('voiceInputCancelled');
+  }
+
+  return false;
 };
 
-export const ErrorUtil = { isTemplateNotFoundError };
+export const ErrorUtil = { isTemplateNotFoundError, isVoiceInputCanceledError };