VideoComposeConfiguration

Field

Type

Description

id

MediaNodeId

The Media Node Id

reference_stream

string

Required. Stream key 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.

parts

ComposePart

The parts (images/overlays) to include in the composition

reference_resolution

Resolution

Optionally supply a fallback 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 set here, this reference resolution will be applied to any parts that do not have their own reference resolution specified

If not provided the source and destination rectangles are in terms of the source and output resolutions respectively.

output_resolution

Resolution

The resolution of the output video

output_pixel_format

VideoComposeConfiguration.PixelFormat

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

missing_stream_behaviour

VideoComposeConfiguration.MissingStreamBehaviour

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.

hardware_acceleration

VideoComposeConfiguration.ComposeHardwareAcceleration