Share via

VideoLayer interface

  • Reference
Package:
@azure/arm-mediaservices

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

Extends
Layer

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.
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.

Inherited Properties

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.
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

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

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

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

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

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

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 Property Details

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 Layer.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 Layer.label

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 Layer.width