config.schema.json

{
  "pluginAlias": "Camera-Swann",
  "pluginType": "platform",
  "singular": true,
  "headerDisplay": "Cameras are exposed to HomeKit as separate accessories and each needs to be manually paired.\n\n1. Open the Home <img src='https://user-images.githubusercontent.com/3979615/78010622-4ea1d380-738e-11ea-8a17-e6a465eeec35.png' height='16.42px'> app on your device.\n2. Tap the Home tab, then tap <img src='https://user-images.githubusercontent.com/3979615/78010869-9aed1380-738e-11ea-9644-9f46b3633026.png' height='16.42px'>.\n3. Tap *Add Accessory*, and select *I Don't Have a Code or Cannot Scan*.\n4. Enter the Homebridge PIN, this can be found under the QR code in Homebridge UI or your Homebridge logs, alternatively you can select *Use Camera* and scan the QR code again.\n\nFor help and examples of common configurations please read the [wiki](https://github.com/KhaosT/homebridge-camera-ffmpeg/wiki).",
  "footerDisplay": "The **ffmpeg** binary must be installed on your system for this plugin to work.",
  "schema": {
    "videoProcessor": {
      "title": "Video Processor",
      "type": "string"
    },
    "interfaceName": {
      "title": "Interface Name",
      "type": "string"
    },
    "cameras": {
      "type": "array",
      "items": {
        "title": "Cameras",
        "type": "object",
        "properties": {
          "name": {
            "title": "Name",
            "type": "string",
            "placeholder": "Enter camera name...",
            "required": true
          },
          "manufacturer": {
            "title": "Manufacturer",
            "type": "string"
          },
          "model": {
            "title": "Model",
            "type": "string"
          },
          "serialNumber": {
            "title": "Serial Number",
            "type": "string"
          },
          "firmwareRevision": {
            "title": "Firmware Version",
            "type": "string"
          },
          "motion": {
            "title": "Enable IOS 13 Motion Notifications",
            "type": "boolean"
          },
          "videoConfig": {
            "title": "Video Configuration",
            "type": "object",
            "properties": {
              "mainStream": {
                "title": "Main Stream Source",
                "type": "string",
                "placeholder": "-re -i rtsp://myfancy_rtsp_stream",
                "required": true
              },
              "subStream": {
                "title": "Sub Stream Source",
                "type": "string",
                "placeholder": "-re -i rtsp://myfancy_rtsp_stream",
                "required": true
              },
              "maxStreams": {
                "title": "Maximum Number of Streams",
                "type": "integer",
                "placeholder": 2,
                "minimum": 1,
                "description": "The maximum number of streams that will be generated for this camera"
              },
              "bitrateThreshold": {
                "title": "Bitrate Threshold",
                "type": "integer",
                "placeholder": 299,
                "minimum": 1,
                "description": "Select the sub stream if iOS requests < bitrateThreshold, otherwise select the main stream"
              },
              "videoPacketSize": {
                "title": "Video SRTP Packet Size",
                "type": "number",
                "placeholder": 1378
              },
              "audioPacketSize": {
                "title": "Audio SRTP Packet Size",
                "type": "number",
                "placeholder": 188
              },
              "mapvideo": {
                "type": "string",
                "title": "Map Video",
                "placeholder": "0:0",
                "description": "Select the stream used for video"
              },
              "mapaudio": {
                "type": "string",
                "title": "Map Audio",
                "placeholder": "0:1",
                "description": "Select the stream used for audio"
              },
              "audio": {
                "title": "Enable Audio (requires ffmpeg with libfdk-aac)",
                "type": "boolean"
              },
              "debug": {
                "title": "Enable Debug Mode",
                "type": "boolean"
              }
            }
          }
        }
      }
    }
  },
  "layout": [
    {
      "key": "cameras",
      "type": "array",
      "orderable": false,
      "buttonText": "Add Camera",
      "items": [
        "cameras[].name",
        "cameras[].manufacturer",
        "cameras[].model",
        "cameras[].serialNumber",
        "cameras[].firmwareRevision",
        "cameras[].videoConfig.mainStream",
        "cameras[].videoConfig.subStream",
        "cameras[].videoConfig.audio",
        "cameras[].videoConfig.debug",
        {
          "key": "cameras[].videoConfig",
          "type": "section",
          "title": "Advanced Settings",
          "expandable": true,
          "expanded": false,
          "items": [
            "cameras[].videoConfig.maxStreams",
            "cameras[].videoConfig.bitrateThreshold",
            "cameras[].videoConfig.videoPacketSize",
            "cameras[].videoConfig.audioPacketSize",
            "cameras[].videoConfig.mapvideo",
            "cameras[].videoConfig.mapaudio",
            "cameras[].motion"
          ]
        }
      ]
    }
  ]
}