IItemChroma

Defined in: core/items/ichroma.ts:48

Methods

getChromaAntiAliasLevel()

getChromaAntiAliasLevel(): Promise<ChromaAntiAliasLevel>

Defined in: core/items/ichroma.ts:91

return: Promise

Gets the antialiasing level for chroma keying.

Returns

Promise<ChromaAntiAliasLevel>

---

getChromaColorKeyColor()

getChromaColorKeyColor(): Promise<Color>

Defined in: core/items/ichroma.ts:273

return: Promise

Gets the color setting for keying in color key mode.

Returns

Promise<Color>

---

getChromaColorKeyExposure()

getChromaColorKeyExposure(): Promise<number>

Defined in: core/items/ichroma.ts:257

return: Promise

Gets the exposure setting (0-255). Only relevant when chroma keying is in color key mode.

Returns

Promise<number>

---

getChromaColorKeyThreshold()

getChromaColorKeyThreshold(): Promise<number>

Defined in: core/items/ichroma.ts:241

return: Promise

Gets the threshold setting (0-255). Only relevant when chroma keying is in color key mode.

Returns

Promise<number>

---

getChromaLegacyAlphaSmoothing()

getChromaLegacyAlphaSmoothing(): Promise<number>

Defined in: core/items/ichroma.ts:173

return: Promise

Gets the alpha smoothing setting (0-255). Only relevant when chroma keying is in Legacy mode.

Returns

Promise<number>

---

getChromaLegacyBrightness()

getChromaLegacyBrightness(): Promise<number>

Defined in: core/items/ichroma.ts:109

return: Promise

Gets the brightness setting (0-255). Only relevant when chroma keying is in Legacy mode.

Returns

Promise<number>

---

getChromaLegacyHue()

getChromaLegacyHue(): Promise<number>

Defined in: core/items/ichroma.ts:141

return: Promise

Gets the hue setting (0-180). Only relevant when chroma keying is in Legacy mode.

Returns

Promise<number>

---

getChromaLegacySaturation()

getChromaLegacySaturation(): Promise<number>

Defined in: core/items/ichroma.ts:125

return: Promise

Gets the saturation setting (0-255). Only relevant when chroma keying is in Legacy mode.

Returns

Promise<number>

---

getChromaLegacyThreshold()

getChromaLegacyThreshold(): Promise<number>

Defined in: core/items/ichroma.ts:157

return: Promise

Gets the threshold setting (0-255). Only relevant when chroma keying is in Legacy mode.

Returns

Promise<number>

---

getChromaRGBKeyExposure()

getChromaRGBKeyExposure(): Promise<number>

Defined in: core/items/ichroma.ts:223

return: Promise

Gets the exposure setting (0-255). Only relevant when chroma keying is in RGB mode.

Returns

Promise<number>

---

getChromaRGBKeyPrimaryColor()

getChromaRGBKeyPrimaryColor(): Promise<ChromaPrimaryColors>

Defined in: core/items/ichroma.ts:191

return: Promise

Gets the primary color setting for chroma key. Only relevant when chroma keying is in RGB mode.

Returns

Promise<ChromaPrimaryColors>

---

getChromaRGBKeyThreshold()

getChromaRGBKeyThreshold(): Promise<number>

Defined in: core/items/ichroma.ts:207

return: Promise

Gets the threshold setting (0-255). Only relevant when chroma keying is in RGB mode.

Returns

Promise<number>

---

getKeyingType()

getKeyingType(): Promise<KeyingType>

Defined in: core/items/ichroma.ts:70

return: Promise

Determines the chroma keying type being used.

Returns

Promise<KeyingType>

---

isChromaEnabled()

isChromaEnabled(): Promise<boolean>

Defined in: core/items/ichroma.ts:54

return: Promise

Determines whether any type of chroma keying is enabled.

Returns

Promise<boolean>

---

setChromaAntiAliasLevel()

setChromaAntiAliasLevel(value): any

Defined in: core/items/ichroma.ts:100

param: (value: ChromaAntiAliasLevel)

Sets the antialiasing level for chroma keying.

Chainable.

Parameters

value

ChromaAntiAliasLevel

Returns

any

---

setChromaColorKeyColor()

setChromaColorKeyColor(value): Promise<IItemChroma>

Defined in: core/items/ichroma.ts:282

param: (value: Color)

Sets the color setting for keying in color key mode.

