Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

By utilising these layer-specific messages and their corresponding parameters, you can control, retrieve information, and subscribe to updates for both common and contextual properties of the layers within the ICE system. Please refer to the API documentation for further details on available properties and their specific usage.

General

...

Message

...

Path

...

Queries

...

Functions

...

Name

...

layer/general/name/

...

id=n+value=v

...

Status
colourYellow
titleGet
Status
colourGreen
titleSet
Status
colourPurple
titlesubscribe

...

Type

...

layer/general/type/

...

id=n+value=v

...

Status
colourYellow
titleGet
Status
colourPurple
titlesubscribe

...

Pin

...

layer/general/pin/

...

id=n+value=v

...

Status
colourYellow
titleGet
Status
colourGreen
titleSet
Status
colourPurple
titlesubscribe

...

Background

...

layer/general/background/

...

id=n+value=v

...

Status
colourYellow
titleGet
Status
colourGreen
titleSet
Status
colourPurple
titlesubscribe

...

Always On Top

...

layer/general/alwaysOnTop/

...

id=n+value=v

...

Status
colourYellow
titleGet
Status
colourGreen
titleSet
Status
colourPurple
titlesubscribe

...

Enabled

...

layer/general/enabled/

...

id=n+value=v

...

Status
colourYellow
titleGet
Status
colourGreen
titleSet
Status
colourPurple
titlesubscribe

...

Enable Home Layer

...

layer/general/enableHomeLayer

Geometry

...

Message

...

Path

...

Queries

...

Functions

...

Reset Geometry

...

layer/geometry/reset

...

id=n

...

Stretch Geometry

...

layer/geometry/stretch

...

id=n

...

Maximise Geometry

...

layer/geometry/maximise

...

id=n

...

Position

...

layer/geometry/position/

...

id=n+x=a+y=b

...

Status
colourYellow
titleGet
Status
colourGreen
titleSet
Status
colourPurple
titlesubscribe

...

Scale

...

layer/geometry/scale/

...

id=n+value=v

...

Status
colourYellow
titleGet
Status
colourGreen
titleSet
Status
colourPurple
titlesubscribe

...

Aspect Ratio

...

layer/geometry/aspectRatio/

...

id=n+value=v

...

Status
colourYellow
titleGet
Status
colourGreen
titleSet
Status
colourPurple
titlesubscribe

...

Resize Mode

...

layer/geometry/resizeMode/

...

id=n+value=v

...

Status
colourYellow
titleGet
Status
colourGreen
titleSet
Status
colourPurple
titlesubscribe

...

Position Mode

...

layer/geometry/positionMode/

...

id=n+value=v

...

Status
colourYellow
titleGet
Status
colourGreen
titleSet
Status
colourPurple
titlesubscribe

...

Layout

...

layer/geometry/layout/

...

id=n+index=n

...

Status
colourYellow
titleGet
Status
colourGreen
titleSet
Status
colourPurple
titlesubscribe

...

Region

...

layer/geometry/region/

...

id=n+index=n

...

Status
colourYellow
titleGet
Status
colourGreen
titleSet
Status
colourPurple
titlesubscribe

...

Custom Ratio

...

layer/geometry/customRatio/

...

id=n+x=a+y=b

...

Status
colourYellow
titleGet
Status
colourGreen
titleSet
Status
colourPurple
titlesubscribe

...

Start Crop

...

layer/geometry/startCrop/

...

id=n+x=a+y=b

...

Status
colourYellow
titleGet
Status
colourGreen
titleSet
Status
colourPurple
titlesubscribe

...

Crop Size

...

layer/geometry/cropSize/

...

id=n+width=a+height=b

...

Status
colourYellow
titleGet
Status
colourGreen
titleSet
Status
colourPurple
titlesubscribe

...

Size

...

layer/geometry/size/

...

id=n+width=a+height=b

...

Status
colourYellow
titleGet
Status
colourGreen
titleSet
Status
colourPurple
titlesubscribe

...

Wrap

...

layer/geometry/wrap/

...

id=n+x=a+y=b

...

Status
colourYellow
titleGet
Status
colourGreen
titleSet
Status
colourPurple
titlesubscribe