Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Output states include waiting, queued, assigning, processing, finished, failed, cancelled and no input.

Jobs

Create

Submit

Input

Encoder settings (optional)

Response

Job ID

Output ID

List

Submit

Response

Details

Submit

Job ID

Response

Job details

  • Created at
  • Finished at
  • Updated at
  • Submitted at
  • Pass-through
  • Job ID

Input details

  • Input ID
  • Format
  • Framerate
  • Height
  • Width
  • etc.

Output details

  • Output ID
  • Format
  • Framerate
  • Height
  • Width
  • etc.

State

Resubmit

Submit

Response

Cancel

Submit

Response

Finish (a Live Job)

Submit

Response

Job Progress

Submit

Response

Notifications

Register for a notification when a job is completed via HTTP POST, email, etc.

...

The value of Job:Status is one of the following: SubmittedProgressingCompleteCanceled, or Error.

Jobs

Create

Submit

Input file

Output file

Preset (encoder settings)

Response

Job details

Input settings

Output details

List by Pipeline

Submit

Response

List by Status

Submit

Response

Read

Submit

Response

Cancel

Submit

Response

Notifications

Register for a notification when a Job changes state via HTTP, email, etc.

...