react-native-davoice-tts 1.0.415 → 1.0.417

package/ios/TTSRNBridge/DavoiceTTS.xcframework/ios-arm64_x86_64-simulator/DavoiceTTS.framework/Headers/DavoiceTTS-Swift.h

@@ -308,36 +308,19 @@ typedef unsigned int swift_uint4  __attribute__((__ext_vector_type__(4)));
 #if defined(__OBJC__)
 
 @class NSString;
-/// Stores the speech library’s audio-routing JSON before STT/TTS initialization.
-/// DaVoice prefers this direct config and falls back to the wakeword library’s config.
 SWIFT_CLASS("_TtC10DavoiceTTS25DaVoiceAudioRoutingConfig")
 @interface DaVoiceAudioRoutingConfig : NSObject
-/// Can be called at any time. When the wake-word framework is in the app,
-/// the JSON is also written into wake word’s store, so both libraries always
-/// run on the same config whichever API the app calls (wake word’s setter
-/// then announces the change). Without wake word, the change is announced
-/// here. Either way RoutingConfigChange applies it once, safely.
 + (BOOL)setAudioRoutingConfigJSONString:(NSString * _Nonnull)json SWIFT_WARN_UNUSED_RESULT;
 + (void)clearAudioRoutingConfig;
 - (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
 @end
 
 @class AVAudioSession;
-/// Echo cancellation for iPhones WITHOUT Apple’s session-level echo-cancelled
-/// input (<code>AVAudioSession.isEchoCancelledInputAvailable</code>, iOS 18.2+ on
-/// supported hardware). On those devices AEC only exists inside an
-/// AVAudioEngine with voice processing on, and it only cancels audio played
-/// through that same engine – so TTS must play through the engine whose mic
-/// input the listeners hear. See pocketTTS/AECSupportIOS.md.
-/// Nothing here runs on devices WITH session-level AEC, or when AEC isn’t
-/// requested: every caller then takes its exact pre-existing path.
 SWIFT_CLASS("_TtC10DavoiceTTS16DaVoiceLegacyAEC")
 @interface DaVoiceLegacyAEC : NSObject
-/// Kill switch for the old-iPhone fallback (default true).
 SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL isEnabled;)
 + (BOOL)isEnabled SWIFT_WARN_UNUSED_RESULT;
 + (void)setIsEnabled:(BOOL)newValue;
