H264Layer interface

  • Reference
Package:
@azure/arm-mediaservices

Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.264 video codec.

Extends
VideoLayer

Properties

bufferWindow

The VBV buffer window length. The value should be in ISO 8601 format. The value should be in the range [0.1-100] seconds. The default is 5 seconds (for example, PT5S).
crf

The value of CRF to be used when encoding this layer. This setting takes effect when RateControlMode of video codec is set at CRF mode. The range of CRF value is between 0 and 51, where lower values would result in better quality, at the expense of higher file sizes. Higher values mean more compression, but at some point quality degradation will be noticed. Default value is 23.
entropyMode

The entropy mode to be used for this layer. If not specified, the encoder chooses the mode that is appropriate for the profile and level.
level

We currently support Level up to 6.2. The value can be Auto, or a number that matches the H.264 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer.
profile

We currently support Baseline, Main, High, High422, High444. Default is Auto.
referenceFrames

The number of reference frames to be used when encoding this layer. If not specified, the encoder determines an appropriate number based on the encoder complexity setting.

Inherited Properties

adaptiveBFrame

Whether or not adaptive B-frames are to be used when encoding this layer. If not specified, the encoder will turn it on whenever the video profile permits its use.
bFrames

The number of B-frames to be used when encoding this layer. If not specified, the encoder chooses an appropriate number based on the video profile and level.
bitrate

The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field.
frameRate

The frame rate (in frames per second) at which to encode this layer. The value can be in the form of M/N where M and N are integers (For example, 30000/1001), or in the form of a number (For example, 30, or 29.97). The encoder enforces constraints on allowed frame rates based on the profile and level. If it is not specified, the encoder will use the same frame rate as the input video.
height

The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input.
label

The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file.
maxBitrate

The maximum bitrate (in bits per second), at which the VBV buffer should be assumed to refill. If not specified, defaults to the same value as bitrate.
slices

The number of slices to be used when encoding this layer. If not specified, default is zero, which means that encoder will use a single slice for each frame.
width

The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input.

Property Details

bufferWindow

The VBV buffer window length. The value should be in ISO 8601 format. The value should be in the range [0.1-100] seconds. The default is 5 seconds (for example, PT5S).

bufferWindow?: string

Property Value

string

crf

The value of CRF to be used when encoding this layer. This setting takes effect when RateControlMode of video codec is set at CRF mode. The range of CRF value is between 0 and 51, where lower values would result in better quality, at the expense of higher file sizes. Higher values mean more compression, but at some point quality degradation will be noticed. Default value is 23.

crf?: number

Property Value

number

entropyMode

The entropy mode to be used for this layer. If not specified, the encoder chooses the mode that is appropriate for the profile and level.

entropyMode?: string

Property Value

string

level

We currently support Level up to 6.2. The value can be Auto, or a number that matches the H.264 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer.

level?: string

Property Value

string

profile

We currently support Baseline, Main, High, High422, High444. Default is Auto.

profile?: string

Property Value

string

referenceFrames

The number of reference frames to be used when encoding this layer. If not specified, the encoder determines an appropriate number based on the encoder complexity setting.

referenceFrames?: number

Property Value

number

Inherited Property Details

adaptiveBFrame

Whether or not adaptive B-frames are to be used when encoding this layer. If not specified, the encoder will turn it on whenever the video profile permits its use.

adaptiveBFrame?: boolean

Property Value

boolean

Inherited From VideoLayer.adaptiveBFrame

bFrames

The number of B-frames to be used when encoding this layer. If not specified, the encoder chooses an appropriate number based on the video profile and level.

bFrames?: number

Property Value

number

Inherited From VideoLayer.bFrames

bitrate

The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field.

bitrate: number

Property Value

number

Inherited From VideoLayer.bitrate

frameRate

The frame rate (in frames per second) at which to encode this layer. The value can be in the form of M/N where M and N are integers (For example, 30000/1001), or in the form of a number (For example, 30, or 29.97). The encoder enforces constraints on allowed frame rates based on the profile and level. If it is not specified, the encoder will use the same frame rate as the input video.

frameRate?: string

Property Value

string

Inherited From VideoLayer.frameRate

height

The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input.

height?: string

Property Value

string

Inherited From VideoLayer.height

label

The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file.

label?: string

Property Value

string

Inherited From VideoLayer.label

maxBitrate

The maximum bitrate (in bits per second), at which the VBV buffer should be assumed to refill. If not specified, defaults to the same value as bitrate.

maxBitrate?: number

Property Value

number

Inherited From VideoLayer.maxBitrate

slices

The number of slices to be used when encoding this layer. If not specified, default is zero, which means that encoder will use a single slice for each frame.

slices?: number

Property Value

number

Inherited From VideoLayer.slices

width

The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input.

width?: string

Property Value

string

Inherited From VideoLayer.width