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

Face detector of the Nubomedia project

{
  "name": "nubofacedetector",
  "version": "0.0.5",
  "kurentoVersion": "^6.0.0",
  "imports": [
    {
      "name": "core",
      "version": "^6.0.0",
      "mavenVersion": "[6.0.0,7.0.0-SNAPSHOT)",
      "npmVersion": ">=6.0.0 <7.0.0"
    },
    {
      "name": "elements",
      "version": "^6.0.0",
      "mavenVersion": "[6.0.0,7.0.0-SNAPSHOT)",
      "npmVersion": ">=6.0.0 <7.0.0"
    },
    {
      "name": "filters",
      "version": "^6.0.0",
      "mavenVersion": "[6.0.0,7.0.0-SNAPSHOT)",
      "npmVersion": ">=6.0.0 <7.0.0"
    }
  ],
  "code": {
    "api": {
      "js": {
        "nodeName": "kurento-module-nubofacedetector",
        "npmDescription": "",
        "npmVersion": "0.0.5"
      },
      "java": {
        "mavenGroupId": "org.kurento.module",
        "packageName": "org.kurento.module.nubofacedetector",
        "mavenArtifactId": "nubofacedetector",
        "mavenVersion": "0.0.5"
      }
    },
    "implementation": {
      "lib": "libkmsnubofacedetector",
      "cppNamespace": "kurento::module::nubofacedetector"
    }
  },
  "remoteClasses": [
    {
      "name": "NuboFaceDetector",
      "doc": "NuboFaceDetector interface. Documentation about the module",
      "extends": "Filter",
      "constructor": {
        "params": [
          {
            "name": "mediaPipeline",
            "doc": "the parent :rom:cls:`MediaPipeline`",
            "type": "MediaPipeline"
          }
        ],
        "doc": "Create an element"
      },
      "methods": [
        {
          "params": [
            {
              "name": "viewFaces",
              "doc": "Determines wheter the detected faces will be displayed or not",
              "type": "int"
            }
          ],
          "name": "showFaces",
          "doc": "Show or Hide the faces in the video stream"
        },
        {
          "params": [
            {
              "name": "event",
              "doc": "0 (default) => process all the frames without constraints; 1 => process only when we receive a specific event such as motion detection",
              "type": "int"
            }
          ],
          "name": "detectByEvent",
          "doc": "To indicate to the algorithm if process all the images or only when it receives an event"
        },
        {
          "params": [
            {
              "name": "metaData",
              "doc": "0 (default) => metadata are not sent; 1 => metadata are sent",
              "type": "int"
            }
          ],
          "name": "sendMetaData",
          "doc": "The faces detected (x,y,width,height) are sent as metadata "
        },
        {
          "params": [
            {
              "name": "scaleFactor",
              "doc": "5-50 (25 default)",
              "type": "int"
            }
          ],
          "name": "multiScaleFactor",
          "doc": "Specify how much the image size is reduced at each haar image "
        },
        {
          "params": [
            {
              "name": "xper4",
              "doc": "1,2,3,4 (default) => process x frames every 4 frames",
              "type": "int"
            }
          ],
          "name": "processXevery4Frames",
          "doc": "process x every 4 frames"
        },
        {
          "params": [
            {
              "name": "width",
              "doc": "160,320 (default),480,640",
              "type": "int"
            }
          ],
          "name": "widthToProcess",
          "doc": "this will be the width of the image that the algorithm is going to process to detect faces"
        }
      ]
    }
  ],
  "complexTypes": [],
  "events": []
}