-/// True when this device/OS offers session-level AEC (see observeDevice).
 + (BOOL)deviceHasSessionLevelAEC:(AVAudioSession * _Nonnull)session SWIFT_WARN_UNUSED_RESULT;
 - (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
 @end
@@ -350,48 +333,9 @@ SWIFT_CLASS("_TtC10DavoiceTTS10DaVoiceTTS")
 + (void)setUseDavoiceProprietaryPhonemizer:(BOOL)enabled;
 + (BOOL)getUseDavoiceProprietaryPhonemizer SWIFT_WARN_UNUSED_RESULT;
 - (BOOL)isUsingDavoiceProprietaryPhonemizer SWIFT_WARN_UNUSED_RESULT;
-/// Voices available in the loaded .dm (the names changeVoice() accepts, the
-/// first being the default). Empty for v1 models, a .dm without voices, or
-/// after destroy().
 - (NSArray<NSString *> * _Nonnull)getAllVoices SWIFT_WARN_UNUSED_RESULT;
-/// Style variants (“abilities”) of a voice in the loaded .dm, e.g.
-/// getVoiceAbilities(“Rich”) -> [“angry_whisper”, …, “military_sergeant_hard”, …].
-/// Use them with ElevenLabs-style “[free text]” tags in speak() text, before
-/// the words they apply to, until the next tag: “Ok, [drill sergeant] give me
-/// 50! [regular] Thanks.” Unmatched tags use the default voice; tags are never
-/// spoken. Empty for voices without variants, v1 models, or after destroy().
 - (NSArray<NSString *> * _Nonnull)getVoiceAbilities:(NSString * _Nonnull)name SWIFT_WARN_UNUSED_RESULT;
-/// Also look for voices in the folder <code>path</code>: <name>.emd / <name>.npy files,
-/// e.g. made by createVoiceClone(). They are listed by getAllVoices()
-/// after the bundled voices and selected with changeVoice() like them; a
-/// bundled voice wins over an external file with the same name. Call it
-/// again to pick up new files; nil or “” removes the external voices.
-/// <code>completion</code> gets the external voice names found ([] for a v1 model or a
-/// missing folder).
 - (void)setExternalVoicesPath:(NSString * _Nullable)path completion:(void (^ _Nullable)(NSArray<NSString *> * _Nonnull))completion;
-/// Voice cloning: creates a voice from a recording and saves it as a
-/// packed .emd at <code>outputPath</code>.
-/// <ul>
-///   <li>
-///     inputAudioPath: a recording of one speaker (wav, mp3, m4a/aac, caf,
-///     aiff, flac, …). It is prepared for cloning automatically.
-///   </li>
-///   <li>
-///     outputPath: the .emd file to write (”.emd” is added when missing), or a
-///     folder (-> <folder>/<input name>.emd). The file name is the voice name.
-///   </li>
-///   <li>
-///     embedderPath: the language’s voice encoder, embedder_<code>.dm
-///     (e.g. embedder_en.dm); it is resolved in memory only.
-///   </li>
-///   <li>
-///     volume: loudness of the voice relative to the recording – 1.0 keeps it
-///     (the 3-argument form), 1.2 is 20% louder, 0.8 is 20% quieter (a number > 0).
-///   </li>
-/// </ul>
-/// Returns [“path”, “voice”, “warnings”]; when “warnings” is non-empty, ask
-/// the user to record again. Put the file in the folder given to
-/// setExternalVoicesPath() (and call that again) to use it.
 + (NSDictionary<NSString *, id> * _Nullable)createVoiceClone:(NSString * _Nonnull)inputAudioPath outputPath:(NSString * _Nonnull)outputPath embedderPath:(NSString * _Nonnull)embedderPath error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
 + (NSDictionary<NSString *, id> * _Nullable)createVoiceClone:(NSString * _Nonnull)inputAudioPath outputPath:(NSString * _Nonnull)outputPath embedderPath:(NSString * _Nonnull)embedderPath volume:(double)volume error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
 - (void)changeVoice:(NSString * _Nonnull)name completion:(void (^ _Nonnull)(NSInteger))completion;
@@ -401,18 +345,11 @@ SWIFT_CLASS("_TtC10DavoiceTTS10DaVoiceTTS")
 - (void)setUseEuropeanNumberFormat:(BOOL)enabled;
 - (nullable instancetype)initWithModel:(NSURL * _Nonnull)model error:(NSError * _Nullable * _Nullable)error OBJC_DESIGNATED_INITIALIZER;
 - (void)stopSpeaking;
-/// Destroy the TTS instance resources; after this call, the object should not be used.
-/// Effectively returns the instance to “pre-init” state.
 - (void)destroy;
 - (void)speak:(NSString * _Nonnull)txt sid:(int32_t)sid;
 - (void)speak:(NSString * _Nonnull)txt sid:(int32_t)sid speed:(float)speed;
 - (AVAudioPCMBuffer * _Nullable)synthesize_top:(NSString * _Nonnull)_text speakerId:(int32_t)speakerId token:(NSUUID * _Nonnull)token speed_adjuster:(float)speed_adjuster error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
-/// Queue an external WAV file for playback via the same AEC path/queue used by speak().
-/// If called repeatedly, items are queued in order. <code>onLastUtteranceFinished</code> fires
-/// after physical playback drains; audio-session restoration may remain debounced.
 - (void)playWav:(NSURL * _Nonnull)url markAsLastUtterance:(BOOL)markAsLastUtterance;
-/// Queue an in-memory PCM buffer (any format) for playback via the same AEC path/queue.
-/// We resample/normalize, write a temp WAV, then enqueue it (so it uses the engine hook).
 - (void)playBuffer:(AVAudioPCMBuffer * _Nonnull)buffer markAsLastUtterance:(BOOL)markAsLastUtterance;
 - (nonnull instancetype)init SWIFT_UNAVAILABLE;
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
@@ -453,33 +390,17 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, copy) NSArray<NSStri
 - (void)unPauseMicrophoneAndWait:(NSNumber * _Nonnull)timeoutMs completion:(void (^ _Nonnull)(BOOL, NSString * _Nullable))completion;
 - (void)pauseMicrophone;
 - (void)unPauseMicrophone;
