ComposePart interface

A single layer of a video compose operation see NorskTransform.videoCompose()

Signature:

export interface ComposePart<Pins>

Properties

Property	Type	Description
destRect	OffsetRect	The area within the destination picture to place this part of the composition. If a referenceResolution is specified, then this is within that coordinate system, otherwise this is taken to be within the coordinate system of the destination image
id?	string	(Optional) Optionally identify the part to enable transitions
opacity	number	Opacity multiplier of this overlay (where 0.0 is fully transparent and 1.0 is fully opaque)
pin	Pins	Input pin for this source
referenceResolution?	Resolution	(Optional) Optionally supply a reference resolution. This allows description of the composition in a desired coordinate system, e.g. a resolution of 100x100 can be specified to allow the source and destination areas to be described in percentage terms, or a notional resolution can be used that is independant of the source resolutions that may be provided. If unset, this will be overriden by a global reference resolution if that is present This is useful to set if you don’t know the input resolution of a part but want to be able to describe an operation on that part.
sourceRect	OffsetRect	The area within the source picture to include. This may be the full picture or cropped, and will be rescaled if necessary. If a referenceResolution is specified, then this is within that coordinate system, otherwise this is taken to be within the coordinate system of the input image
transition?	PartTransition	(Optional) Optionally specify a transition for this part. A transition is applied only if the part is specified in both the existing and the current/new configuration, identified by having the same id specified, and a transition is specified for the new configuration.
zIndex	number	Z-index to determine ordering by which the sources are overlaid (higher layers appear on top)

Property

Type

Description

destRect

OffsetRect

The area within the destination picture to place this part of the composition. If a referenceResolution is specified, then this is within that coordinate system, otherwise this is taken to be within the coordinate system of the destination image

id?

string

(Optional) Optionally identify the part to enable transitions

opacity

number

Opacity multiplier of this overlay (where 0.0 is fully transparent and 1.0 is fully opaque)

Pins

Input pin for this source

referenceResolution?

Resolution

(Optional) Optionally supply a reference resolution. This allows description of the composition in a desired coordinate system, e.g. a resolution of 100x100 can be specified to allow the source and destination areas to be described in percentage terms, or a notional resolution can be used that is independant of the source resolutions that may be provided.

If unset, this will be overriden by a global reference resolution if that is present

This is useful to set if you don’t know the input resolution of a part but want to be able to describe an operation on that part.

sourceRect

OffsetRect

The area within the source picture to include. This may be the full picture or cropped, and will be rescaled if necessary. If a referenceResolution is specified, then this is within that coordinate system, otherwise this is taken to be within the coordinate system of the input image

transition?

PartTransition

(Optional) Optionally specify a transition for this part. A transition is applied only if the part is specified in both the existing and the current/new configuration, identified by having the same id specified, and a transition is specified for the new configuration.

zIndex

number

Z-index to determine ordering by which the sources are overlaid (higher layers appear on top)