Create H264/AVC Codec Configuration

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The H264/AVC 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

Ouput should be in Standard Definition Range (SDR).

Allowed:

crf

double

0 to 51

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

profile

string

enum

required

Defaults to BASELINE

When setting a profile, all other settings must not exceed the limits which are defined in the profile. Otherwise, a higher profile may be automatically chosen.

Allowed:

bframes

integer

0 to 16

Defaults to 3

Amount of b frames

refFrames

integer

1 to 16

Defaults to 5

Amount of reference frames.

qpMin

integer

0 to 69

Minimum quantization factor

qpMax

integer

0 to 69

Maximum quantization factor

mvPredictionMode

string

enum

Defaults to AUTO

Motion vector prediction mode

Allowed:

mvSearchRangeMax

integer

16 to 24

Defaults to 16

Maximum motion vector search range

cabac

boolean

Defaults to true

Enable or disable CABAC

maxBitrate

int64

Maximum Bitrate (bps)

minBitrate

int64

Minimum Bitrate (bps)

bufsize

int64

Playback device buffer size (bits)

minGop

integer

Minimum GOP length, the minimum distance between I-frames

maxGop

integer

Maximum GOP length, the maximum distance between I-frames

openGop

boolean

Enable open-gop, allows referencing frames from a previous gop

minKeyframeInterval

double

Minimum interval in seconds between key frames

maxKeyframeInterval

double

Maximum interval in seconds between key frames

level

string

enum

Defaults to L1

Specified set of constraints that indicate a degree of required decoder performance for a profile, see: https://en.wikipedia.org/wiki/H.264/MPEG-4_AVC#Levels

bAdaptiveStrategy

string

enum

Defaults to FULL

Allowed:

motionEstimationMethod

string

enum

Defaults to UMH

Integer pixel motion estimation method

Allowed:

rcLookahead

integer

0 to 250

Defaults to 50

Number of frames for frame-type decision lookahead

subMe

string

enum

Defaults to RD_REF_IP

Subpixel motion estimation and mode decision

trellis

string

enum

Defaults to ENABLED_FINAL_MB

Enables or disables Trellis quantization. NOTE: This requires cabac

Allowed:

partitions

array of objects

Partitions to consider. Analyzing more partition options improves quality at the cost of speed.

partitions

Allowed:

slices

integer

1 to 45

Number of slices per frame.

interlaceMode

string

enum

Defaults to NONE

Using TOP_FIELD_FIRST or BOTTOM_FIELD_FIRST will output interlaced video

Allowed:

sceneCutThreshold

integer

0 to 100

Scene change sensitivity. The higher the value, the more likely an I-frame will be inserted. Set to 0 to disable it which is advised for scenarios where fixed GOP is required, e.g., adaptive streaming outputs like DASH, HLS and Smooth. Having this setting enabled can improve quality for progressive output with an increased internal chunk length (see internalChunkLength of muxings).

nalHrd

string

enum

Defaults to NONE

Signal hypothetical reference decoder (HRD) information (requires bufsize to be set)

Allowed:

bPyramid

string

enum

Defaults to NORMAL

Keep some B-frames as references

Allowed:

cea608708SubtitleConfig

object

Defines whether CEA 608/708 subtitles are copied from the input video stream

deblockAlpha

integer

Strength of the in-loop deblocking filter. Higher values deblock more effectively but also soften the image

deblockBeta

integer

Threshold of the in-loop deblocking filter. Higher values apply deblocking stronger on non flat blocks, lower values on flat blocks

adaptiveQuantizationMode

string

enum

Defaults to VARIANCE

Allowed:

adaptiveQuantizationStrength

double

Values greater than 1 reduce blocking and blurring in flat and textured areas. Values less than 1 reduces ringing artifacts at the cost of more banding artifacts. Negative values are not allowed

mixedReferences

boolean

Allow references on a per partition basis, rather than per-macroblock basis

adaptiveSpatialTransform

boolean

Enables adaptive spatial transform (high profile 8x8 transform)

fastSkipDetectionPFrames

boolean

Enables fast skip detection on P-frames. Disabling this very slightly increases quality but at a large speed loss

weightedPredictionBFrames

boolean

Enable open-gop, allows referencing frames from a previous gop

weightedPredictionPFrames

string

enum

Defaults to SMART

Defines the mode for weighted prediction for P-frames

Allowed:

macroblockTreeRatecontrol

boolean

Enable macroblock tree ratecontrol. Macroblock tree rate control tracks how often blocks of the frame are used for prediciting future frames

quantizerCurveCompression

double

Ratio between constant bitrate (0.0) and constant quantizer (1.0). Valid range 0.0 - 1.0

psyRateDistortionOptimization

double

Psychovisual Rate Distortion retains fine details like film grain at the expense of more blocking artifacts. Higher values make the video appear sharper and more detailed but with a higher risk of blocking artifacts. Needs to have subMe with RD_IP, RD_ALL, RD_REF_IP or RD_REF_ALL

psyTrellis

double

Higher values will improve sharpness and detail retention but might come at costs of artifacts. Needs to have trellis enabled

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.