Class DownstreamKeyAutoCommand

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

Hierarchy

WritableCommand<{
isTowardsOnAir: boolean;
}>
- DownstreamKeyAutoCommand

Index

Constructors

Properties

_properties downstreamKeyerId flag MaskFlags minimumVersion? rawName

Accessors

Methods

_updateProps serialize updateProps

Constructors

constructor

new DownstreamKeyAutoCommand(downstreamKeyerId): DownstreamKeyAutoCommand
Parameters
- downstreamKeyerId: number
Returns DownstreamKeyAutoCommand
Overrides WritableCommand.constructor
- Defined in src/commands/DownstreamKey/DownstreamKeyAutoCommand.ts:12

Properties

`Protected` _properties

_properties: Partial<{
isTowardsOnAir: boolean;
}>

Type declaration

isTowardsOnAir: boolean

`Readonly` downstreamKeyerId

downstreamKeyerId: number

flag

flag: number

`Static` `Readonly` MaskFlags

MaskFlags: {
isTowardsOnAir: number;
} = ...

Type declaration

isTowardsOnAir: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "DDsA" = 'DDsA'

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(version): Buffer
Parameters
- version: ProtocolVersion
Returns Buffer
Overrides WritableCommand.serialize
- Defined in src/commands/DownstreamKey/DownstreamKeyAutoCommand.ts:18

updateProps

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

Generated using TypeDoc