Presets

`PR_01`: Set Custom Greyscale Based Preset

Version: 1.0.0
Interface: presets
Action: pr_01

Payload Definition

Type: `GreyscalePresetData`

{
  "Version": "String",
  "Name": "String",
  "Lower": "Float",
  "Upper": "Float"
}

Example definition

Type: `GreyscalePresetData`

{
  "Version": "0.0.1",
  "Name": "Preset",
  "Lower": 1,
  "Upper": 2
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00016`	Lower must be of a lower value than Upper
`A00001`	Input value exceeded limits defined

`PR_02`: Set Custom Colour Preset with Gradient Map

Version: 1.0.0
Interface: presets
Action: pr_02

Payload Definition

Type: `ColourPresetData`

{
  "Version": "String",
  "Name": "String",
  "ColourGradient": [
    {
      "Version": "String",
      "R": "Float",
      "G": "Float",
      "B": "Float",
      "Time": "Float"
    }
  ],
  "AlphaGradient": [
    {
      "Version": "String",
      "Alpha": "Float",
      "Time": "Float"
    }
  ]
}

Example definition

Type: `ColourPresetData`

{
  "Version": "0.0.1",
  "Name": "Some Colour Preset",
  "ColourGradient": [
    {
      "Version": "1.0.0",
      "R": 255,
      "G": 255,
      "B": 255,
      "Time": 2
    }
  ],
  "AlphaGradient": [
    {
      "Version": "1.0.0",
      "Alpha": 1,
      "Time": 2
    }
  ]
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00014`