Main Documentation

Paths

POST /encoreJobs

Description

create-encorejob

Parameters

Type Name Schema

Body

body
optional

EncoreJob

Responses

HTTP Code Description Schema

201

Created

EntityModelEncoreJob

Consumes

  • application/json

Produces

  • application/hal+json

Tags

  • encorejob

GET /encoreJobs

Description

get-encorejob

Parameters

Type Name Description Schema Default

Query

page
optional

Zero-based page index (0..N)

integer

0

Query

size
optional

The size of the page to be returned

integer

20

Query

sort
optional

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

< string > array(multi)

Responses

HTTP Code Description Schema

200

OK

CollectionModelEntityModelEncoreJob

Produces

  • application/hal+json

  • text/uri-list

  • application/x-spring-data-compact+json

Tags

  • encorejob

Finds EncoreJobs By Status

GET /encoreJobs/search/findByStatus

Description

Returns EncoreJobs according to the given Status

Parameters

Type Name Description Schema Default

Query

page
optional

Zero-based page index (0..N)

integer

0

Query

size
optional

The size of the page to be returned

integer

20

Query

sort
optional

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

< string > array(multi)

Query

status
optional

enum (NEW, QUEUED, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED)

Responses

HTTP Code Description Schema

200

OK

PagedModelEncoreJob

404

Not Found

No Content

Produces

  • application/hal+json

Tags

  • encorejob

GET /encoreJobs/{id}

Description

get-encorejob

Parameters

Type Name Schema

Path

id
required

string

Responses

HTTP Code Description Schema

200

OK

EntityModelEncoreJob

404

Not Found

No Content

Produces

  • application/hal+json

Tags

  • encorejob

PUT /encoreJobs/{id}

Description

update-encorejob

Parameters

Type Name Schema

Path

id
required

string

Body

body
optional

EncoreJob

Responses

HTTP Code Description Schema

200

OK

EntityModelEncoreJob

201

Created

EntityModelEncoreJob

204

No Content

No Content

Consumes

  • application/json

Produces

  • application/hal+json

Tags

  • encorejob

DELETE /encoreJobs/{id}

Description

delete-encorejob

Parameters

Type Name Schema

Path

id
required

string

Responses

HTTP Code Description Schema

204

No Content

No Content

404

Not Found

No Content

Tags

  • encorejob

PATCH /encoreJobs/{id}

Description

patch-encorejob

Parameters

Type Name Schema

Path

id
required

string

Body

body
optional

EncoreJob

Responses

HTTP Code Description Schema

200

OK

EntityModelEncoreJob

204

No Content

No Content

Consumes

  • application/json

Produces

  • application/hal+json

Tags

  • encorejob

Cancel an EncoreJob

POST /encoreJobs/{jobId}/cancel

Description

Cancels an EncoreJob with thw given JobId

Parameters

Type Name Schema

Path

jobId
required

string (uuid)

Responses

HTTP Code Description Schema

200

OK

string

Produces

  • application/hal+json

Tags

  • encorejob

Get Queues

GET /queue

Description

Returns a list of queues (QueueItems)

Responses

HTTP Code Description Schema

200

OK

< QueueItem > array

Produces

  • application/hal+json

Tags

  • queue

Definitions

AudioFile

Polymorphism : Inheritance
Discriminator : type

Name Schema

audioStreams
optional

< AudioStream > array

duration
optional

number (double)

file
required

string

fileSize
required

integer (int64)

format
required

string

overallBitrate
optional

integer (int64)

type
required

string

AudioStream

Name Schema

bitrate
optional

integer (int64)

channels
required

integer (int32)

codec
optional

string

duration
optional

number (double)

format
optional

string

samplingRate
optional

integer (int32)

CollectionModelEntityModelEncoreJob

Name Schema

_embedded
optional

_embedded

_links
optional

Links

_embedded

Name Schema

encoreJobs
optional

< EntityModelEncoreJob > array

EncoreJob

Name Description Schema

completedDate
optional
read-only

The time for when the EncoreJob was completed (fail or success)
Example : "2021-04-19T07:20:43.819141+02:00"

string (date-time)

createdDate
required
read-only

