# adjustColors

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /json-rpc/output/adjustment:
    post:
      summary: adjustColors
      deprecated: false
      description: 'Adjustments reflect the color calibration. '
      tags:
        - Hyperion API/Controls/Output Controls
        - Websocket
        - HTTP/S
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                command:
                  type: string
                  description: The type of command to execute.
                  title: ''
                  enum:
                    - adjustment
                  x-apidog-enum:
                    - value: adjustment
                      name: ''
                      description: ''
                instance:
                  type: array
                  items: &ref_0
                    $ref: '#/components/schemas/instance%20-%20single'
                  uniqueItems: true
                  description: >-
                    List of instance indices (0-254) to which the command
                    applies. An empty array applies a command to all instances.
                adjustment:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Profile identifier
                    red:
                      type: array
                      items:
                        type: integer
                        minimum: 0
                        maximum: 255
                      minItems: 3
                      maxItems: 3
                      description: An array of R G B Integer values e.g. [R,G,B]
                    green:
                      type: array
                      items:
                        type: integer
                        minimum: 0
                        maximum: 255
                      minItems: 3
                      maxItems: 3
                      description: An array of R G B Integer values e.g. [R,G,B]
                    blue:
                      type: array
                      items:
                        type: integer
                        minimum: 0
                        maximum: 255
                      minItems: 3
                      maxItems: 3
                      description: An array of R G B Integer values e.g. [R,G,B]
                    yellow:
                      type: array
                      items:
                        type: integer
                        minimum: 0
                        maximum: 255
                      minItems: 3
                      maxItems: 3
                      description: An array of R G B Integer values e.g. [R,G,B]
                    magenta:
                      type: array
                      items:
                        type: integer
                        minimum: 0
                        maximum: 255
                      minItems: 3
                      maxItems: 3
                      description: An array of R G B Integer values e.g. [R,G,B]
                    cyan:
                      type: array
                      items:
                        type: integer
                        minimum: 0
                        maximum: 255
                      minItems: 3
                      maxItems: 3
                      description: An array of R G B Integer values e.g. [R,G,B]
                    white:
                      type: array
                      items:
                        type: integer
                        minimum: 0
                        maximum: 255
                      minItems: 3
                      maxItems: 3
                      description: An array of R G B Integer values e.g. [R,G,B]
                    gammaRed:
                      type: number
                      minimum: 0.1
                      maximum: 5
                      multipleOf: 0.1
                      description: >-
                        The gamma of red. 1.0 is neutral. Over 1.0 it reduces
                        red, lower than 1.0 it adds red.
                    gammaGreen:
                      type: number
                      minimum: 0.1
                      maximum: 5
                      multipleOf: 0.1
                      description: >-
                        The gamma of green. 1.0 is neutral. Over 1.0 it reduces
                        green, lower than 1.0 it adds green.
                    gammaBlue:
                      type: number
                      minimum: 0.1
                      maximum: 5
                      multipleOf: 0.1
                      description: >-
                        The gamma of blue. 1.0 is neutral. Over 1.0 it reduces
                        blue, lower than 1.0 it adds blue.
                    backlightThreshold:
                      type: integer
                      minimum: 0
                      maximum: 100
                      description: Minimum brightness! Disabled for effect/color/image
                    backlightColored:
                      type: boolean
                      description: >-
                        If true the backlight is colored, false it is white.
                        Disabled for 

                        effect/color/image
                    brightness:
                      type: integer
                      minimum: 0
                      maximum: 100
                      description: The overall brightness of LEDs.
                    brightnessCompensation:
                      type: integer
                      minimum: 0
                      maximum: 100
                      description: >-
                        Compensates brightness differences between red green
                        blue, cyan magenta yellow and white. 100 means full
                        compensation, 0 no compensation.
                    saturationGain:
                      type: number
                      minimum: 0
                      maximum: 10
                      description: >-
                        Saturation of colors. 1.0 means no change, over 1.0
                        increases saturation, under 1.0 desaturates.
                    brightnessGain:
                      type: number
                      minimum: 0.1
                      maximum: 10
                      description: >-
                        Brightness of colors. 1.0 means no change, over 1.0
                        increases brightness, under 1.0 decreases brightness.
                    temperature:
                      type: integer
                      minimum: 1000
                      maximum: 40000
                      description: Color temperature
                  additionalProperties: false
                  x-apidog-orders:
                    - id
                    - red
                    - green
                    - blue
                    - yellow
                    - magenta
                    - cyan
                    - white
                    - gammaRed
                    - gammaGreen
                    - gammaBlue
                    - backlightThreshold
                    - backlightColored
                    - brightness
                    - brightnessCompensation
                    - saturationGain
                    - brightnessGain
                    - temperature
                  description: Adjustment profile
                  x-apidog-ignore-properties: []
                tan:
                  type: integer
                  minimum: 0
                  examples:
                    - 4711
                  description: Transaction number for tracking requests and responses.
              x-apidog-orders:
                - command
                - 01JVGZANHBD0DQ769VX67F14YR
                - adjustment
                - 01JVGZBGH2P61WBCFN18B13DCY
              required:
                - command
                - adjustment
              x-apidog-refs:
                01JVGZANHBD0DQ769VX67F14YR:
                  $ref: '#/components/schemas/instance%20-%20multiple'
                01JVGZBGH2P61WBCFN18B13DCY:
                  $ref: '#/components/schemas/tan'
                  x-apidog-overrides: {}
                  required: []
              x-apidog-ignore-properties:
                - instance
                - tan
            examples:
              '1':
                value:
                  command: adjustment
                  adjustment:
                    gammaRed: 1.5
                  tan: 4711
                description: Set gammaRed to 1.5
              '2':
                value:
                  command: adjustment
                  adjustment:
                    green:
                      - 0
                      - 236
                      - 0
                  tan: 4711
                description: Set green to [0,236,0]
              '3':
                value:
                  command: adjustment
                  adjustment:
                    backlightColored: true
                  tan: 4711
                description: Enable backlight coloring
              '4':
                value:
                  command: adjustment
                  adjustment:
                    backlightColored: true
                    gammaRed: 1.5
                    green:
                      - 0
                      - 236
                      - 0
                  tan: 4711
                description: >-
                  Set gammaRed to 1.5, green to [0,236,0] and enable baclight
                  coloring in one go
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  command:
                    type: string
                    description: The command executed
                  subcommand:
                    type: string
                    description: The sub-command executed
                  success:
                    type: boolean
                    description: Result, if the request excuted successfully
                  info:
                    type: object
                    properties: {}
                    x-apidog-orders: []
                    description: Information requested
                    additionalProperties: true
                    x-apidog-ignore-properties: []
                  error:
                    type: string
                    description: Reason why a request did not execute successfully
                  errorData:
                    type: array
                    items:
                      type: object
                      properties:
                        description:
                          type: string
                      x-apidog-orders:
                        - description
                      x-apidog-ignore-properties: []
                    description: Detailed error explaination
                  tan:
                    type: integer
                    description: Request's transaction number
                x-apidog-orders:
                  - 01JV5M76DZ4M3GA4AD8Y4G69AP
                required:
                  - command
                  - success
                  - tan
                x-apidog-refs:
                  01JV5M76DZ4M3GA4AD8Y4G69AP:
                    $ref: '#/components/schemas/response'
                x-apidog-ignore-properties:
                  - command
                  - subcommand
                  - success
                  - info
                  - error
                  - errorData
                  - tan
              example:
                command: adjustment
                success: true
                tan: 4711
          headers: {}
          x-apidog-name: Success
      security:
        - bearer: []
      x-apidog-folder: Hyperion API/Controls/Output Controls
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/894413/apis/api-17014622-run
components:
  schemas:
    instance - single:
      type: integer
      minimum: 0
      maximum: 254
      description: Instance index (0-254) to which the command applies.
      x-apidog-folder: ''
    tan:
      type: object
      properties:
        tan:
          type: integer
          minimum: 0
          examples:
            - 4711
          description: Transaction number for tracking requests and responses.
      x-apidog-orders:
        - tan
      title: tan
      x-apidog-folder: ''
      x-apidog-ignore-properties: []
    instance - multiple:
      type: object
      properties:
        instance:
          type: array
          items: *ref_0
          uniqueItems: true
          description: >-
            List of instance indices (0-254) to which the command applies. An
            empty array applies a command to all instances.
      x-apidog-orders:
        - instance
      x-apidog-folder: ''
      x-apidog-ignore-properties: []
    response:
      type: object
      properties:
        command:
          type: string
          description: The command executed
        subcommand:
          type: string
          description: The sub-command executed
        success:
          type: boolean
          description: Result, if the request excuted successfully
        info:
          type: object
          properties: {}
          x-apidog-orders: []
          description: Information requested
          additionalProperties: true
          x-apidog-ignore-properties: []
        error:
          type: string
          description: Reason why a request did not execute successfully
        errorData:
          type: array
          items:
            type: object
            properties:
              description:
                type: string
            x-apidog-orders:
              - description
            x-apidog-ignore-properties: []
          description: Detailed error explaination
        tan:
          type: integer
          description: Request's transaction number
      required:
        - command
        - success
        - tan
      x-apidog-orders:
        - command
        - subcommand
        - success
        - info
        - error
        - errorData
        - tan
      x-apidog-folder: ''
      x-apidog-ignore-properties: []
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
servers:
  - url: http://{{host}}:8090
    description: Develop Env
  - url: https://{{host}}:8092
    description: Testing Env
security: []

```