Class DisplayClockPropertiesSetCommand

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

Hierarchy

WritableCommand<DisplayClockPropertiesExt>
- DisplayClockPropertiesSetCommand

Index

Constructors

constructor

new DisplayClockPropertiesSetCommand(): DisplayClockPropertiesSetCommand
Returns DisplayClockPropertiesSetCommand
Inherited from WritableCommand.constructor
- Defined in src/commands/CommandBase.ts:52

Properties

`Protected` _properties

_properties: Partial<DisplayClockPropertiesExt>

flag

flag: number

`Static` MaskFlags

MaskFlags: {
    autoHide: number;
    clockMode: number;
    enabled: number;
    opacity: number;
    positionX: number;
    positionY: number;
    size: number;
    startFrom: number;
    startFromFrames: number;
} = ...

Type declaration

autoHide: number
clockMode: number
enabled: number
opacity: number
positionX: number
positionY: number
size: number
startFrom: number
startFromFrames: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "DCPC" = 'DCPC'

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/DisplayClock/DisplayClockPropertiesSetCommand.ts:22

updateProps

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

Class DisplayClockPropertiesSetCommand

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns DisplayClockPropertiesSetCommand

Properties

Protected _properties

flag

Static MaskFlags

Type declaration

autoHide: number

clockMode: number

enabled: number

opacity: number

positionX: number

positionY: number

size: number

startFrom: number

startFromFrames: 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<DisplayClockPropertiesExt>

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Protected` _properties

`Static` MaskFlags

`Static` `Optional` `Readonly` minimumVersion

`Static` `Readonly` rawName

`Protected` _updateProps

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