Export

Stream

Hierarchy (view full)

Constructors

Properties

appliedSettings?: AppliedStreamSettings

Contains stream properties which may not have been defined in the configuration

Memberof

Stream

codecConfigId?: string

Id of the codec configuration (required)

Memberof

Stream

conditions?: AbstractCondition

Defines a condition that is evaluated against the input of the Stream. If the condition is not fulfilled, the Stream will be ignored during the encoding process. The 'streamConditionMode' of a Muxing allows to control how ignored Streams affect the Muxing. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored. See Stream Conditions for more information

Memberof

Stream

createQualityMetaData?: boolean

Set true to create quality metadata for this stream

Memberof

Stream

createdAt?: Date

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

Memberof

BitmovinResource

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

User-specific meta data. This can hold anything.

Type declaration

  • [key: string]: any

Memberof

BitmovinResource

decodingErrorMode?: DecodingErrorMode

Determines how to react to errors during decoding

Memberof

Stream

description?: string

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

Memberof

BitmovinResource

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

ignoredBy?: Ignoring[]

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

Memberof

Stream

inputStreams?: StreamInput[]

Determines the input source(s) for the stream. All video streams of an encoding need to have identical input configurations (required)

Memberof

Stream

metadata?: StreamMetadata

Memberof

Stream

mode?: StreamMode

Mode of the stream

Memberof

Stream

modifiedAt?: Date

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

Memberof

BitmovinResource

name?: string

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

Memberof

BitmovinResource

outputs?: EncodingOutput[]

Memberof

Stream

perTitleSettings?: StreamPerTitleSettings

Settings to configure Per-Title on stream level

Memberof

Stream

segmentsEncoded?: number

Number of encoded segments. Available after encoding finishes.

Memberof

Stream

selectedEncodingMode?: EncodingMode

The encoding mode that was used for this stream. This is derived from encodingMode, which can be specified in the codec configuration or in the encoding start request. Note that all streams of an encoding need to use the same encoding mode. This will therefore always match selectedEncodingMode of the related Encoding resource. Especially useful when encodingMode was not set explicitly or set to STANDARD (which translates to one of the other possible values on encoding start).

Memberof

Stream