API Documentation‎ > ‎Actions‎ > ‎Jobs‎ > ‎

Create


Description

Starts an Encoding Job in the Media Encoding Cluster, the Job will be immediately queued to the Job list and processed when a free Encoding Slot is available. 

Request Method    
POST

ActionUrl

/api/v1/encoding

Request Parameter

 Name Description Required
 inputthis can be a local file path or an http url to a webresource
http url "infile":"http://codergrid/test.mp4"
local file "infile":"/tmp/test.mp4"
 yes
 output this file or path can be a local filepath
 e.g. "output":"/tmp/result.m4v"
 
 indir this loads a local directory, this is usefull for mass encoding from directory yes
 in conjunction with outdir
 profileidthe profile id from a profile to convert the infile to the requested format.
"profileid":"072e8402-b401-48d3-a35e-414a485f18ba" 
 yes
 outfilethe outfile can be a local file or a http url web resource.
http url "outfile":"http://codergrid.de/result.avi"
local file "outfile":"/tmp/result.avi"
 yes
in conjunction with infile
 outdir here will the resulting encodings placed generated by indir yes
 in conjunction with indir
 outfilepattern defining the resulting filenames for the generated encodings by indir
 
possible variables are:
 $filename -> this is the inputfilename without extension
 $extension -> this is the inputfile extension
 $profilename -> the profile name encode to
 $profileid -> the profile id encode to
 yes
 in conjunction with indir

Response Elements

 NameDescription 
 idthe id from the generated Encoding Job 

Examples

Example Request for encoding a single file

URL:
http://localhost:8080/api/v1/encoding
JSON Payload:
{
    "infile":"/data/Movies/Die silicon Valley Story.avi",
    "profileid":"072e8402-b401-48d3-a35e-414a485f18ba",
    "outfile":"/tmp/test/Die silicon Valley Story.mp4"
}

Example Response
{
"requestId":"7130581e-c62d-4b73-84db-f57fabc82dba",
"id":"1234abcd-b401-4321-1234-4321bcda1234"
}


Example Request for encoding a directory
URL:
http://localhost:8080/api/v1/encoding
JSON Payload:
{
    "indir":"/data/Movies/",
    "profileid":"072e8402-b401-48d3-a35e-414a485f18ba",
    "outdir":"/tmp/test",
    "outfilepattern":"$profileid.$fileanme.mp4"
}

Example Response
{
"requestId":"7130581e-c62d-4b73-84db-f57fabc82dba",
"id":"1234abcd-b401-4321-1234-4321bcda1234"
}

Related Operations

Comments