Add Chunked Text muxing

post

https://api.bitmovin.com/v1/encoding/encodings/{encoding_id}/muxings/chunked-text

Path Params

encoding_id

string

required

Id of the encoding.

Body Params

The Chunked Text muxing to be created

name

string

Name of the resource. Can be freely chosen by the user.

description

string

Description of the resource. Can be freely chosen by the user.

customData

string

User-specific meta data. This can hold anything.

streams

array of objects

required

streams*

outputs

array of objects

outputs

streamConditionsMode

string

enum

Defaults to DROP_MUXING

Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.

Allowed:

segmentLength

double

required

Length of the segments in seconds

segmentNaming

string

Defaults to segment_%number%

Segment naming policy

segmentNamingTemplate

string

Segment naming policy containing one or both of the following placeholders:

'{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)
on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property.
Intended to avoid re-use of segment names after restarting a live encoding.
'{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)
for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers.

If segmentNamingTemplate is set, segmentNaming must not be set.

startOffset

integer

Offset of MPEG-TS timestamps in seconds. This only affects streams with WebVttConfiguration. If set, the X-TIMESTAMP-MAP will be added as described in the HLS specification. For example, if set to 10 seconds, X-TIMESTAMP-MAP=MPEGTS:900000,LOCAL:00:00:00.000 will be added after each WEBVTT header. The default for ChunkedTextMuxing is that the X-TIMESTAMP-MAP will not be written. Important to note is that the default for startOffset for TsMuxings and ProgressiveTsMuxings is 10 seconds. If the output of this muxing is used for HLS together with video/audio streams using TsMuxings and ProgressiveTsMuxings, this value should be set to the same startOffset.

Responses

201Successful response.

defaultError response.