[object Object] Icon

Encoding
Learn how to create, start, manage and modify Encodings

[object Object] Icon

Player
Learn how to create, start, manage and modify Players

[object Object] Icon

Analytics
Learn how to create, start, manage and modify Analyticss

Docs Home
User shortcuts for search
Focus by pressing f
Hide results by pressing Esc
Navigate via   keys

Mon Oct 15 2018

Bitmovin Video Encoder v1 to v2 migration guide

Breaking changes that may impact your encoding workflowsLink Icon

Some of the changes to our new encoder will impact your existing encoding workflows. In this section, we’ll cover those key breaking changes and show you what they entail exactly. The list below explains how these changes reflect in our API, where to find the related section in our documentation and which exact properties are concerned.

The following changes impact the encoder’s input resilience:

  • Add Stream (Decoding Error Mode): Default set to DUPLICATE_FRAMES With this setting, the encoding will not fail if a frame cannot be decoded, but instead other frames are duplicated to compensate. The encoding can continue and an error message is displayed.

  • Start Encoding (Variable FPS): handleVariableInputFps set to true per default Impacts the way input streams with variable FPS are being handled. With the new default, the encoder will process files with a dynamic framerate automatically and adjust (e.g. by dropping or duplicating frames) if a constant framerate is required for the output file. For input streams with a fixed framerate, this change does not have any impact.

  • Start Encoding (Tweaks): audioVideoSyncMode set to RESYNC_AT_START by default By setting the synchronization mode to “RESYNC_AT_START” the encoder re-syncs the audio and the video stream, based on the values transported in the metadata. This is useful for workflows containing previously encoded content.

Migration quick guide: how to revert back to the old defaultsLink Icon

If you intend to use Bitmovin Encoder in the exact way that you used to before the update, you can do so by simply changing the settings from the new default values to the old values. The table below shows you which properties you will need to change to revert back to the previous behavior.

API propertyChange to valueAPI call in our API reference
Start Encoding > encodingModeSINGLE_PASSStart (encodingMode)
Start Encoding > trimming > ignoreDurationIfInputTooShortFALSEStart (ignoreDurationIfInputTooShort)
Start Encoding > handleVariableInputFpsFALSEStart (handleVariableInputFps)
Start Encoding > tweaks > audioVideoSyncModeSTANDARDStart (audioVideoSyncMode)
Add Stream > decodingErrorModeFAIL_ON_ERRORAdd Stream

Give us feedback