VideoComposeConfiguration
Configure a Compose Media Node.
Field |
Type |
Repeated |
Description |
id |
The Media Node Id |
||
reference_stream |
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 |
✅ |
The parts (images/overlays) to include in the composition |
|
output_resolution |
The resolution of the output video |
||
output_pixel_format |
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 |
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 |
Enums defined in this message
Name |
Number |
Description |
COMPOSE_NONE |
0 |
|
COMPOSE_QUADRA |
1 |
|
COMPOSE_NVIDIA |
2 |
Name |
Number |
Description |
UNSPECIFIED_BEHAVIOUR |
0 |
|
WAIT_FOR_ALL |
1 |
Wait for all streams to be present before producing (further) output |
DROP_PART |
2 |
Produce frames on output by dropping the part(s) of the composition which cannot be fulfilled. |