Class MixEffectKeyFlyKeyframeCommand

Base command type for a full writable command, which uses flags to indicate the changed properties

Hierarchy

WritableCommand<Omit<UpstreamKeyerFlyKeyframe, "keyFrameId">>
- MixEffectKeyFlyKeyframeCommand

Index

Constructors

constructor

new MixEffectKeyFlyKeyframeCommand(mixEffect, upstreamKeyerId, keyFrameId): MixEffectKeyFlyKeyframeCommand
Parameters
- mixEffect: number
- upstreamKeyerId: number
- keyFrameId: number
Returns MixEffectKeyFlyKeyframeCommand
Overrides WritableCommand.constructor
- Defined in src/commands/MixEffects/Key/MixEffectKeyFlyKeyframeCommand.ts:115

Properties

`Protected` _properties

_properties: Partial<Omit<UpstreamKeyerFlyKeyframe, "keyFrameId">>

flag

flag: number

`Readonly` keyFrameId

keyFrameId: number

`Readonly` mixEffect

mixEffect: number

`Readonly` upstreamKeyerId

upstreamKeyerId: number

`Static` MaskFlags

MaskFlags: {
    borderBevelPosition: number;
    borderBevelSoftness: number;
    borderHue: number;
    borderInnerSoftness: number;
    borderInnerWidth: number;
    borderLuma: number;
    borderOpacity: number;
    borderOuterSoftness: number;
    borderOuterWidth: number;
    borderSaturation: number;
    lightSourceAltitude: number;
    lightSourceDirection: number;
    maskBottom: number;
    maskLeft: number;
    maskRight: number;
    maskTop: number;
    positionX: number;
    positionY: number;
    rotation: number;
    sizeX: number;
    sizeY: number;
} = ...

Type declaration

borderBevelPosition: number
borderBevelSoftness: number
borderHue: number
borderInnerSoftness: number
borderInnerWidth: number
borderLuma: number
borderOpacity: number
borderOuterSoftness: number
borderOuterWidth: number
borderSaturation: number
lightSourceAltitude: number
lightSourceDirection: number
maskBottom: number
maskLeft: number
maskRight: number
maskTop: number
positionX: number
positionY: number
rotation: number
sizeX: number
sizeY: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "CKFP" = 'CKFP'

Accessors

properties

get properties(): Readonly<T>
Returns Readonly<T>
Inherited from WritableCommand.properties
- Defined in src/commands/CommandBase.ts:35

Methods

`Protected` _updateProps

_updateProps(newProps): boolean
Parameters
- newProps: {
  [key: string]: any;
  }
  - [key: string]: any
Returns boolean
Inherited from WritableCommand._updateProps
- Defined in src/commands/CommandBase.ts:63

serialize

serialize(): Buffer
Returns Buffer
Overrides WritableCommand.serialize
- Defined in src/commands/MixEffects/Key/MixEffectKeyFlyKeyframeCommand.ts:123

updateProps

updateProps(newProps): boolean
Update the values of some properties with this command
Parameters
- newProps: Partial<Omit<UpstreamKeyerFlyKeyframe, "keyFrameId">>
Returns boolean
Inherited from WritableCommand.updateProps
- Defined in src/commands/CommandBase.ts:59

Class MixEffectKeyFlyKeyframeCommand

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

mixEffect: number

upstreamKeyerId: number

keyFrameId: number

Returns MixEffectKeyFlyKeyframeCommand

Properties

Protected _properties

flag

Readonly keyFrameId

Readonly mixEffect

Readonly upstreamKeyerId

Static MaskFlags

Type declaration

borderBevelPosition: number

borderBevelSoftness: number

borderHue: number

borderInnerSoftness: number

borderInnerWidth: number

borderLuma: number

borderOpacity: number

borderOuterSoftness: number

borderOuterWidth: number

borderSaturation: number

lightSourceAltitude: number

lightSourceDirection: number

maskBottom: number

maskLeft: number

maskRight: number

maskTop: number

positionX: number

positionY: number

rotation: number

sizeX: number

sizeY: number

Static Optional Readonly minimumVersion

Static Readonly rawName

Accessors

properties

Returns Readonly<T>

Methods

Protected _updateProps

Parameters

newProps: { [key: string]: any; }

[key: string]: any

Returns boolean

serialize

Returns Buffer

updateProps

Parameters

newProps: Partial<Omit<UpstreamKeyerFlyKeyframe, "keyFrameId">>

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Protected` _properties

`Readonly` keyFrameId

`Readonly` mixEffect

`Readonly` upstreamKeyerId

`Static` MaskFlags

`Static` `Optional` `Readonly` minimumVersion

`Static` `Readonly` rawName

`Protected` _updateProps

newProps: {
[key: string]: any;
}