ItemChroma
Defined in: core/items/ichroma.ts:285
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ItemChroma():
ItemChroma
Returns
Section titled “Returns”ItemChroma
Methods
Section titled “Methods”getChromaAntiAliasLevel()
Section titled “getChromaAntiAliasLevel()”getChromaAntiAliasLevel():
Promise<ChromaAntiAliasLevel>
Defined in: core/items/ichroma.ts:330
return: Promise
Gets the antialiasing level for chroma keying.
Returns
Section titled “Returns”Promise<ChromaAntiAliasLevel>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaAntiAliasLevel
getChromaColorKeyColor()
Section titled “getChromaColorKeyColor()”getChromaColorKeyColor():
Promise<Color>
Defined in: core/items/ichroma.ts:578
return: Promise
Gets the color setting for keying in color key mode.
Returns
Section titled “Returns”Promise<Color>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaColorKeyColor
getChromaColorKeyExposure()
Section titled “getChromaColorKeyExposure()”getChromaColorKeyExposure():
Promise<number>
Defined in: core/items/ichroma.ts:556
return: Promise
Gets the exposure setting (0-255). Only relevant when chroma keying is in color key mode.
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaColorKeyExposure
getChromaColorKeyThreshold()
Section titled “getChromaColorKeyThreshold()”getChromaColorKeyThreshold():
Promise<number>
Defined in: core/items/ichroma.ts:534
return: Promise
Gets the threshold setting (0-255). Only relevant when chroma keying is in color key mode.
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaColorKeyThreshold
getChromaLegacyAlphaSmoothing()
Section titled “getChromaLegacyAlphaSmoothing()”getChromaLegacyAlphaSmoothing():
Promise<number>
Defined in: core/items/ichroma.ts:442
return: Promise
Gets the alpha smoothing setting (0-255). Only relevant when chroma keying is in Legacy mode.
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaLegacyAlphaSmoothing
getChromaLegacyBrightness()
Section titled “getChromaLegacyBrightness()”getChromaLegacyBrightness():
Promise<number>
Defined in: core/items/ichroma.ts:354
return: Promise
Gets the brightness setting (0-255). Only relevant when chroma keying is in Legacy mode.
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaLegacyBrightness
getChromaLegacyHue()
Section titled “getChromaLegacyHue()”getChromaLegacyHue():
Promise<number>
Defined in: core/items/ichroma.ts:398
return: Promise
Gets the hue setting (0-180). Only relevant when chroma keying is in Legacy mode.
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaLegacyHue
getChromaLegacySaturation()
Section titled “getChromaLegacySaturation()”getChromaLegacySaturation():
Promise<number>
Defined in: core/items/ichroma.ts:376
return: Promise
Gets the saturation setting (0-255). Only relevant when chroma keying is in Legacy mode.
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaLegacySaturation
getChromaLegacyThreshold()
Section titled “getChromaLegacyThreshold()”getChromaLegacyThreshold():
Promise<number>
Defined in: core/items/ichroma.ts:420
return: Promise
Gets the threshold setting (0-255). Only relevant when chroma keying is in Legacy mode.
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaLegacyThreshold
getChromaRGBKeyExposure()
Section titled “getChromaRGBKeyExposure()”getChromaRGBKeyExposure():
Promise<number>
Defined in: core/items/ichroma.ts:510
return: Promise
Gets the exposure setting (0-255). Only relevant when chroma keying is in RGB mode.
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaRGBKeyExposure
getChromaRGBKeyPrimaryColor()
Section titled “getChromaRGBKeyPrimaryColor()”getChromaRGBKeyPrimaryColor():
Promise<ChromaPrimaryColors>
Defined in: core/items/ichroma.ts:466
return: Promise
Gets the primary color setting for chroma key. Only relevant when chroma keying is in RGB mode.
Returns
Section titled “Returns”Promise<ChromaPrimaryColors>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaRGBKeyPrimaryColor
getChromaRGBKeyThreshold()
Section titled “getChromaRGBKeyThreshold()”getChromaRGBKeyThreshold():
Promise<number>
Defined in: core/items/ichroma.ts:488
return: Promise
Gets the threshold setting (0-255). Only relevant when chroma keying is in RGB mode.
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”IItemChroma.getChromaRGBKeyThreshold
getKeyingType()
Section titled “getKeyingType()”getKeyingType():
Promise<KeyingType>
Defined in: core/items/ichroma.ts:308
return: Promise
Determines the chroma keying type being used.
Returns
Section titled “Returns”Promise<KeyingType>
Implementation of
Section titled “Implementation of”isChromaEnabled()
Section titled “isChromaEnabled()”isChromaEnabled():
Promise<boolean>
Defined in: core/items/ichroma.ts:288
return: Promise
Determines whether any type of chroma keying is enabled.
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”setChromaAntiAliasLevel()
Section titled “setChromaAntiAliasLevel()”setChromaAntiAliasLevel(
value):Promise<ItemChroma>
Defined in: core/items/ichroma.ts:338
param: (value: ChromaAntiAliasLevel)
Sets the antialiasing level for chroma keying.
Chainable.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<ItemChroma>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaAntiAliasLevel
setChromaColorKeyColor()
Section titled “setChromaColorKeyColor()”setChromaColorKeyColor(
value):Promise<ItemChroma>
Defined in: core/items/ichroma.ts:587
param: (value: Color)
Sets the color setting for keying in color key mode.
Chainable.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<ItemChroma>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaColorKeyColor
setChromaColorKeyExposure()
Section titled “setChromaColorKeyExposure()”setChromaColorKeyExposure(
value):Promise<ItemChroma>
Defined in: core/items/ichroma.ts:564
param: (value: number)
Sets the exposure setting (0-255). Only relevant when chroma keying is in color key mode.
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<ItemChroma>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaColorKeyExposure
setChromaColorKeyThreshold()
Section titled “setChromaColorKeyThreshold()”setChromaColorKeyThreshold(
value):Promise<ItemChroma>
Defined in: core/items/ichroma.ts:542
param: (value: number)
Sets the threshold setting (0-255). Only relevant when chroma keying is in color key mode.
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<ItemChroma>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaColorKeyThreshold
setChromaEnabled()
Section titled “setChromaEnabled()”setChromaEnabled(
value):Promise<ItemChroma>
Defined in: core/items/ichroma.ts:296
param: (value: boolean)
Enables or disables chroma keying. Use together with getKeyingType().
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ItemChroma>
Implementation of
Section titled “Implementation of”setChromaLegacyAlphaSmoothing()
Section titled “setChromaLegacyAlphaSmoothing()”setChromaLegacyAlphaSmoothing(
value):Promise<ItemChroma>
Defined in: core/items/ichroma.ts:450
param: (value: number)
Sets the alpha smoothing setting (0-255). Only relevant when chroma keying is in Legacy mode.
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<ItemChroma>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaLegacyAlphaSmoothing
setChromaLegacyBrightness()
Section titled “setChromaLegacyBrightness()”setChromaLegacyBrightness(
value):Promise<ItemChroma>
Defined in: core/items/ichroma.ts:362
param: (value: number)
Sets the brightness setting (0-255). Only relevant when chroma keying is in Legacy mode.
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<ItemChroma>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaLegacyBrightness
setChromaLegacyHue()
Section titled “setChromaLegacyHue()”setChromaLegacyHue(
value):Promise<ItemChroma>
Defined in: core/items/ichroma.ts:406
param: (value: number)
Sets the hue setting (0-180). Only relevant when chroma keying is in Legacy mode.
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<ItemChroma>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaLegacyHue
setChromaLegacySaturation()
Section titled “setChromaLegacySaturation()”setChromaLegacySaturation(
value):Promise<ItemChroma>
Defined in: core/items/ichroma.ts:384
param: (value: number)
Sets the saturation setting (0-255). Only relevant when chroma keying is in Legacy mode.
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<ItemChroma>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaLegacySaturation
setChromaLegacyThreshold()
Section titled “setChromaLegacyThreshold()”setChromaLegacyThreshold(
value):Promise<ItemChroma>
Defined in: core/items/ichroma.ts:428
param: (value: number)
Sets the threshold setting (0-255). Only relevant when chroma keying is in Legacy mode.
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<ItemChroma>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaLegacyThreshold
setChromaRGBKeyExposure()
Section titled “setChromaRGBKeyExposure()”setChromaRGBKeyExposure(
value):Promise<ItemChroma>
Defined in: core/items/ichroma.ts:518
param: (value: number)
Sets the exposure setting (0-255). Only relevant when chroma keying is in RGB mode.
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<ItemChroma>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaRGBKeyExposure
setChromaRGBKeyPrimaryColor()
Section titled “setChromaRGBKeyPrimaryColor()”setChromaRGBKeyPrimaryColor(
value):Promise<ItemChroma>
Defined in: core/items/ichroma.ts:474
param: (value: ChromaPrimaryColors)
Sets the primary color setting for chroma key. Only relevant when chroma keying is in RGB mode.
Chainable.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<ItemChroma>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaRGBKeyPrimaryColor
setChromaRGBKeyThreshold()
Section titled “setChromaRGBKeyThreshold()”setChromaRGBKeyThreshold(
value):Promise<ItemChroma>
Defined in: core/items/ichroma.ts:496
param: (value: number)
Sets the threshold setting (0-255). Only relevant when chroma keying is in RGB mode.
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<ItemChroma>
Implementation of
Section titled “Implementation of”IItemChroma.setChromaRGBKeyThreshold
setKeyingType()
Section titled “setKeyingType()”setKeyingType(
value):Promise<ItemChroma>
Defined in: core/items/ichroma.ts:316
param: (value: KeyingType)
Sets the chroma keying scheme to any one of three possible choices: Chroma RGB Key, Color Key, or Legacy Mode.
Chainable.
After setting the keying type, you may tweak settings specific to that type.
- RGB Key: methods prefixed with
getChromaRGBKey-*orsetChromaRGBKey-* - Color Key: methods prefixed with
getChromaColorKey-*orsetChromaColorKey-* - Chroma Legacy Mode: methods prefixed with
getChromaLegacy-*orsetChromaLegacy-*
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<ItemChroma>