@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
47 lines (46 loc) • 2.61 kB
TypeScript
import Muxing from './Muxing';
import MuxingType from './MuxingType';
/**
* @export
* @class ChunkedTextMuxing
*/
export declare class ChunkedTextMuxing extends Muxing {
/**
* Discriminator property for Muxing
* @type {string}
* @memberof ChunkedTextMuxing
*/
readonly type: MuxingType;
/**
* Length of the segments in seconds (required)
* @type {number}
* @memberof ChunkedTextMuxing
*/
segmentLength?: number;
/**
* Segment naming policy
* @type {string}
* @memberof ChunkedTextMuxing
*/
segmentNaming?: 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.
* @type {string}
* @memberof ChunkedTextMuxing
*/
segmentNamingTemplate?: string;
/**
* 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`.
* @type {number}
* @memberof ChunkedTextMuxing
*/
startOffset?: number;
/**
* Number of segments which have been encoded
* @type {number}
* @memberof ChunkedTextMuxing
*/
segmentsMuxed?: number;
constructor(obj?: Partial<ChunkedTextMuxing>);
}
export default ChunkedTextMuxing;