Add Channel Archive Heartbeat event (#15885)

* Add Channel Archive Heartbeat event * Removed added "required" field which caused validation errors. * Added examples for the new/updated events. Co-authored-by: Xueping Deng <[email protected]>
Azure · Sep 22, 2021 · 9b489ff · 9b489ff
1 parent c8d9a26
commit 9b489ff
Show file tree

Hide file tree

Showing 3 changed files with 86 additions and 2 deletions.
diff --git a/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json b/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json
@@ -816,7 +816,7 @@
         }
       },
       "type": "object",
-      "description": "Incoming video stream out of synch event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingVideoStreamsOutOfSync event."
+      "description": "Incoming video stream out of sync event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingVideoStreamsOutOfSync event."
     },
     "MediaLiveEventIncomingDataChunkDroppedEventData": {
       "properties": {
@@ -867,6 +867,16 @@
           "description": "Gets the track name.",
           "readOnly": true
         },
+        "transcriptionLanguage": {
+          "description": "Gets the Live Transcription language.",
+          "readOnly": true,
+          "type": "string"
+        },
+        "transcriptionState": {
+            "description": "Gets the Live Transcription state.",
+            "readOnly": true,
+            "type": "string"
+        },
         "bitrate": {
           "type": "integer",
           "format": "int64",
@@ -879,6 +889,16 @@
           "description": "Gets the incoming bitrate.",
           "readOnly": true
         },
+        "ingestDriftValue": {
+          "description": "Gets the track ingest drift value.",
+          "readOnly": true,
+          "type": "string"
+        },
+        "lastFragmentArrivalTime": {
+            "description": "Gets the arrival UTC time of the last fragment.",
+            "readOnly": true,
+            "type": "string"
+        },
         "lastTimestamp": {
           "type": "string",
           "description": "Gets the last timestamp.",
@@ -924,7 +944,7 @@
         }
       },
       "type": "object",
-      "description": "Ingest fragment dropped event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIngestHeartbeat event."
+      "description": "Ingest heartbeat event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIngestHeartbeatEventData event."
     },
     "MediaLiveEventTrackDiscontinuityDetectedEventData": {
       "properties": {
@@ -967,6 +987,26 @@
       },
       "type": "object",
       "description": "Ingest track discontinuity detected event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventTrackDiscontinuityDetected event."
+    },
+    "MediaLiveEventChannelArchiveHeartbeatEventData": {
+        "properties": {
+            "channelLatencyMs": {
+                "type": "string",
+                "description": "Gets the channel latency in ms.",
+                "readOnly": true
+            },
+            "latencyResultCode": {
+                "type": "string",
+                "description": "Gets the latency result code.",
+                "readOnly": true
+            }
+        },
+        "type": "object",
+        "required": [
+            "channelLatencyMs",
+            "latencyResultCode"
+        ],
+        "description": "Channel Archive heartbeat event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventChannelArchiveHeartbeatEventData event."
     }
   }
 }
diff --git a/...icrosoft.Media/stable/2018-01-01/examples/MediaLiveEventChannelArchiveHeartbeatEvent.json b/...icrosoft.Media/stable/2018-01-01/examples/MediaLiveEventChannelArchiveHeartbeatEvent.json
@@ -0,0 +1,15 @@
+[
+  {
+    "topic": "/subscriptions/<subscription-id>/resourceGroups/<rg-name>/providers/Microsoft.Media/mediaservices/<account-name>",
+    "subject": "liveEvent/mle1",
+    "eventType": "Microsoft.Media.LiveEventChannelArchiveHeartbeat",
+    "eventTime": "2021-05-14T23:50:00.324",
+    "id": "7f450938-491f-41e1-b06f-c6cd3965d786",
+    "data": {
+      "channelLatencyMs": "10",
+      "latencyResultCode": "S_OK"
+    },
+    "dataVersion": "1.0",
+    "metadataVersion": "1"
+  }
+]
diff --git a/...-plane/Microsoft.Media/stable/2018-01-01/examples/MediaLiveEventIngestHeartbeatEvent.json b/...-plane/Microsoft.Media/stable/2018-01-01/examples/MediaLiveEventIngestHeartbeatEvent.json
@@ -0,0 +1,29 @@
+[
+  {
+    "topic": "/subscriptions/<subscription-id>/resourceGroups/<rg-name>/providers/Microsoft.Media/mediaservices/<account-name>",
+    "subject": "liveEvent/mle1",
+    "eventType": "Microsoft.Media.LiveEventIngestHeartbeat",
+    "eventTime": "2021-05-14T23:50:00.324",
+    "id": "7f450938-491f-41e1-b06f-c6cd3965d786",
+    "data": {
+      "trackType": "video",
+      "trackName": "video",
+      "bitrate": 2500000,
+      "incomingBitrate": 2462597,
+      "lastTimestamp": "106999",
+      "timescale": "1000",
+      "overlapCount": 0,
+      "discontinuityCount": 0,
+      "nonincreasingCount": 0,
+      "unexpectedBitrate": false,
+      "state": "Running",
+      "healthy": true,
+      "lastFragmentArrivalTime": "2021-05-14T23:50:00.00",
+      "ingestDriftValue": "0",
+      "transcriptionState": "On",
+      "transcriptionLanguage": "en-us"
+    },
+    "dataVersion": "2.0",
+    "metadataVersion": "1"
+  }
+]