Class TransitionWipeCommand

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

Hierarchy

WritableCommand<WipeTransitionSettings>
- TransitionWipeCommand

Index

Constructors

constructor

new TransitionWipeCommand(mixEffect): TransitionWipeCommand
Parameters
- mixEffect: number
Returns TransitionWipeCommand
Overrides WritableCommand.constructor
- Defined in src/commands/MixEffects/Transition/TransitionWipeCommand.ts:23

Properties

`Protected` _properties

_properties: Partial<WipeTransitionSettings>

flag

flag: number

`Readonly` mixEffect

mixEffect: number

`Static` MaskFlags

MaskFlags: {
    borderInput: number;
    borderSoftness: number;
    borderWidth: number;
    flipFlop: number;
    pattern: number;
    rate: number;
    reverseDirection: number;
    symmetry: number;
    xPosition: number;
    yPosition: number;
} = ...

Type declaration

borderInput: number
borderSoftness: number
borderWidth: number
flipFlop: number
pattern: number
rate: number
reverseDirection: number
symmetry: number
xPosition: number
yPosition: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "CTWp" = 'CTWp'

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/Transition/TransitionWipeCommand.ts:29

updateProps

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

Class TransitionWipeCommand

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

mixEffect: number

Returns TransitionWipeCommand

Properties

Protected _properties

flag

Readonly mixEffect

Static MaskFlags

Type declaration

borderInput: number

borderSoftness: number

borderWidth: number

flipFlop: number

pattern: number

rate: number

reverseDirection: number

symmetry: number

xPosition: number

yPosition: 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<WipeTransitionSettings>

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Protected` _properties

`Readonly` mixEffect

`Static` MaskFlags

`Static` `Optional` `Readonly` minimumVersion

`Static` `Readonly` rawName

`Protected` _updateProps

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