Class InputPropertiesCommand

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

Hierarchy

WritableCommand<OmitReadonly<InputChannel>>
- InputPropertiesCommand

Index

Constructors

Properties

_properties flag inputId runOrderGroup? MaskFlags minimumVersion? rawName

Accessors

Methods

_updateProps serialize updateProps

Constructors

constructor

new InputPropertiesCommand(inputId): InputPropertiesCommand
Parameters
- inputId: number
Returns InputPropertiesCommand
Overrides WritableCommand.constructor
- Defined in src/commands/Inputs/InputPropertiesCommand.ts:18

Properties

`Protected` _properties

_properties: Partial<OmitReadonly<InputChannel>>

flag

flag: number

`Readonly` inputId

inputId: number

`Optional` runOrderGroup

runOrderGroup?: number = 0

Link

ISerializableCommand.runOrderGroup

`Static` MaskFlags

MaskFlags: {
    externalPortType: number;
    longName: number;
    shortName: number;
} = ...

Type declaration

externalPortType: number
longName: number
shortName: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "CInL" = 'CInL'

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/Inputs/InputPropertiesCommand.ts:24

updateProps

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

Generated using TypeDoc