Models

RunnerJob

object
uuidUUIDv4<uuid>
Example
9c9de5e8-0a1e-484a-b099-e80766180a6d
typeRunnerJobTypevod-web-video-transcodingvod-hls-transcodingvod-audio-merge-transcodinglive-rtmp-hls-transcoding
stateRunnerJobStateConstant
Show child attributes
idRunnerJobState12345678

The runner job state:

  • 1 Pending
  • 2 Processing
  • 3 Completed
  • 4 Errored
  • 5 Waiting for a parent job
  • 6 Cancelled
  • 7 Parent had an error
  • 8 Parent has been cancelled
labelstring
Example
Processing
payloadobject
Show child attributes
Any of
inputobject
Show child attributes
videoFileUrlstring
outputobject
Show child attributes
resolutionnumber
fpsnumber
inputobject
Show child attributes
videoFileUrlstring
outputobject
Show child attributes
resolutionnumber
fpsnumber
inputobject
Show child attributes
audioFileUrlstring
previewFileUrlstring
outputobject
Show child attributes
resolutionnumber
fpsnumber
failuresinteger

Number of times a remote runner failed to process this job. After too many failures, the job in "error" state

errorstring | null

Error message if the job is errored

progressinteger

Percentage progress

priorityinteger

Job priority (less has more priority)

updatedAtstring<date-time>
createdAtstring<date-time>
startedAtstring<date-time>
finishedAtstring<date-time>
parentobject | null

If job has a parent job

Show child attributes
typeRunnerJobTypevod-web-video-transcodingvod-hls-transcodingvod-audio-merge-transcodinglive-rtmp-hls-transcoding
stateRunnerJobStateConstant
Show child attributes
idRunnerJobState12345678

The runner job state:

  • 1 Pending
  • 2 Processing
  • 3 Completed
  • 4 Errored
  • 5 Waiting for a parent job
  • 6 Cancelled
  • 7 Parent had an error
  • 8 Parent has been cancelled
labelstring
Example
Processing
uuidUUIDv4<uuid>
Example
9c9de5e8-0a1e-484a-b099-e80766180a6d
runnerany | null

If job is associated to a runner

Show child attributes
idnumber
namestring
descriptionstring
Docs by Sourcey
↑↓ navigate↵ selectesc close