Class Vp9VideoConfiguration

Export

Vp9VideoConfiguration

Hierarchy (view full)

Constructors

constructor

Properties

aqMode? arnrMaxFrames? arnrStrength? arnrType? autoLevelSetup? automaticAltRefFramesEnabled? biasPct? bitrate? clientBufferSize? clientInitialBufferSize? colorConfig? cpuUsed? createdAt? crf? customData? description? displayAspectRatio? dynamicRangeFormat? encodingMode? errorResiliencyEnabled? frameParallel? height? id? lagInFrames? lossless? maxGop? maxIntraRate? maxKeyframeInterval? minGop? minKeyframeInterval? modifiedAt? name? noiseSensitivity? pixelFormat? presetConfiguration? qpMax? qpMin? quality? rate? rateOvershootPct? rateUndershootPct? rowMultiThreadingEnabled? sampleAspectRatioDenominator? sampleAspectRatioNumerator? sharpness? staticThresh? targetLevel? tileColumns? tileRows? type width? _discriminatorMapping _discriminatorName

Constructors

constructor

Properties

Optional aqMode

aqMode?: Vp9AqMode

Memberof

Vp9VideoConfiguration

Optional arnrMaxFrames

arnrMaxFrames?: number

altref noise reduction max frame count.

Memberof

Vp9VideoConfiguration

Optional arnrStrength

arnrStrength?: number

altref noise reduction filter strength.

Memberof

Vp9VideoConfiguration

Optional arnrType

arnrType?: Vp9ArnrType

Memberof

Vp9VideoConfiguration

Optional autoLevelSetup

autoLevelSetup?: AutoLevelSetup

Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting rateOvershootPct, or clientBufferSize properties will disable the automatic calculation.

Memberof

Vp9VideoConfiguration

Optional automaticAltRefFramesEnabled

automaticAltRefFramesEnabled?: boolean

Enable automatic alternate reference frames (2pass only)

Memberof

Vp9VideoConfiguration

Optional biasPct

biasPct?: number

CBR/VBR bias (0=CBR, 100=VBR)

Memberof

Vp9VideoConfiguration

Optional bitrate

bitrate?: number

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

Memberof

VideoConfiguration

Optional clientBufferSize

clientBufferSize?: number

Client buffer size (ms)

Memberof

Vp9VideoConfiguration

Optional clientInitialBufferSize

clientInitialBufferSize?: number

Client initial buffer size (ms)

Memberof

Vp9VideoConfiguration

Optional colorConfig

colorConfig?: ColorConfig

Memberof

VideoConfiguration

Optional cpuUsed

cpuUsed?: number

Controls the tradeoff between compression efficiency and encoding speed. Higher values indicate a faster encoding. The minimum value for width * height >= 1280 * 720 is 2. If the value is too low it will be overridden.

Memberof

Vp9VideoConfiguration

Optional createdAt

createdAt?: Date

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

Memberof

BitmovinResource

Optional crf

crf?: number

Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.

Memberof

Vp9VideoConfiguration

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 dynamicRangeFormat

dynamicRangeFormat?: Vp9DynamicRangeFormat

Automatically configures the VP9 Video Codec to be compatible with the given SDR/HLG format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results. Explicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.

Memberof

Vp9VideoConfiguration

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 errorResiliencyEnabled

errorResiliencyEnabled?: boolean

Enables error resiliency feature

Memberof

Vp9VideoConfiguration

Optional frameParallel

frameParallel?: boolean

Enable frame parallel decodability features

Memberof

Vp9VideoConfiguration

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 lagInFrames

lagInFrames?: number

Number of frames to look ahead for alternate reference frame selection.

Memberof

Vp9VideoConfiguration

Optional lossless

lossless?: boolean

Lossless mode

Memberof

Vp9VideoConfiguration

Optional maxGop

maxGop?: number

Maximum GOP length, the maximum distance between I-frames

Memberof

Vp9VideoConfiguration

Optional maxIntraRate

maxIntraRate?: number

