/
models_0.ts
3438 lines (2906 loc) · 90.7 KB
/
models_0.ts
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
// smithy-typescript generated code
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
import { MediaConnectServiceException as __BaseException } from "./MediaConnectServiceException";
export enum Colorimetry {
BT2020 = "BT2020",
BT2100 = "BT2100",
BT601 = "BT601",
BT709 = "BT709",
ST2065_1 = "ST2065-1",
ST2065_3 = "ST2065-3",
XYZ = "XYZ",
}
export enum Range {
FULL = "FULL",
FULLPROTECT = "FULLPROTECT",
NARROW = "NARROW",
}
export enum ScanMode {
interlace = "interlace",
progressive = "progressive",
progressive_segmented_frame = "progressive-segmented-frame",
}
export enum Tcs {
BT2100LINHLG = "BT2100LINHLG",
BT2100LINPQ = "BT2100LINPQ",
DENSITY = "DENSITY",
HLG = "HLG",
LINEAR = "LINEAR",
PQ = "PQ",
SDR = "SDR",
ST2065_1 = "ST2065-1",
ST428_1 = "ST428-1",
}
/**
* The settings that you want to use to define the media stream.
*/
export interface FmtpRequest {
/**
* The format of the audio channel.
*/
ChannelOrder?: string;
/**
* The format that is used for the representation of color.
*/
Colorimetry?: Colorimetry | string;
/**
* The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
*/
ExactFramerate?: string;
/**
* The pixel aspect ratio (PAR) of the video.
*/
Par?: string;
/**
* The encoding range of the video.
*/
Range?: Range | string;
/**
* The type of compression that was used to smooth the video’s appearance.
*/
ScanMode?: ScanMode | string;
/**
* The transfer characteristic system (TCS) that is used in the video.
*/
Tcs?: Tcs | string;
}
/**
* Attributes that are related to the media stream.
*/
export interface MediaStreamAttributesRequest {
/**
* The settings that you want to use to define the media stream.
*/
Fmtp?: FmtpRequest;
/**
* The audio language, in a format that is recognized by the receiver.
*/
Lang?: string;
}
export enum MediaStreamType {
ancillary_data = "ancillary-data",
audio = "audio",
video = "video",
}
/**
* The media stream that you want to add to the flow.
*/
export interface AddMediaStreamRequest {
/**
* The attributes that you want to assign to the new media stream.
*/
Attributes?: MediaStreamAttributesRequest;
/**
* The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.
*/
ClockRate?: number;
/**
* A description that can help you quickly identify what your media stream is used for.
*/
Description?: string;
/**
* A unique identifier for the media stream.
*/
MediaStreamId: number | undefined;
/**
* A name that helps you distinguish one media stream from another.
*/
MediaStreamName: string | undefined;
/**
* The type of media stream.
*/
MediaStreamType: MediaStreamType | string | undefined;
/**
* The resolution of the video.
*/
VideoFormat?: string;
}
export enum Algorithm {
aes128 = "aes128",
aes192 = "aes192",
aes256 = "aes256",
}
export enum KeyType {
speke = "speke",
srt_password = "srt-password",
static_key = "static-key",
}
/**
* Information about the encryption of the flow.
*/
export interface Encryption {
/**
* The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
*/
Algorithm?: Algorithm | string;
/**
* A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
*/
ConstantInitializationVector?: string;
/**
* The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
*/
DeviceId?: string;
/**
* The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
*/
KeyType?: KeyType | string;
/**
* The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
*/
Region?: string;
/**
* An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
*/
ResourceId?: string;
/**
* The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
*/
RoleArn: string | undefined;
/**
* The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
*/
SecretArn?: string;
/**
* The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
*/
Url?: string;
}
/**
* The VPC interface that you want to designate where the media stream is coming from or going to.
*/
export interface InterfaceRequest {
/**
* The name of the VPC interface.
*/
Name: string | undefined;
}
/**
* The transport parameters that you want to associate with an outbound media stream.
*/
export interface DestinationConfigurationRequest {
/**
* The IP address where you want MediaConnect to send contents of the media stream.
*/
DestinationIp: string | undefined;
/**
* The port that you want MediaConnect to use when it distributes the media stream to the output.
*/
DestinationPort: number | undefined;
/**
* The VPC interface that you want to use for the media stream associated with the output.
*/
Interface: InterfaceRequest | undefined;
}
export enum EncodingName {
jxsv = "jxsv",
pcm = "pcm",
raw = "raw",
smpte291 = "smpte291",
}
export enum EncoderProfile {
high = "high",
main = "main",
}
/**
* A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.
*/
export interface EncodingParametersRequest {
/**
* A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
*/
CompressionFactor: number | undefined;
/**
* A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, if at least one source on the flow uses the CDI protocol.
*/
EncoderProfile: EncoderProfile | string | undefined;
}
/**
* The media stream that you want to associate with the output, and the parameters for that association.
*/
export interface MediaStreamOutputConfigurationRequest {
/**
* The transport parameters that you want to associate with the media stream.
*/
DestinationConfigurations?: DestinationConfigurationRequest[];
/**
* The format that will be used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
*/
EncodingName: EncodingName | string | undefined;
/**
* A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.
*/
EncodingParameters?: EncodingParametersRequest;
/**
* The name of the media stream that is associated with the output.
*/
MediaStreamName: string | undefined;
}
export enum Protocol {
cdi = "cdi",
fujitsu_qos = "fujitsu-qos",
rist = "rist",
rtp = "rtp",
rtp_fec = "rtp-fec",
srt_caller = "srt-caller",
srt_listener = "srt-listener",
st2110_jpegxs = "st2110-jpegxs",
zixi_pull = "zixi-pull",
zixi_push = "zixi-push",
}
/**
* The settings for attaching a VPC interface to an output.
*/
export interface VpcInterfaceAttachment {
/**
* The name of the VPC interface to use for this output.
*/
VpcInterfaceName?: string;
}
/**
* The output that you want to add to this flow.
*/
export interface AddOutputRequest {
/**
* The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
*/
CidrAllowList?: string[];
/**
* A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
*/
Description?: string;
/**
* The IP address from which video will be sent to output destinations.
*/
Destination?: string;
/**
* The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
*/
Encryption?: Encryption;
/**
* The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
*/
MaxLatency?: number;
/**
* The media streams that are associated with the output, and the parameters for those associations.
*/
MediaStreamOutputConfigurations?: MediaStreamOutputConfigurationRequest[];
/**
* The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
*/
MinLatency?: number;
/**
* The name of the output. This value must be unique within the current flow.
*/
Name?: string;
/**
* The port to use when content is distributed to this output.
*/
Port?: number;
/**
* The protocol to use for the output.
*/
Protocol: Protocol | string | undefined;
/**
* The remote ID for the Zixi-pull output stream.
*/
RemoteId?: string;
/**
* The port that the flow uses to send outbound requests to initiate connection with the sender.
*/
SenderControlPort?: number;
/**
* The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
*/
SmoothingLatency?: number;
/**
* The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
*/
StreamId?: string;
/**
* The name of the VPC interface attachment to use for this output.
*/
VpcInterfaceAttachment?: VpcInterfaceAttachment;
}
/**
* The VPC interface that is used for the media stream associated with the source or output.
*/
export interface Interface {
/**
* The name of the VPC interface.
*/
Name: string | undefined;
}
/**
* The transport parameters that are associated with an outbound media stream.
*/
export interface DestinationConfiguration {
/**
* The IP address where contents of the media stream will be sent.
*/
DestinationIp: string | undefined;
/**
* The port to use when the content of the media stream is distributed to the output.
*/
DestinationPort: number | undefined;
/**
* The VPC interface that is used for the media stream associated with the output.
*/
Interface: Interface | undefined;
/**
* The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol.
*/
OutboundIp: string | undefined;
}
export enum EntitlementStatus {
DISABLED = "DISABLED",
ENABLED = "ENABLED",
}
/**
* The settings for a flow entitlement.
*/
export interface Entitlement {
/**
* Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
*/
DataTransferSubscriberFeePercent?: number;
/**
* A description of the entitlement.
*/
Description?: string;
/**
* The type of encryption that will be used on the output that is associated with this entitlement.
*/
Encryption?: Encryption;
/**
* The ARN of the entitlement.
*/
EntitlementArn: string | undefined;
/**
* An indication of whether the entitlement is enabled.
*/
EntitlementStatus?: EntitlementStatus | string;
/**
* The name of the entitlement.
*/
Name: string | undefined;
/**
* The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
*/
Subscribers: string[] | undefined;
}
/**
* The entitlements that you want to grant on a flow.
*/
export interface GrantEntitlementRequest {
/**
* Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
*/
DataTransferSubscriberFeePercent?: number;
/**
* A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
*/
Description?: string;
/**
* The type of encryption that will be used on the output that is associated with this entitlement.
*/
Encryption?: Encryption;
/**
* An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.
*/
EntitlementStatus?: EntitlementStatus | string;
/**
* The name of the entitlement. This value must be unique within the current flow.
*/
Name?: string;
/**
* The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source.
*/
Subscribers: string[] | undefined;
}
/**
* The transport parameters that are associated with an incoming media stream.
*/
export interface InputConfiguration {
/**
* The IP address that the flow listens on for incoming content for a media stream.
*/
InputIp: string | undefined;
/**
* The port that the flow listens on for an incoming media stream.
*/
InputPort: number | undefined;
/**
* The VPC interface where the media stream comes in from.
*/
Interface: Interface | undefined;
}
/**
* The transport parameters that you want to associate with an incoming media stream.
*/
export interface InputConfigurationRequest {
/**
* The port that you want the flow to listen on for an incoming media stream.
*/
InputPort: number | undefined;
/**
* The VPC interface that you want to use for the incoming media stream.
*/
Interface: InterfaceRequest | undefined;
}
/**
* An entitlement that has been granted to you from other AWS accounts.
*/
export interface ListedEntitlement {
/**
* Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
*/
DataTransferSubscriberFeePercent?: number;
/**
* The ARN of the entitlement.
*/
EntitlementArn: string | undefined;
/**
* The name of the entitlement.
*/
EntitlementName: string | undefined;
}
export enum MaintenanceDay {
Friday = "Friday",
Monday = "Monday",
Saturday = "Saturday",
Sunday = "Sunday",
Thursday = "Thursday",
Tuesday = "Tuesday",
Wednesday = "Wednesday",
}
/**
* The maintenance setting of a flow
*/
export interface Maintenance {
/**
* A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
*/
MaintenanceDay?: MaintenanceDay | string;
/**
* The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.
*/
MaintenanceDeadline?: string;
/**
* A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
*/
MaintenanceScheduledDate?: string;
/**
* UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
*/
MaintenanceStartHour?: string;
}
export enum SourceType {
ENTITLED = "ENTITLED",
OWNED = "OWNED",
}
export enum Status {
ACTIVE = "ACTIVE",
DELETING = "DELETING",
ERROR = "ERROR",
STANDBY = "STANDBY",
STARTING = "STARTING",
STOPPING = "STOPPING",
UPDATING = "UPDATING",
}
/**
* Provides a summary of a flow, including its ARN, Availability Zone, and source type.
*/
export interface ListedFlow {
/**
* The Availability Zone that the flow was created in.
*/
AvailabilityZone: string | undefined;
/**
* A description of the flow.
*/
Description: string | undefined;
/**
* The ARN of the flow.
*/
FlowArn: string | undefined;
/**
* The name of the flow.
*/
Name: string | undefined;
/**
* The type of source. This value is either owned (originated somewhere other than an AWS Elemental MediaConnect flow owned by another AWS account) or entitled (originated at an AWS Elemental MediaConnect flow owned by another AWS account).
*/
SourceType: SourceType | string | undefined;
/**
* The current status of the flow.
*/
Status: Status | string | undefined;
/**
* The maintenance setting of a flow
*/
Maintenance?: Maintenance;
}
/**
* FMTP
*/
export interface Fmtp {
/**
* The format of the audio channel.
*/
ChannelOrder?: string;
/**
* The format that is used for the representation of color.
*/
Colorimetry?: Colorimetry | string;
/**
* The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
*/
ExactFramerate?: string;
/**
* The pixel aspect ratio (PAR) of the video.
*/
Par?: string;
/**
* The encoding range of the video.
*/
Range?: Range | string;
/**
* The type of compression that was used to smooth the video’s appearance
*/
ScanMode?: ScanMode | string;
/**
* The transfer characteristic system (TCS) that is used in the video.
*/
Tcs?: Tcs | string;
}
/**
* Attributes that are related to the media stream.
*/
export interface MediaStreamAttributes {
/**
* A set of parameters that define the media stream.
*/
Fmtp: Fmtp | undefined;
/**
* The audio language, in a format that is recognized by the receiver.
*/
Lang?: string;
}
/**
* A single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams.
*/
export interface MediaStream {
/**
* Attributes that are related to the media stream.
*/
Attributes?: MediaStreamAttributes;
/**
* The sample rate for the stream. This value is measured in Hz.
*/
ClockRate?: number;
/**
* A description that can help you quickly identify what your media stream is used for.
*/
Description?: string;
/**
* The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.
*/
Fmt: number | undefined;
/**
* A unique identifier for the media stream.
*/
MediaStreamId: number | undefined;
/**
* A name that helps you distinguish one media stream from another.
*/
MediaStreamName: string | undefined;
/**
* The type of media stream.
*/
MediaStreamType: MediaStreamType | string | undefined;
/**
* The resolution of the video.
*/
VideoFormat?: string;
}
/**
* A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.
*/
export interface EncodingParameters {
/**
* A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
*/
CompressionFactor: number | undefined;
/**
* A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.
*/
EncoderProfile: EncoderProfile | string | undefined;
}
/**
* The media stream that is associated with the output, and the parameters for that association.
*/
export interface MediaStreamOutputConfiguration {
/**
* The transport parameters that are associated with each outbound media stream.
*/
DestinationConfigurations?: DestinationConfiguration[];
/**
* The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
*/
EncodingName: EncodingName | string | undefined;
/**
* Encoding parameters
*/
EncodingParameters?: EncodingParameters;
/**
* The name of the media stream.
*/
MediaStreamName: string | undefined;
}
/**
* The media stream that is associated with the source, and the parameters for that association.
*/
export interface MediaStreamSourceConfiguration {
/**
* The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
*/
EncodingName: EncodingName | string | undefined;
/**
* The transport parameters that are associated with an incoming media stream.
*/
InputConfigurations?: InputConfiguration[];
/**
* The name of the media stream.
*/
MediaStreamName: string | undefined;
}
/**
* The definition of a media stream that you want to associate with the source.
*/
export interface MediaStreamSourceConfigurationRequest {
/**
* The format you want to use to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
*/
EncodingName: EncodingName | string | undefined;
/**
* The transport parameters that you want to associate with the media stream.
*/
InputConfigurations?: InputConfigurationRequest[];
/**
* The name of the media stream.
*/
MediaStreamName: string | undefined;
}
export enum DurationUnits {
MONTHS = "MONTHS",
}
export enum PriceUnits {
HOURLY = "HOURLY",
}
export enum ResourceType {
Mbps_Outbound_Bandwidth = "Mbps_Outbound_Bandwidth",
}
/**
* A definition of what is being billed for, including the type and amount.
*/
export interface ResourceSpecification {
/**
* The amount of outbound bandwidth that is discounted in the offering.
*/
ReservedBitrate?: number;
/**
* The type of resource and the unit that is being billed for.
*/
ResourceType: ResourceType | string | undefined;
}
/**
* A savings plan that reserves a certain amount of outbound bandwidth usage at a discounted rate each month over a period of time.
*/
export interface Offering {
/**
* The type of currency that is used for billing. The currencyCode used for all reservations is US dollars.
*/
CurrencyCode: string | undefined;
/**
* The length of time that your reservation would be active.
*/
Duration: number | undefined;
/**
* The unit of measurement for the duration of the offering.
*/
DurationUnits: DurationUnits | string | undefined;
/**
* The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
*/
OfferingArn: string | undefined;
/**
* A description of the offering.
*/
OfferingDescription: string | undefined;
/**
* The cost of a single unit. This value, in combination with priceUnits, makes up the rate.
*/
PricePerUnit: string | undefined;
/**
* The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate.
*/
PriceUnits: PriceUnits | string | undefined;
/**
* A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering.
*/
ResourceSpecification: ResourceSpecification | undefined;
}
/**
* Attributes related to the transport stream that are used in a source or output.
*/
export interface Transport {
/**
* The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
*/
CidrAllowList?: string[];
/**
* The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
*/
MaxBitrate?: number;
/**
* The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
*/
MaxLatency?: number;
/**
* The size of the buffer (in milliseconds) to use to sync incoming source data.
*/
MaxSyncBuffer?: number;
/**
* The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
*/
MinLatency?: number;
/**
* The protocol that is used by the source or output.
*/
Protocol: Protocol | string | undefined;
/**
* The remote ID for the Zixi-pull stream.
*/
RemoteId?: string;
/**
* The port that the flow uses to send outbound requests to initiate connection with the sender.
*/
SenderControlPort?: number;
/**
* The IP address that the flow communicates with to initiate connection with the sender.
*/
SenderIpAddress?: string;
/**
* The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
*/
SmoothingLatency?: number;
/**
* Source IP or domain name for SRT-caller protocol.
*/
SourceListenerAddress?: string;
/**
* Source port for SRT-caller protocol.
*/
SourceListenerPort?: number;
/**
* The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
*/
StreamId?: string;
}
/**
* The settings for an output.
*/
export interface Output {
/**
* Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
*/
DataTransferSubscriberFeePercent?: number;
/**
* A description of the output.
*/
Description?: string;
/**
* The address where you want to send the output.
*/
Destination?: string;
/**
* The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
*/
Encryption?: Encryption;
/**
* The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
*/
EntitlementArn?: string;
/**
* The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.