Class SuperSourcePropertiesV8Command

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

Hierarchy

WritableCommand<SuperSourceProperties>
- SuperSourcePropertiesV8Command

Index

Constructors

constructor

new SuperSourcePropertiesV8Command(ssrcId): SuperSourcePropertiesV8Command
Parameters
- ssrcId: number
Returns SuperSourcePropertiesV8Command
Overrides WritableCommand.constructor
- Defined in src/commands/SuperSource/SuperSourcePropertiesCommand.ts:82

Properties

`Protected` _properties

_properties: Partial<SuperSourceProperties>

flag

flag: number

`Optional` runOrderGroup

runOrderGroup?: number = 0

Link

ISerializableCommand.runOrderGroup

`Readonly` ssrcId

ssrcId: number

`Static` MaskFlags

MaskFlags: {
    artClip: number;
    artCutSource: number;
    artFillSource: number;
    artGain: number;
    artInvertKey: number;
    artOption: number;
    artPreMultiplied: number;
} = ...

Type declaration

artClip: number
artCutSource: number
artFillSource: number
artGain: number
artInvertKey: number
artOption: number
artPreMultiplied: number

`Static` `Readonly` minimumVersion

minimumVersion: V8_0 = ProtocolVersion.V8_0

`Static` `Readonly` rawName

rawName: "CSSc" = 'CSSc'

Accessors

properties

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

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:75

serialize

serialize(): Buffer
Returns Buffer
Overrides WritableCommand.serialize
- Defined in src/commands/SuperSource/SuperSourcePropertiesCommand.ts:88

updateProps

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

Class SuperSourcePropertiesV8Command

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

ssrcId: number

Returns SuperSourcePropertiesV8Command

Properties

Protected _properties

flag

Optional runOrderGroup

Link

Readonly ssrcId

Static MaskFlags

Type declaration

artClip: number

artCutSource: number

artFillSource: number

artGain: number

artInvertKey: number

artOption: number

artPreMultiplied: number

Static 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<SuperSourceProperties>

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Protected` _properties

`Optional` runOrderGroup

`Readonly` ssrcId

`Static` MaskFlags

`Static` `Readonly` minimumVersion

`Static` `Readonly` rawName

`Protected` _updateProps

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