Platform API
This page provides a reference to the V-Nova Platform for encoding LCEVC-enhanced x264 and x265 encodes using the REST API .
The Platform’s REST API is designed to rapidly create automated encoding solutions and to facilitate the integration of LCEVC-enhanced encoding into other services and platforms. To learn more about the options for integrating LCEVC contact V-Nova at www.v-nova.com/contact.
This section details how to use the platform’s API to retrieve encode information from a previous job or start a new job with defined parameters for VOD or live content.
In order to authenticate your user account with the platform's API you must acquire an API key. Please bear in mind this key will give full access to your account and it is therefore recommended to store the key in a secure location to guard against the potential security risk of exposing an account API key to third parties. The platform API only supports JSON.
- 1.Login into the platform, then go to System on the left-hand navigation panel and select Users.
- 2.Edit the user you wish to assign API access to. At the bottom of the user page you will find the API Key for that user.
- 3.If the API key has not been generated, then go to API Key Refresh, select Generate and save the user. You may need to logout and back in again to retrieve the key.
get
https://api.v-nova.com/production/prod_vod/v-nova/{username}
/{contentid}
Get VOD asset details
get
https://api.v-nova.com/production/prod_vod
/presets/{presetID}
Get Preset Parameters
post
https://api.v-nova.com/production/prod_vod/v-nova/{username}
Post Offline file (VOD) - Using parameters
post
https://api.v-nova.com/production/prod_vod/v-nova/{username}
Post Offline file (VOD) - Using Preset ID
An example of creating a ladder of two encodes from the same source file.
{
"title" : "ABC1",
"url" : "input.mp4",
"cast" : "AC",
"description" : "DE",
"rating" : "AA",
"packaging" : "1"
"segmentDurationSecs" : "10",
"encodingMode" : "0",
"packagingMode" : "0",
"presetID" : "",
"profiles" : [
{
"encodingType" : "2",
"applyRateControl" : "0",
"width" : "1920",
"height" : "1080",
"videoBitrate": "1000",
"audioBitrate" : "64",
"applyLcevc" : "on",
"x264Preset" : "veryslow",
"x264RateControl" : "crf",
"x265Preset" : "",
"x265RateControl" : "",
"lcevcTune" : "vq",
"transform" : "auto",
"scalingMode" : "auto",
"bframes" : "3" ,
"maxgop" : "50",
"MAdaptiveDownsampling" : "auto",
"HFstrength" : "",
"LFstrength" : "",
"ditherCheck" : "auto",
"strength" : "",
"QpMin" : "",
"QpMax" : ""
},
{
"encodingType" : "2",
"applyRateControl" : "0",
"width" : "1920",
"height" : "1080",
"videoBitrate": "1000",
"audioBitrate" : "64",
"applyLcevc" : "on",
"x264Preset" : "veryslow",
"x264RateControl" : "crf",
"x265Preset" : "",
"x265RateControl" : "",
"lcevcTune" : "vq",
"transform" : "auto",
"scalingMode" : "auto",
"bframes" : "3" ,
"maxgop" : "50",
"MAdaptiveDownsampling" : "auto",
"HFstrength" : "",
"LFstrength" : "",
"ditherCheck" : "auto",
"strength" : "",
"QpMin" : "",
"QpMax" : ""
}
],
Errors are returned within standard http syntax, these are shown above in the response tab of the GET or POST headers. If you experience any errors or wish to file a bug report, please contact your V-Nova representative or [email protected] and include the API response concerned.
Last modified 2yr ago