Events and errors

What a running job tells every caller as it goes, and how a request that fails says why.

Events

Every event carries job and path. As a bare object the tag is event; in the JSON-RPC envelope the tag becomes the notification's method and the rest its params.

cutout.progress

Payload

  • fetchingboolrequired

    True while a model downloads, false while it runs.

  • fractionnumberrequired

    How far along, 0..=1.

  • jobstringrequired

    The job.

  • mediaIdstringrequired

    The media being analysed.

  • pathstringrequired

    The project folder.

stabilize.progress

A stabilized clip's media is being measured ahead of an export.

Payload

  • fractionnumberrequired

    How far along, 0..=1.

  • jobstringrequired

    The job.

  • mediaIdstringrequired

    The media being measured.

  • pathstringrequired

    The project folder.

export.progress

Payload

  • frameintegerrequired

    Frames done.

  • jobstringrequired

    The job.

  • pathstringrequired

    The project folder.

  • stagestringrequired

    "video", "audio" or "mux".

  • totalintegerrequired

    Frames in total.

export.done

Payload

  • heightintegerrequired

    Its picture size.

  • jobstringrequired

    The job.

  • outputstringrequired

    The file written.

  • pathstringrequired

    The project folder.

  • widthintegerrequired

    Its picture size.

export.failed

Payload

  • errorApiErrorrequired

    Why: Cancelled when asked to stop, otherwise what went wrong.

  • jobstringrequired

    The job.

  • pathstringrequired

    The project folder.


Errors

  • parse

    The line was not JSON.

  • invalid

    The JSON was not a request: an unknown method, a missing or ill-typed field, a value out of range.

  • notOpen

    The project named is not open; open it first.

  • notFound

    A job, template or package named does not exist.

  • refused

    The edit layer said no. The message is the sentence the window would show, and the state is as it was.

  • busy

    A one-at-a-time job is already running.

  • cancelled

    The job was stopped by export.cancel.

  • unauthorized

    The transport wanted a token and did not get the right one. Never raised by the API itself.

  • failed

    Everything else: a file that could not be read or written, a decode that failed, a model that did not download.

Every error a method replies with is an ApiError.