Media Server 24.1

# ListColors

Lists the color names that have been defined in a color dictionary file, and the associated color values.

Type: synchronous

Parameter | Description | Required
--- | --- | ---
`ColorDictionary` | The dictionary file. If the dictionary file is located in the `colorcluster` folder, in the StaticDataDirectory, you can specify just the file name. Otherwise specify a path - either absolute or relative to the Media Server executable file. | Yes

## Example

The following example lists the colors in the basic colors dictionary:

    /action=ListColors&ColorDictionary=basiccolors.dat

## Response

The response returns the color names that have been defined:

    <autnresponse>
      <action>LISTCOLORS</action>
      <response>SUCCESS</response>
      <responsedata>
        <colorspace>RGB</colorspace>
        <dictionary>
          <entry>
            <colorname>white</colorname>
            <color weight="5">248 247 246</color>
            <color weight="4">236 233 224</color>
          </entry>
          <entry>
            <colorname>silver</colorname>
            <color weight="5">212 213 217</color>
            <color weight="1">169 179 181</color>
          </entry>
          ...
        </dictionary>
      </responsedata>
    </autnresponse>

The response contains the following information for each entry in the dictionary:

- The `colorname` element contains the name of the color.

- The `color` element contains the definition for the color, in the color space specified by the `colorspace` element. Some entries might have more than one `color` element. This means that the dictionary has multiple definitions for the same color name. The color dictionary can have different definitions for the same color to allow for lighting variations. In the output, Media Server combines the clusters for definitions with the same name (unless you set the parameter CombineNamedColors to `FALSE`).

  The `weight` attribute indicates that an optional weight has been assigned to the color for scoring purposes. In the results of color analysis, a greater weight results in a greater score. If the same weight is applied to every color the score is the proportion of the image or video frame that belongs to that color cluster. The `weightedcarcolors.dat` dictionary uses weights to help score the paintwork color more highly than trim and reflections from glass.

Copyright 2023 Open Text
Version 24.1 | Last updated December 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Media Server 24.1

Topic Title: ListColors