Search
Loading...
Skip to content

Type Alias: AudioExportOptions

type AudioExportOptions = object;

Represents the options for exporting audio.

Defines the possible options for exporting audio.

  • ‘mimeType’: The MIME type of the output audio file.
  • ‘onProgress’: A callback which reports on the progress of the export.
  • ‘timeOffset’: The time offset in seconds relative to the target block.
  • ‘duration’: The duration in seconds of the final audio.
  • ‘sampleRate’: The sample rate of the exported audio.
  • ‘numberOfChannels’: The number of channels of the exported audio.

Properties#

PropertyTypeDefault valueDescription
mimeType?AudioMimeType'audio/wav'The MIME type of the output audio file.
onProgress?(numberOfRenderedFrames, numberOfEncodedFrames, totalNumberOfFrames) => voidundefinedA callback which reports on the progress of the export.
timeOffset?number0The time offset in seconds relative to the target block.
duration?numberThe duration of the block.The duration in seconds of the final audio.
sampleRate?number48000The sample rate of the exported audio.
numberOfChannels?number2The number of channels of the exported audio.