Maximum I-frame bitrate (percentage) 0=unlimited

Memberof

Vp9VideoConfiguration

Optional maxKeyframeInterval

maxKeyframeInterval?: number

Maximum interval in seconds between key frames

Memberof

Vp9VideoConfiguration

Optional minGop

minGop?: number

Minimum GOP length, the minimum distance between I-frames.

Memberof

Vp9VideoConfiguration

Optional minKeyframeInterval

minKeyframeInterval?: number

Minimum interval in seconds between key frames

Memberof

Vp9VideoConfiguration

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 noiseSensitivity

noiseSensitivity?: boolean

Enable noise sensitivity on Y channel

Memberof

Vp9VideoConfiguration

Optional pixelFormat

pixelFormat?: PixelFormat

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

Memberof

VideoConfiguration

Optional presetConfiguration

presetConfiguration?: PresetConfiguration

Choose from a set of preset configurations tailored for common use cases. Check out VP9 Presets to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset's value for that property.

Memberof

Vp9VideoConfiguration

Optional qpMax

qpMax?: number

Maximum quantization factor.

Memberof

Vp9VideoConfiguration

Optional qpMin

qpMin?: number

Minimum quantization factor.

Memberof

Vp9VideoConfiguration

Optional quality

quality?: Vp9Quality

Memberof

Vp9VideoConfiguration

Optional rate

rate?: number

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

Memberof

VideoConfiguration

Optional rateOvershootPct

rateOvershootPct?: number

Datarate overshoot (max) target (percentage).

Memberof

Vp9VideoConfiguration

Optional rateUndershootPct

rateUndershootPct?: number

Datarate undershoot (min) target (percentage).

Memberof

Vp9VideoConfiguration

Optional rowMultiThreadingEnabled

rowMultiThreadingEnabled?: boolean

Enable row based non-deterministic multi-threading

Memberof

Vp9VideoConfiguration

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 sharpness

sharpness?: number

Loop filter sharpness.

Memberof

Vp9VideoConfiguration

Optional staticThresh

staticThresh?: number

A change threshold on blocks below which they will be skipped by the encoder.

Memberof

Vp9VideoConfiguration

Optional targetLevel

targetLevel?: number

Target level (255: off, 0: only keep level stats; 10: level 1.0; 11: level 1.1; ... 62: level 6.2)

Memberof

Vp9VideoConfiguration

Optional tileColumns

tileColumns?: number

Number of tile columns to use, log2. Depending on the encoding width there are limitations on this value. The minimum values are 2 for width >= 1920 and 1 for width >= 1280. The minimum width of each tile is 256 pixels so the maximum values are 0 for width < 256, 1 for width < 512, 2 for width < 1024, 3 for width < 2048, 4 for width < 4096, 5 for width < 8192. If the value is too high or too low it will be overridden.

Memberof

Vp9VideoConfiguration

Optional tileRows

tileRows?: number

Number of tile rows to use, log2.

Memberof

Vp9VideoConfiguration

Readonly type

type: CodecConfigType = CodecConfigType.VP9

Discriminator property for CodecConfiguration

Memberof

Vp9VideoConfiguration

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

constructoraqModearnrMaxFramesarnrStrengtharnrTypeautoLevelSetupautomaticAltRefFramesEnabledbiasPctbitrateclientBufferSizeclientInitialBufferSizecolorConfigcpuUsedcreatedAtcrfcustomDatadescriptiondisplayAspectRatiodynamicRangeFormatencodingModeerrorResiliencyEnabledframeParallelheightidlagInFrameslosslessmaxGopmaxIntraRatemaxKeyframeIntervalminGopminKeyframeIntervalmodifiedAtnamenoiseSensitivitypixelFormatpresetConfigurationqpMaxqpMinqualityraterateOvershootPctrateUndershootPctrowMultiThreadingEnabledsampleAspectRatioDenominatorsampleAspectRatioNumeratorsharpnessstaticThreshtargetLeveltileColumnstileRowstypewidth_discriminatorMapping_discriminatorName