BitmovinApiSdk\Models\ChunkedTextMuxing
Synopsis
class ChunkedTextMuxing
extends Muxing
{
- // members
- public float $segmentLength;
- public string $segmentNaming;
- public string $segmentNamingTemplate;
- public int $startOffset;
- public int $segmentsMuxed;
- // Inherited members from Muxing
- public array $streams;
- public array $outputs;
- public int $avgBitrate;
- public int $minBitrate;
- public int $maxBitrate;
- public array $ignoredBy;
- public StreamConditionsMode $streamConditionsMode;
- public static string $discriminatorName;
- public static array $discriminatorMapping;
- // Inherited members from BitmovinResource
- public string $name;
- public string $description;
- public Carbon $createdAt;
- public Carbon $modifiedAt;
- public mixed $customData;
- // Inherited members from BitmovinResponse
- public string $id;
- // methods
- public void __construct()
- public $this segmentLength()
- public $this segmentNaming()
- public $this segmentNamingTemplate()
- public $this startOffset()
- // Inherited methods from Muxing
- public void __construct()
- public $this streams()
- public $this outputs()
- public $this streamConditionsMode()
- // Inherited methods from BitmovinResource
- public void __construct()
- public $this name()
- public $this description()
- public $this customData()
- // Inherited methods from BitmovinResponse
- public void __construct()
- // Inherited methods from ApiResource
- public void __construct()
- public static $this create()
- public void toArray()
Hierarchy
Extends
Members
public
- $avgBitrate — int
- $createdAt — Carbon\Carbon
- $customData — mixed
- $description — string
- $discriminatorMapping
- $discriminatorName
- $id — string
- $ignoredBy — \BitmovinApiSdk\Models\Ignoring[]
- $maxBitrate — int
- $minBitrate — int
- $modifiedAt — Carbon\Carbon
- $name — string
- $outputs — \BitmovinApiSdk\Models\EncodingOutput[]
- $segmentLength — float
- $segmentNaming — string
- $segmentNamingTemplate — string
- $segmentsMuxed — int
- $startOffset — int
- $streamConditionsMode — BitmovinApiSdk\Models\StreamConditionsMode
- $streams — \BitmovinApiSdk\Models\MuxingStream[]
Methods
public
- __construct()
- segmentLength() — Length of the segments in seconds (required)
- segmentNaming() — Segment naming policy
- segmentNamingTemplate() — 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() — Offset of MPEG-TS timestamps in seconds. This only affects streams with [WebVttConfiguration](#/Encoding/PostEncodingConfigurationsSubtitlesWebVtt). If set, the X-TIMESTAMP-MAP will be added as described in the [HLS specification](https://datatracker.ietf.org/doc/html/rfc8216#section-3.5). 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](#/Encoding/PostEncodingEncodingsMuxingsTsByEncodingId) and [ProgressiveTsMuxings](#/Encoding/PostEncodingEncodingsMuxingsProgressiveTsByEncodingId) 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`.
Inherited from BitmovinApiSdk\Models\Muxing
public
- outputs() — outputs
- streamConditionsMode() — 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.
- streams() — streams
Inherited from BitmovinApiSdk\Models\BitmovinResource
public
- customData() — User-specific meta data. This can hold anything.
- description() — Description of the resource. Can be freely chosen by the user.
- name() — Name of the resource. Can be freely chosen by the user.