Skip to main content

Interface: SFXGenerateRequest

Defined in: packages/agentos/src/core/audio/types.ts:154

Request payload for sound-effect generation from a text prompt.

Passed to IAudioGenerator.generateSFX by the high-level orchestration layer after normalising user input.

Example​

const request: SFXGenerateRequest = {
  prompt: 'Thunder crack followed by heavy rain on a tin roof',
  durationSec: 5,
};

Properties​

durationSec?​

optional durationSec: number

Defined in: packages/agentos/src/core/audio/types.ts:176

Desired output duration in seconds.

SFX clips are typically short (1-15 seconds). Providers may enforce their own limits.

modelId?​

optional modelId: string

Defined in: packages/agentos/src/core/audio/types.ts:168

Model identifier to use for generation.

When omitted the provider falls back to its IAudioGenerator.defaultModelId.

n?​

optional n: number

Defined in: packages/agentos/src/core/audio/types.ts:197

Number of audio clips to generate.

Default​

1

outputFormat?​

optional outputFormat: AudioOutputFormat

Defined in: packages/agentos/src/core/audio/types.ts:183

Output audio format.

Default​

'mp3'

prompt​

prompt: string

Defined in: packages/agentos/src/core/audio/types.ts:161

Text prompt describing the desired sound effect.

Be specific about the sound, its environment, and any layering (e.g. "glass breaking on a marble floor in a large hall with reverb").

providerOptions?​

optional providerOptions: Record<string, unknown>

Defined in: packages/agentos/src/core/audio/types.ts:203

Arbitrary provider-specific options.

seed?​

optional seed: number

Defined in: packages/agentos/src/core/audio/types.ts:190

Seed for reproducible output.

Not all providers honour seeds — check provider documentation.

userId?​

optional userId: string

Defined in: packages/agentos/src/core/audio/types.ts:200

Identifier of the requesting user (for billing / rate limiting).