Start HD Options Live Encoding

post

https://api.bitmovin.com/v1/encoding/encodings/{encoding_id}/live/hd/start

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

encoding_id

string

required

Id of the encoding

Body Params

Live Encoding startup options

streamKey

string

required

Key for the stream. (a-zA-Z, 3-20 characters)

hlsManifests

array of objects

HLS manifests to be generated during the encoding. See documentation

hlsManifests

dashManifests

array of objects

DASH manifests to be generated during the encoding. See documentation

dashManifests

liveEncodingMode

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:

reuploadSettings

object

Reupload specific files during a live encoding. This can be helpful if an automatic life cycle policy is enabled on the output storage

manifestGenerator

string

enum

Defaults to LEGACY

Major version of the manifest generator to be used for manifests referenced in this request (by properties dashManifests, dashManifests). 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:

autoRestartConfiguration

object

Configuration for auto restarting the live encoding

autoShutdownConfiguration

object

Configuration for auto shutdown of the live encoding

esamSettings

object

Configuration for Event Signaling and Management (ESAM) system,
allowing the encoder to communicate with an ESAM server for signal processing and dynamic ad insertion update.'

cacheControlSettings

object

Configuration of cache control policies for media segments, HLS, and DASH manifests.
You can set caching for the HLS multivariant playlist, HLS media playlist, DASH timeline manifest,
DASH template manifest, initialization segment, and media segment.

adInsertionSettings

object

Configuration for ad insertion features like ESAM MediaPoint insertion

Responses

202Successful response.

409Error response.

defaultError response.