Class SuperSourceBoxParametersCommand

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

Hierarchy

WritableCommand<SuperSourceBox>
- SuperSourceBoxParametersCommand

Index

Constructors

constructor

new SuperSourceBoxParametersCommand(ssrcId, boxId): SuperSourceBoxParametersCommand
Parameters
- ssrcId: number
- boxId: number
Returns SuperSourceBoxParametersCommand
Overrides WritableCommand.constructor
- Defined in src/commands/SuperSource/SuperSourceBoxParametersCommand.ts:25

Properties

`Protected` _properties

_properties: Partial<SuperSourceBox>

`Readonly` boxId

boxId: number

flag

flag: number

`Readonly` ssrcId

ssrcId: number

`Static` MaskFlags

MaskFlags: {
    cropBottom: number;
    cropLeft: number;
    cropRight: number;
    cropTop: number;
    cropped: number;
    enabled: number;
    size: number;
    source: number;
    x: number;
    y: number;
} = ...

Type declaration

cropBottom: number
cropLeft: number
cropRight: number
cropTop: number
cropped: number
enabled: number
size: number
source: number
x: number
y: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "CSBP" = 'CSBP'

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/SuperSource/SuperSourceBoxParametersCommand.ts:32

updateProps

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

Class SuperSourceBoxParametersCommand

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

ssrcId: number

boxId: number

Returns SuperSourceBoxParametersCommand

Properties

Protected _properties

Readonly boxId

flag

Readonly ssrcId

Static MaskFlags

Type declaration

cropBottom: number

cropLeft: number

cropRight: number

cropTop: number

cropped: number

enabled: number

size: number

source: number

x: number

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

Parameters

version: ProtocolVersion

Returns Buffer

updateProps

Parameters

newProps: Partial<SuperSourceBox>

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Protected` _properties

`Readonly` boxId

`Readonly` ssrcId

`Static` MaskFlags

`Static` `Optional` `Readonly` minimumVersion

`Static` `Readonly` rawName

`Protected` _updateProps

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