For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Chroma Keyer

Retrieves details of the Chroma Keyer. This action returns an error on those switchers that feature the Advanced Chroma keyer.

Parameters

  • Index: The 1-based USK index for the keyer.

  • Mix Effect Block Index: The Mix Effect Block to change. Default is M/E 1.

Returns

Chroma details object, which contains the following fields:

  • Index: The 1-based USK index for the keyer.

  • Mix Effect Block Index: The Mix Effect Block to change. Default is M/E 1.

  • Fill Source: The fill source to use for the Chroma keyer.

  • Enable Mask: Toggle whether to crop the Chroma key area.

  • Mask Top: The mask top value from -9.0 to 9.0.

  • Mask Bottom: The mask bottom value from -9.0 to 9.0.

  • Mask Left: The mask left value from -16.0 to 16.0.

  • Mask Right: The mask right value from -16.0 to 16.0.

  • Foreground: Adjustment on how opaque the foreground mask is.

  • Hue: Adjustment to the hue value.

  • Gain: Adjustment to the gain of the keyer area.

  • Y Suppress: Adjustment to remove colored tint from the edges of the foreground elements.

  • Life: Adjustment to lift value of the keyer area.

  • Narrow Chroma Key Range: Boolean.

  • Enable Flying Key: Enable the flying key.

  • Position X: The X position of the keyer box.

  • Position Y: The Y position the keyer box.

  • Size X: Set the horizontal size of the keyer box.

  • Size Y: The vertical size of the keyer box.

  • Rotation: The rotation of the keyer box. Not all switchers support rotation.

Last updated