Class TransitionStingerCommand

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

Hierarchy

WritableCommand<StingerTransitionSettings>
- TransitionStingerCommand

Index

Constructors

constructor

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

Properties

`Protected` _properties

_properties: Partial<StingerTransitionSettings>

flag

flag: number

`Readonly` mixEffect

mixEffect: number

`Static` MaskFlags

MaskFlags: {
    clip: number;
    clipDuration: number;
    gain: number;
    invert: number;
    mixRate: number;
    preMultipliedKey: number;
    preroll: number;
    source: number;
    triggerPoint: number;
} = ...

Type declaration

clip: number
clipDuration: number
gain: number
invert: number
mixRate: number
preMultipliedKey: number
preroll: number
source: number
triggerPoint: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "CTSt" = 'CTSt'

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/TransitionStingerCommand.ts:28

updateProps

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

Class TransitionStingerCommand

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

mixEffect: number

Returns TransitionStingerCommand

Properties

Protected _properties

flag

Readonly mixEffect

Static MaskFlags

Type declaration

clip: number

clipDuration: number

gain: number

invert: number

mixRate: number

preMultipliedKey: number

preroll: number

source: number

triggerPoint: 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<StingerTransitionSettings>

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;
}