umaircsstd / bitmovin-api-sdk-examples

Set of encoding workflow examples highlighting the use of the Bitmovin API SDKs

This repository provides examples demonstrating usage of the
Bitmovin API SDKs in different programming languages.

💡 Getting started

You'll need an active Bitmovin API key for these examples to work.

Don't have an account yet? Sign up for a free Bitmovin trial plan!

If you are new to the topic, we suggest reading our tutorial Understanding the Bitmovin Encoding Object Model to get a basic idea of the building blocks that make up an encoding.

For instructions how to set up the configuration environment and run examples, consult the README.md file in the subfolder for your preferred programming language.

For full documentation of all available API endpoints, see the Bitmovin API reference.

Overview

• Fixed Bitrate Ladder Encoding
  Generate multiple MP4 renditions from a single input file using a fixed set of resolutions and target bitrates

• Generating Default Manifests
  Generate basic DASH and HLS manifests tailored to your encoding output

• Per-Title Encoding
  Generate optimized renditions by letting the Per-Title algorithm choose resolutions and bitrates based on the complexity of your content

• Multi Codec Encoding
  Run a multi-codec workflow following the best practices.

• Multi-language Broadcast TS Encoding
  Add multiple audio streams to a Broadcast TS muxing

• Applying Filters
  Enhance and manipulate content by applying pre-defined video or audio filters

• Applying CENC DRM Content Protection
  Encrypt output to prevent unauthorized playback

• Server-Side Ad Insertion (SSAI)
  Prevent blocking of ads by delivering a continuous content stream

• RTMP Live Encoding
  Start a live encoding using an RTMP stream as input

• Batch Encoding
  Efficiently start and track a large number of encodings

• Multiple Inputs Concatenation
  Combine multiple input files into a single output using concatenation and trimming

• HDR SDR Conversion
  Convert dynamic range format between DolbyVision, HDR10, HLG and SDR.

• Audio Manipulations

  Map, mix and merge audio streams and channels from one or multiple sources

  • Simple Handling - Implicit Mapping
  • Simple Handling - Distinct Input Files
  • Channel Mixing - Swapping Channels
  • Channel Mixing - Downmixing
  • Stream Mapping - Mono Input Tracks
  • Stream Merging - Multiple Streams

---

Fixed Bitrate Ladder Encoding

C# - Java - TS/JS - PHP - Python

This example demonstrates how to create multiple MP4 renditions in a single encoding, using a fixed resolution- and bitrate ladder.

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• HTTP_INPUT_HOST (?)
• HTTP_INPUT_FILE_PATH (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)

---

Generating Default Manifests

C# - Java - TS/JS - PHP - Python

This example demonstrates how to create basic DASH and HLS manifests for an encoding. Default manifests will try include all the encoding's features that are supported by the respective manifest type.

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• HTTP_INPUT_HOST (?)
• HTTP_INPUT_FILE_PATH (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)

---

Per-Title Encoding

C# - Java - TS/JS - PHP - Python

This example shows how to do a Per-Title encoding with default manifests. A Per-Title encoding automatically detects the optimal codec settings for your video assets.

Visit https://bitmovin.com/per-title-encoding/ to get an insight what Per-Title encoding is and how it works.

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• HTTP_INPUT_HOST (?)
• HTTP_INPUT_FILE_PATH (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)

---

Multi Codec Encoding

C# - Java - TS/JS - PHP - Python

This example showcases how to run a multi-codec workflow following the best practices.

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• HTTP_INPUT_HOST (?)
• HTTP_INPUT_FILE_PATH (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)

---

Multi-language Broadcast TS Encoding

C# - Java - TS/JS - PHP - Python

This example demonstrates how multiple audio streams can be included in a BroadcastTS muxing. BroadcastTS muxings are MPEG transport stream muxings which allow setting custom properties such as PCR interval and PIDs for transmission to traditional broadcast targets like set top boxes, QAM streamers and similar devices. This muxing is not generally used for streaming to IP devices such as browsers, iOS, or Android devices.

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• HTTP_INPUT_HOST (?)
• HTTP_INPUT_FILE_PATH (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)

---

Applying Filters

C# - Java - TS/JS - PHP - Python

This example demonstrates how to apply filters to a video stream. Filters will manipulate the content of a stream, e.g. remove noise or add a watermark image. See the Encoding Filters API Reference for a complete list of available filters.

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• HTTP_INPUT_HOST (?)
• HTTP_INPUT_FILE_PATH (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)
• WATERMARK_IMAGE_PATH (?)
• TEXT_FILTER_TEXT (?)

---

Applying CENC DRM Content Protection

C# - Java - TS/JS - PHP - Python