The Creation date for the EncoreJob
Example : "2021-04-22T03:00:48.759168+02:00"

string (date-time)

cropTo
optional

Crop output video to given aspect ratio
Pattern : "^[1-9]\\d*[:/][1-9]\\d*$"
Example : "1:1"

string

dar
optional

The Display Aspect Ratio to use if the input is anamorphic. Overrides DAR found from input metadata (for corrupt video metadata)
Pattern : "^[1-9]\\d*[:/][1-9]\\d*$"
Example : "16:9"

string

debugOverlay
required

Instruct Encore to overlay encoding metadata on the encoded video stream
Default : false

boolean

endTime
optional

Seek in video stream to given end time in ms (start time must currently be given)
Example : 20000

integer (int32)

externalId
optional

External id - for external backreference
Example : "any-string"

string

filename
required

The input file that the EncoreJob should process
Example : "/path/to/a/file/file.mxf"

string

globalAudioFilters
required

List of FFmpeg filters to apply to all audio outputs
Example : "to-do"

< string > array

globalVideoFilters
required

List of FFmpeg filters to apply to all video outputs
Example : "proxy=filter_path=/ffmpeg-filters/libsvg_filter.so:config='svg=/path/logo-white.svg"

< string > array

id
required
read-only

The Encore Internal EncoreJob Identity
Example : "fb2baa17-8972-451b-bb1e-1bc773283476"

string (uuid)

input
optional

VideoFile

logContext
required

Key/Values to append to the MDC log context

< string, string > map

message
optional
read-only

The exception message, if the EncoreJob failed
Example : "input/output error"

string

output
required
read-only

Analyzed models of the output files

< object > array

outputFolder
required

A directory path to where the output should be written
Example : "/an/output/path/dir"

string

padTo
optional

Pad output video to given aspect ratio
Pattern : "^[1-9]\\d*[:/][1-9]\\d*$"
Example : "16:9"

string

priority
required

The queue priority of the EncoreJob
Default : 0
Minimum value : 0
Maximum value : 100

integer (int32)

profile
required

The name of the encoding profile to use
Example : "x264-animated"

string

progress
required
read-only

The EncoreJob progress
Default : 0
Example : 57

integer (int32)

progressCallbackUri
optional

An url to which the progress status callback should be directed
Example : "http://projectx/encorecallback"

string (uri)

speed
optional
read-only

The Encoding speed of the job (compared to it’s play speed/input duration)
Example : 0.334

number (double)

startTime
optional

Seek in video stream to given start time in ms (end time must currently be given)
Example : 10000

integer (int32)

startedDate
optional
read-only

The time for when the EncoreJob was picked from the queue)
Example : "2021-04-19T07:20:43.819141+02:00"

string (date-time)

status
required
read-only

The Job Status

enum (NEW, QUEUED, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED)

thumbnailTime
optional

Time in ms for when the thumbnail should be picked. Overrides profile configuration for thumbnails
Example : 5000

integer (int32)

useFirstAudioStreams
optional

Only the audio input streams up to the given value
Example : 2

integer (int32)

EntityModelEncoreJob

Name Description Schema

_links
optional

Links

completedDate
optional
read-only

The time for when the EncoreJob was completed (fail or success)
Example : "2021-04-19T07:20:43.819141+02:00"

string (date-time)

createdDate
optional
read-only

The Creation date for the EncoreJob
Example : "2021-04-22T03:00:48.759168+02:00"

string (date-time)

cropTo
optional

Crop output video to given aspect ratio
Pattern : "^[1-9]\\d*[:/][1-9]\\d*$"
Example : "1:1"

string

dar
optional

The Display Aspect Ratio to use if the input is anamorphic. Overrides DAR found from input metadata (for corrupt video metadata)
Pattern : "^[1-9]\\d*[:/][1-9]\\d*$"
Example : "16:9"

string

debugOverlay
optional

Instruct Encore to overlay encoding metadata on the encoded video stream
Default : false

boolean

endTime
optional

Seek in video stream to given end time in ms (start time must currently be given)
Example : 20000

integer (int32)

externalId
optional

External id - for external backreference
Example : "any-string"

string

filename
optional

