Skip to main content

EncodeAudioJob

An audio encoding job.

type EncodeAudioJob implements Job {
  audioInfoDestination: DestinationData
  completed: Boolean!
  completedAt: DateTime
  createdAt: DateTime!
  destinations: [EncodeAudioDestination!]!
  errors: [JobError!]!
  id: ID!
  locked: Boolean!
  lockedAt: DateTime
  log: LogID
  logViewerURL: URL
  namespace: Namespace!
  namespaceId: ID!
  source: SourceData!
  success: Boolean
  updatedAt: DateTime!
  webhook: URL
}

Fields

`EncodeAudioJob.audioInfoDestination` ● `DestinationData` object

The destination for the audio file information, as a json file. (optional)

`EncodeAudioJob.completed` ● `Boolean!` non-null scalar

Whether the job as been completed or not.

`EncodeAudioJob.completedAt` ● `DateTime` scalar

Date and time at which the job was completed.

`EncodeAudioJob.createdAt` ● `DateTime!` non-null scalar

The date and time at which the job was first created.

`EncodeAudioJob.destinations` ● `[EncodeAudioDestination!]!` non-null object

The different destinations of the encoding job.

`EncodeAudioJob.errors` ● `[JobError!]!` non-null interface

List of errors occured during the execution of the job.

`EncodeAudioJob.id` ● `ID!` non-null scalar

The ID of the audio encoding job, as an URI.

`EncodeAudioJob.locked` ● `Boolean!` non-null scalar

Whether the job is locked or not.

`EncodeAudioJob.lockedAt` ● `DateTime` scalar

Date and time at which the job was last locked.

`EncodeAudioJob.log` ● `LogID` scalar

ID for logging events related to this job.

`EncodeAudioJob.logViewerURL` ● `URL` scalar

Get an URL to view the log.

`EncodeAudioJob.namespace` ● `Namespace!` non-null object

The namespace that owns the job.

`EncodeAudioJob.namespaceId` ● `ID!` non-null scalar

The namespace that owns the job.

`EncodeAudioJob.source` ● `SourceData!` non-null object

The source data for the job.

`EncodeAudioJob.success` ● `Boolean` scalar

Whether the job completion was a success or not.

`EncodeAudioJob.updatedAt` ● `DateTime!` non-null scalar

The date and time at which the job was last updated.

`EncodeAudioJob.webhook` ● `URL` scalar

The URL to post a notification to when the job has finished.

Interfaces

`Job` interface

A unit of work managed by the audio service.

Fields
Interfaces