ComposePart
Describe an individual part representing the contribution of one source to a composition.
Field |
Type |
Repeated |
Description |
pin |
Input pin for this source |
||
source_rect |
The area within the source picture to include. This may be the full picture or cropped, and will be rescaled if necessary. |
||
dest_rect |
The area within the destination picture to place this part of the composition. |
||
z_index |
Z-index to determine ordering by which the sources are overlaid (higher layers appear on top) |
||
opacity |
Opacity multiplier of this overlay (where 0.0 is fully transparent and 1.0 is fully opaque) |
||
id |
Optionally identify the part to enable transitions |
||
transition |
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. |
||
reference_resolution |
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 present |