Updated .json and .md files as per latest code

jaroslaw-bojko-red · Jan 3, 2022 · 66e87d2 · 66e87d2
1 parent 32be3ac
commit 66e87d2
Show file tree

Hide file tree

Showing 2 changed files with 195 additions and 47 deletions.
diff --git a/HdmiInput/HdmiInput.json b/HdmiInput/HdmiInput.json
@@ -69,7 +69,7 @@
     },
     "methods": {
         "getHDMIInputDevices": {
-            "summary": "Returns an array of available HDMI Input ports",
+            "summary": "Returns an array of available HDMI Input ports.\n \n### Events\n \nNo Events.",
             "result": {
                 "type": "object",
                 "properties": {
@@ -87,7 +87,7 @@
             }
         },
         "getEdidVersion":{
-            "summary": "(Version 2) Returns the EDID version",
+            "summary": "(Version 2) Returns the EDID version.\n \n### Events\n \nNo Events.",
             "params": {
                 "type":"object",
                 "properties": {
@@ -118,7 +118,7 @@
             }
         },
         "getHDMISPD": {
-            "summary": "(Version 2) Returns the Source Data Product Descriptor (SPD) infoFrame packet information for the specified HDMI Input device. The SPD infoFrame packet includes vendor name, product description, and source information.",
+            "summary": "(Version 2) Returns the Source Data Product Descriptor (SPD) infoFrame packet information for the specified HDMI Input device. The SPD infoFrame packet includes vendor name, product description, and source information.\n \n### Events\n \nNo Events.",
             "params": {
                 "type":"object",
                 "properties": {
@@ -149,7 +149,7 @@
             }
         },
         "getRawHDMISPD":{
-            "summary": "(Version 2) Returns the Source Data Product Descriptor (SPD) infoFrame packet information for the specified HDMI Input device as raw bits.",
+            "summary": "(Version 2) Returns the Source Data Product Descriptor (SPD) infoFrame packet information for the specified HDMI Input device as raw bits.\n \n### Events\n \nNo Events.",
             "params": {
                 "type":"object",
                 "properties": {
@@ -180,7 +180,7 @@
             }
         },
         "readEDID":{
-            "summary": "Returns the current EDID value",
+            "summary": "Returns the current EDID value.\n \n### Events\n \nNo Events.",
             "params": {
                 "type":"object",
                 "properties": {
@@ -211,7 +211,11 @@
             }
         },
         "startHdmiInput": {
-            "summary": "Activates the specified HDMI Input port as the primary video source",
+            "summary": "Activates the specified HDMI Input port as the primary video source.\n \n### Events \n| Event | Description | \n| :----------- | :----------- | \n| `onInputStatusChanged` | Triggers the event when HDMI Input source is activated and Input status changes to `started` | \n| `onSignalChanged` | Triggers the event when HDMI Input signal changes (must be one of the following:noSignal, unstableSignal, notSupportedSignal, stableSignal)",
+            "events": [
+                "onInputStatusChanged",
+                "onSignalChanged"
+            ],
             "params": {
                 "type":"object",
                 "properties": {
@@ -228,7 +232,10 @@
             }
         },
         "stopHdmiInput": {
-            "summary": "Deactivates the HDMI Input port currently selected as the primary video source",
+            "summary": "Deactivates the HDMI Input port currently selected as the primary video source.\n \n### Events \n| Event | Description | \n| :----------- | :----------- | \n| `onInputStatusChanged` | Triggers the event when HDMI Input source is deactivated and Input status changes to `stopped`",
+            "events": [
+                "onInputStatusChanged"
+            ],
             "result": {
                 "type": "object",
                 "properties": {
@@ -242,7 +249,7 @@
             }            
         },
         "setEdidVersion": {
-            "summary": "(Version 2) Sets an HDMI EDID version",
+            "summary": "(Version 2) Sets an HDMI EDID version.\n \n### Events\n \nNo Events.",
             "params": {
                 "type":"object",
                 "properties": {
@@ -265,7 +272,7 @@
             }
         },
         "setVideoRectangle": {
-            "summary": "Sets an HDMI Input video window",
+            "summary": "Sets an HDMI Input video window.\n \n### Events\n \nNo Events.",
             "params": {
                 "type":"object",
                 "properties": {
@@ -301,7 +308,7 @@
             }
         },
         "writeEDID": {
-            "summary": "Changes a current EDID value",
+            "summary": "Changes a current EDID value.\n \n### Events\n \nNo Events.",
             "params": {
                 "type":"object",
                 "properties": {
@@ -388,6 +395,55 @@
                     "signalStatus"
                 ]                
             }
+        },
+        "videoStreamInfoUpdate": {
+            "summary": "Triggered whenever there is an update in HDMI Input video stream info",
+            "params": {
+                "type": "object",
+                "properties": {
+                    "id": {
+                        "$ref": "#/definitions/id"
+                    },
+                    "locator": {
+                        "$ref": "#/definitions/locator"
+                    },
+                    "width": {
+                        "summary": "Width of the Video Stream",
+                        "type": "integer",
+                        "example": 3840
+                    },
+                    "height": {
+                        "summary": "Height of the Video Stream",
+                        "type": "integer",
+                        "example": 2160
+                    },
+                    "progressive": {
+                        "summary": "Whether the streaming video is progressive or not?",
+                        "type": "boolean",
+                        "example": "true"
+                    },
+                    "frameRateN": {
+                        "summary": "FrameRate Numerator",
+                        "type": "integer",
+                        "example": 60000
+                    },
+                    "frameRateD": {
+                        "summary": "FrameRate Denomirator",
+                        "type": "integer",
+                        "example": 1001
+                    }
+                },
+                "required": [
+                    "id",
+                    "locator",
+                    "width",
+                    "height",
+                    "progressive",
+                    "frameRateN",
+                    "frameRateD"
+                ]
+            }
         }
+
     }
 }