ComposePart interface

Signature:

export interface ComposePart<Pins>

Properties

Property Type Description

compose

<Pins extends string>(partStream: VideoStreamMetadata, settings: VideoComposeSettings<Pins>) ⇒ ComposeOperation

A callback that produces a compose operation, specifying in exact pixels a) The source rect from the source video to select b) The dest rect within the output video to render to

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

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)