InputSoundFile

constructor

• new InputSoundFile(): InputSoundFile

  Create a decoder with no open data source.

  Returns

  InputSoundFile

  Source & inheritance

close

• close(): Promise<void>

  Wait for prior operations, then asynchronously close the decoder and release its retained data source.

  Returns

  Promise<void>

  Source & inheritance

getChannelCount

• getChannelCount(): number

  Return the number of channels.

  Returns

  number

  Source & inheritance

getChannelMap

• getChannelMap(): Readonly

  Return the position mapping of interleaved channels.

  Returns

  Readonly

  Source & inheritance

getDuration

• getDuration(): Time

  Return the total audio duration.

  Returns

  Time

  Source & inheritance

getSampleCount

• getSampleCount(): bigint

  Return the total sample count across all channels.

  Returns

  bigint

  Source & inheritance

getSampleOffset

• getSampleOffset(): bigint

  Return the current sample offset, including all interleaved channels.

  Returns

  bigint

  Source & inheritance

getSampleRate

• getSampleRate(): number

  Return the sample rate per channel, in Hz.

  Returns

  number

  Source & inheritance

getTimeOffset

• getTimeOffset(): Time

  Return the time corresponding to the current decoding position.

  Returns

  Time

  Source & inheritance

openFromFile

• openFromFile(filename: string): Promise<boolean>

  Asynchronously open an audio file and read its format information, returning whether it succeeded.

  Parameters

  filename

  string

  Returns

  Promise<boolean>

  Source & inheritance

openFromMemory

• openFromMemory(data: Uint8Array): Promise<boolean>

  Asynchronously open encoded audio bytes, returning whether it succeeded.

  Parameters

  data

  Uint8Array

  Returns

  Promise<boolean>

  Source & inheritance

openFromStream

• openFromStream(stream: InputStream): Promise<boolean>

  Asynchronously open a seekable stream, retaining the data source reference during reading.

  Parameters

  stream

  InputStream

  Returns

  Promise<boolean>

  Source & inheritance

read

• read(data: Int16Array): Promise<bigint>

  Asynchronously decode into data, returning the actual number of samples written; return 0n at the end. Do not modify the buffer before completion.

  Parameters

  data

  Int16Array

  Returns

  Promise<bigint>

  Source & inheritance

seek

• seek(offset: bigint | ReadonlyValue<Time>): Promise<void>

  Asynchronously seek to a sample offset (bigint, including all channels) or a time offset (Time).

  Parameters

  offset

  bigint | ReadonlyValue<Time>

  Returns

  Promise<void>

  Source & inheritance

Readonly[audioHandle]