-
Notifications
You must be signed in to change notification settings - Fork 5.2k
/
Copy pathAzureVideoAnalyzer.json
1689 lines (1689 loc) · 61.4 KB
/
AzureVideoAnalyzer.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"swagger": "2.0",
"info": {
"version": "1.0.0",
"title": "Azure Video Analyzer for Edge",
"description": "Azure Video Analyzer resources which can be utilized when performing direct method calls through Azure IoT Edge.",
"contact": {
"email": "[email protected]"
}
},
"security": [
{
"sharedAccessSignature": []
}
],
"paths": {},
"securityDefinitions": {
"sharedAccessSignature": {
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
},
"definitions": {
"LivePipeline": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Live pipeline unique identifier."
},
"systemData": {
"$ref": "#/definitions/SystemData",
"description": "Read-only system metadata associated with this object."
},
"properties": {
"$ref": "#/definitions/LivePipelineProperties",
"description": "Live pipeline properties."
}
},
"description": "Live Pipeline represents an unique instance of a pipeline topology which is used for real-time content ingestion and analysis."
},
"LivePipelineProperties": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "An optional description of the live pipeline."
},
"topologyName": {
"type": "string",
"description": "The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition."
},
"parameters": {
"type": "array",
"description": "List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.",
"items": {
"$ref": "#/definitions/ParameterDefinition"
}
},
"state": {
"type": "string",
"description": "Current pipeline state (read-only).",
"enum": [
"inactive",
"activating",
"active",
"deactivating"
],
"x-ms-enum": {
"name": "livePipelineState",
"values": [
{
"value": "inactive",
"description": "The live pipeline is idle and not processing media."
},
{
"value": "activating",
"description": "The live pipeline is transitioning into the active state."
},
{
"value": "active",
"description": "The live pipeline is active and able to process media. If your data source is not available, for instance, if your RTSP camera is powered off or unreachable, the pipeline will still be active and periodically retrying the connection. Your Azure subscription will be billed for the duration in which the live pipeline is in the active state."
},
{
"value": "deactivating",
"description": "The live pipeline is transitioning into the inactive state."
}
],
"modelAsString": true
}
}
},
"description": "Live pipeline properties."
},
"ParameterDefinition": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the parameter declared in the pipeline topology."
},
"value": {
"type": "string",
"description": "Parameter value to be applied on this specific live pipeline."
}
},
"description": "Defines the parameter value of an specific pipeline topology parameter. See pipeline topology parameters for more information."
},
"LivePipelineCollection": {
"type": "object",
"properties": {
"value": {
"type": "array",
"description": "List of live pipelines.",
"items": {
"$ref": "#/definitions/LivePipeline"
}
},
"@continuationToken": {
"type": "string",
"description": "A continuation token to be used in subsequent calls when enumerating through the collection. This is returned when the collection results won't fit in a single response."
}
},
"description": "A collection of live pipelines."
},
"PipelineTopologyCollection": {
"type": "object",
"properties": {
"value": {
"type": "array",
"description": "List of pipeline topologies.",
"items": {
"$ref": "#/definitions/PipelineTopology"
}
},
"@continuationToken": {
"type": "string",
"description": "A continuation token to be used in subsequent calls when enumerating through the collection. This is returned when the collection results won't fit in a single response."
}
},
"description": "A collection of pipeline topologies."
},
"PipelineTopology": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Pipeline topology unique identifier."
},
"systemData": {
"$ref": "#/definitions/SystemData",
"description": "Read-only system metadata associated with this object."
},
"properties": {
"$ref": "#/definitions/PipelineTopologyProperties",
"description": "Pipeline topology properties."
}
},
"description": "Pipeline topology describes the processing steps to be applied when processing media for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics. For instance, a pipeline topology which acquires data from a RTSP camera, process it with an specific AI model and stored the data on the cloud can be reused across many different cameras, as long as the same processing should be applied across all the cameras. Individual instance properties can be defined through the use of user-defined parameters, which allow for a topology to be parameterized, thus allowing individual pipelines to refer to different values, such as individual cameras RTSP endpoints and credentials. Overall a topology is composed of the following:\r\n\r\n - Parameters: list of user defined parameters that can be references across the topology nodes.\r\n - Sources: list of one or more data sources nodes such as an RTSP source which allows for media to be ingested from cameras.\r\n - Processors: list of nodes which perform data analysis or transformations.\r\n -Sinks: list of one or more data sinks which allow for data to be stored or exported to other destinations."
},
"PipelineTopologyProperties": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here."
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/ParameterDeclaration"
},
"description": "List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through the use of \"${PARAMETER_NAME}\" string pattern. Parameters can have optional default values and can later be defined in individual instances of the pipeline."
},
"sources": {
"type": "array",
"items": {
"$ref": "#/definitions/SourceNodeBase"
},
"description": "List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline."
},
"processors": {
"type": "array",
"items": {
"$ref": "#/definitions/ProcessorNodeBase"
},
"description": "List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed."
},
"sinks": {
"type": "array",
"items": {
"$ref": "#/definitions/SinkNodeBase"
},
"description": "List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported."
}
},
"description": "Pipeline topology properties."
},
"SystemData": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date and time when this resource was first created. Value is represented in UTC according to the ISO8601 date format."
},
"lastModifiedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time when this resource was last modified. Value is represented in UTC according to the ISO8601 date format."
}
},
"description": "Read-only system metadata associated with a resource."
},
"ParameterDeclaration": {
"type": "object",
"required": [
"name",
"type"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the parameter.",
"maxLength": 64
},
"type": {
"type": "string",
"description": "Type of the parameter.",
"enum": [
"string",
"secretString",
"int",
"double",
"bool"
],
"x-ms-enum": {
"name": "parameterType",
"values": [
{
"value": "string",
"description": "The parameter's value is a string."
},
{
"value": "secretString",
"description": "The parameter's value is a string that holds sensitive information."
},
{
"value": "int",
"description": "The parameter's value is a 32-bit signed integer."
},
{
"value": "double",
"description": "The parameter's value is a 64-bit double-precision floating point."
},
{
"value": "bool",
"description": "The parameter's value is a boolean value that is either true or false."
}
],
"modelAsString": true
}
},
"description": {
"type": "string",
"description": "Description of the parameter."
},
"default": {
"type": "string",
"description": "The default value for the parameter to be used if the live pipeline does not specify a value."
}
},
"description": "Single topology parameter declaration. Declared parameters can and must be referenced throughout the topology and can optionally have default values to be used when they are not defined in the pipeline instances."
},
"SourceNodeBase": {
"type": "object",
"required": [
"@type",
"name"
],
"discriminator": "@type",
"properties": {
"@type": {
"type": "string",
"description": "Type discriminator for the derived types."
},
"name": {
"type": "string",
"description": "Node name. Must be unique within the topology."
}
},
"description": "Base class for topology source nodes."
},
"RtspSource": {
"type": "object",
"properties": {
"transport": {
"type": "string",
"description": "Network transport utilized by the RTSP and RTP exchange: TCP or HTTP. When using TCP, the RTP packets are interleaved on the TCP RTSP connection. When using HTTP, the RTSP messages are exchanged through long lived HTTP connections, and the RTP packages are interleaved in the HTTP connections alongside the RTSP messages.",
"enum": [
"http",
"tcp"
],
"x-ms-enum": {
"name": "rtspTransport",
"values": [
{
"value": "http",
"description": "HTTP transport. RTSP messages are exchanged over long running HTTP requests and RTP packets are interleaved within the HTTP channel."
},
{
"value": "tcp",
"description": "TCP transport. RTSP is used directly over TCP and RTP packets are interleaved within the TCP channel."
}
],
"modelAsString": true
}
},
"endpoint": {
"description": "RTSP endpoint information for Video Analyzer to connect to. This contains the required information for Video Analyzer to connect to RTSP cameras and/or generic RTSP servers.",
"$ref": "#/definitions/EndpointBase"
}
},
"required": [
"endpoint"
],
"allOf": [
{
"$ref": "#/definitions/SourceNodeBase"
}
],
"description": "RTSP source allows for media from an RTSP camera or generic RTSP server to be ingested into a live pipeline.",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.RtspSource"
},
"IotHubMessageSource": {
"type": "object",
"properties": {
"hubInputName": {
"type": "string",
"description": "Name of the IoT Edge Hub input from which messages will be consumed."
}
},
"allOf": [
{
"$ref": "#/definitions/SourceNodeBase"
}
],
"description": "IoT Hub Message source allows for the pipeline to consume messages from the IoT Edge Hub. Messages can be routed from other IoT modules via routes declared in the IoT Edge deployment manifest.",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.IotHubMessageSource"
},
"IotHubMessageSink": {
"type": "object",
"properties": {
"hubOutputName": {
"type": "string",
"description": "Name of the Iot Edge Hub output to which the messages will be published."
}
},
"required": [
"@type",
"hubOutputName"
],
"allOf": [
{
"$ref": "#/definitions/SinkNodeBase"
}
],
"description": "IoT Hub Message sink allows for pipeline messages to published into the IoT Edge Hub. Published messages can then be delivered to the cloud and other modules via routes declared in the IoT Edge deployment manifest.",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.IotHubMessageSink"
},
"EndpointBase": {
"type": "object",
"required": [
"@type",
"url"
],
"discriminator": "@type",
"properties": {
"@type": {
"type": "string",
"description": "Type discriminator for the derived types."
},
"credentials": {
"description": "Credentials to be presented to the endpoint.",
"$ref": "#/definitions/CredentialsBase"
},
"url": {
"type": "string",
"description": "The endpoint URL for Video Analyzer to connect to."
}
},
"description": "Base class for endpoints."
},
"CredentialsBase": {
"type": "object",
"required": [
"@type"
],
"discriminator": "@type",
"properties": {
"@type": {
"type": "string",
"description": "Type discriminator for the derived types."
}
},
"description": "Base class for credential objects."
},
"UsernamePasswordCredentials": {
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "Username to be presented as part of the credentials."
},
"password": {
"type": "string",
"description": "Password to be presented as part of the credentials. It is recommended that this value is parameterized as a secret string in order to prevent this value to be returned as part of the resource on API requests."
}
},
"required": [
"username",
"password"
],
"allOf": [
{
"$ref": "#/definitions/CredentialsBase"
}
],
"description": "Username and password credentials.",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.UsernamePasswordCredentials"
},
"HttpHeaderCredentials": {
"type": "object",
"properties": {
"headerName": {
"type": "string",
"description": "HTTP header name."
},
"headerValue": {
"type": "string",
"description": "HTTP header value. It is recommended that this value is parameterized as a secret string in order to prevent this value to be returned as part of the resource on API requests."
}
},
"required": [
"headerName",
"headerValue"
],
"allOf": [
{
"$ref": "#/definitions/CredentialsBase"
}
],
"description": "HTTP header credentials.",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.HttpHeaderCredentials"
},
"UnsecuredEndpoint": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/EndpointBase"
}
],
"description": "Unsecured endpoint describes an endpoint that the pipeline can connect to over clear transport (no encryption in transit).",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.UnsecuredEndpoint"
},
"TlsEndpoint": {
"type": "object",
"properties": {
"trustedCertificates": {
"description": "List of trusted certificate authorities when authenticating a TLS connection. A null list designates that Azure Video Analyzer's list of trusted authorities should be used.",
"$ref": "#/definitions/CertificateSource"
},
"validationOptions": {
"description": "Validation options to use when authenticating a TLS connection. By default, strict validation is used.",
"$ref": "#/definitions/TlsValidationOptions"
}
},
"allOf": [
{
"$ref": "#/definitions/EndpointBase"
}
],
"description": "TLS endpoint describes an endpoint that the pipeline can connect to over TLS transport (data is encrypted in transit).",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.TlsEndpoint"
},
"CertificateSource": {
"type": "object",
"required": [
"@type"
],
"discriminator": "@type",
"properties": {
"@type": {
"type": "string",
"description": "Type discriminator for the derived types."
}
},
"description": "Base class for certificate sources."
},
"TlsValidationOptions": {
"type": "object",
"properties": {
"ignoreHostname": {
"type": "string",
"description": "When set to 'true' causes the certificate subject name validation to be skipped. Default is 'false'."
},
"ignoreSignature": {
"type": "string",
"description": "When set to 'true' causes the certificate chain trust validation to be skipped. Default is 'false'."
}
},
"description": "Options for controlling the validation of TLS endpoints."
},
"PemCertificateList": {
"type": "object",
"properties": {
"certificates": {
"type": "array",
"description": "PEM formatted public certificates. One certificate per entry.",
"items": {
"type": "string"
}
}
},
"required": [
"certificates"
],
"allOf": [
{
"$ref": "#/definitions/CertificateSource"
}
],
"description": "A list of PEM formatted certificates.",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.PemCertificateList"
},
"SinkNodeBase": {
"type": "object",
"required": [
"@type",
"inputs",
"name"
],
"discriminator": "@type",
"properties": {
"@type": {
"type": "string",
"description": "Type discriminator for the derived types."
},
"name": {
"type": "string",
"description": "Node name. Must be unique within the topology."
},
"inputs": {
"type": "array",
"description": "An array of upstream node references within the topology to be used as inputs for this node.",
"items": {
"$ref": "#/definitions/NodeInput"
}
}
},
"description": "Base class for topology sink nodes."
},
"NodeInput": {
"type": "object",
"required": [
"nodeName"
],
"properties": {
"nodeName": {
"type": "string",
"description": "The name of the upstream node in the pipeline which output is used as input of the current node."
},
"outputSelectors": {
"type": "array",
"description": "Allows for the selection of specific data streams (eg. video only) from another node.",
"items": {
"$ref": "#/definitions/OutputSelector"
}
}
},
"description": "Describes an input signal to be used on a pipeline node."
},
"OutputSelector": {
"type": "object",
"properties": {
"property": {
"type": "string",
"description": "The property of the data stream to be used as the selection criteria.",
"enum": [
"mediaType"
],
"x-ms-enum": {
"name": "outputSelectorProperty",
"values": [
{
"value": "mediaType",
"description": "The stream's MIME type or subtype: audio, video or application"
}
],
"modelAsString": true
}
},
"operator": {
"type": "string",
"description": "The operator to compare properties by.",
"enum": [
"is",
"isNot"
],
"x-ms-enum": {
"name": "outputSelectorOperator",
"values": [
{
"value": "is",
"description": "The property is of the type defined by value."
},
{
"value": "isNot",
"description": "The property is not of the type defined by value."
}
],
"modelAsString": true
}
},
"value": {
"type": "string",
"description": "Value to compare against."
}
},
"description": "Allows for the selection of particular streams from another node."
},
"FileSink": {
"type": "object",
"properties": {
"baseDirectoryPath": {
"type": "string",
"description": "Absolute directory path where media files will be stored.",
"example": "/var/media/output/"
},
"fileNamePattern": {
"type": "string",
"description": "File name pattern for creating new files when performing event based recording. The pattern must include at least one system variable.",
"example": "mySampleFile-${System.TopologyName}-${System.PipelineName}-${System.Runtime.DateTime}"
},
"maximumSizeMiB": {
"type": "string",
"description": "Maximum amount of disk space that can be used for storing files from this sink. Once this limit is reached, the oldest files from this sink will be automatically deleted."
}
},
"required": [
"fileNamePattern",
"baseDirectoryPath",
"maximumSizeMiB"
],
"allOf": [
{
"$ref": "#/definitions/SinkNodeBase"
}
],
"description": "File sink allows for video and audio content to be recorded on the file system on the edge device.",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.FileSink"
},
"VideoCreationProperties": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Optional video title provided by the user. Value can be up to 256 characters long."
},
"description": {
"type": "string",
"description": "Optional video description provided by the user. Value can be up to 2048 characters long."
},
"segmentLength": {
"type": "string",
"example": "PT30S",
"description": "Video segment length indicates the length of individual video files (segments) which are persisted to storage. Smaller segments provide lower archive playback latency but generate larger volume of storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency. Value must be specified in ISO8601 duration format (i.e. \"PT30S\" equals 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments. Changing this value after the video is initially created can lead to errors when uploading media to the archive. Default value is 30 seconds."
}
},
"description": "Optional video properties to be used in case a new video resource needs to be created on the service. These will not take effect if the video already exists."
},
"VideoSink": {
"type": "object",
"properties": {
"videoName": {
"type": "string",
"description": "Name of a new or existing Video Analyzer video resource used for the media recording.",
"example": "myVideo001"
},
"videoCreationProperties": {
"description": "Optional video properties to be used in case a new video resource needs to be created on the service.",
"$ref": "#/definitions/VideoCreationProperties"
},
"localMediaCachePath": {
"type": "string",
"description": "Path to a local file system directory for caching of temporary media files. This will also be used to store content which cannot be immediately uploaded to Azure due to Internet connectivity issues.",
"example": "/var/lib/tmp/"
},
"localMediaCacheMaximumSizeMiB": {
"type": "string",
"description": "Maximum amount of disk space that can be used for caching of temporary media files. Once this limit is reached, the oldest segments of the media archive will be continuously deleted in order to make space for new media, thus leading to gaps in the cloud recorded content."
}
},
"required": [
"@type",
"videoName",
"localMediaCachePath",
"localMediaCacheMaximumSizeMiB"
],
"allOf": [
{
"$ref": "#/definitions/SinkNodeBase"
}
],
"description": "Video sink allows for video and audio to be recorded to the Video Analyzer service. The recorded video can be played from anywhere and further managed from the cloud. Due to security reasons, a given Video Analyzer edge module instance can only record content to new video entries, or existing video entries previously recorded by the same module. Any attempt to record content to an existing video which has not been created by the same module instance will result in failure to record.",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.VideoSink"
},
"ProcessorNodeBase": {
"type": "object",
"required": [
"@type",
"inputs",
"name"
],
"discriminator": "@type",
"properties": {
"@type": {
"type": "string",
"description": "Type discriminator for the derived types."
},
"name": {
"type": "string",
"description": "Node name. Must be unique within the topology."
},
"inputs": {
"type": "array",
"description": "An array of upstream node references within the topology to be used as inputs for this node.",
"items": {
"$ref": "#/definitions/NodeInput"
}
}
},
"description": "Base class for topology processor nodes."
},
"MotionDetectionProcessor": {
"type": "object",
"properties": {
"sensitivity": {
"type": "string",
"description": "Motion detection sensitivity: low, medium, high.",
"enum": [
"low",
"medium",
"high"
],
"x-ms-enum": {
"name": "motionDetectionSensitivity",
"values": [
{
"value": "low",
"description": "Low sensitivity."
},
{
"value": "medium",
"description": "Medium sensitivity."
},
{
"value": "high",
"description": "High sensitivity."
}
],
"modelAsString": true
}
},
"outputMotionRegion": {
"type": "boolean",
"description": "Indicates whether the processor should detect and output the regions within the video frame where motion was detected. Default is true."
},
"eventAggregationWindow": {
"type": "string",
"description": "Time window duration on which events are aggregated before being emitted. Value must be specified in ISO8601 duration format (i.e. \"PT2S\" equals 2 seconds). Use 0 seconds for no aggregation. Default is 1 second."
}
},
"allOf": [
{
"$ref": "#/definitions/ProcessorNodeBase"
}
],
"description": "Motion detection processor allows for motion detection on the video stream. It generates motion events whenever motion is present on the video.",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.MotionDetectionProcessor"
},
"ObjectTrackingProcessor": {
"type": "object",
"properties": {
"accuracy": {
"type": "string",
"description": "Object tracker accuracy: low, medium, high. Higher accuracy leads to higher CPU consumption in average.",
"enum": [
"low",
"medium",
"high"
],
"x-ms-enum": {
"name": "objectTrackingAccuracy",
"values": [
{
"value": "low",
"description": "Low accuracy."
},
{
"value": "medium",
"description": "Medium accuracy."
},
{
"value": "high",
"description": "High accuracy."
}
],
"modelAsString": true
}
}
},
"allOf": [
{
"$ref": "#/definitions/ProcessorNodeBase"
}
],
"description": "Object tracker processor allows for continuous tracking of one of more objects over a finite sequence of video frames. It must be used downstream of an object detector extension node, thus allowing for the extension to be configured to to perform inferences on sparse frames through the use of the 'maximumSamplesPerSecond' sampling property. The object tracker node will then track the detected objects over the frames in which the detector is not invoked resulting on a smother tracking of detected objects across the continuum of video frames. The tracker will stop tracking objects which are not subsequently detected by the upstream detector on the subsequent detections.",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.ObjectTrackingProcessor"
},
"LineCrossingProcessor": {
"type": "object",
"required": [
"lines"
],
"properties": {
"lines": {
"type": "array",
"description": "An array of lines used to compute line crossing events.",
"items": {
"$ref": "#/definitions/NamedLineBase"
}
}
},
"allOf": [
{
"$ref": "#/definitions/ProcessorNodeBase"
}
],
"description": "Line crossing processor allows for the detection of tracked objects moving across one or more predefined lines. It must be downstream of an object tracker of downstream on an AI extension node that generates sequenceId for objects which are tracked across different frames of the video. Inference events are generated every time objects crosses from one side of the line to another.",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.LineCrossingProcessor"
},
"ExtensionProcessorBase": {
"type": "object",
"required": [
"endpoint",
"image"
],
"properties": {
"endpoint": {
"description": "Endpoint details of the pipeline extension plugin.",
"$ref": "#/definitions/EndpointBase"
},
"image": {
"description": "Image transformations and formatting options to be applied to the video frame(s) prior submission to the pipeline extension plugin.",
"$ref": "#/definitions/ImageProperties"
},
"samplingOptions": {
"description": "Media sampling parameters that define how often media is submitted to the extension plugin.",
"$ref": "#/definitions/SamplingOptions"
}
},
"allOf": [
{
"$ref": "#/definitions/ProcessorNodeBase"
}
],
"description": "Base class for pipeline extension processors. Pipeline extensions allow for custom media analysis and processing to be plugged into the Video Analyzer pipeline.",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.ExtensionProcessorBase"
},
"GrpcExtension": {
"type": "object",
"required": [
"dataTransfer"
],
"properties": {
"dataTransfer": {
"description": "Specifies how media is transferred to the extension plugin.",
"$ref": "#/definitions/GrpcExtensionDataTransfer"
},
"extensionConfiguration": {
"type": "string",
"description": "An optional configuration string that is sent to the extension plugin. The configuration string is specific to each custom extension and it not understood neither validated by Video Analyzer. Please see https://aka.ms/ava-extension-grpc for details."
}
},
"allOf": [
{
"$ref": "#/definitions/ExtensionProcessorBase"
}
],
"description": "GRPC extension processor allows pipeline extension plugins to be connected to the pipeline through over a gRPC channel. Extension plugins must act as an gRPC server. Please see https://aka.ms/ava-extension-grpc for details.",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.GrpcExtension"
},
"GrpcExtensionDataTransfer": {
"type": "object",
"required": [
"mode"
],
"properties": {
"sharedMemorySizeMiB": {
"type": "string",
"description": "The share memory buffer for sample transfers, in mebibytes. It can only be used with the 'SharedMemory' transfer mode."
},
"mode": {
"type": "string",
"description": "Data transfer mode: embedded or sharedMemory.",
"enum": [
"embedded",
"sharedMemory"
],
"x-ms-enum": {
"name": "grpcExtensionDataTransferMode",
"values": [
{
"value": "embedded",
"description": "Media samples are embedded into the gRPC messages. This mode is less efficient but it requires a simpler implementations and can be used with plugins which are not on the same node as the Video Analyzer module."
},
{
"value": "sharedMemory",
"description": "Media samples are made available through shared memory. This mode enables efficient data transfers but it requires that the extension plugin to be co-located on the same node and sharing the same shared memory space."
}
],
"modelAsString": true
}
}
},
"description": "Describes how media is transferred to the extension plugin.",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.GrpcExtensionDataTransfer"
},
"HttpExtension": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/ExtensionProcessorBase"
}
],
"description": "HTTP extension processor allows pipeline extension plugins to be connected to the pipeline through over the HTTP protocol. Extension plugins must act as an HTTP server. Please see https://aka.ms/ava-extension-http for details.",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.HttpExtension"
},
"ImageProperties": {
"type": "object",
"properties": {
"scale": {
"$ref": "#/definitions/ImageScale"
},
"format": {
"$ref": "#/definitions/ImageFormatProperties"
}
},
"description": "Image transformations and formatting options to be applied to the video frame(s)."
},
"SamplingOptions": {
"type": "object",
"properties": {
"skipSamplesWithoutAnnotation": {
"type": "string",
"description": "When set to 'true', prevents frames without upstream inference data to be sent to the extension plugin. This is useful to limit the frames sent to the extension to pre-analyzed frames only. For example, when used downstream from a motion detector, this can enable for only frames in which motion has been detected to be further analyzed."
},
"maximumSamplesPerSecond": {
"type": "string",
"description": "Maximum rate of samples submitted to the extension. This prevents an extension plugin to be overloaded with data."
}
},
"description": "Defines how often media is submitted to the extension plugin."
},
"ImageScale": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "Describes the image scaling mode to be applied. Default mode is 'pad'.",
"enum": [
"preserveAspectRatio",
"pad",
"stretch"
],
"x-ms-enum": {
"name": "imageScaleMode",
"values": [
{