-/// Enable/disable iOS voice-processing (AEC + ducking).
-/// If STT is already active, we rebuild the session/graph so it takes effect.
 - (void)setAECEnabled:(BOOL)enabled;
 - (BOOL)isAECEnabled SWIFT_WARN_UNUSED_RESULT;
 - (void)isSpeechAvailable:(void (^ _Nonnull)(BOOL))completion;
 - (BOOL)isRecognizing SWIFT_WARN_UNUSED_RESULT;
 - (void)startSpeechWithLocaleStr:(NSString * _Nullable)localeStr;
-/// Starts STT with one speaker. <code>onboardingJsonPath</code> may be a path or the JSON
-/// itself. The speaker is added to the current set (same id or same voiceprint
-/// replaces the older entry) under the id “default”.
 - (void)startSpeechWithLocaleStr:(NSString * _Nullable)localeStr onboardingJsonPath:(NSString * _Nonnull)onboardingJsonPath;
 - (void)startSpeechWithLocaleStr:(NSString * _Nullable)localeStr onboardingJsonPath:(NSString * _Nonnull)onboardingJsonPath speakerId:(NSString * _Nonnull)speakerId;
-/// Starts STT with an array of speakers, replacing the current set.
-/// Each item: [“id”: speakerId, “json”: JSON string or path to the JSON file].
 - (void)startSpeechWithLocaleStr:(NSString * _Nullable)localeStr speakers:(NSArray<NSDictionary<NSString *, NSString *> *> * _Nonnull)speakers;
-/// Adds one speaker (JSON string or path). Same id or same voiceprint replaces
-/// the older entry. Applies immediately when STT is running, otherwise at the
-/// next start. Throws if the JSON can’t be read or its audio-feature settings
-/// differ from the running engine’s.
 - (BOOL)addSpeakerWithId:(NSString * _Nonnull)id jsonOrPath:(NSString * _Nonnull)jsonOrPath error:(NSError * _Nullable * _Nullable)error;
-/// Replaces the whole speaker set. Items: [“id”: …, “json”: JSON string or path].
-/// An empty array turns speaker verification off.
 - (BOOL)setSpeakers:(NSArray<NSDictionary<NSString *, NSString *> *> * _Nonnull)speakers error:(NSError * _Nullable * _Nullable)error;
-/// Removes a speaker by id. Removing the last one turns the gate off (all audio
-/// passes). Returns false if the id wasn’t enrolled.
 - (BOOL)removeSpeakerWithId:(NSString * _Nonnull)id;
-/// Ids of the enrolled speakers, in insertion order.
 - (NSArray<NSString *> * _Nonnull)getSpeakerIds SWIFT_WARN_UNUSED_RESULT;
 - (void)stopSpeech:(void (^ _Nullable)(BOOL))completion;
 - (void)cancelSpeech:(void (^ _Nullable)(BOOL))completion;
@@ -514,9 +435,6 @@ SWIFT_CLASS("_TtC10DavoiceTTS15SwiftSoundQueue")
 - (nonnull instancetype)init SWIFT_UNAVAILABLE;
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 - (void)audioPlayerDidFinishPlaying:(AVAudioPlayer * _Nonnull)p successfully:(BOOL)ok;
-/// A decode error ends playback WITHOUT audioPlayerDidFinishPlaying, which
-/// used to leave the queue waiting on this player forever. Treat it as the
-/// end of the item.
 - (void)audioPlayerDecodeErrorDidOccur:(AVAudioPlayer * _Nonnull)p error:(NSError * _Nullable)error;
 @end
 
