/**
 * Text-to-Speech (TTS) Type Definitions for NeuroLink
 *
 * This module defines types for TTS audio generation and output.
 *
 * @module types/ttsTypes
 */
/**
 * Supported audio formats for TTS output, STT input, and Realtime PCM streams.
 *
 * `pcm16` is included for the OpenAI Realtime PCM16 output stream — the chunk
 * is raw PCM, not a RIFF/WAV-headered file. Consumers must not pass `pcm16`
 * bytes to a WAV duration parser.
 */
export type TTSAudioFormat = "mp3" | "wav" | "ogg" | "opus" | "m4a" | "flac" | "webm" | "mp4" | "mpeg" | "mpga" | "pcm16";
/**
 * TTS quality settings
 */
export type TTSQuality = "standard" | "hd";
/**
 * Known TTS provider identifiers shipped with NeuroLink.
 *
 * The `(string & {})` intersection keeps the union open for custom
 * provider names registered via `TTSProcessor.registerHandler()` while
 * still surfacing the built-in choices in editor autocomplete.
 */
export type TTSProviderName = "google-ai" | "vertex" | "openai-tts" | "elevenlabs" | "elevenlabs-tts" | "azure-tts" | "fish-audio" | "cartesia" | (string & {});
/**
 * TTS configuration options
 */
export type TTSOptions = {
    /** Enable TTS output */
    enabled?: boolean;
    /**
     * Use the AI-generated response for TTS instead of the input text
     *
     * When false or undefined (default): TTS will synthesize the input text/prompt directly without calling AI generation
     * When true: TTS will synthesize the AI-generated response after generation completes
     *
     * @default false
     *
     * @example Using input text directly (default)
     * ```typescript
     * const result = await neurolink.generate({
     *   input: { text: "Hello world" },
     *   provider: "google-ai",
     *   tts: { enabled: true }  // or useAiResponse: false
     * });
     * // TTS synthesizes "Hello world" directly, no AI generation
     * ```
     *
     * @example Using AI response
     * ```typescript
     * const result = await neurolink.generate({
     *   input: { text: "Tell me a joke" },
     *   provider: "google-ai",
     *   tts: { enabled: true, useAiResponse: true }
     * });
     * // AI generates the joke, then TTS synthesizes the AI's response
     * ```
     */
    useAiResponse?: boolean;
    /** Voice identifier (e.g., "en-US-Neural2-C") */
    voice?: string;
    /** Audio format (default: mp3) */
    format?: TTSAudioFormat;
    /** Speaking rate 0.25-4.0 (default: 1.0) */
    speed?: number;
    /** Voice pitch adjustment -20.0 to 20.0 semitones (default: 0.0) */
    pitch?: number;
    /** Volume gain in dB -96.0 to 16.0 (default: 0.0) */
    volumeGainDb?: number;
    /** Audio quality (default: standard) */
    quality?: TTSQuality;
    /** Output file path (optional) */
    output?: string;
    /** Auto-play audio after generation (default: false) */
    play?: boolean;
    /** Override TTS provider (e.g., "elevenlabs", "openai-tts", "azure-tts") */
    provider?: TTSProviderName;
};
/**
 * TTS audio result returned from generation
 */
export type TTSResult = {
    /** Audio data as Buffer */
    buffer: Buffer;
    /** Audio format */
    format: TTSAudioFormat;
    /** Audio file size in bytes */
    size: number;
    /** Duration in seconds (if available) */
    duration?: number;
    /** Voice used for generation */
    voice?: string;
    /** Sample rate in Hz */
    sampleRate?: number;
    /** Performance and request metadata */
    metadata?: {
        /** Request latency in milliseconds */
        latency: number;
        /** Provider name */
        provider?: string;
        /** Additional provider-specific metadata */
        [key: string]: unknown;
    };
};
/**
 * Result of saving audio to file
 */
export type AudioSaveResult = {
    /** Whether the save was successful */
    success: boolean;
    /** Full path to the saved file */
    path: string;
    /** File size in bytes */
    size: number;
    /** Error message if failed */
    error?: string;
};
/** Allowed TTS voice types */
export type TTSVoiceType = "standard" | "wavenet" | "neural" | "chirp" | "unknown";
/** Allowed genders for TTS voices */
export type TTSGender = "male" | "female" | "neutral";
/** @deprecated Use `TTSAudioFormat` instead. */
export type AudioFormat = TTSAudioFormat;
/** @deprecated Use `TTSVoiceType` instead. */
export type VoiceType = TTSVoiceType;
/** @deprecated Use `TTSGender` instead. */
export type Gender = TTSGender;
/**
 * TTS voice information
 */
export type TTSVoice = {
    /** Voice identifier */
    id: string;
    /** Display name */
    name: string;
    /** Primary language code (e.g., "en-US") */
    languageCode: string;
    /** All supported language codes */
    languageCodes: string[];
    /** TTSGender */
    gender: TTSGender;
    /** Voice type */
    type?: TTSVoiceType;
    /** Voice description (optional) */
    description?: string;
    /** Natural sample rate in Hz (optional) */
    naturalSampleRateHertz?: number;
};
/** Valid audio formats as an array for runtime validation */
export declare const VALID_AUDIO_FORMATS: readonly TTSAudioFormat[];
/** Valid TTS quality levels as an array for runtime validation */
export declare const VALID_TTS_QUALITIES: readonly TTSQuality[];
/** Valid Google TTS audio formats */
export type GoogleAudioEncoding = "MP3" | "LINEAR16" | "OGG_OPUS";
/**
 * Type guard to check if an object is a TTSResult
 */
export declare function isTTSResult(value: unknown): value is TTSResult;
/**
 * Type guard to check if TTSOptions are valid
 */
export declare function isValidTTSOptions(options: unknown): options is TTSOptions;
/**
 * TTS audio chunk for streaming Text-to-Speech output
 *
 * Represents a chunk of audio data generated during streaming TTS.
 * Used in StreamChunk type to deliver audio alongside text content.
 */
export type TTSChunk = {
    /** Audio data chunk as Buffer */
    data: Buffer;
    /** Audio format of this chunk */
    format: TTSAudioFormat;
    /** Chunk sequence number (0-indexed) */
    index: number;
    /** Whether this is the final audio chunk */
    isFinal: boolean;
    /** Cumulative audio size in bytes so far */
    cumulativeSize?: number;
    /** Estimated total duration in seconds (if available) */
    estimatedDuration?: number;
    /** Voice used for generation */
    voice?: string;
    /** Sample rate in Hz */
    sampleRate?: number;
};
/** Message envelope received from the Cartesia TTS WebSocket. */
export type CartesiaMessage = {
    data?: string;
    done?: boolean;
    error?: string;
};
