JobProperties

Object

correlationDatamap

• Type: from strings to any (Optional)
  Customer provided key, value pairs that will be returned in Job and JobOutput state events.

created

• Type: string (Optional)
  Format: date-time
  The creation date and time of the Job. Set by the system.

description

• Type: string or null (Optional)
  Length <= 1024 characters
  The description of the Job.

endTime

• Type: string or null (Optional)
  The UTC date and time at which this Job finished processing.

input

• Type: object (Required)
  The inputs of the Job.

Variants

• Discriminated by: @odata.type. Select one variant:
  • Microsoft.Media.JobInputAsset
    • Type: object
    • Link: JobInputAsset
    • @odata.type: string (Required)
    • 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.

AbsoluteClipTime

• Type: object (Required)
  • @odata.type: string (Required)
  • 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.

UtcClipTime

• Type: object (Required)
  • @odata.type: string (Required)
  • time: string (Optional)
    • Format: date-time
    • The time position on the timeline of the input media based on UTC time.

trigger

• Type: object (Optional)
  • Link: ScteTrigger
  • SCTE-35 signal trigger. Recording starts/stops at the first matching signal.

filters

• Type: list of list of maps (Optional)
  Outer array is OR-combined; each inner array is AND-combined field matchers.

searchRange

• Type: object (Optional)
  • Link: ScteTriggerSearchRange
  • 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

• Type: enum (Required)
  Allowed values: SCTE35

files

• Type: list of strings (Optional)
  List of files.

label

• Type: string (Optional)
  A label that is assigned to a JobInputClip.

start

• Type: 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.

Variants

• Discriminated by: @odata.type. Select one variant:
  • Microsoft.Media.AbsoluteClipTime
  • Microsoft.Media.UtcClipTime

recording

• Type: object or null (Optional)
  • Link: JobRecording
  • Recording status. Present only for recording jobs.

lastModified

• Type: string (Optional)
  • Format: date-time
  • The last modified date and time of the Job. Set by the system.

outputs

• Type: list of objects (Required)
  The outputs for the Job.

Variants

• Discriminated by: @odata.type. Select one variant:
  • Microsoft.Media.JobOutputAsset

assetName

• Type: string (Required)
  The name of the output Asset.

endTime

• Type: string or null (Optional)
  The UTC date and time at which this Output finished processing.

error

• Type: object (Optional)
  • Details of the Job Output if it is in error state.

progress

• Type: 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.