Chainable.

Parameters

value

Color

Returns

Promise<IItemChroma>

---

setChromaColorKeyExposure()

setChromaColorKeyExposure(value): Promise<IItemChroma>

Defined in: core/items/ichroma.ts:266

param: (value: number)

Sets the exposure setting (0-255). Only relevant when chroma keying is in color key mode.

Chainable.

Parameters

value

number

Returns

Promise<IItemChroma>

---

setChromaColorKeyThreshold()

setChromaColorKeyThreshold(value): Promise<IItemChroma>

Defined in: core/items/ichroma.ts:250

param: (value: number)

Sets the threshold setting (0-255). Only relevant when chroma keying is in color key mode.

Chainable.

Parameters

value

number

Returns

Promise<IItemChroma>

---

setChromaEnabled()

setChromaEnabled(value): Promise<IItemChroma>

Defined in: core/items/ichroma.ts:63

param: (value: boolean)

Enables or disables chroma keying. Use together with getKeyingType().

Chainable.

Parameters

value

boolean

Returns

Promise<IItemChroma>

---

setChromaLegacyAlphaSmoothing()

setChromaLegacyAlphaSmoothing(value): Promise<IItemChroma>

Defined in: core/items/ichroma.ts:182

param: (value: number)

Sets the alpha smoothing setting (0-255). Only relevant when chroma keying is in Legacy mode.

Chainable.

Parameters

value

number

Returns

Promise<IItemChroma>

---

setChromaLegacyBrightness()

setChromaLegacyBrightness(value): Promise<IItemChroma>

Defined in: core/items/ichroma.ts:118

param: (value: number)

Sets the brightness setting (0-255). Only relevant when chroma keying is in Legacy mode.

Chainable.

Parameters

value

number

Returns

Promise<IItemChroma>

---

setChromaLegacyHue()

setChromaLegacyHue(value): Promise<IItemChroma>

Defined in: core/items/ichroma.ts:150

param: (value: number)

Sets the hue setting (0-180). Only relevant when chroma keying is in Legacy mode.

Chainable.

Parameters

value

number

Returns

Promise<IItemChroma>

---

setChromaLegacySaturation()

setChromaLegacySaturation(value): Promise<IItemChroma>

Defined in: core/items/ichroma.ts:134

param: (value: number)

Sets the saturation setting (0-255). Only relevant when chroma keying is in Legacy mode.

Chainable.

Parameters

value

number

Returns

Promise<IItemChroma>

---

setChromaLegacyThreshold()

setChromaLegacyThreshold(value): Promise<IItemChroma>

Defined in: core/items/ichroma.ts:166

param: (value: number)

Sets the threshold setting (0-255). Only relevant when chroma keying is in Legacy mode.

Chainable.

Parameters

value

number

Returns

Promise<IItemChroma>

---

setChromaRGBKeyExposure()

setChromaRGBKeyExposure(value): Promise<IItemChroma>

Defined in: core/items/ichroma.ts:232

param: (value: number)

Sets the exposure setting (0-255). Only relevant when chroma keying is in RGB mode.

Chainable.

Parameters

value

number

Returns

Promise<IItemChroma>

---

setChromaRGBKeyPrimaryColor()

setChromaRGBKeyPrimaryColor(value): Promise<IItemChroma>

Defined in: core/items/ichroma.ts:200

param: (value: ChromaPrimaryColors)

Sets the primary color setting for chroma key. Only relevant when chroma keying is in RGB mode.

Chainable.

Parameters

value

ChromaPrimaryColors

Returns

Promise<IItemChroma>

---

setChromaRGBKeyThreshold()

setChromaRGBKeyThreshold(value): Promise<IItemChroma>

Defined in: core/items/ichroma.ts:216

param: (value: number)

Sets the threshold setting (0-255). Only relevant when chroma keying is in RGB mode.

Chainable.

Parameters

value

number

Returns

Promise<IItemChroma>

---

setKeyingType()

setKeyingType(value): Promise<IItemChroma>

Defined in: core/items/ichroma.ts:84

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-* or setChromaRGBKey-*
• Color Key: methods prefixed with getChromaColorKey-* or setChromaColorKey-*
• Chroma Legacy Mode: methods prefixed with getChromaLegacy-* or setChromaLegacy-*

Parameters

value

KeyingType

Returns

Promise<IItemChroma>