VideoComposeSettings interface

Signature:

export interface VideoComposeSettings<Pins extends string> extends ProcessorNodeSettings<VideoComposeNode<Pins>>

Extends: ProcessorNodeSettings<VideoComposeNode<Pins>>

Properties

Property	Type	Description
hardwareAcceleration?	ComposeHardwareAcceleration	(Optional) Optionally attempt to perform the compose operation on hardware
missingStreamBehaviour?	ComposeMissingStreamBehaviour	(Optional) Behaviour in the case of a missing stream used in an active composition part. Note that this does not apply to the reference stream, but to every part which does not use the reference stream, whether at startup or on context change. Missing means not present in the context or never having sent a frame.
onTransitionComplete?	() ⇒ void	(Optional) Called when the transitions specified in the last config update have completed (in the case of multiple parts with specified transitions of different duration, this means that the last remaining transitions have completed
outputPixelFormat?	PixelFormat	(Optional) Output pixel format to use. If not specified, this will be chosen automatically based on the sources present in the initial composition
outputResolution	Resolution	The resolution of the output video
parts	readonly (ComposePart<Pins>)[]	The parts (images/overlays) to include in the composition The functions provided here will be invoked when source contexts arrive so that pixel-based configuration can be generated see
referenceStream	Pins	Required. Pin name of the reference stream. This is the video stream which defines the output frame timing, which will typically be part of the composition, e.g. the main picture in the case of a simple overlay/picture-in-picture, or the top left quadrant of a 4-way split screen.

Property

Type

Description

hardwareAcceleration?

ComposeHardwareAcceleration

(Optional) Optionally attempt to perform the compose operation on hardware

missingStreamBehaviour?

ComposeMissingStreamBehaviour

(Optional) Behaviour in the case of a missing stream used in an active composition part. Note that this does not apply to the reference stream, but to every part which does not use the reference stream, whether at startup or on context change.

Missing means not present in the context or never having sent a frame.

onTransitionComplete?

() ⇒ void

(Optional) Called when the transitions specified in the last config update have completed (in the case of multiple parts with specified transitions of different duration, this means that the last remaining transitions have completed

outputPixelFormat?

PixelFormat

(Optional) Output pixel format to use. If not specified, this will be chosen automatically based on the sources present in the initial composition

outputResolution

Resolution

The resolution of the output video

parts

readonly (ComposePart<Pins>)[]

The parts (images/overlays) to include in the composition The functions provided here will be invoked when source contexts arrive so that pixel-based configuration can be generated see

referenceStream

Pins

Required. Pin name of the reference stream. This is the video stream which defines the output frame timing, which will typically be part of the composition, e.g. the main picture in the case of a simple overlay/picture-in-picture, or the top left quadrant of a 4-way split screen.