Class VideoConfiguration

Export

VideoConfiguration

Hierarchy (view full)

Constructors

constructor

Properties

bitrate? colorConfig? createdAt? customData? description? displayAspectRatio? encodingMode? height? id? modifiedAt? name? pixelFormat? rate? sampleAspectRatioDenominator? sampleAspectRatioNumerator? width? _discriminatorMapping _discriminatorName

Constructors

constructor

Properties

Optional bitrate

bitrate?: number

Target bitrate for the encoded video in bps. Either bitrate or crf is required.

Memberof

VideoConfiguration

Optional colorConfig

colorConfig?: ColorConfig

Memberof

VideoConfiguration

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 displayAspectRatio

displayAspectRatio?: DisplayAspectRatio

Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.

Memberof

VideoConfiguration

Optional encodingMode

encodingMode?: EncodingMode

The mode of the encoding. When this is set, encodingMode (liveEncodingMode) must not be set in the (live) encoding start request.

Memberof

VideoConfiguration

Optional height

height?: number

Height of the encoded video in pixels

Memberof

VideoConfiguration

Optional id

id?: string

Id of the resource (required)

Memberof

BitmovinResponse

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 pixelFormat

pixelFormat?: PixelFormat

Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.

Memberof

VideoConfiguration

Optional rate

rate?: number

Target frame rate of the encoded video. Must be set for live encodings

Memberof

VideoConfiguration

Optional sampleAspectRatioDenominator

sampleAspectRatioDenominator?: number

The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.

Memberof

VideoConfiguration

Optional sampleAspectRatioNumerator

sampleAspectRatioNumerator?: number

The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.

Memberof

VideoConfiguration

Optional width

width?: number

Width of the encoded video in pixels

Memberof

VideoConfiguration

Static Protected Readonly _discriminatorMapping

_discriminatorMapping: {
    AAC: string;
    AC3: string;
    AUDIO_PASSTHROUGH: string;
    AV1: string;
    DD: string;
    DDPLUS: string;
    DOLBY_ATMOS: string;
    DTS: string;
    DTSX: string;
    DTS_PASSTHROUGH: string;
    DVB_SUBTITLE: string;
    EAC3: string;
    H262: string;
    H264: string;
    H265: string;
    HE_AAC_V1: string;
    HE_AAC_V2: string;
    IMSC: string;
    MJPEG: string;
    MP2: string;
    MP3: string;
    OPUS: string;
    PCM: string;
    VORBIS: string;
    VP8: string;
    VP9: string;
    WEBVTT: string;
} = ...

Type declaration

  • AAC: string
  • AC3: string
  • AUDIO_PASSTHROUGH: string
  • AV1: string
  • DD: string
  • DDPLUS: string
  • DOLBY_ATMOS: string
  • DTS: string
  • DTSX: string
  • DTS_PASSTHROUGH: string
  • DVB_SUBTITLE: string
  • EAC3: string
  • H262: string
  • H264: string
  • H265: string
  • HE_AAC_V1: string
  • HE_AAC_V2: string
  • IMSC: string
  • MJPEG: string
  • MP2: string
  • MP3: string
  • OPUS: string
  • PCM: string
  • VORBIS: string
  • VP8: string
  • VP9: string
  • WEBVTT: string

Static Protected Readonly _discriminatorName

_discriminatorName: "type" = 'type'

Settings

Member Visibility

Theme

On This Page

constructorbitratecolorConfigcreatedAtcustomDatadescriptiondisplayAspectRatioencodingModeheightidmodifiedAtnamepixelFormatratesampleAspectRatioDenominatorsampleAspectRatioNumeratorwidth_discriminatorMapping_discriminatorName