@@ -838,36 +756,19 @@ typedef unsigned int swift_uint4  __attribute__((__ext_vector_type__(4)));
 #if defined(__OBJC__)
 
 @class NSString;
-/// Stores the speech library’s audio-routing JSON before STT/TTS initialization.
-/// DaVoice prefers this direct config and falls back to the wakeword library’s config.
 SWIFT_CLASS("_TtC10DavoiceTTS25DaVoiceAudioRoutingConfig")
 @interface DaVoiceAudioRoutingConfig : NSObject
-/// Can be called at any time. When the wake-word framework is in the app,
-/// the JSON is also written into wake word’s store, so both libraries always
-/// run on the same config whichever API the app calls (wake word’s setter
-/// then announces the change). Without wake word, the change is announced
-/// here. Either way RoutingConfigChange applies it once, safely.
 + (BOOL)setAudioRoutingConfigJSONString:(NSString * _Nonnull)json SWIFT_WARN_UNUSED_RESULT;
 + (void)clearAudioRoutingConfig;
 - (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
 @end
 
 @class AVAudioSession;
-/// Echo cancellation for iPhones WITHOUT Apple’s session-level echo-cancelled
-/// input (<code>AVAudioSession.isEchoCancelledInputAvailable</code>, iOS 18.2+ on
-/// supported hardware). On those devices AEC only exists inside an
-/// AVAudioEngine with voice processing on, and it only cancels audio played
-/// through that same engine – so TTS must play through the engine whose mic
-/// input the listeners hear. See pocketTTS/AECSupportIOS.md.
-/// Nothing here runs on devices WITH session-level AEC, or when AEC isn’t
-/// requested: every caller then takes its exact pre-existing path.
 SWIFT_CLASS("_TtC10DavoiceTTS16DaVoiceLegacyAEC")
 @interface DaVoiceLegacyAEC : NSObject
-/// Kill switch for the old-iPhone fallback (default true).
 SWIFT_CLASS_PROPERTY(@property (nonatomic, class) BOOL isEnabled;)
 + (BOOL)isEnabled SWIFT_WARN_UNUSED_RESULT;
 + (void)setIsEnabled:(BOOL)newValue;
-/// True when this device/OS offers session-level AEC (see observeDevice).
 + (BOOL)deviceHasSessionLevelAEC:(AVAudioSession * _Nonnull)session SWIFT_WARN_UNUSED_RESULT;
 - (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
 @end
@@ -880,48 +781,9 @@ SWIFT_CLASS("_TtC10DavoiceTTS10DaVoiceTTS")
 + (void)setUseDavoiceProprietaryPhonemizer:(BOOL)enabled;
 + (BOOL)getUseDavoiceProprietaryPhonemizer SWIFT_WARN_UNUSED_RESULT;
 - (BOOL)isUsingDavoiceProprietaryPhonemizer SWIFT_WARN_UNUSED_RESULT;
-/// Voices available in the loaded .dm (the names changeVoice() accepts, the
-/// first being the default). Empty for v1 models, a .dm without voices, or
-/// after destroy().
 - (NSArray<NSString *> * _Nonnull)getAllVoices SWIFT_WARN_UNUSED_RESULT;
-/// Style variants (“abilities”) of a voice in the loaded .dm, e.g.
-/// getVoiceAbilities(“Rich”) -> [“angry_whisper”, …, “military_sergeant_hard”, …].
-/// Use them with ElevenLabs-style “[free text]” tags in speak() text, before
-/// the words they apply to, until the next tag: “Ok, [drill sergeant] give me
-/// 50! [regular] Thanks.” Unmatched tags use the default voice; tags are never
-/// spoken. Empty for voices without variants, v1 models, or after destroy().
 - (NSArray<NSString *> * _Nonnull)getVoiceAbilities:(NSString * _Nonnull)name SWIFT_WARN_UNUSED_RESULT;
-/// Also look for voices in the folder <code>path</code>: <name>.emd / <name>.npy files,
-/// e.g. made by createVoiceClone(). They are listed by getAllVoices()
-/// after the bundled voices and selected with changeVoice() like them; a
-/// bundled voice wins over an external file with the same name. Call it
-/// again to pick up new files; nil or “” removes the external voices.
-/// <code>completion</code> gets the external voice names found ([] for a v1 model or a
-/// missing folder).
 - (void)setExternalVoicesPath:(NSString * _Nullable)path completion:(void (^ _Nullable)(NSArray<NSString *> * _Nonnull))completion;
-/// Voice cloning: creates a voice from a recording and saves it as a
-/// packed .emd at <code>outputPath</code>.
-/// <ul>
-///   <li>
-///     inputAudioPath: a recording of one speaker (wav, mp3, m4a/aac, caf,
-///     aiff, flac, …). It is prepared for cloning automatically.
-///   </li>
-///   <li>
-///     outputPath: the .emd file to write (”.emd” is added when missing), or a
-///     folder (-> <folder>/<input name>.emd). The file name is the voice name.
-///   </li>
-///   <li>
-///     embedderPath: the language’s voice encoder, embedder_<code>.dm
-///     (e.g. embedder_en.dm); it is resolved in memory only.
-///   </li>
-///   <li>
-///     volume: loudness of the voice relative to the recording – 1.0 keeps it
-///     (the 3-argument form), 1.2 is 20% louder, 0.8 is 20% quieter (a number > 0).
-///   </li>
-/// </ul>
-/// Returns [“path”, “voice”, “warnings”]; when “warnings” is non-empty, ask
-/// the user to record again. Put the file in the folder given to
-/// setExternalVoicesPath() (and call that again) to use it.
 + (NSDictionary<NSString *, id> * _Nullable)createVoiceClone:(NSString * _Nonnull)inputAudioPath outputPath:(NSString * _Nonnull)outputPath embedderPath:(NSString * _Nonnull)embedderPath error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
 + (NSDictionary<NSString *, id> * _Nullable)createVoiceClone:(NSString * _Nonnull)inputAudioPath outputPath:(NSString * _Nonnull)outputPath embedderPath:(NSString * _Nonnull)embedderPath volume:(double)volume error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
 - (void)changeVoice:(NSString * _Nonnull)name completion:(void (^ _Nonnull)(NSInteger))completion;
@@ -931,18 +793,11 @@ SWIFT_CLASS("_TtC10DavoiceTTS10DaVoiceTTS")
 - (void)setUseEuropeanNumberFormat:(BOOL)enabled;
 - (nullable instancetype)initWithModel:(NSURL * _Nonnull)model error:(NSError * _Nullable * _Nullable)error OBJC_DESIGNATED_INITIALIZER;
 - (void)stopSpeaking;
-/// Destroy the TTS instance resources; after this call, the object should not be used.
-/// Effectively returns the instance to “pre-init” state.
 - (void)destroy;
 - (void)speak:(NSString * _Nonnull)txt sid:(int32_t)sid;
 - (void)speak:(NSString * _Nonnull)txt sid:(int32_t)sid speed:(float)speed;
 - (AVAudioPCMBuffer * _Nullable)synthesize_top:(NSString * _Nonnull)_text speakerId:(int32_t)speakerId token:(NSUUID * _Nonnull)token speed_adjuster:(float)speed_adjuster error:(NSError * _Nullable * _Nullable)error SWIFT_WARN_UNUSED_RESULT;
-/// Queue an external WAV file for playback via the same AEC path/queue used by speak().
-/// If called repeatedly, items are queued in order. <code>onLastUtteranceFinished</code> fires
-/// after physical playback drains; audio-session restoration may remain debounced.
 - (void)playWav:(NSURL * _Nonnull)url markAsLastUtterance:(BOOL)markAsLastUtterance;
-/// Queue an in-memory PCM buffer (any format) for playback via the same AEC path/queue.
-/// We resample/normalize, write a temp WAV, then enqueue it (so it uses the engine hook).
 - (void)playBuffer:(AVAudioPCMBuffer * _Nonnull)buffer markAsLastUtterance:(BOOL)markAsLastUtterance;
 - (nonnull instancetype)init SWIFT_UNAVAILABLE;
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
@@ -983,33 +838,17 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, copy) NSArray<NSStri
 - (void)unPauseMicrophoneAndWait:(NSNumber * _Nonnull)timeoutMs completion:(void (^ _Nonnull)(BOOL, NSString * _Nullable))completion;
 - (void)pauseMicrophone;
 - (void)unPauseMicrophone;
-/// Enable/disable iOS voice-processing (AEC + ducking).
-/// If STT is already active, we rebuild the session/graph so it takes effect.
 - (void)setAECEnabled:(BOOL)enabled;
 - (BOOL)isAECEnabled SWIFT_WARN_UNUSED_RESULT;
 - (void)isSpeechAvailable:(void (^ _Nonnull)(BOOL))completion;
 - (BOOL)isRecognizing SWIFT_WARN_UNUSED_RESULT;
 - (void)startSpeechWithLocaleStr:(NSString * _Nullable)localeStr;
-/// Starts STT with one speaker. <code>onboardingJsonPath</code> may be a path or the JSON
-/// itself. The speaker is added to the current set (same id or same voiceprint
-/// replaces the older entry) under the id “default”.
 - (void)startSpeechWithLocaleStr:(NSString * _Nullable)localeStr onboardingJsonPath:(NSString * _Nonnull)onboardingJsonPath;
 - (void)startSpeechWithLocaleStr:(NSString * _Nullable)localeStr onboardingJsonPath:(NSString * _Nonnull)onboardingJsonPath speakerId:(NSString * _Nonnull)speakerId;
-/// Starts STT with an array of speakers, replacing the current set.
-/// Each item: [“id”: speakerId, “json”: JSON string or path to the JSON file].
 - (void)startSpeechWithLocaleStr:(NSString * _Nullable)localeStr speakers:(NSArray<NSDictionary<NSString *, NSString *> *> * _Nonnull)speakers;
-/// Adds one speaker (JSON string or path). Same id or same voiceprint replaces
-/// the older entry. Applies immediately when STT is running, otherwise at the
-/// next start. Throws if the JSON can’t be read or its audio-feature settings
-/// differ from the running engine’s.
 - (BOOL)addSpeakerWithId:(NSString * _Nonnull)id jsonOrPath:(NSString * _Nonnull)jsonOrPath error:(NSError * _Nullable * _Nullable)error;
-/// Replaces the whole speaker set. Items: [“id”: …, “json”: JSON string or path].
-/// An empty array turns speaker verification off.
 - (BOOL)setSpeakers:(NSArray<NSDictionary<NSString *, NSString *> *> * _Nonnull)speakers error:(NSError * _Nullable * _Nullable)error;
-/// Removes a speaker by id. Removing the last one turns the gate off (all audio
-/// passes). Returns false if the id wasn’t enrolled.
 - (BOOL)removeSpeakerWithId:(NSString * _Nonnull)id;
-/// Ids of the enrolled speakers, in insertion order.
 - (NSArray<NSString *> * _Nonnull)getSpeakerIds SWIFT_WARN_UNUSED_RESULT;
 - (void)stopSpeech:(void (^ _Nullable)(BOOL))completion;
 - (void)cancelSpeech:(void (^ _Nullable)(BOOL))completion;
@@ -1044,9 +883,6 @@ SWIFT_CLASS("_TtC10DavoiceTTS15SwiftSoundQueue")
 - (nonnull instancetype)init SWIFT_UNAVAILABLE;
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 - (void)audioPlayerDidFinishPlaying:(AVAudioPlayer * _Nonnull)p successfully:(BOOL)ok;
-/// A decode error ends playback WITHOUT audioPlayerDidFinishPlaying, which
-/// used to leave the queue waiting on this player forever. Treat it as the
-/// end of the item.
 - (void)audioPlayerDecodeErrorDidOccur:(AVAudioPlayer * _Nonnull)p error:(NSError * _Nullable)error;
 @end