JobPutSchema

object
properties
object JobPutProperties Required

Properties of the job

correlationData

map from strings to any
Optional
Customer provided key, value pairs that will be returned in Job and JobOutput state events.

description

string or null
Optional
<=1024 characters
The description of the Job.

input

object
Required
The inputs of the Job.

Discriminated by @odata.type. Select one variant:

#Microsoft.Media.JobInputAsset

object JobInputAsset

• @odata.type string Required
  The discriminator for derived types.
• assetName string Required
  The name of the input Asset
• end object Optional
  Defines a point on the timeline of the input media at which processing will end. Defaults to the end of the input media.

Discriminated by @odata.type. Select one variant:

#Microsoft.Media.AbsoluteClipTime

object AbsoluteClipTime

• @odata.type string Required
  The discriminator for derived types.
• time string Optional
  pattern: ^P(?:(?P\d+)Y)?(?:(?P\d+)M)?(?:(?P\d+)W)?(?:(?P\d+)D)?T(?:(?P\d+)H)?(?:(?P\d+)M)?(?:(?P(?:\d*.)?\d+)S)?$
  The time position on the timeline of the input media. Specified as an ISO8601 period. e.g PT30S for 30 seconds.

#Microsoft.Media.UtcClipTime

object UtcClipTime

• @odata.type string Required
  The discriminator for derived types.
• time string Optional
  format: date-time
  The time position on the timeline of the input media based on UTC time.

trigger

object ScteTrigger
Optional
SCTE-35 signal trigger. Recording starts/stops at the first matching signal.

filters

list of list of maps
Optional
Outer array is OR-combined; each inner array is AND-combined field matchers.

searchRange

object ScteTriggerSearchRange
Optional
Bounds the signal search to [anchor+startOffset, anchor+endOffset]. Anchor is time if present, else dispatch_time (start) or resolved_start (end).

• endOffset string Required
  Closes the signal-search window relative to the anchor (ISO 8601 Duration, e.g. "PT2M").

• startOffset string Required
  Opens the signal-search window relative to the anchor (ISO 8601 Duration; negative allowed, e.g. "-PT5M").

• signalType enum Required
  Signal type.
  Allowed values: SCTE35

files

list of strings
Optional
List of files.

label

string
Optional
A label that is assigned to a JobInputClip

start

object
Optional
Defines a point on the timeline of the input media at which processing will start. Defaults to the beginning of the input media.

Discriminated by @odata.type. Select one variant:

#Microsoft.Media.AbsoluteClipTime

object AbsoluteClipTime

#Microsoft.Media.UtcClipTime

object UtcClipTime

filters

list of list of maps
Optional
Outer array is OR-combined; each inner array is AND-combined field matchers.

• signalType enum Required
  Signal type.
  Allowed values: SCTE35

outputs

list of objects Required
The outputs for the Job.

Discriminated by @odata.type. Select one variant:

#Microsoft.Media.JobOutputAsset

object JobOutputAsset

• @odata.type string Required
  The discriminator for derived types.
• assetName string Required
  The name of the output Asset
• endTime string or null Optional
  The UTC date and time at which this Output finished processing.

error

object JobError
Optional
Details of the Job Output if it is in error state.

• category enum Optional
  Allowed values: AccountConfigurationContentDownloadServiceUpload

• code enum Optional
  Allowed values: ConfigurationUnsupportedContentMalformedContentUnsupportedDownloadNotAccessibleDownloadTransientErrorIdentityUnsupportedServiceErrorServiceTransientErrorUploadNotAccessibleUploadTransientError

• message string Optional

• retry enum Optional
  Allowed values: DoNotRetryMayRetry

• label string Optional
  A label that is assigned to a JobOutput in order to help uniquely identify it.

• progress integer or null Optional
  Defaults to 0
  If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times.

• startTime string or null Optional
  The UTC date and time at which this Output began processing.

• state enum or null Optional
  Defaults to Queued
  The current state of the job.
  Allowed values: CanceledCancelingErrorFinishedProcessingQueuedScheduled

• priority enum Optional
  Defaults to Normal
  Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal.
  Allowed values: HighLowNormal