Class TextMuxing

Export

TextMuxing

Hierarchy (view full)

Constructors

constructor

Properties

avgBitrate? createdAt? customData? description? filename? id? ignoredBy? maxBitrate? minBitrate? modifiedAt? name? outputs? startOffset? streamConditionsMode? streams? type _discriminatorMapping _discriminatorName

Constructors

constructor

Properties

Optional avgBitrate

avgBitrate?: number

Average bitrate. Available after encoding finishes.

Memberof

Muxing

Optional createdAt

createdAt?: Date

Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

Optional customData

customData?: {
    [key: string]: any;
}

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

Optional description

description?: string

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

Memberof

BitmovinResource

Optional filename

filename?: string

Name of the output file (required)

Memberof

TextMuxing

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

Optional ignoredBy

ignoredBy?: Ignoring[]

This read-only property is set during the analysis step of the encoding. If it contains items, the Muxing has been ignored during the encoding process according to its 'streamConditionsMode'

Memberof

Muxing

Optional maxBitrate

maxBitrate?: number

Max bitrate. Available after encoding finishes.

Memberof

Muxing

Optional minBitrate

minBitrate?: number

Min bitrate. Available after encoding finishes.

Memberof

Muxing

Optional modifiedAt

modifiedAt?: Date

Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Memberof

BitmovinResource

Optional name

name?: string

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

Memberof

BitmovinResource

Optional outputs

outputs?: EncodingOutput[]

Memberof

Muxing

Optional startOffset

startOffset?: number

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 TextMuxing 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.

Memberof

TextMuxing

Optional streamConditionsMode

streamConditionsMode?: 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.

Memberof

Muxing

Optional streams

streams?: MuxingStream[]

Memberof

Muxing

Readonly type

type: MuxingType = MuxingType.TEXT

Discriminator property for Muxing

Memberof

TextMuxing

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    BROADCAST_TS: string;
    CHUNKED_TEXT: string;
    CMAF: string;
    FMP4: string;
    MP3: string;
    MP4: string;
    MXF: string;
    PACKED_AUDIO: string;
    PROGRESSIVE_MOV: string;
    PROGRESSIVE_TS: string;
    PROGRESSIVE_WAV: string;
    PROGRESSIVE_WEBM: string;
    SEGMENTED_RAW: string;
    TEXT: string;
    TS: string;
    WEBM: string;
} = ...

Type declaration

  • BROADCAST_TS: string
  • CHUNKED_TEXT: string
  • CMAF: string
  • FMP4: string
  • MP3: string
  • MP4: string
  • MXF: string
  • PACKED_AUDIO: string
  • PROGRESSIVE_MOV: string
  • PROGRESSIVE_TS: string
  • PROGRESSIVE_WAV: string
  • PROGRESSIVE_WEBM: string
  • SEGMENTED_RAW: string
  • TEXT: string
  • TS: string
  • WEBM: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructoravgBitratecreatedAtcustomDatadescriptionfilenameidignoredBymaxBitrateminBitratemodifiedAtnameoutputsstartOffsetstreamConditionsModestreamstype_discriminatorMapping_discriminatorName