-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
PipelineTopologies.json
2516 lines (2516 loc) · 94.8 KB
/
PipelineTopologies.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
{
"schemes": [
"https"
],
"swagger": "2.0",
"info": {
"title": "Azure Video Analyzer Resource Provider",
"description": "Azure Video Analyzer resource provider API definition.",
"version": "2021-11-01-preview"
},
"host": "management.azure.com",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "Impersonate your user account"
}
}
},
"definitions": {
"Sku": {
"properties": {
"name": {
"type": "string",
"enum": [
"Live_S1",
"Batch_S1"
],
"x-ms-enum": {
"name": "SkuName",
"values": [
{
"value": "Live_S1",
"description": "Represents the Live S1 SKU name. Using this SKU you can create live pipelines to capture, record, and stream live video from RTSP-capable cameras at bitrate settings from 0.5 Kbps to 3000 Kbps."
},
{
"value": "Batch_S1",
"description": "Represents the Batch S1 SKU name. Using this SKU you can create pipeline jobs to process recorded content."
}
],
"modelAsString": true
},
"description": "The SKU name."
},
"tier": {
"type": "string",
"enum": [
"Standard"
],
"x-ms-enum": {
"name": "SkuTier",
"values": [
{
"value": "Standard",
"description": "Standard tier."
}
],
"modelAsString": true
},
"description": "The SKU tier.",
"readOnly": true,
"x-nullable": false
}
},
"type": "object",
"required": [
"name"
],
"description": "The SKU details."
},
"PipelineTopologyProperties": {
"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"
},
"x-ms-identifiers": [
"name"
],
"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"
},
"x-ms-identifiers": [
"name"
],
"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"
},
"x-ms-identifiers": [
"name"
],
"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"
},
"x-ms-identifiers": [
"name"
],
"description": "List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported."
}
},
"type": "object",
"required": [
"sources",
"sinks"
],
"description": "Describes the properties of a pipeline topology."
},
"PipelineTopologyPropertiesUpdate": {
"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"
},
"x-ms-identifiers": [
"name"
],
"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"
},
"x-ms-identifiers": [
"name"
],
"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"
},
"x-ms-identifiers": [
"name"
],
"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"
},
"x-ms-identifiers": [
"name"
],
"description": "List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported."
}
},
"type": "object",
"description": "Describes the properties of a pipeline topology."
},
"ParameterDeclaration": {
"properties": {
"name": {
"type": "string",
"description": "Name of the parameter."
},
"type": {
"type": "string",
"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 of the parameter."
},
"description": {
"type": "string",
"description": "Description of the parameter."
},
"default": {
"type": "string",
"description": "The default value for the parameter to be used if the pipeline does not specify a value."
}
},
"type": "object",
"required": [
"name",
"type"
],
"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 pipelines."
},
"NodeBase": {
"discriminator": "@type",
"properties": {
"@type": {
"type": "string",
"description": "The discriminator for derived types."
},
"name": {
"type": "string",
"description": "Node name. Must be unique within the topology."
}
},
"type": "object",
"required": [
"@type",
"name"
],
"description": "Base class for nodes."
},
"SourceNodeBase": {
"discriminator": "@type",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.SourceNodeBase",
"allOf": [
{
"$ref": "#/definitions/NodeBase"
}
],
"properties": {
"@type": {
"type": "string",
"description": "The discriminator for derived types."
}
},
"type": "object",
"required": [
"@type"
],
"description": "Base class for topology source nodes."
},
"ProcessorNodeBase": {
"discriminator": "@type",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.ProcessorNodeBase",
"allOf": [
{
"$ref": "#/definitions/NodeBase"
}
],
"properties": {
"@type": {
"type": "string",
"description": "The discriminator for derived types."
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/definitions/NodeInput"
},
"x-ms-identifiers": [
"nodeName"
],
"description": "An array of upstream node references within the topology to be used as inputs for this node."
}
},
"type": "object",
"required": [
"@type",
"inputs"
],
"description": "Base class for topology processor nodes."
},
"SinkNodeBase": {
"discriminator": "@type",
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.SinkNodeBase",
"allOf": [
{
"$ref": "#/definitions/NodeBase"
}
],
"properties": {
"@type": {
"type": "string",
"description": "The discriminator for derived types."
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/definitions/NodeInput"
},
"x-ms-identifiers": [
"nodeName"
],
"description": "An array of upstream node references within the topology to be used as inputs for this node."
}
},
"type": "object",
"required": [
"@type",
"inputs"
],
"description": "Base class for topology sink nodes."
},
"NodeInput": {
"properties": {
"nodeName": {
"type": "string",
"description": "The name of the upstream node in the pipeline which output is used as input of the current node."
}
},
"type": "object",
"required": [
"nodeName"
],
"description": "Describes an input signal to be used on a pipeline node."
},
"RtspSource": {
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.RtspSource",
"allOf": [
{
"$ref": "#/definitions/SourceNodeBase"
}
],
"properties": {
"transport": {
"type": "string",
"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
},
"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."
},
"endpoint": {
"$ref": "#/definitions/EndpointBase",
"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."
}
},
"type": "object",
"required": [
"endpoint"
],
"description": "RTSP source allows for media from an RTSP camera or generic RTSP server to be ingested into a pipeline."
},
"EndpointBase": {
"discriminator": "@type",
"properties": {
"@type": {
"type": "string",
"description": "The discriminator for derived types."
},
"credentials": {
"$ref": "#/definitions/CredentialsBase",
"description": "Credentials to be presented to the endpoint."
},
"url": {
"type": "string",
"description": "The endpoint URL for Video Analyzer to connect to."
},
"tunnel": {
"$ref": "#/definitions/TunnelBase",
"description": "Describes the tunnel through which Video Analyzer can connect to the endpoint URL. This is an optional property, typically used when the endpoint is behind a firewall."
}
},
"type": "object",
"required": [
"@type",
"credentials",
"url"
],
"description": "Base class for endpoints."
},
"CredentialsBase": {
"discriminator": "@type",
"properties": {
"@type": {
"type": "string",
"description": "The discriminator for derived types."
}
},
"type": "object",
"required": [
"@type"
],
"description": "Base class for credential objects."
},
"TunnelBase": {
"discriminator": "@type",
"properties": {
"@type": {
"type": "string",
"description": "The discriminator for derived types."
}
},
"type": "object",
"required": [
"@type"
],
"description": "Base class for tunnel objects."
},
"UsernamePasswordCredentials": {
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.UsernamePasswordCredentials",
"allOf": [
{
"$ref": "#/definitions/CredentialsBase"
}
],
"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."
}
},
"type": "object",
"required": [
"username",
"password"
],
"description": "Username and password credentials."
},
"SecureIotDeviceRemoteTunnel": {
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.SecureIotDeviceRemoteTunnel",
"allOf": [
{
"$ref": "#/definitions/TunnelBase"
}
],
"properties": {
"iotHubName": {
"type": "string",
"description": "Name of the IoT Hub."
},
"deviceId": {
"type": "string",
"description": "The IoT device id to use when establishing the remote tunnel. This string is case-sensitive."
}
},
"type": "object",
"required": [
"iotHubName",
"deviceId"
],
"description": "A remote tunnel securely established using IoT Hub device information."
},
"UnsecuredEndpoint": {
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.UnsecuredEndpoint",
"allOf": [
{
"$ref": "#/definitions/EndpointBase"
}
],
"properties": {},
"type": "object",
"description": "Unsecured endpoint describes an endpoint that the pipeline can connect to over clear transport (no encryption in transit)."
},
"TlsEndpoint": {
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.TlsEndpoint",
"allOf": [
{
"$ref": "#/definitions/EndpointBase"
}
],
"properties": {
"trustedCertificates": {
"$ref": "#/definitions/CertificateSource",
"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."
},
"validationOptions": {
"$ref": "#/definitions/TlsValidationOptions",
"description": "Validation options to use when authenticating a TLS connection. By default, strict validation is used."
}
},
"type": "object",
"description": "TLS endpoint describes an endpoint that the pipeline can connect to over TLS transport (data is encrypted in transit)."
},
"CertificateSource": {
"discriminator": "@type",
"properties": {
"@type": {
"type": "string",
"description": "The discriminator for derived types."
}
},
"type": "object",
"required": [
"@type"
],
"description": "Base class for certificate sources."
},
"TlsValidationOptions": {
"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'."
}
},
"type": "object",
"description": "Options for controlling the validation of TLS endpoints."
},
"PemCertificateList": {
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.PemCertificateList",
"allOf": [
{
"$ref": "#/definitions/CertificateSource"
}
],
"properties": {
"certificates": {
"type": "array",
"items": {
"type": "string"
},
"description": "PEM formatted public certificates. One certificate per entry."
}
},
"type": "object",
"required": [
"certificates"
],
"description": "A list of PEM formatted certificates."
},
"VideoSource": {
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.VideoSource",
"allOf": [
{
"$ref": "#/definitions/SourceNodeBase"
}
],
"properties": {
"videoName": {
"type": "string",
"description": "Name of the Video Analyzer video resource to be used as the source."
},
"timeSequences": {
"$ref": "#/definitions/TimeSequenceBase",
"description": "Describes a sequence of datetime ranges. The video source only picks up recorded media within these ranges."
}
},
"type": "object",
"required": [
"videoName",
"timeSequences"
],
"description": "Video source allows for content from a Video Analyzer video resource to be ingested into a pipeline. Currently supported only with batch pipelines."
},
"TimeSequenceBase": {
"discriminator": "@type",
"properties": {
"@type": {
"type": "string",
"description": "The discriminator for derived types."
}
},
"type": "object",
"required": [
"@type"
],
"description": "A sequence of datetime ranges as a string."
},
"VideoSequenceAbsoluteTimeMarkers": {
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.VideoSequenceAbsoluteTimeMarkers",
"allOf": [
{
"$ref": "#/definitions/TimeSequenceBase"
}
],
"properties": {
"ranges": {
"type": "string",
"description": "The sequence of datetime ranges. Example: '[[\"2021-10-05T03:30:00Z\", \"2021-10-05T03:40:00Z\"]]'."
}
},
"type": "object",
"required": [
"ranges"
],
"description": "A sequence of absolute datetime ranges as a string. The datetime values should follow IS08601, and the sum of the ranges should add up to 24 hours or less. Currently, there can be only one range specified in the sequence."
},
"EncoderProcessor": {
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.EncoderProcessor",
"allOf": [
{
"$ref": "#/definitions/ProcessorNodeBase"
}
],
"properties": {
"preset": {
"$ref": "#/definitions/EncoderPresetBase",
"description": "The encoder preset, which defines the recipe or instructions on how the input content should be processed."
}
},
"type": "object",
"required": [
"preset"
],
"description": "Encoder processor allows for encoding of the input content. For example, it can used to change the resolution from 4K to 1280x720."
},
"EncoderPresetBase": {
"discriminator": "@type",
"properties": {
"@type": {
"type": "string",
"description": "The discriminator for derived types."
}
},
"type": "object",
"required": [
"@type"
],
"description": "Base type for all encoder presets, which define the recipe or instructions on how the input content should be processed."
},
"EncoderSystemPreset": {
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.EncoderSystemPreset",
"allOf": [
{
"$ref": "#/definitions/EncoderPresetBase"
}
],
"properties": {
"name": {
"type": "string",
"enum": [
"SingleLayer_540p_H264_AAC",
"SingleLayer_720p_H264_AAC",
"SingleLayer_1080p_H264_AAC",
"SingleLayer_2160p_H264_AAC"
],
"x-ms-enum": {
"name": "EncoderSystemPresetType",
"values": [
{
"value": "SingleLayer_540p_H264_AAC",
"description": "Produces an MP4 file where the video is encoded with H.264 codec at a picture height of 540 pixels, and at a maximum bitrate of 2000 Kbps. Encoded video has the same average frame rate as the input. The aspect ratio of the input is preserved. If the input content has audio, then it is encoded with AAC-LC codec at 96 Kbps"
},
{
"value": "SingleLayer_720p_H264_AAC",
"description": "Produces an MP4 file where the video is encoded with H.264 codec at a picture height of 720 pixels, and at a maximum bitrate of 3500 Kbps. Encoded video has the same average frame rate as the input. The aspect ratio of the input is preserved. If the input content has audio, then it is encoded with AAC-LC codec at 96 Kbps"
},
{
"value": "SingleLayer_1080p_H264_AAC",
"description": "Produces an MP4 file where the video is encoded with H.264 codec at a picture height of 1080 pixels, and at a maximum bitrate of 6000 Kbps. Encoded video has the same average frame rate as the input. The aspect ratio of the input is preserved. If the input content has audio, then it is encoded with AAC-LC codec at 128 Kbps"
},
{
"value": "SingleLayer_2160p_H264_AAC",
"description": "Produces an MP4 file where the video is encoded with H.264 codec at a picture height of 2160 pixels, and at a maximum bitrate of 16000 Kbps. Encoded video has the same average frame rate as the input. The aspect ratio of the input is preserved. If the input content has audio, then it is encoded with AAC-LC codec at 128 Kbps"
}
],
"modelAsString": true
},
"description": "Name of the built-in encoding preset."
}
},
"type": "object",
"required": [
"name"
],
"description": "Describes a built-in preset for encoding the input content using the encoder processor."
},
"EncoderCustomPreset": {
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.EncoderCustomPreset",
"allOf": [
{
"$ref": "#/definitions/EncoderPresetBase"
}
],
"properties": {
"audioEncoder": {
"$ref": "#/definitions/AudioEncoderBase",
"description": "Describes a custom preset for encoding audio."
},
"videoEncoder": {
"$ref": "#/definitions/VideoEncoderBase",
"description": "Describes a custom preset for encoding video."
}
},
"type": "object",
"description": "Describes a custom preset for encoding the input content using the encoder processor."
},
"AudioEncoderBase": {
"discriminator": "@type",
"properties": {
"@type": {
"type": "string",
"description": "The discriminator for derived types."
},
"bitrateKbps": {
"type": "string",
"description": "Bitrate, in kilobits per second or Kbps, at which audio should be encoded (2-channel stereo audio at a sampling rate of 48 kHz). Allowed values are 96, 112, 128, 160, 192, 224, and 256. If omitted, the bitrate of the input audio is used."
}
},
"type": "object",
"required": [
"@type"
],
"description": "Base type for all audio encoder presets, which define the recipe or instructions on how audio should be processed."
},
"VideoEncoderBase": {
"discriminator": "@type",
"properties": {
"@type": {
"type": "string",
"description": "The discriminator for derived types."
},
"bitrateKbps": {
"type": "string",
"description": "The maximum bitrate, in kilobits per second or Kbps, at which video should be encoded. If omitted, encoder sets it automatically to try and match the quality of the input video."
},
"frameRate": {
"type": "string",
"description": "The frame rate (in frames per second) of the encoded video. The value must be greater than zero, and less than or equal to 300. If omitted, the encoder uses the average frame rate of the input video."
},
"scale": {
"$ref": "#/definitions/VideoScale",
"description": "Describes the resolution of the encoded video. If omitted, the encoder uses the resolution of the input video."
}
},
"type": "object",
"required": [
"@type"
],
"description": "Base type for all video encoding presets, which define the recipe or instructions on how the input video should be processed."
},
"AudioEncoderAac": {
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.AudioEncoderAac",
"allOf": [
{
"$ref": "#/definitions/AudioEncoderBase"
}
],
"properties": {},
"type": "object",
"description": "A custom preset for encoding audio with the AAC codec."
},
"VideoScale": {
"properties": {
"height": {
"type": "string",
"description": "The desired output video height."
},
"width": {
"type": "string",
"description": "The desired output video width."
},
"mode": {
"type": "string",
"enum": [
"Pad",
"PreserveAspectRatio",
"Stretch"
],
"x-ms-enum": {
"name": "VideoScaleMode",
"values": [
{
"value": "Pad",
"description": "Pads the video with black horizontal stripes (letterbox) or black vertical stripes (pillar-box) so the video is resized to the specified dimensions while not altering the content aspect ratio."
},
{
"value": "PreserveAspectRatio",
"description": "Preserves the same aspect ratio as the input video. If only one video dimension is provided, the second dimension is calculated based on the input video aspect ratio. When 2 dimensions are provided, the video is resized to fit the most constraining dimension, considering the input video size and aspect ratio."
},
{
"value": "Stretch",
"description": "Stretches the original video so it resized to the specified dimensions."
}
],
"modelAsString": true
},
"description": "Describes the video scaling mode to be applied. Default mode is 'Pad'. If the mode is 'Pad' or 'Stretch' then both width and height must be specified. Else if the mode is 'PreserveAspectRatio' then only one of width or height need be provided."
}
},
"type": "object",
"description": "The video scaling information."
},
"VideoEncoderH264": {
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.VideoEncoderH264",
"allOf": [
{
"$ref": "#/definitions/VideoEncoderBase"
}
],
"properties": {},
"type": "object",
"description": "A custom preset for encoding video with the H.264 (AVC) codec."
},
"VideoSink": {
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.VideoSink",
"allOf": [
{
"$ref": "#/definitions/SinkNodeBase"
}
],
"properties": {
"videoName": {
"type": "string",
"description": "Name of a new or existing video resource used to capture and publish content. Note: if downstream of RTSP source, and if disableArchive is set to true, then no content is archived."
},
"videoCreationProperties": {
"$ref": "#/definitions/VideoCreationProperties",
"description": "Optional video properties to be used in case a new video resource needs to be created on the service."
},
"videoPublishingOptions": {
"$ref": "#/definitions/VideoPublishingOptions",
"description": "Options to change how the video sink publishes content via the video resource. This property is only allowed for topologies where \"kind\" is set to \"live\"."
}
},
"type": "object",
"required": [
"videoName"
],
"description": "Video sink in a live topology allows for video and audio to be captured, optionally archived, and published via a video resource. If archiving is enabled, this results in a video of type 'archive'. If used in a batch topology, this allows for video and audio to be stored as a file, and published via a video resource of type 'file'"
},
"VideoCreationProperties": {
"properties": {
"title": {
"type": "string",
"description": "Optional title provided by the user. Value can be up to 256 characters long."
},
"description": {
"type": "string",
"description": "Optional description provided by the user. Value can be up to 2048 characters long."
},
"segmentLength": {
"type": "string",
"description": "Segment length indicates the length of individual content 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 initial call to create the video resource can lead to errors when uploading content to the archive. Default value is 30 seconds. This property is only allowed for topologies where \"kind\" is set to \"live\"."
},
"retentionPeriod": {
"type": "string",
"description": "Video retention period indicates how long the video is kept in storage. Value must be specified in ISO8601 duration format (i.e. \"P1D\" equals 1 day) and can vary between 1 day to 10 years, in 1 day increments. When absent (null), all video content is retained indefinitely. This property is only allowed for topologies where \"kind\" is set to \"live\"."
}
},
"type": "object",
"description": "Optional 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."
},
"VideoPublishingOptions": {
"properties": {
"disableArchive": {
"type": "string",
"description": "When set to 'true' content will not be archived or recorded. This is used, for example, when the topology is used only for low latency video streaming. Default is 'false'. If set to 'true', then \"disableRtspPublishing\" must be set to 'false'."
},
"disableRtspPublishing": {
"type": "string",
"description": "When set to 'true' the RTSP playback URL will not be published, disabling low latency streaming. This is used, for example, when the topology is used only for archiving content. Default is 'false'. If set to 'true', then \"disableArchive\" must be set to 'false'."
}
},
"type": "object",
"description": "Optional flags used to change how video is published. These are only allowed for topologies where \"kind\" is set to \"live\"."
},
"ParameterDefinition": {
"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 pipeline."
}
},
"type": "object",
"required": [
"name"
],
"description": "Defines the parameter value of an specific pipeline topology parameter. See pipeline topology parameters for more information."
},
"PipelineTopology": {
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
],
"properties": {
"properties": {
"$ref": "#/definitions/PipelineTopologyProperties",
"description": "The resource properties.",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"enum": [
"Live",
"Batch"
],
"x-ms-enum": {
"name": "Kind",
"values": [
{
"value": "Live",
"description": "Live pipeline topology resource."
},
{
"value": "Batch",
"description": "Batch pipeline topology resource."
}
],
"modelAsString": true
},
"description": "Topology kind."
},
"sku": {
"$ref": "#/definitions/Sku",
"description": "Describes the properties of a SKU."
}
},
"type": "object",
"required": [
"kind",
"sku"
],
"description": "Pipeline topology describes the processing steps to be applied when processing content 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 captures content from a RTSP camera and archives the content can be reused across many different cameras, as long as the same processing is to 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. This allows individual pipelines 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 content 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."
},
"PipelineTopologyUpdate": {
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
],
"properties": {
"properties": {
"$ref": "#/definitions/PipelineTopologyPropertiesUpdate",
"description": "The resource properties.",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"enum": [
"Live",
"Batch"
],
"x-ms-enum": {
"name": "Kind",
"values": [
{
"value": "Live",
"description": "Live pipeline topology resource."
},
{
"value": "Batch",
"description": "Batch pipeline topology resource."