API Reference
Bitmovin PlatformPlaybackEncodingBitmovin Dashboard

Start VoD Encoding

post
https://api.bitmovin.com/v1/encoding/encodings//start
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Id of the encoding

Body Params

Encoding Startup Options

trimming
object

Allows to encode only part of the input. Defines start (offset) and duration of the desired section. This is not allowed when the Encoding uses any kind of Input Stream resource.

scheduling
object

Scheduling parameters of the encoding.

tweaks
object

Special tweaks for your encoding job.

boolean

Enable frame dropping/duplication to handle variable frames per seconds of video input streams

string
enum
Defaults to STANDARD

The pass mode of the encoding. Must only be set when encodingMode is not set on any codec configuration used by this encoding.

Allowed:
previewDashManifests
array of objects

DASH manifests to be generated for previewing while the encoding is still running. See documentation

previewDashManifests
previewHlsManifests
array of objects

HLS manifests to be generated for previewing while the encoding is still running. See documentation

previewHlsManifests
vodDashManifests
array of objects

DASH manifests to be generated right after encoding (just-in-time). See documentation

vodDashManifests
vodHlsManifests
array of objects

HLS manifests to be generated right after encoding (just-in-time). See documentation

vodHlsManifests
vodSmoothManifests
array of objects

Smooth Streaming manifests to be generated right after encoding (just-in-time). See documentation

vodSmoothManifests
string
enum
Defaults to LEGACY

Major version of the manifest generator to be used for manifests referenced in this request (by properties vodDashManifests, vodHlsManifests, vodSmoothManifests, previewDashManifests, previewHlsManifests). V2 is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See documentation page for a detailed explanation.

Allowed:
perTitle
object

Per-Title settings

aiSceneAnalysis
object

AI scene analysis settings

Responses

Updated 23 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 23 days ago