@audiotool/nexus - v0.0.17
    Preparing search index...

    Type Alias SampleUpload

    SampleUpload: SamplePending & {
        ready: Promise<SampleMeta | Error>;
        uploaded: Promise<void | Error>;
    }

    Handle returned by SamplesAPI.upload. Contains the sample metadata available immediately, plus promises that resolve as the upload progresses.

    Type declaration

    • Readonlyready: Promise<SampleMeta | Error>

      Resolves when server-side processing completes and the sample is ready to be downloaded immediately, with full SampleMeta including transcoded download URLs.

      Awaiting this is optional - inserting an unready sample into a project still works, the DAW will just wait before downloading until this promise resolves.

      Returns an Error if the upload fails, processing fails, or the operation is cancelled via the AbortSignal.

    • Readonlyuploaded: Promise<void | Error>

      Resolves once the audio file has finished uploading to storage and the server has acknowledged the upload. This is the important one: after it resolves the bytes are safely on the server and the user can close the tab. Server-side processing (transcoding, waveform generation) may still be in progress.

      Returns an Error if the upload fails or is cancelled via the AbortSignal.