// Declaration companion generated from use-generate-audio.tsrx. import type { AudioGenerationResult, StreamChunk } from '@tanstack/ai'; import type { AIDevtoolsDisplayOptions, AudioGenerateInput, ConnectConnectionAdapter, GenerationClientState, GenerationFetcher, InferGenerationOutputFromReturn } from '@tanstack/ai-client'; /** * Options for the useGenerateAudio hook. * * @template TOutput - The output type after optional transform (defaults to AudioGenerationResult) */ export interface UseGenerateAudioOptions { /** Connect-based adapter for streaming transport (SSE, HTTP stream, custom) */ connection?: ConnectConnectionAdapter; /** Direct async function for audio generation */ fetcher?: GenerationFetcher; /** Unique identifier for this generation instance */ id?: string; /** Additional body parameters to send with connect-based adapter requests */ body?: Record; /** Display options for TanStack AI Devtools. */ devtools?: AIDevtoolsDisplayOptions; /** * Callback when audio is generated. Can optionally return a transformed value. * * - Return a non-null value to transform and store it as the result * - Return `null` to keep the previous result unchanged * - Return nothing (`void`) to store the raw result as-is */ onResult?: (result: AudioGenerationResult) => TOutput | null | void; /** Callback when an error occurs */ onError?: (error: Error) => void; /** Callback when progress is reported (0-100) */ onProgress?: (progress: number, message?: string) => void; /** Callback for each stream chunk (connect-based adapter mode only) */ onChunk?: (chunk: StreamChunk) => void; } /** * Return type for the useGenerateAudio hook. * * @template TOutput - The output type (after optional transform) */ export interface UseGenerateAudioReturn { /** Trigger audio generation */ generate: (input: AudioGenerateInput) => Promise; /** The generation result containing audio, or null */ result: TOutput | null; /** Whether generation is in progress */ isLoading: boolean; /** Current error, if any */ error: Error | undefined; /** Current state of the generation */ status: GenerationClientState; /** Abort the current generation */ stop: () => void; /** Clear result, error, and return to idle */ reset: () => void; } /** * Octane hook for generating audio (music, sound effects) using AI models. * * Supports two transport modes: * - **ConnectConnectionAdapter** — Streaming transport (SSE, HTTP stream, custom) * - **Fetcher** — Direct async function call * * @example * ```tsx * import { useGenerateAudio } from '@octanejs/tanstack-ai' * import { fetchServerSentEvents } from '@tanstack/ai-client' * * function AudioGenerator() { * const { generate, result, isLoading, error, reset } = useGenerateAudio({ * connection: fetchServerSentEvents('/api/generate/audio'), * }) * * return ( *
* * {isLoading &&

Generating...

} * {error &&

Error: {error.message}

} * {result?.audio.url &&
* ) * } * ``` */ export declare function useGenerateAudio(options: Omit & { onResult?: (result: AudioGenerationResult) => TTransformed; }): UseGenerateAudioReturn>;