This example shows how DRM content protection can be applied to a fragmented MP4 muxing. DRM is used to prevent playback on unauthorized devices (piracy) and requires integration with a key server.
The encryption is configured to be compatible with both FairPlay and Widevine, using the MPEG Common Encryption standard.

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• HTTP_INPUT_HOST (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)
• DRM_KEY (?)
• DRM_FAIRPLAY_IV (?)
• DRM_FAIRPLAY_URI (?)
• DRM_WIDEVINE_KID (?)
• DRM_WIDEVINE_PSSH (?)

---

Server-Side Ad Insertion (SSAI)

C# - Java - TS/JS - PHP - Python

This example demonstrates how to create multiple fMP4 renditions with Server Side Ad Insertion (SSAI).

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• HTTP_INPUT_HOST (?)
• HTTP_INPUT_FILE_PATH (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)

---

RTMP Live Encoding

C# - Java - TS/JS - PHP - Python

This example shows how to configure and start a live encoding using default DASH and HLS manifests. For more information see: https://bitmovin.com/live-encoding-live-streaming

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)

---

Batch Encoding

C# - Java - TS/JS - PHP - Python

This example demonstrates how to efficiently execute a large batch of encodings in parallel. In order to keep the startup time for each encoding to a minimum, it is advisable to constantly have some encodings queued. Encodings will therefore be started in a way to maintain a constant queue size.

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• HTTP_INPUT_HOST (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)

---

Multiple Inputs Concatenation

C# - Java - TS/JS - PHP - Python

This example demonstrates how to use concatenation and trimming to combine multiple input files into a single output. This script is the full version of the script documented in the tutorial on concatenation and trimming https://bitmovin.com/docs/encoding/tutorials/stitching-and-trimming-part-1-the-basics

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• HTTP_INPUT_HOST (?)
• HTTP_INPUT_FILE_PATH (?)
• HTTP_INPUT_BUMPER_FILE_PATH (?)
• HTTP_INPUT_PROMO_FILE_PATH (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)

---

HDR SDR Conversion

Python - Java - TS/JS

This example demonstrates how to convert dynamic range format between DolbyVision, HDR10, HLG and SDR.

The supported HDR/SDR conversions are as follows. If the target output format is either DolbyVision, HDR10 or HLG, this example adds SDR renditions automatically. This example works only with Bitmovin Encoder version 2.98.0 or later.

• Input: DolbyVision
  • Output:
    • DolbyVision and SDR
    • HDR10 and SDR
• Input: HDR10
  • Output:
    • HDR10 and SDR
    • HLG and SDR
• Input: HLG
  • Output:
    • HLG and SDR
    • HDR10 and SDR
• Input: SDR
  • Output:
    • HDR10 and SDR
    • HLG and SDR

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• HTTP_INPUT_HOST (?)
• HTTP_INPUT_FILE_PATH (?)
• HTTP_INPUT_AUDIO_FILE_PATH (?)
• HDR_CONVERSION_INPUT_FORMAT (?)
• HDR_CONVERSION_OUTPUT_FORMAT (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)

If you want to load a DolbyVision metadata as a sidecar XML file, the following parameter also needs to be specified. If that parameter is not provided for a DolbyVision encoding, the example assumes the corresponding metadata is embedded into the DolbyVision input mezzanine file itself.

• HTTP_INPUT_DOLBY_VISION_METADATA_FILE_PATH (?)

---

Audio Manipulations