The input file that the EncoreJob should process
Example : "/path/to/a/file/file.mxf"

string

globalAudioFilters
optional

List of FFmpeg filters to apply to all audio outputs
Example : "to-do"

< string > array

globalVideoFilters
optional

List of FFmpeg filters to apply to all video outputs
Example : "proxy=filter_path=/ffmpeg-filters/libsvg_filter.so:config='svg=/path/logo-white.svg"

< string > array

id
optional
read-only

The Encore Internal EncoreJob Identity
Example : "fb2baa17-8972-451b-bb1e-1bc773283476"

string (uuid)

input
optional

VideoFile

logContext
optional

Key/Values to append to the MDC log context

< string, string > map

message
optional
read-only

The exception message, if the EncoreJob failed
Example : "input/output error"

string

output
optional
read-only

Analyzed models of the output files

< MediaFile > array

outputFolder
optional

A directory path to where the output should be written
Example : "/an/output/path/dir"

string

padTo
optional

Pad output video to given aspect ratio
Pattern : "^[1-9]\\d*[:/][1-9]\\d*$"
Example : "16:9"

string

priority
optional

The queue priority of the EncoreJob
Default : 0
Minimum value : 0
Maximum value : 100

integer (int32)

profile
optional

The name of the encoding profile to use
Example : "x264-animated"

string

progress
optional
read-only

The EncoreJob progress
Default : 0
Example : 57

integer (int32)

progressCallbackUri
optional

An url to which the progress status callback should be directed
Example : "http://projectx/encorecallback"

string (uri)

speed
optional
read-only

The Encoding speed of the job (compared to it’s play speed/input duration)
Example : 0.334

number (double)

startTime
optional

Seek in video stream to given start time in ms (end time must currently be given)
Example : 10000

integer (int32)

startedDate
optional
read-only

The time for when the EncoreJob was picked from the queue)
Example : "2021-04-19T07:20:43.819141+02:00"

string (date-time)

status
optional
read-only

The Job Status

enum (NEW, QUEUED, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED)

thumbnailTime
optional

Time in ms for when the thumbnail should be picked. Overrides profile configuration for thumbnails
Example : 5000

integer (int32)

useFirstAudioStreams
optional

Only the audio input streams up to the given value
Example : 2

integer (int32)

ImageFile

Polymorphism : Inheritance
Discriminator : type

Name Schema

file
required

string

fileSize
required

integer (int64)

format
required

string

height
optional

integer (int32)

type
required

string

width
optional

integer (int32)

Link

Name Schema

deprecation
optional

string

href
optional

string

hreflang
optional

string

name
optional

string

profile
optional

string

templated
optional

boolean

title
optional

string

type
optional

string

Links

Type : < string, Link > map

MediaFile

Analyzed models of the output files

Name Schema

file
required

string

fileSize
required

integer (int64)

format
required

string

type
required

string

PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

PagedModelEncoreJob

Name Schema

_embedded
optional

_embedded

_links
optional

Links

page
optional

PageMetadata

_embedded

Name Schema

encoreJobs
optional

< EncoreJob > array

QueueItem

Name Schema

created
required

string (date-time)

id
required

string

priority
required

integer (int32)

SubtitleFile

Polymorphism : Inheritance
Discriminator : type

Name Schema

file
required

string

fileSize
required

integer (int64)

format
required

string

type
required

string

VideoFile

Polymorphism : Inheritance
Discriminator : type

Name Schema

audioStreams
optional

< AudioStream > array

duration
optional

number (double)

file
required

string

fileSize
required

integer (int64)

format
required

string

overallBitrate
optional

integer (int64)

type
required

string

videoStreams
optional

< VideoStream > array

VideoStream

Name Schema

bitDepth
optional

integer (int32)

bitrate
optional

integer (int64)

codec
required

string

displayAspectRatio
optional

string

duration
required

number (double)

format
optional

string

frameRate
required

string

height
required

integer (int32)

isInterlaced
required

boolean

level
optional

string

numFrames
required

integer (int32)

pixelFormat
optional

string

profile
optional

string

sampleAspectRatio
optional

string

transferCharacteristics
optional

string

width
required

integer (int32)

To Main Documentation