Skip to main content

PreviewOptions

@siteed/audio-studio

@siteed/audio-studio / PreviewOptions

Interface: PreviewOptions

Defined in: src/AudioAnalysis/AudioAnalysis.types.ts:166

Options for generating a quick preview of audio waveform. This is optimized for UI rendering with a specified number of points.

Extends​

Properties​

decodingOptions?​

optional decodingOptions: DecodingConfig

Defined in: src/AudioAnalysis/AudioAnalysis.types.ts:186

Optional configuration for decoding the audio file. Defaults to:

  • targetSampleRate: undefined (keep original)
  • targetChannels: undefined (keep original)
  • targetBitDepth: 16
  • normalizeAudio: false

endTimeMs?​

optional endTimeMs: number

Defined in: src/AudioAnalysis/AudioAnalysis.types.ts:159

End time in milliseconds

Inherited from​

AudioRangeOptions.endTimeMs

fileUri​

fileUri: string

Defined in: src/AudioAnalysis/AudioAnalysis.types.ts:168

URI of the audio file to analyze

logger?​

optional logger: ConsoleLike

Defined in: src/AudioAnalysis/AudioAnalysis.types.ts:177

Optional logger for debugging.

numberOfPoints?​

optional numberOfPoints: number

Defined in: src/AudioAnalysis/AudioAnalysis.types.ts:173

Total number of points to generate for the preview.

Default​

100

startTimeMs?​

optional startTimeMs: number

Defined in: src/AudioAnalysis/AudioAnalysis.types.ts:157

Start time in milliseconds

Inherited from​

AudioRangeOptions.startTimeMs