A set of examples that demonstrate how to perform audio stream and channel manipulations. They are provided as illustrations of the [tutorial on audio manipulations] (https://bitmovin.com/docs/encoding/tutorials/separating-and-combining-audio-streams)

Simple Handling - Implicit Mapping

C# - Java - TS/JS - PHP - Python

This example demonstrates the simplest mechanism to include a stereo audio stream in an output MP4, from an input file containing a stereo audio stream (and a video stream), with the use of a single IngestInputStream.

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• HTTP_INPUT_HOST (?)
• HTTP_INPUT_FILE_PATH_STEREO_SOUND (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)

Simple Handling - Distinct Input Files

C# - Java - TS/JS - PHP - Python

This example demonstrates how to combine and map audio streams from multiple input files into a single output MP4 file with multiple audio streams/tracks, with multiple IngestInputStreams.

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• HTTP_INPUT_HOST (?)
• HTTP_INPUT_FILE_PATH (?)
• HTTP_INPUT_FILE_PATH_STEREO_SOUND (?)
• HTTP_INPUT_FILE_PATH_SURROUND_SOUND (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)

Channel Mixing - Swapping Channels

C# - Java - TS/JS - PHP - Python

This example demonstrates how to swap 2 audio channels from a stereo input, using a simple AudioMixInputStream configuration.

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• HTTP_INPUT_HOST (?)
• HTTP_INPUT_FILE_PATH_STEREO_SOUND (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)

Channel Mixing - Downmixing

C# - Java - TS/JS - PHP - Python

This example demonstrates one mechanism to downmix a 5.1 stream down to 2.0. It uses an advanced AudioMixInputStream configuration with gain adjusted on each input channel.

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• HTTP_INPUT_HOST (?)
• HTTP_INPUT_FILE_PATH_SURROUND_SOUND (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)

Stream Mapping - Mono Input Tracks

C# - Java - TS/JS - PHP - Python

This example demonstrates one mechanism to create single output tracks from multiple mono input tracks, using multiple IngestInputStreams (by position in the source), and mapping them to output channels (by type).

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• HTTP_INPUT_HOST (?)
• HTTP_INPUT_FILE_PATH_MULTIPLE_MONO_AUDIO_TRACKS (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)

Stream Merging - Background Audio

C# - Java - TS/JS - PHP - Python

This example demonstrates how to merge multiple stereo streams (from a single file, but this can easily be extended to select them from separate input files), adjusting gain on the second stream to turn it into a background effect.

Required configuration parameters:

• BITMOVIN_API_KEY (?)
• BITMOVIN_TENANT_ORG_ID (?)
• HTTP_INPUT_HOST (?)
• HTTP_INPUT_FILE_PATH_TWO_STEREO_TRACKS (?)
• S3_OUTPUT_BUCKET_NAME (?)
• S3_OUTPUT_ACCESS_KEY (?)
• S3_OUTPUT_SECRET_KEY (?)
• S3_OUTPUT_BASE_PATH (?)

Configuration Parameters

These are the parameters that need to be supplied for the examples to work. They can be defined in a file, set as environment variables or passed directly to the run-example script.

Note! See the README.md of the API SDK examples in your preferred programming language on how to configure parameters.

BITMOVIN_API_KEY - Your API key for the Bitmovin API

BITMOVIN_TENANT_ORG_ID - The ID of the Organisation in which you want to perform the encoding. Only required if working with a multi-tenant account.

HTTP_INPUT_HOST - The Hostname or IP address of the HTTP server hosting your input files
Example: my-storage.biz

HTTP_INPUT_FILE_PATH - The path to your input file on the HTTP host
Example: videos/1080p_Sintel.mp4

HTTP_INPUT_BUMPER_FILE_PATH - The path to your input file on the provided HTTP server to be concatenated before HTTP_INPUT_FILE_PATH
Example: videos/bumper.mp4

HTTP_INPUT_PROMO_FILE_PATH - The path to your input file on the provided HTTP server to be concatenated after HTTP_INPUT_FILE_PATH
Example: videos/promo.mp4

HTTP_INPUT_FILE_PATH_STEREO_SOUND - the path to a file containing a video with a single audio stereo stream Example: videos/1080p_Sintel_Stereo.mp4

HTTP_INPUT_FILE_PATH_SURROUND_SOUND - the path and filename for a file containing a video with a 5.1 audio stream Example: videos/1080p_Sintel_Surround.mp4

HTTP_INPUT_FILE_PATH_MULTIPLE_MONO_AUDIO_TRACKS - the path to a file containing a video with multiple mono audio tracks Example: videos/1080p_Sintel_8_Mono_Audio_Tracks.mp4

HTTP_INPUT_FILE_PATH_TWO_STEREO_TRACKS - the path to a file containing a video with 2 stereo tracks Example: videos/1080p_Sintel_Two_Stereos.mp4

S3_OUTPUT_BUCKET_NAME - The name of your S3 output bucket
Example: my-s3-bucket-name

S3_OUTPUT_ACCESS_KEY - The access key of your S3 output bucket
Example: AKIAIOSFODNN7EXAMPLE

S3_OUTPUT_SECRET_KEY - The secret key of your S3 output bucket
Example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

S3_OUTPUT_BASE_PATH - The base path on your S3 output bucket where content will be written
Example: /outputs

WATERMARK_IMAGE_PATH - The path to the watermark image
Example: http://my-storage.biz/logo.png

TEXT_FILTER_TEXT - The text to be displayed by the text filter

DRM_KEY - 16 byte encryption key, represented as 32 hexadecimal characters
Example: cab5b529ae28d5cc5e3e7bc3fd4a544d

DRM_FAIRPLAY_IV - 16 byte initialization vector, represented as 32 hexadecimal characters
Example: 08eecef4b026deec395234d94218273d

DRM_FAIRPLAY_URI - URI of the licensing server
Example: skd://userspecifc?custom=information

DRM_WIDEVINE_KID - 16 byte encryption key id, represented as 32 hexadecimal characters
Example: 08eecef4b026deec395234d94218273d

DRM_WIDEVINE_PSSH - Base64 encoded PSSH payload
Example: QWRvYmVhc2Rmc2FkZmFzZg==

You may also add your own parameters in your configuration. The ConfigProvider class in each example offers a generic function to get the value of the parameter by its name.