Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Progress Events

Some methods have optional onProgress callbacks to handle progress events for uploading resources.

The first argument to the onProgress callback is always a rolled up progress value from 0-1. The second will be one of the following types depending on the method.

UploadTrackProgressEvent

{
  key: 'audio' | 'image' // Which file upload triggered the event
  loaded: number // How much of the file has been uploaded, in bytes
  total: number // Total number of bytes of the file
  transcode: number // Completion percent (from 0-1) of the transcoding
}

UploadPlaylistProgressEvent

{
  key: 'image' | number // The index of the audioFile or 'image'
  loaded: number // How much of the file has been uploaded, in bytes
  total: number // Total number of bytes of the file
  transcode: number // Completion percent (from 0-1) of the transcoding
}