VideoEncodeRung interface

A single rung in a video encode ladder see: NorskTransform.videoEncode()

Signature:

export interface VideoEncodeRung

Properties

Property	Type	Description
codec	X264Codec \| X265Codec \| NvidiaH264 \| NvidiaHevc \| LoganH264 \| LoganHevc \| QuadraH264 \| QuadraHevc \| QuadraAv1 \| AmdU30H264 \| AmdU30Hevc \| AmdMA35DH264 \| AmdMA35DHevc \| AmdMA35DAv1	The codec (and detailed configuration) to use for the encoding operation. Note: Nvidia, Logan/Quadra, AmdU30, AmdMA35D require the appropriate hardware to be set up and made available to Norsk A ladder can use several different codecs across its various rungs and the VideoEncode node will attempt to build a pipeline that uses the hardware efficently
consistentGops?	boolean	(Optional) Arrange for gops to be created in a consistent manner across multiple encoders; used for primary/backup systems so that HLS/DASH outputs have consistent segmentation to enable seamless player switching. If you want this, then you should set this to 'true' for every run that is being used in your ABR ladder; rungs not used in the ladder can be left as false (or unset, which defaults to false). For rungs where consistentGops is true there are some restrictions: - gop sizes must be set and fixed, and must all be equal or be integral multiples of each other - frame rates must either be all left undefined (in which case source frame rate is used), or must all be set and, as with the gop size, they can be different but if they are they must be integral multiples.
frameRate?	FrameRate	(Optional) Optionally change the frameRate for this rendition This can be useful if the input is 50FPS for example and some lower rungs need to be 25fps Note: If you wish to apply the same frame rate across all rungs, it is more efficient to use a single VideoTransformNode before the ladder created with NorskTransform.videoTransform() and leave this value undefined
height	number	The height of the outgoing video resolution
name	string	The name of this rung, this should be unique across the ladder and will end up in the renditionName of the outgoing StreamKey
pipelineHints?	QuadraPipelineHints	(Optional) Extra options for influencing how the ladder gets constructed and what algorithms get used for certain operations
sar?	SampleAspectRatio	(Optional) Specifies the input video’s Sample Aspect Ratio (SAR) to be used by the encoder in width:height
width	number	The width of the outgoing video resolution

Property

Type

Description

codec

The codec (and detailed configuration) to use for the encoding operation.

Note: Nvidia, Logan/Quadra, AmdU30, AmdMA35D require the appropriate hardware to be set up and made available to Norsk

A ladder can use several different codecs across its various rungs and the VideoEncode node will attempt to build a pipeline that uses the hardware efficently

consistentGops?

boolean

(Optional) Arrange for gops to be created in a consistent manner across multiple encoders; used for primary/backup systems so that HLS/DASH outputs have consistent segmentation to enable seamless player switching. If you want this, then you should set this to 'true' for every run that is being used in your ABR ladder; rungs not used in the ladder can be left as false (or unset, which defaults to false). For rungs where consistentGops is true there are some restrictions: - gop sizes must be set and fixed, and must all be equal or be integral multiples of each other - frame rates must either be all left undefined (in which case source frame rate is used), or must all be set and, as with the gop size, they can be different but if they are they must be integral multiples.

frameRate?

FrameRate

(Optional) Optionally change the frameRate for this rendition This can be useful if the input is 50FPS for example and some lower rungs need to be 25fps

Note: If you wish to apply the same frame rate across all rungs, it is more efficient to use a single VideoTransformNode before the ladder created with NorskTransform.videoTransform() and leave this value undefined

height

number

The height of the outgoing video resolution

name

string

The name of this rung, this should be unique across the ladder and will end up in the renditionName of the outgoing StreamKey

pipelineHints?

QuadraPipelineHints

(Optional) Extra options for influencing how the ladder gets constructed and what algorithms get used for certain operations

sar?

SampleAspectRatio

(Optional) Specifies the input video’s Sample Aspect Ratio (SAR) to be used by the encoder in width:height