Class SidecarFile

A file that is added to an encoding. The size limit for a sidecar file is 10 MB

Export

SidecarFile

Hierarchy (view full)

Constructors

constructor

Properties

createdAt? customData? description? errorMode? id? inputId? inputPath? modifiedAt? name? outputs? _discriminatorMapping _discriminatorName

Constructors

constructor

Properties

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 errorMode

errorMode?: SidecarErrorMode

This defines how errors should be handled

Memberof

SidecarFile

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

Optional inputId

inputId?: string

Id of input (required)

Memberof

SidecarFile

Optional inputPath

inputPath?: string

Path to sidecar file (required)

Memberof

SidecarFile

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

SidecarFile

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    WEB_VTT: string;
} = ...

Type declaration

  • WEB_VTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcustomDatadescriptionerrorModeidinputIdinputPathmodifiedAtnameoutputs_discriminatorMapping_discriminatorName