Create VP9 Codec Configuration

post

https://api.bitmovin.com/v1/encoding/configurations/video/vp9

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The VP9 Codec Configuration to be created

name

string

required

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

description

string

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

customData

string

User-specific meta data. This can hold anything.

width

integer

Width of the encoded video in pixels

height

integer

Height of the encoded video in pixels

bitrate

int64

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

rate

double

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

pixelFormat

string

enum

Defaults to YUV420P

The pixel format to be set

colorConfig

object

sampleAspectRatioNumerator

integer

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.

sampleAspectRatioDenominator

integer

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.

displayAspectRatio

object

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.

encodingMode

string

enum

Defaults to STANDARD

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

Allowed:

presetConfiguration

string

enum

dynamicRangeFormat

string

enum

Configures what kind of dynamic range the output should conform to. Can be used to convert from SDR to HLG, from HLG to SDR.

Allowed:

crf

integer

0 to 63

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

lagInFrames

integer

0 to 25

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

errorResiliencyEnabled

boolean

Enables error resiliency feature

tileColumns

integer

0 to 6

Defaults to 0

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.

tileRows

integer

0 to 2

Defaults to 0

Number of tile rows to use, log2.

frameParallel

boolean

Defaults to false

Enable frame parallel decodability features

maxIntraRate

int64

Maximum I-frame bitrate (percentage) 0=unlimited

qpMin

integer

0 to 63

Defaults to 0

Minimum quantization factor.

qpMax

integer

0 to 63

Defaults to 63

Maximum quantization factor.

rateUndershootPct

integer

0 to 100

Defaults to 25

Datarate undershoot (min) target (percentage).

rateOvershootPct

integer

0 to 100

Defaults to 25

Datarate overshoot (max) target (percentage).

clientBufferSize

int64

≥ 0

Client buffer size (ms)

clientInitialBufferSize

int64

≥ 0

Client initial buffer size (ms)

biasPct

integer

0 to 100

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

noiseSensitivity

boolean

Enable noise sensitivity on Y channel

cpuUsed

integer

1 to 8

Defaults to 1

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.

automaticAltRefFramesEnabled

boolean

Enable automatic alternate reference frames (2pass only)

targetLevel

integer

0 to 255

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

rowMultiThreadingEnabled

boolean

Enable row based non-deterministic multi-threading

sharpness

integer

0 to 7

deprecated

Loop filter sharpness.

minGop

integer

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

maxGop

integer

Maximum GOP length, the maximum distance between I-frames

minKeyframeInterval

double

Minimum interval in seconds between key frames

maxKeyframeInterval

double

Maximum interval in seconds between key frames

quality

string

enum

Defaults to GOOD

Determines quality for the price of speed.

Allowed:

lossless

boolean

Lossless mode

staticThresh

integer

≥ 0

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

aqMode

string

enum

Defaults to NONE

Adaptive quantization mode.

Allowed:

arnrMaxFrames

integer

0 to 15

Defaults to 0

altref noise reduction max frame count.

arnrStrength

integer

0 to 6

Defaults to 3

altref noise reduction filter strength.

arnrType

string

enum

Defaults to CENTERED

altref noise reduction filter type

Allowed:

autoLevelSetup

string

enum

Defaults to ENABLED

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.

Allowed:

Responses

201Successful response.

defaultError response.