Skip to main content

Function: generateSFX()

generateSFX(opts): Promise<GenerateSFXResult>

Defined in: packages/agentos/src/api/generateSFX.ts:310

Generates a sound effect using a provider-agnostic interface.

Resolves provider credentials via explicit options or environment variable auto-detection, initialises the matching audio provider (optionally wrapped in a fallback chain), and returns a normalised GenerateSFXResult.

Parameters​

opts​

GenerateSFXOptions

SFX generation options.

Returns​

Promise<GenerateSFXResult>

A promise resolving to the generation result with audio data and metadata.

Example​

const result = await generateSFX({
  prompt: 'Thunder crack followed by heavy rain on a tin roof',
  durationSec: 5,
});
console.log(result.audio[0].url);