kurento-module-chroma/src/chroma.kmd.json

JavaScript Client API for Kurento Media Server

{
  "name": "chroma",
  "version": "7.2.0",
  "kurentoVersion": "^7.1.0",
  "imports": [
    {
      "name": "core",
      "version": "^7.1.0",
      "mavenVersion": "[7.1.0,8.0.0-SNAPSHOT)",
      "npmVersion": ">=7.1.0 <8.0.0"
    },
    {
      "name": "elements",
      "version": "^7.1.0",
      "mavenVersion": "[7.1.0,8.0.0-SNAPSHOT)",
      "npmVersion": ">=7.1.0 <8.0.0"
    },
    {
      "name": "filters",
      "version": "^7.1.0",
      "mavenVersion": "[7.1.0,8.0.0-SNAPSHOT)",
      "npmVersion": ">=7.1.0 <8.0.0"
    }
  ],
  "code": {
    "api": {
      "js": {
        "nodeName": "kurento-module-chroma",
        "npmDescription": "JavaScript Client API for Kurento Media Server",
        "npmGit": "https://github.com/Kurento/kurento-module-chroma-js.git",
        "npmVersion": "7.2.0"
      },
      "java": {
        "mavenGroupId": "org.kurento.module",
        "mavenArtifactId": "chroma",
        "mavenVersion": "7.2.0",
        "packageName": "org.kurento.module.chroma"
      }
    },
    "implementation": {
      "cppNamespace": "kurento::module::chroma",
      "lib": "libkmschroma"
    }
  },
  "remoteClasses": [
    {
      "name": "ChromaFilter",
      "doc": "ChromaFilter interface. This type of :rom:cls:`Filter` makes transparent a colour\nrange in the top layer, revealing another image behind",
      "extends": "Filter",
      "constructor": {
        "params": [
          {
            "name": "mediaPipeline",
            "doc": "the :rom:cls:`MediaPipeline` to which the filter belongs",
            "type": "MediaPipeline"
          },
          {
            "name": "window",
            "doc": "Window of replacement for the :rom:cls:`ChromaFilter`",
            "type": "WindowParam"
          },
          {
            "name": "backgroundImage",
            "doc": "url of image to be used to replace the detected background",
            "type": "String",
            "optional": true,
            "defaultValue": ""
          }
        ],
        "doc": "Create a :rom:cls:`ChromaFilter`"
      },
      "methods": [
        {
          "params": [
            {
              "name": "uri",
              "doc": "URI where the image is located",
              "type": "String"
            }
          ],
          "name": "setBackground",
          "doc": "Sets the image to show on the detected chroma surface."
        },
        {
          "params": [],
          "name": "unsetBackground",
          "doc": "Clears the image used to be shown behind the chroma surface."
        }
      ]
    }
  ],
  "complexTypes": [
    {
      "typeFormat": "REGISTER",
      "properties": [
        {
          "name": "topRightCornerX",
          "doc": "X coordinate of the left upper point of the window",
          "type": "int"
        },
        {
          "name": "topRightCornerY",
          "doc": "Y coordinate of the left upper point of the window",
          "type": "int"
        },
        {
          "name": "width",
          "doc": "width in pixels of the window",
          "type": "int"
        },
        {
          "name": "height",
          "doc": "height in pixels of the window",
          "type": "int"
        }
      ],
      "name": "WindowParam",
      "doc": "Parameter representing a window in a video stream.\nIt is used in command and constructor for media elements.\n\nAll units are in pixels, X runs from left to right, Y from top to bottom."
    }
  ],
  "events": []
}