ParsedAudioMetadata
Audio format parameters recovered from a container header.
Defined in: src/utils/audioFormat.ts:436
Audio format parameters recovered from a container header.
Remarks
Extends the optional parts of AudioMetadata with the container DetectedAudioFormat the values were read from. Numeric fields are optional because not every container declares them in a form this module parses — see parseAudioMetadata for the per-format coverage table.
See
parseAudioMetadata for the function that produces this type
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
bitDepth? | number | Bits per sample, for uncompressed or lossless formats. | src/utils/audioFormat.ts:450 |
channels? | number | Channel count, when the container declares one. | src/utils/audioFormat.ts:447 |
encoding? | AudioEncoding | Sample encoding, when it maps onto the SDK’s AudioEncoding type. Remarks Left undefined for encodings the SDK has no name for (24-bit PCM, IEEE float WAV, Vorbis, FLAC), so callers fall back to their configured default rather than adopting a wrong value. | src/utils/audioFormat.ts:460 |
format | DetectedAudioFormat | The container format the parameters were read from. | src/utils/audioFormat.ts:438 |
mimeType | string | MIME type of the container, e.g. 'audio/wav'. | src/utils/audioFormat.ts:441 |
sampleRate? | number | Sample rate in Hz, when the container declares one. | src/utils/audioFormat.ts:444 |