@aws-sdk/client-medialive 3.378.0 → 3.382.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,10 +4,12 @@
4
4
  */
5
5
  export interface InputChannelLevel {
6
6
  /**
7
+ * @public
7
8
  * Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
8
9
  */
9
10
  Gain: number | undefined;
10
11
  /**
12
+ * @public
11
13
  * The index of the input channel used as a source.
12
14
  */
13
15
  InputChannel: number | undefined;
@@ -18,10 +20,12 @@ export interface InputChannelLevel {
18
20
  */
19
21
  export interface AudioChannelMapping {
20
22
  /**
23
+ * @public
21
24
  * Indices and gain values for each input channel that should be remixed into this output channel.
22
25
  */
23
26
  InputChannelLevels: InputChannelLevel[] | undefined;
24
27
  /**
28
+ * @public
25
29
  * The index of the output channel being produced.
26
30
  */
27
31
  OutputChannel: number | undefined;
@@ -55,14 +59,17 @@ export type AudioNormalizationAlgorithmControl = (typeof AudioNormalizationAlgor
55
59
  */
56
60
  export interface AudioNormalizationSettings {
57
61
  /**
62
+ * @public
58
63
  * Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification.
59
64
  */
60
65
  Algorithm?: AudioNormalizationAlgorithm | string;
61
66
  /**
67
+ * @public
62
68
  * When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted.
63
69
  */
64
70
  AlgorithmControl?: AudioNormalizationAlgorithmControl | string;
65
71
  /**
72
+ * @public
66
73
  * Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
67
74
  */
68
75
  TargetLkfs?: number;
@@ -111,14 +118,17 @@ export type NielsenWatermarksCbetStepaside = (typeof NielsenWatermarksCbetStepas
111
118
  */
112
119
  export interface NielsenCBET {
113
120
  /**
121
+ * @public
114
122
  * Enter the CBET check digits to use in the watermark.
115
123
  */
116
124
  CbetCheckDigitString: string | undefined;
117
125
  /**
126
+ * @public
118
127
  * Determines the method of CBET insertion mode when prior encoding is detected on the same layer.
119
128
  */
120
129
  CbetStepaside: NielsenWatermarksCbetStepaside | string | undefined;
121
130
  /**
131
+ * @public
122
132
  * Enter the CBET Source ID (CSID) to use in the watermark
123
133
  */
124
134
  Csid: string | undefined;
@@ -161,14 +171,17 @@ export type NielsenWatermarkTimezones = (typeof NielsenWatermarkTimezones)[keyof
161
171
  */
162
172
  export interface NielsenNaesIiNw {
163
173
  /**
174
+ * @public
164
175
  * Enter the check digit string for the watermark
165
176
  */
166
177
  CheckDigitString: string | undefined;
167
178
  /**
179
+ * @public
168
180
  * Enter the Nielsen Source ID (SID) to include in the watermark
169
181
  */
170
182
  Sid: number | undefined;
171
183
  /**
184
+ * @public
172
185
  * Choose the timezone for the time stamps in the watermark. If not provided,
173
186
  * the timestamps will be in Coordinated Universal Time (UTC)
174
187
  */
@@ -180,16 +193,19 @@ export interface NielsenNaesIiNw {
180
193
  */
181
194
  export interface NielsenWatermarksSettings {
182
195
  /**
196
+ * @public
183
197
  * Complete these fields only if you want to insert watermarks of type Nielsen CBET
184
198
  */
185
199
  NielsenCbetSettings?: NielsenCBET;
186
200
  /**
201
+ * @public
187
202
  * Choose the distribution types that you want to assign to the watermarks:
188
203
  * - PROGRAM_CONTENT
189
204
  * - FINAL_DISTRIBUTOR
190
205
  */
191
206
  NielsenDistributionType?: NielsenWatermarksDistributionTypes | string;
192
207
  /**
208
+ * @public
193
209
  * Complete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW).
194
210
  */
195
211
  NielsenNaesIiNwSettings?: NielsenNaesIiNw;
@@ -200,6 +216,7 @@ export interface NielsenWatermarksSettings {
200
216
  */
201
217
  export interface AudioWatermarkSettings {
202
218
  /**
219
+ * @public
203
220
  * Settings to configure Nielsen Watermarks in the audio encode
204
221
  */
205
222
  NielsenWatermarksSettings?: NielsenWatermarksSettings;
@@ -300,40 +317,49 @@ export type AacVbrQuality = (typeof AacVbrQuality)[keyof typeof AacVbrQuality];
300
317
  */
301
318
  export interface AacSettings {
302
319
  /**
320
+ * @public
303
321
  * Average bitrate in bits/second. Valid values depend on rate control mode and profile.
304
322
  */
305
323
  Bitrate?: number;
306
324
  /**
325
+ * @public
307
326
  * Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.
308
327
  */
309
328
  CodingMode?: AacCodingMode | string;
310
329
  /**
330
+ * @public
311
331
  * Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd.
312
332
  *
313
333
  * Leave set to "normal" when input does not contain pre-mixed audio + AD.
314
334
  */
315
335
  InputType?: AacInputType | string;
316
336
  /**
337
+ * @public
317
338
  * AAC Profile.
318
339
  */
319
340
  Profile?: AacProfile | string;
320
341
  /**
342
+ * @public
321
343
  * Rate Control Mode.
322
344
  */
323
345
  RateControlMode?: AacRateControlMode | string;
324
346
  /**
347
+ * @public
325
348
  * Sets LATM / LOAS AAC output for raw containers.
326
349
  */
327
350
  RawFormat?: AacRawFormat | string;
328
351
  /**
352
+ * @public
329
353
  * Sample rate in Hz. Valid values depend on rate control mode and profile.
330
354
  */
331
355
  SampleRate?: number;
332
356
  /**
357
+ * @public
333
358
  * Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.
334
359
  */
335
360
  Spec?: AacSpec | string;
336
361
  /**
362
+ * @public
337
363
  * VBR Quality Level - Only used if rateControlMode is VBR.
338
364
  */
339
365
  VbrQuality?: AacVbrQuality | string;
@@ -412,30 +438,37 @@ export type Ac3MetadataControl = (typeof Ac3MetadataControl)[keyof typeof Ac3Met
412
438
  */
413
439
  export interface Ac3Settings {
414
440
  /**
441
+ * @public
415
442
  * Average bitrate in bits/second. Valid bitrates depend on the coding mode.
416
443
  */
417
444
  Bitrate?: number;
418
445
  /**
446
+ * @public
419
447
  * Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.
420
448
  */
421
449
  BitstreamMode?: Ac3BitstreamMode | string;
422
450
  /**
451
+ * @public
423
452
  * Dolby Digital coding mode. Determines number of channels.
424
453
  */
425
454
  CodingMode?: Ac3CodingMode | string;
426
455
  /**
456
+ * @public
427
457
  * Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
428
458
  */
429
459
  Dialnorm?: number;
430
460
  /**
461
+ * @public
431
462
  * If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.
432
463
  */
433
464
  DrcProfile?: Ac3DrcProfile | string;
434
465
  /**
466
+ * @public
435
467
  * When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.
436
468
  */
437
469
  LfeFilter?: Ac3LfeFilter | string;
438
470
  /**
471
+ * @public
439
472
  * When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
440
473
  */
441
474
  MetadataControl?: Ac3MetadataControl | string;
@@ -491,31 +524,38 @@ export type Eac3AtmosDrcRf = (typeof Eac3AtmosDrcRf)[keyof typeof Eac3AtmosDrcRf
491
524
  */
492
525
  export interface Eac3AtmosSettings {
493
526
  /**
527
+ * @public
494
528
  * Average bitrate in bits/second. Valid bitrates depend on the coding mode.
495
529
  * // * @affectsRightSizing true
496
530
  */
497
531
  Bitrate?: number;
498
532
  /**
533
+ * @public
499
534
  * Dolby Digital Plus with Dolby Atmos coding mode. Determines number of channels.
500
535
  */
501
536
  CodingMode?: Eac3AtmosCodingMode | string;
502
537
  /**
538
+ * @public
503
539
  * Sets the dialnorm for the output. Default 23.
504
540
  */
505
541
  Dialnorm?: number;
506
542
  /**
543
+ * @public
507
544
  * Sets the Dolby dynamic range compression profile.
508
545
  */
509
546
  DrcLine?: Eac3AtmosDrcLine | string;
510
547
  /**
548
+ * @public
511
549
  * Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.
512
550
  */
513
551
  DrcRf?: Eac3AtmosDrcRf | string;
514
552
  /**
553
+ * @public
515
554
  * Height dimensional trim. Sets the maximum amount to attenuate the height channels when the downstream player isn??t configured to handle Dolby Digital Plus with Dolby Atmos and must remix the channels.
516
555
  */
517
556
  HeightTrim?: number;
518
557
  /**
558
+ * @public
519
559
  * Surround dimensional trim. Sets the maximum amount to attenuate the surround channels when the downstream player isn't configured to handle Dolby Digital Plus with Dolby Atmos and must remix the channels.
520
560
  */
521
561
  SurroundTrim?: number;
@@ -710,82 +750,102 @@ export type Eac3SurroundMode = (typeof Eac3SurroundMode)[keyof typeof Eac3Surrou
710
750
  */
711
751
  export interface Eac3Settings {
712
752
  /**
753
+ * @public
713
754
  * When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.
714
755
  */
715
756
  AttenuationControl?: Eac3AttenuationControl | string;
716
757
  /**
758
+ * @public
717
759
  * Average bitrate in bits/second. Valid bitrates depend on the coding mode.
718
760
  */
719
761
  Bitrate?: number;
720
762
  /**
763
+ * @public
721
764
  * Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.
722
765
  */
723
766
  BitstreamMode?: Eac3BitstreamMode | string;
724
767
  /**
768
+ * @public
725
769
  * Dolby Digital Plus coding mode. Determines number of channels.
726
770
  */
727
771
  CodingMode?: Eac3CodingMode | string;
728
772
  /**
773
+ * @public
729
774
  * When set to enabled, activates a DC highpass filter for all input channels.
730
775
  */
731
776
  DcFilter?: Eac3DcFilter | string;
732
777
  /**
778
+ * @public
733
779
  * Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
734
780
  */
735
781
  Dialnorm?: number;
736
782
  /**
783
+ * @public
737
784
  * Sets the Dolby dynamic range compression profile.
738
785
  */
739
786
  DrcLine?: Eac3DrcLine | string;
740
787
  /**
788
+ * @public
741
789
  * Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.
742
790
  */
743
791
  DrcRf?: Eac3DrcRf | string;
744
792
  /**
793
+ * @public
745
794
  * When encoding 3/2 audio, setting to lfe enables the LFE channel
746
795
  */
747
796
  LfeControl?: Eac3LfeControl | string;
748
797
  /**
798
+ * @public
749
799
  * When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.
750
800
  */
751
801
  LfeFilter?: Eac3LfeFilter | string;
752
802
  /**
803
+ * @public
753
804
  * Left only/Right only center mix level. Only used for 3/2 coding mode.
754
805
  */
755
806
  LoRoCenterMixLevel?: number;
756
807
  /**
808
+ * @public
757
809
  * Left only/Right only surround mix level. Only used for 3/2 coding mode.
758
810
  */
759
811
  LoRoSurroundMixLevel?: number;
760
812
  /**
813
+ * @public
761
814
  * Left total/Right total center mix level. Only used for 3/2 coding mode.
762
815
  */
763
816
  LtRtCenterMixLevel?: number;
764
817
  /**
818
+ * @public
765
819
  * Left total/Right total surround mix level. Only used for 3/2 coding mode.
766
820
  */
767
821
  LtRtSurroundMixLevel?: number;
768
822
  /**
823
+ * @public
769
824
  * When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
770
825
  */
771
826
  MetadataControl?: Eac3MetadataControl | string;
772
827
  /**
828
+ * @public
773
829
  * When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.
774
830
  */
775
831
  PassthroughControl?: Eac3PassthroughControl | string;
776
832
  /**
833
+ * @public
777
834
  * When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.
778
835
  */
779
836
  PhaseControl?: Eac3PhaseControl | string;
780
837
  /**
838
+ * @public
781
839
  * Stereo downmix preference. Only used for 3/2 coding mode.
782
840
  */
783
841
  StereoDownmix?: Eac3StereoDownmix | string;
784
842
  /**
843
+ * @public
785
844
  * When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.
786
845
  */
787
846
  SurroundExMode?: Eac3SurroundExMode | string;
788
847
  /**
848
+ * @public
789
849
  * When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.
790
850
  */
791
851
  SurroundMode?: Eac3SurroundMode | string;
@@ -808,14 +868,17 @@ export type Mp2CodingMode = (typeof Mp2CodingMode)[keyof typeof Mp2CodingMode];
808
868
  */
809
869
  export interface Mp2Settings {
810
870
  /**
871
+ * @public
811
872
  * Average bitrate in bits/second.
812
873
  */
813
874
  Bitrate?: number;
814
875
  /**
876
+ * @public
815
877
  * The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).
816
878
  */
817
879
  CodingMode?: Mp2CodingMode | string;
818
880
  /**
881
+ * @public
819
882
  * Sample rate in Hz.
820
883
  */
821
884
  SampleRate?: number;
@@ -846,14 +909,17 @@ export type WavCodingMode = (typeof WavCodingMode)[keyof typeof WavCodingMode];
846
909
  */
847
910
  export interface WavSettings {
848
911
  /**
912
+ * @public
849
913
  * Bits per sample.
850
914
  */
851
915
  BitDepth?: number;
852
916
  /**
917
+ * @public
853
918
  * The audio coding mode for the WAV audio. The mode determines the number of channels in the audio.
854
919
  */
855
920
  CodingMode?: WavCodingMode | string;
856
921
  /**
922
+ * @public
857
923
  * Sample rate in Hz.
858
924
  */
859
925
  SampleRate?: number;
@@ -864,30 +930,37 @@ export interface WavSettings {
864
930
  */
865
931
  export interface AudioCodecSettings {
866
932
  /**
933
+ * @public
867
934
  * Aac Settings
868
935
  */
869
936
  AacSettings?: AacSettings;
870
937
  /**
938
+ * @public
871
939
  * Ac3 Settings
872
940
  */
873
941
  Ac3Settings?: Ac3Settings;
874
942
  /**
943
+ * @public
875
944
  * Eac3 Atmos Settings
876
945
  */
877
946
  Eac3AtmosSettings?: Eac3AtmosSettings;
878
947
  /**
948
+ * @public
879
949
  * Eac3 Settings
880
950
  */
881
951
  Eac3Settings?: Eac3Settings;
882
952
  /**
953
+ * @public
883
954
  * Mp2 Settings
884
955
  */
885
956
  Mp2Settings?: Mp2Settings;
886
957
  /**
958
+ * @public
887
959
  * Pass Through Settings
888
960
  */
889
961
  PassThroughSettings?: PassThroughSettings;
890
962
  /**
963
+ * @public
891
964
  * Wav Settings
892
965
  */
893
966
  WavSettings?: WavSettings;
@@ -910,14 +983,17 @@ export type AudioDescriptionLanguageCodeControl = (typeof AudioDescriptionLangua
910
983
  */
911
984
  export interface RemixSettings {
912
985
  /**
986
+ * @public
913
987
  * Mapping of input channels to output channels, with appropriate gain adjustments.
914
988
  */
915
989
  ChannelMappings: AudioChannelMapping[] | undefined;
916
990
  /**
991
+ * @public
917
992
  * Number of input channels to be used.
918
993
  */
919
994
  ChannelsIn?: number;
920
995
  /**
996
+ * @public
921
997
  * Number of output channels to be produced.
922
998
  * Valid values: 1, 2, 4, 6, 8
923
999
  */
@@ -929,18 +1005,22 @@ export interface RemixSettings {
929
1005
  */
930
1006
  export interface AudioDescription {
931
1007
  /**
1008
+ * @public
932
1009
  * Advanced audio normalization settings.
933
1010
  */
934
1011
  AudioNormalizationSettings?: AudioNormalizationSettings;
935
1012
  /**
1013
+ * @public
936
1014
  * The name of the AudioSelector used as the source for this AudioDescription.
937
1015
  */
938
1016
  AudioSelectorName: string | undefined;
939
1017
  /**
1018
+ * @public
940
1019
  * Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
941
1020
  */
942
1021
  AudioType?: AudioType | string;
943
1022
  /**
1023
+ * @public
944
1024
  * Determines how audio type is determined.
945
1025
  * followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output.
946
1026
  * useConfigured: The value in Audio Type is included in the output.
@@ -948,30 +1028,37 @@ export interface AudioDescription {
948
1028
  */
949
1029
  AudioTypeControl?: AudioDescriptionAudioTypeControl | string;
950
1030
  /**
1031
+ * @public
951
1032
  * Settings to configure one or more solutions that insert audio watermarks in the audio encode
952
1033
  */
953
1034
  AudioWatermarkingSettings?: AudioWatermarkSettings;
954
1035
  /**
1036
+ * @public
955
1037
  * Audio codec settings.
956
1038
  */
957
1039
  CodecSettings?: AudioCodecSettings;
958
1040
  /**
1041
+ * @public
959
1042
  * RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
960
1043
  */
961
1044
  LanguageCode?: string;
962
1045
  /**
1046
+ * @public
963
1047
  * Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.
964
1048
  */
965
1049
  LanguageCodeControl?: AudioDescriptionLanguageCodeControl | string;
966
1050
  /**
1051
+ * @public
967
1052
  * The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
968
1053
  */
969
1054
  Name: string | undefined;
970
1055
  /**
1056
+ * @public
971
1057
  * Settings that control how input audio channels are remixed into the output audio channels.
972
1058
  */
973
1059
  RemixSettings?: RemixSettings;
974
1060
  /**
1061
+ * @public
975
1062
  * Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
976
1063
  */
977
1064
  StreamName?: string;
@@ -982,10 +1069,12 @@ export interface AudioDescription {
982
1069
  */
983
1070
  export interface AudioHlsRenditionSelection {
984
1071
  /**
1072
+ * @public
985
1073
  * Specifies the GROUP-ID in the #EXT-X-MEDIA tag of the target HLS audio rendition.
986
1074
  */
987
1075
  GroupId: string | undefined;
988
1076
  /**
1077
+ * @public
989
1078
  * Specifies the NAME in the #EXT-X-MEDIA tag of the target HLS audio rendition.
990
1079
  */
991
1080
  Name: string | undefined;
@@ -1008,10 +1097,12 @@ export type AudioLanguageSelectionPolicy = (typeof AudioLanguageSelectionPolicy)
1008
1097
  */
1009
1098
  export interface AudioLanguageSelection {
1010
1099
  /**
1100
+ * @public
1011
1101
  * Selects a specific three-letter language code from within an audio source.
1012
1102
  */
1013
1103
  LanguageCode: string | undefined;
1014
1104
  /**
1105
+ * @public
1015
1106
  * When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language.
1016
1107
  */
1017
1108
  LanguageSelectionPolicy?: AudioLanguageSelectionPolicy | string;
@@ -1022,6 +1113,7 @@ export interface AudioLanguageSelection {
1022
1113
  */
1023
1114
  export interface AudioPidSelection {
1024
1115
  /**
1116
+ * @public
1025
1117
  * Selects a specific PID from within a source.
1026
1118
  */
1027
1119
  Pid: number | undefined;
@@ -1051,6 +1143,7 @@ export type DolbyEProgramSelection = (typeof DolbyEProgramSelection)[keyof typeo
1051
1143
  */
1052
1144
  export interface AudioDolbyEDecode {
1053
1145
  /**
1146
+ * @public
1054
1147
  * Applies only to Dolby E. Enter the program ID (according to the metadata in the audio) of the Dolby E program to extract from the specified track. One program extracted per audio selector. To select multiple programs, create multiple selectors with the same Track and different Program numbers. “All channels” means to ignore the program IDs and include all the channels in this selector; useful if metadata is known to be incorrect.
1055
1148
  */
1056
1149
  ProgramSelection: DolbyEProgramSelection | string | undefined;
@@ -1061,6 +1154,7 @@ export interface AudioDolbyEDecode {
1061
1154
  */
1062
1155
  export interface AudioTrack {
1063
1156
  /**
1157
+ * @public
1064
1158
  * 1-based integer value that maps to a specific audio track
1065
1159
  */
1066
1160
  Track: number | undefined;
@@ -1071,10 +1165,12 @@ export interface AudioTrack {
1071
1165
  */
1072
1166
  export interface AudioTrackSelection {
1073
1167
  /**
1168
+ * @public
1074
1169
  * Selects one or more unique audio tracks from within a source.
1075
1170
  */
1076
1171
  Tracks: AudioTrack[] | undefined;
1077
1172
  /**
1173
+ * @public
1078
1174
  * Configure decoding options for Dolby E streams - these should be Dolby E frames carried in PCM streams tagged with SMPTE-337
1079
1175
  */
1080
1176
  DolbyEDecode?: AudioDolbyEDecode;
@@ -1085,18 +1181,22 @@ export interface AudioTrackSelection {
1085
1181
  */
1086
1182
  export interface AudioSelectorSettings {
1087
1183
  /**
1184
+ * @public
1088
1185
  * Audio Hls Rendition Selection
1089
1186
  */
1090
1187
  AudioHlsRenditionSelection?: AudioHlsRenditionSelection;
1091
1188
  /**
1189
+ * @public
1092
1190
  * Audio Language Selection
1093
1191
  */
1094
1192
  AudioLanguageSelection?: AudioLanguageSelection;
1095
1193
  /**
1194
+ * @public
1096
1195
  * Audio Pid Selection
1097
1196
  */
1098
1197
  AudioPidSelection?: AudioPidSelection;
1099
1198
  /**
1199
+ * @public
1100
1200
  * Audio Track Selection
1101
1201
  */
1102
1202
  AudioTrackSelection?: AudioTrackSelection;
@@ -1107,10 +1207,12 @@ export interface AudioSelectorSettings {
1107
1207
  */
1108
1208
  export interface AudioSelector {
1109
1209
  /**
1210
+ * @public
1110
1211
  * The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
1111
1212
  */
1112
1213
  Name: string | undefined;
1113
1214
  /**
1215
+ * @public
1114
1216
  * The audio selector settings.
1115
1217
  */
1116
1218
  SelectorSettings?: AudioSelectorSettings;
@@ -1121,18 +1223,22 @@ export interface AudioSelector {
1121
1223
  */
1122
1224
  export interface BatchFailedResultModel {
1123
1225
  /**
1226
+ * @public
1124
1227
  * ARN of the resource
1125
1228
  */
1126
1229
  Arn?: string;
1127
1230
  /**
1231
+ * @public
1128
1232
  * Error code for the failed operation
1129
1233
  */
1130
1234
  Code?: string;
1131
1235
  /**
1236
+ * @public
1132
1237
  * ID of the resource
1133
1238
  */
1134
1239
  Id?: string;
1135
1240
  /**
1241
+ * @public
1136
1242
  * Error message for the failed operation
1137
1243
  */
1138
1244
  Message?: string;
@@ -1143,14 +1249,17 @@ export interface BatchFailedResultModel {
1143
1249
  */
1144
1250
  export interface BatchSuccessfulResultModel {
1145
1251
  /**
1252
+ * @public
1146
1253
  * ARN of the resource
1147
1254
  */
1148
1255
  Arn?: string;
1149
1256
  /**
1257
+ * @public
1150
1258
  * ID of the resource
1151
1259
  */
1152
1260
  Id?: string;
1153
1261
  /**
1262
+ * @public
1154
1263
  * Current state of the resource
1155
1264
  */
1156
1265
  State?: string;
@@ -1205,14 +1314,17 @@ export type BurnInBackgroundColor = (typeof BurnInBackgroundColor)[keyof typeof
1205
1314
  */
1206
1315
  export interface InputLocation {
1207
1316
  /**
1317
+ * @public
1208
1318
  * key used to extract the password from EC2 Parameter store
1209
1319
  */
1210
1320
  PasswordParam?: string;
1211
1321
  /**
1322
+ * @public
1212
1323
  * Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
1213
1324
  */
1214
1325
  Uri: string | undefined;
1215
1326
  /**
1327
+ * @public
1216
1328
  * Documentation update needed
1217
1329
  */
1218
1330
  Username?: string;
@@ -1280,70 +1392,87 @@ export type BurnInTeletextGridControl = (typeof BurnInTeletextGridControl)[keyof
1280
1392
  */
1281
1393
  export interface BurnInDestinationSettings {
1282
1394
  /**
1395
+ * @public
1283
1396
  * If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.
1284
1397
  */
1285
1398
  Alignment?: BurnInAlignment | string;
1286
1399
  /**
1400
+ * @public
1287
1401
  * Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
1288
1402
  */
1289
1403
  BackgroundColor?: BurnInBackgroundColor | string;
1290
1404
  /**
1405
+ * @public
1291
1406
  * Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
1292
1407
  */
1293
1408
  BackgroundOpacity?: number;
1294
1409
  /**
1410
+ * @public
1295
1411
  * External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
1296
1412
  */
1297
1413
  Font?: InputLocation;
1298
1414
  /**
1415
+ * @public
1299
1416
  * Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
1300
1417
  */
1301
1418
  FontColor?: BurnInFontColor | string;
1302
1419
  /**
1420
+ * @public
1303
1421
  * Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
1304
1422
  */
1305
1423
  FontOpacity?: number;
1306
1424
  /**
1425
+ * @public
1307
1426
  * Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
1308
1427
  */
1309
1428
  FontResolution?: number;
1310
1429
  /**
1430
+ * @public
1311
1431
  * When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
1312
1432
  */
1313
1433
  FontSize?: string;
1314
1434
  /**
1435
+ * @public
1315
1436
  * Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
1316
1437
  */
1317
1438
  OutlineColor?: BurnInOutlineColor | string;
1318
1439
  /**
1440
+ * @public
1319
1441
  * Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
1320
1442
  */
1321
1443
  OutlineSize?: number;
1322
1444
  /**
1445
+ * @public
1323
1446
  * Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
1324
1447
  */
1325
1448
  ShadowColor?: BurnInShadowColor | string;
1326
1449
  /**
1450
+ * @public
1327
1451
  * Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
1328
1452
  */
1329
1453
  ShadowOpacity?: number;
1330
1454
  /**
1455
+ * @public
1331
1456
  * Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
1332
1457
  */
1333
1458
  ShadowXOffset?: number;
1334
1459
  /**
1460
+ * @public
1335
1461
  * Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
1336
1462
  */
1337
1463
  ShadowYOffset?: number;
1338
1464
  /**
1465
+ * @public
1339
1466
  * Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
1340
1467
  */
1341
1468
  TeletextGridControl?: BurnInTeletextGridControl | string;
1342
1469
  /**
1470
+ * @public
1343
1471
  * Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
1344
1472
  */
1345
1473
  XPosition?: number;
1346
1474
  /**
1475
+ * @public
1347
1476
  * Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
1348
1477
  */
1349
1478
  YPosition?: number;
@@ -1437,70 +1566,87 @@ export type DvbSubDestinationTeletextGridControl = (typeof DvbSubDestinationTele
1437
1566
  */
1438
1567
  export interface DvbSubDestinationSettings {
1439
1568
  /**
1569
+ * @public
1440
1570
  * If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
1441
1571
  */
1442
1572
  Alignment?: DvbSubDestinationAlignment | string;
1443
1573
  /**
1574
+ * @public
1444
1575
  * Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
1445
1576
  */
1446
1577
  BackgroundColor?: DvbSubDestinationBackgroundColor | string;
1447
1578
  /**
1579
+ * @public
1448
1580
  * Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
1449
1581
  */
1450
1582
  BackgroundOpacity?: number;
1451
1583
  /**
1584
+ * @public
1452
1585
  * External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
1453
1586
  */
1454
1587
  Font?: InputLocation;
1455
1588
  /**
1589
+ * @public
1456
1590
  * Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
1457
1591
  */
1458
1592
  FontColor?: DvbSubDestinationFontColor | string;
1459
1593
  /**
1594
+ * @public
1460
1595
  * Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
1461
1596
  */
1462
1597
  FontOpacity?: number;
1463
1598
  /**
1599
+ * @public
1464
1600
  * Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
1465
1601
  */
1466
1602
  FontResolution?: number;
1467
1603
  /**
1604
+ * @public
1468
1605
  * When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
1469
1606
  */
1470
1607
  FontSize?: string;
1471
1608
  /**
1609
+ * @public
1472
1610
  * Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
1473
1611
  */
1474
1612
  OutlineColor?: DvbSubDestinationOutlineColor | string;
1475
1613
  /**
1614
+ * @public
1476
1615
  * Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
1477
1616
  */
1478
1617
  OutlineSize?: number;
1479
1618
  /**
1619
+ * @public
1480
1620
  * Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
1481
1621
  */
1482
1622
  ShadowColor?: DvbSubDestinationShadowColor | string;
1483
1623
  /**
1624
+ * @public
1484
1625
  * Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
1485
1626
  */
1486
1627
  ShadowOpacity?: number;
1487
1628
  /**
1629
+ * @public
1488
1630
  * Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
1489
1631
  */
1490
1632
  ShadowXOffset?: number;
1491
1633
  /**
1634
+ * @public
1492
1635
  * Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
1493
1636
  */
1494
1637
  ShadowYOffset?: number;
1495
1638
  /**
1639
+ * @public
1496
1640
  * Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
1497
1641
  */
1498
1642
  TeletextGridControl?: DvbSubDestinationTeletextGridControl | string;
1499
1643
  /**
1644
+ * @public
1500
1645
  * Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
1501
1646
  */
1502
1647
  XPosition?: number;
1503
1648
  /**
1649
+ * @public
1504
1650
  * Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
1505
1651
  */
1506
1652
  YPosition?: number;
@@ -1535,10 +1681,12 @@ export type EbuTtDDestinationStyleControl = (typeof EbuTtDDestinationStyleContro
1535
1681
  */
1536
1682
  export interface EbuTtDDestinationSettings {
1537
1683
  /**
1684
+ * @public
1538
1685
  * Complete this field if you want to include the name of the copyright holder in the copyright tag in the captions metadata.
1539
1686
  */
1540
1687
  CopyrightHolder?: string;
1541
1688
  /**
1689
+ * @public
1542
1690
  * Specifies how to handle the gap between the lines (in multi-line captions).
1543
1691
  *
1544
1692
  * - enabled: Fill with the captions background color (as specified in the input captions).
@@ -1546,6 +1694,7 @@ export interface EbuTtDDestinationSettings {
1546
1694
  */
1547
1695
  FillLineGap?: EbuTtDFillLineGapControl | string;
1548
1696
  /**
1697
+ * @public
1549
1698
  * Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to "monospaced". (If styleControl is set to exclude, the font family is always set to "monospaced".)
1550
1699
  *
1551
1700
  * You specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size.
@@ -1555,6 +1704,7 @@ export interface EbuTtDDestinationSettings {
1555
1704
  */
1556
1705
  FontFamily?: string;
1557
1706
  /**
1707
+ * @public
1558
1708
  * Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions.
1559
1709
  *
1560
1710
  * - include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext.
@@ -1622,6 +1772,7 @@ export type TtmlDestinationStyleControl = (typeof TtmlDestinationStyleControl)[k
1622
1772
  */
1623
1773
  export interface TtmlDestinationSettings {
1624
1774
  /**
1775
+ * @public
1625
1776
  * This field is not currently supported and will not affect the output styling. Leave the default value.
1626
1777
  */
1627
1778
  StyleControl?: TtmlDestinationStyleControl | string;
@@ -1644,6 +1795,7 @@ export type WebvttDestinationStyleControl = (typeof WebvttDestinationStyleContro
1644
1795
  */
1645
1796
  export interface WebvttDestinationSettings {
1646
1797
  /**
1798
+ * @public
1647
1799
  * Controls whether the color and position of the source captions is passed through to the WebVTT output captions. PASSTHROUGH - Valid only if the source captions are EMBEDDED or TELETEXT. NO_STYLE_DATA - Don't pass through the style. The output captions will not contain any font styling information.
1648
1800
  */
1649
1801
  StyleControl?: WebvttDestinationStyleControl | string;
@@ -1654,54 +1806,67 @@ export interface WebvttDestinationSettings {
1654
1806
  */
1655
1807
  export interface CaptionDestinationSettings {
1656
1808
  /**
1809
+ * @public
1657
1810
  * Arib Destination Settings
1658
1811
  */
1659
1812
  AribDestinationSettings?: AribDestinationSettings;
1660
1813
  /**
1814
+ * @public
1661
1815
  * Burn In Destination Settings
1662
1816
  */
1663
1817
  BurnInDestinationSettings?: BurnInDestinationSettings;
1664
1818
  /**
1819
+ * @public
1665
1820
  * Dvb Sub Destination Settings
1666
1821
  */
1667
1822
  DvbSubDestinationSettings?: DvbSubDestinationSettings;
1668
1823
  /**
1824
+ * @public
1669
1825
  * Ebu Tt DDestination Settings
1670
1826
  */
1671
1827
  EbuTtDDestinationSettings?: EbuTtDDestinationSettings;
1672
1828
  /**
1829
+ * @public
1673
1830
  * Embedded Destination Settings
1674
1831
  */
1675
1832
  EmbeddedDestinationSettings?: EmbeddedDestinationSettings;
1676
1833
  /**
1834
+ * @public
1677
1835
  * Embedded Plus Scte20 Destination Settings
1678
1836
  */
1679
1837
  EmbeddedPlusScte20DestinationSettings?: EmbeddedPlusScte20DestinationSettings;
1680
1838
  /**
1839
+ * @public
1681
1840
  * Rtmp Caption Info Destination Settings
1682
1841
  */
1683
1842
  RtmpCaptionInfoDestinationSettings?: RtmpCaptionInfoDestinationSettings;
1684
1843
  /**
1844
+ * @public
1685
1845
  * Scte20 Plus Embedded Destination Settings
1686
1846
  */
1687
1847
  Scte20PlusEmbeddedDestinationSettings?: Scte20PlusEmbeddedDestinationSettings;
1688
1848
  /**
1849
+ * @public
1689
1850
  * Scte27 Destination Settings
1690
1851
  */
1691
1852
  Scte27DestinationSettings?: Scte27DestinationSettings;
1692
1853
  /**
1854
+ * @public
1693
1855
  * Smpte Tt Destination Settings
1694
1856
  */
1695
1857
  SmpteTtDestinationSettings?: SmpteTtDestinationSettings;
1696
1858
  /**
1859
+ * @public
1697
1860
  * Teletext Destination Settings
1698
1861
  */
1699
1862
  TeletextDestinationSettings?: TeletextDestinationSettings;
1700
1863
  /**
1864
+ * @public
1701
1865
  * Ttml Destination Settings
1702
1866
  */
1703
1867
  TtmlDestinationSettings?: TtmlDestinationSettings;
1704
1868
  /**
1869
+ * @public
1705
1870
  * Webvtt Destination Settings
1706
1871
  */
1707
1872
  WebvttDestinationSettings?: WebvttDestinationSettings;
@@ -1712,26 +1877,32 @@ export interface CaptionDestinationSettings {
1712
1877
  */
1713
1878
  export interface CaptionDescription {
1714
1879
  /**
1880
+ * @public
1715
1881
  * Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds.
1716
1882
  */
1717
1883
  Accessibility?: AccessibilityType | string;
1718
1884
  /**
1885
+ * @public
1719
1886
  * Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
1720
1887
  */
1721
1888
  CaptionSelectorName: string | undefined;
1722
1889
  /**
1890
+ * @public
1723
1891
  * Additional settings for captions destination that depend on the destination type.
1724
1892
  */
1725
1893
  DestinationSettings?: CaptionDestinationSettings;
1726
1894
  /**
1895
+ * @public
1727
1896
  * ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
1728
1897
  */
1729
1898
  LanguageCode?: string;
1730
1899
  /**
1900
+ * @public
1731
1901
  * Human readable information to indicate captions available for players (eg. English, or Spanish).
1732
1902
  */
1733
1903
  LanguageDescription?: string;
1734
1904
  /**
1905
+ * @public
1735
1906
  * Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
1736
1907
  */
1737
1908
  Name: string | undefined;
@@ -1742,14 +1913,17 @@ export interface CaptionDescription {
1742
1913
  */
1743
1914
  export interface CaptionLanguageMapping {
1744
1915
  /**
1916
+ * @public
1745
1917
  * The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
1746
1918
  */
1747
1919
  CaptionChannel: number | undefined;
1748
1920
  /**
1921
+ * @public
1749
1922
  * Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
1750
1923
  */
1751
1924
  LanguageCode: string | undefined;
1752
1925
  /**
1926
+ * @public
1753
1927
  * Textual description of language
1754
1928
  */
1755
1929
  LanguageDescription: string | undefined;
@@ -1760,6 +1934,7 @@ export interface CaptionLanguageMapping {
1760
1934
  */
1761
1935
  export interface AncillarySourceSettings {
1762
1936
  /**
1937
+ * @public
1763
1938
  * Specifies the number (1 to 4) of the captions channel you want to extract from the ancillary captions. If you plan to convert the ancillary captions to another format, complete this field. If you plan to choose Embedded as the captions destination in the output (to pass through all the channels in the ancillary captions), leave this field blank because MediaLive ignores the field.
1764
1939
  */
1765
1940
  SourceAncillaryChannelNumber?: number;
@@ -1792,11 +1967,13 @@ export type DvbSubOcrLanguage = (typeof DvbSubOcrLanguage)[keyof typeof DvbSubOc
1792
1967
  */
1793
1968
  export interface DvbSubSourceSettings {
1794
1969
  /**
1970
+ * @public
1795
1971
  * If you will configure a WebVTT caption description that references this caption selector, use this field to
1796
1972
  * provide the language to consider when translating the image-based source to text.
1797
1973
  */
1798
1974
  OcrLanguage?: DvbSubOcrLanguage | string;
1799
1975
  /**
1976
+ * @public
1800
1977
  * When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
1801
1978
  */
1802
1979
  Pid?: number;
@@ -1831,18 +2008,22 @@ export type EmbeddedScte20Detection = (typeof EmbeddedScte20Detection)[keyof typ
1831
2008
  */
1832
2009
  export interface EmbeddedSourceSettings {
1833
2010
  /**
2011
+ * @public
1834
2012
  * If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
1835
2013
  */
1836
2014
  Convert608To708?: EmbeddedConvert608To708 | string;
1837
2015
  /**
2016
+ * @public
1838
2017
  * Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.
1839
2018
  */
1840
2019
  Scte20Detection?: EmbeddedScte20Detection | string;
1841
2020
  /**
2021
+ * @public
1842
2022
  * Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
1843
2023
  */
1844
2024
  Source608ChannelNumber?: number;
1845
2025
  /**
2026
+ * @public
1846
2027
  * This field is unused and deprecated.
1847
2028
  */
1848
2029
  Source608TrackNumber?: number;
@@ -1865,10 +2046,12 @@ export type Scte20Convert608To708 = (typeof Scte20Convert608To708)[keyof typeof
1865
2046
  */
1866
2047
  export interface Scte20SourceSettings {
1867
2048
  /**
2049
+ * @public
1868
2050
  * If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.
1869
2051
  */
1870
2052
  Convert608To708?: Scte20Convert608To708 | string;
1871
2053
  /**
2054
+ * @public
1872
2055
  * Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
1873
2056
  */
1874
2057
  Source608ChannelNumber?: number;
@@ -1895,11 +2078,13 @@ export type Scte27OcrLanguage = (typeof Scte27OcrLanguage)[keyof typeof Scte27Oc
1895
2078
  */
1896
2079
  export interface Scte27SourceSettings {
1897
2080
  /**
2081
+ * @public
1898
2082
  * If you will configure a WebVTT caption description that references this caption selector, use this field to
1899
2083
  * provide the language to consider when translating the image-based source to text.
1900
2084
  */
1901
2085
  OcrLanguage?: Scte27OcrLanguage | string;
1902
2086
  /**
2087
+ * @public
1903
2088
  * The pid field is used in conjunction with the caption selector languageCode field as follows:
1904
2089
  * - Specify PID and Language: Extracts captions from that PID; the language is "informational".
1905
2090
  * - Specify PID and omit Language: Extracts the specified PID.
@@ -1914,12 +2099,14 @@ export interface Scte27SourceSettings {
1914
2099
  */
1915
2100
  export interface CaptionRectangle {
1916
2101
  /**
2102
+ * @public
1917
2103
  * See the description in leftOffset.
1918
2104
  * For height, specify the entire height of the rectangle as a percentage of the underlying frame height. For example, \"80\" means the rectangle height is 80% of the underlying frame height. The topOffset and rectangleHeight must add up to 100% or less.
1919
2105
  * This field corresponds to tts:extent - Y in the TTML standard.
1920
2106
  */
1921
2107
  Height: number | undefined;
1922
2108
  /**
2109
+ * @public
1923
2110
  * Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. (Make sure to leave the default if you don't have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages.
1924
2111
  * If you specify a value for one of these fields, you must specify a value for all of them.
1925
2112
  * For leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, \"10\" means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame.
@@ -1927,12 +2114,14 @@ export interface CaptionRectangle {
1927
2114
  */
1928
2115
  LeftOffset: number | undefined;
1929
2116
  /**
2117
+ * @public
1930
2118
  * See the description in leftOffset.
1931
2119
  * For topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, \"10\" means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame.
1932
2120
  * This field corresponds to tts:origin - Y in the TTML standard.
1933
2121
  */
1934
2122
  TopOffset: number | undefined;
1935
2123
  /**
2124
+ * @public
1936
2125
  * See the description in leftOffset.
1937
2126
  * For width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, \"80\" means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less.
1938
2127
  * This field corresponds to tts:extent - X in the TTML standard.
@@ -1945,10 +2134,12 @@ export interface CaptionRectangle {
1945
2134
  */
1946
2135
  export interface TeletextSourceSettings {
1947
2136
  /**
2137
+ * @public
1948
2138
  * Optionally defines a region where TTML style captions will be displayed
1949
2139
  */
1950
2140
  OutputRectangle?: CaptionRectangle;
1951
2141
  /**
2142
+ * @public
1952
2143
  * Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
1953
2144
  */
1954
2145
  PageNumber?: string;
@@ -1959,30 +2150,37 @@ export interface TeletextSourceSettings {
1959
2150
  */
1960
2151
  export interface CaptionSelectorSettings {
1961
2152
  /**
2153
+ * @public
1962
2154
  * Ancillary Source Settings
1963
2155
  */
1964
2156
  AncillarySourceSettings?: AncillarySourceSettings;
1965
2157
  /**
2158
+ * @public
1966
2159
  * Arib Source Settings
1967
2160
  */
1968
2161
  AribSourceSettings?: AribSourceSettings;
1969
2162
  /**
2163
+ * @public
1970
2164
  * Dvb Sub Source Settings
1971
2165
  */
1972
2166
  DvbSubSourceSettings?: DvbSubSourceSettings;
1973
2167
  /**
2168
+ * @public
1974
2169
  * Embedded Source Settings
1975
2170
  */
1976
2171
  EmbeddedSourceSettings?: EmbeddedSourceSettings;
1977
2172
  /**
2173
+ * @public
1978
2174
  * Scte20 Source Settings
1979
2175
  */
1980
2176
  Scte20SourceSettings?: Scte20SourceSettings;
1981
2177
  /**
2178
+ * @public
1982
2179
  * Scte27 Source Settings
1983
2180
  */
1984
2181
  Scte27SourceSettings?: Scte27SourceSettings;
1985
2182
  /**
2183
+ * @public
1986
2184
  * Teletext Source Settings
1987
2185
  */
1988
2186
  TeletextSourceSettings?: TeletextSourceSettings;
@@ -1993,14 +2191,17 @@ export interface CaptionSelectorSettings {
1993
2191
  */
1994
2192
  export interface CaptionSelector {
1995
2193
  /**
2194
+ * @public
1996
2195
  * When specified this field indicates the three letter language code of the caption track to extract from the source.
1997
2196
  */
1998
2197
  LanguageCode?: string;
1999
2198
  /**
2199
+ * @public
2000
2200
  * Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
2001
2201
  */
2002
2202
  Name: string | undefined;
2003
2203
  /**
2204
+ * @public
2004
2205
  * Caption selector settings.
2005
2206
  */
2006
2207
  SelectorSettings?: CaptionSelectorSettings;
@@ -2011,6 +2212,7 @@ export interface CaptionSelector {
2011
2212
  */
2012
2213
  export interface ChannelEgressEndpoint {
2013
2214
  /**
2215
+ * @public
2014
2216
  * Public IP of where a channel's output comes from
2015
2217
  */
2016
2218
  SourceIp?: string;
@@ -2035,6 +2237,7 @@ export type CdiInputResolution = (typeof CdiInputResolution)[keyof typeof CdiInp
2035
2237
  */
2036
2238
  export interface CdiInputSpecification {
2037
2239
  /**
2240
+ * @public
2038
2241
  * Maximum CDI input resolution
2039
2242
  */
2040
2243
  Resolution?: CdiInputResolution | string;
@@ -2057,6 +2260,7 @@ export type ChannelClass = (typeof ChannelClass)[keyof typeof ChannelClass];
2057
2260
  */
2058
2261
  export interface MediaPackageOutputDestinationSettings {
2059
2262
  /**
2263
+ * @public
2060
2264
  * ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
2061
2265
  */
2062
2266
  ChannelId?: string;
@@ -2067,11 +2271,13 @@ export interface MediaPackageOutputDestinationSettings {
2067
2271
  */
2068
2272
  export interface MultiplexProgramChannelDestinationSettings {
2069
2273
  /**
2274
+ * @public
2070
2275
  * The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances.
2071
2276
  * The Multiplex must be in the same region as the Channel.
2072
2277
  */
2073
2278
  MultiplexId?: string;
2074
2279
  /**
2280
+ * @public
2075
2281
  * The program name of the Multiplex program that the encoder is providing output to.
2076
2282
  */
2077
2283
  ProgramName?: string;
@@ -2082,18 +2288,22 @@ export interface MultiplexProgramChannelDestinationSettings {
2082
2288
  */
2083
2289
  export interface OutputDestinationSettings {
2084
2290
  /**
2291
+ * @public
2085
2292
  * key used to extract the password from EC2 Parameter store
2086
2293
  */
2087
2294
  PasswordParam?: string;
2088
2295
  /**
2296
+ * @public
2089
2297
  * Stream name for RTMP destinations (URLs of type rtmp://)
2090
2298
  */
2091
2299
  StreamName?: string;
2092
2300
  /**
2301
+ * @public
2093
2302
  * A URL specifying a destination
2094
2303
  */
2095
2304
  Url?: string;
2096
2305
  /**
2306
+ * @public
2097
2307
  * username for destination
2098
2308
  */
2099
2309
  Username?: string;
@@ -2104,18 +2314,22 @@ export interface OutputDestinationSettings {
2104
2314
  */
2105
2315
  export interface OutputDestination {
2106
2316
  /**
2317
+ * @public
2107
2318
  * User-specified id. This is used in an output group or an output.
2108
2319
  */
2109
2320
  Id?: string;
2110
2321
  /**
2322
+ * @public
2111
2323
  * Destination settings for a MediaPackage output; one destination for both encoders.
2112
2324
  */
2113
2325
  MediaPackageSettings?: MediaPackageOutputDestinationSettings[];
2114
2326
  /**
2327
+ * @public
2115
2328
  * Destination settings for a Multiplex output; one destination for both encoders.
2116
2329
  */
2117
2330
  MultiplexSettings?: MultiplexProgramChannelDestinationSettings;
2118
2331
  /**
2332
+ * @public
2119
2333
  * Destination settings for a standard output; one destination for each redundant encoder.
2120
2334
  */
2121
2335
  Settings?: OutputDestinationSettings[];
@@ -2126,10 +2340,12 @@ export interface OutputDestination {
2126
2340
  */
2127
2341
  export interface AudioSilenceFailoverSettings {
2128
2342
  /**
2343
+ * @public
2129
2344
  * The name of the audio selector in the input that MediaLive should monitor to detect silence. Select your most important rendition. If you didn't create an audio selector in this input, leave blank.
2130
2345
  */
2131
2346
  AudioSelectorName: string | undefined;
2132
2347
  /**
2348
+ * @public
2133
2349
  * The amount of time (in milliseconds) that the active input must be silent before automatic input failover occurs. Silence is defined as audio loss or audio quieter than -50 dBFS.
2134
2350
  */
2135
2351
  AudioSilenceThresholdMsec?: number;
@@ -2140,6 +2356,7 @@ export interface AudioSilenceFailoverSettings {
2140
2356
  */
2141
2357
  export interface InputLossFailoverSettings {
2142
2358
  /**
2359
+ * @public
2143
2360
  * The amount of time (in milliseconds) that no input is detected. After that time, an input failover will occur.
2144
2361
  */
2145
2362
  InputLossThresholdMsec?: number;
@@ -2150,10 +2367,12 @@ export interface InputLossFailoverSettings {
2150
2367
  */
2151
2368
  export interface VideoBlackFailoverSettings {
2152
2369
  /**
2370
+ * @public
2153
2371
  * A value used in calculating the threshold below which MediaLive considers a pixel to be 'black'. For the input to be considered black, every pixel in a frame must be below this threshold. The threshold is calculated as a percentage (expressed as a decimal) of white. Therefore .1 means 10% white (or 90% black). Note how the formula works for any color depth. For example, if you set this field to 0.1 in 10-bit color depth: (1023*0.1=102.3), which means a pixel value of 102 or less is 'black'. If you set this field to .1 in an 8-bit color depth: (255*0.1=25.5), which means a pixel value of 25 or less is 'black'. The range is 0.0 to 1.0, with any number of decimal places.
2154
2372
  */
2155
2373
  BlackDetectThreshold?: number;
2156
2374
  /**
2375
+ * @public
2157
2376
  * The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs.
2158
2377
  */
2159
2378
  VideoBlackThresholdMsec?: number;
@@ -2164,14 +2383,17 @@ export interface VideoBlackFailoverSettings {
2164
2383
  */
2165
2384
  export interface FailoverConditionSettings {
2166
2385
  /**
2386
+ * @public
2167
2387
  * MediaLive will perform a failover if the specified audio selector is silent for the specified period.
2168
2388
  */
2169
2389
  AudioSilenceSettings?: AudioSilenceFailoverSettings;
2170
2390
  /**
2391
+ * @public
2171
2392
  * MediaLive will perform a failover if content is not detected in this input for the specified period.
2172
2393
  */
2173
2394
  InputLossSettings?: InputLossFailoverSettings;
2174
2395
  /**
2396
+ * @public
2175
2397
  * MediaLive will perform a failover if content is considered black for the specified period.
2176
2398
  */
2177
2399
  VideoBlackSettings?: VideoBlackFailoverSettings;
@@ -2182,6 +2404,7 @@ export interface FailoverConditionSettings {
2182
2404
  */
2183
2405
  export interface FailoverCondition {
2184
2406
  /**
2407
+ * @public
2185
2408
  * Failover condition type-specific settings.
2186
2409
  */
2187
2410
  FailoverConditionSettings?: FailoverConditionSettings;
@@ -2204,18 +2427,22 @@ export type InputPreference = (typeof InputPreference)[keyof typeof InputPrefere
2204
2427
  */
2205
2428
  export interface AutomaticInputFailoverSettings {
2206
2429
  /**
2430
+ * @public
2207
2431
  * This clear time defines the requirement a recovered input must meet to be considered healthy. The input must have no failover conditions for this length of time. Enter a time in milliseconds. This value is particularly important if the input_preference for the failover pair is set to PRIMARY_INPUT_PREFERRED, because after this time, MediaLive will switch back to the primary input.
2208
2432
  */
2209
2433
  ErrorClearTimeMsec?: number;
2210
2434
  /**
2435
+ * @public
2211
2436
  * A list of failover conditions. If any of these conditions occur, MediaLive will perform a failover to the other input.
2212
2437
  */
2213
2438
  FailoverConditions?: FailoverCondition[];
2214
2439
  /**
2440
+ * @public
2215
2441
  * Input preference when deciding which input to make active when a previously failed input has recovered.
2216
2442
  */
2217
2443
  InputPreference?: InputPreference | string;
2218
2444
  /**
2445
+ * @public
2219
2446
  * The input ID of the secondary input in the automatic input failover pair.
2220
2447
  */
2221
2448
  SecondaryInputId: string | undefined;
@@ -2275,22 +2502,27 @@ export type HlsScte35SourceType = (typeof HlsScte35SourceType)[keyof typeof HlsS
2275
2502
  */
2276
2503
  export interface HlsInputSettings {
2277
2504
  /**
2505
+ * @public
2278
2506
  * When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
2279
2507
  */
2280
2508
  Bandwidth?: number;
2281
2509
  /**
2510
+ * @public
2282
2511
  * When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
2283
2512
  */
2284
2513
  BufferSegments?: number;
2285
2514
  /**
2515
+ * @public
2286
2516
  * The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
2287
2517
  */
2288
2518
  Retries?: number;
2289
2519
  /**
2520
+ * @public
2290
2521
  * The number of seconds between retries when an attempt to read a manifest or segment fails.
2291
2522
  */
2292
2523
  RetryInterval?: number;
2293
2524
  /**
2525
+ * @public
2294
2526
  * Identifies the source for the SCTE-35 messages that MediaLive will ingest. Messages can be ingested from the content segments (in the stream) or from tags in the playlist (the HLS manifest). MediaLive ignores SCTE-35 information in the source that is not selected.
2295
2527
  */
2296
2528
  Scte35Source?: HlsScte35SourceType | string;
@@ -2313,10 +2545,12 @@ export type NetworkInputServerValidation = (typeof NetworkInputServerValidation)
2313
2545
  */
2314
2546
  export interface NetworkInputSettings {
2315
2547
  /**
2548
+ * @public
2316
2549
  * Specifies HLS input settings when the uri is for a HLS manifest.
2317
2550
  */
2318
2551
  HlsInputSettings?: HlsInputSettings;
2319
2552
  /**
2553
+ * @public
2320
2554
  * Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https.
2321
2555
  */
2322
2556
  ServerValidation?: NetworkInputServerValidation | string;
@@ -2366,12 +2600,14 @@ export type VideoSelectorColorSpace = (typeof VideoSelectorColorSpace)[keyof typ
2366
2600
  */
2367
2601
  export interface Hdr10Settings {
2368
2602
  /**
2603
+ * @public
2369
2604
  * Maximum Content Light Level
2370
2605
  * An integer metadata value defining the maximum light level, in nits,
2371
2606
  * of any single pixel within an encoded HDR video stream or file.
2372
2607
  */
2373
2608
  MaxCll?: number;
2374
2609
  /**
2610
+ * @public
2375
2611
  * Maximum Frame Average Light Level
2376
2612
  * An integer metadata value defining the maximum average light level, in nits,
2377
2613
  * for any single frame within an encoded HDR video stream or file.
@@ -2384,6 +2620,7 @@ export interface Hdr10Settings {
2384
2620
  */
2385
2621
  export interface VideoSelectorColorSpaceSettings {
2386
2622
  /**
2623
+ * @public
2387
2624
  * Hdr10 Settings
2388
2625
  */
2389
2626
  Hdr10Settings?: Hdr10Settings;
@@ -2406,6 +2643,7 @@ export type VideoSelectorColorSpaceUsage = (typeof VideoSelectorColorSpaceUsage)
2406
2643
  */
2407
2644
  export interface VideoSelectorPid {
2408
2645
  /**
2646
+ * @public
2409
2647
  * Selects a specific PID from within a video source.
2410
2648
  */
2411
2649
  Pid?: number;
@@ -2416,6 +2654,7 @@ export interface VideoSelectorPid {
2416
2654
  */
2417
2655
  export interface VideoSelectorProgramId {
2418
2656
  /**
2657
+ * @public
2419
2658
  * Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
2420
2659
  */
2421
2660
  ProgramId?: number;
@@ -2426,10 +2665,12 @@ export interface VideoSelectorProgramId {
2426
2665
  */
2427
2666
  export interface VideoSelectorSettings {
2428
2667
  /**
2668
+ * @public
2429
2669
  * Video Selector Pid
2430
2670
  */
2431
2671
  VideoSelectorPid?: VideoSelectorPid;
2432
2672
  /**
2673
+ * @public
2433
2674
  * Video Selector Program Id
2434
2675
  */
2435
2676
  VideoSelectorProgramId?: VideoSelectorProgramId;
@@ -2440,18 +2681,22 @@ export interface VideoSelectorSettings {
2440
2681
  */
2441
2682
  export interface VideoSelector {
2442
2683
  /**
2684
+ * @public
2443
2685
  * Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed.
2444
2686
  */
2445
2687
  ColorSpace?: VideoSelectorColorSpace | string;
2446
2688
  /**
2689
+ * @public
2447
2690
  * Color space settings
2448
2691
  */
2449
2692
  ColorSpaceSettings?: VideoSelectorColorSpaceSettings;
2450
2693
  /**
2694
+ * @public
2451
2695
  * Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data.
2452
2696
  */
2453
2697
  ColorSpaceUsage?: VideoSelectorColorSpaceUsage | string;
2454
2698
  /**
2699
+ * @public
2455
2700
  * The video selector settings.
2456
2701
  */
2457
2702
  SelectorSettings?: VideoSelectorSettings;
@@ -2462,26 +2707,32 @@ export interface VideoSelector {
2462
2707
  */
2463
2708
  export interface InputSettings {
2464
2709
  /**
2710
+ * @public
2465
2711
  * Used to select the audio stream to decode for inputs that have multiple available.
2466
2712
  */
2467
2713
  AudioSelectors?: AudioSelector[];
2468
2714
  /**
2715
+ * @public
2469
2716
  * Used to select the caption input to use for inputs that have multiple available.
2470
2717
  */
2471
2718
  CaptionSelectors?: CaptionSelector[];
2472
2719
  /**
2720
+ * @public
2473
2721
  * Enable or disable the deblock filter when filtering.
2474
2722
  */
2475
2723
  DeblockFilter?: InputDeblockFilter | string;
2476
2724
  /**
2725
+ * @public
2477
2726
  * Enable or disable the denoise filter when filtering.
2478
2727
  */
2479
2728
  DenoiseFilter?: InputDenoiseFilter | string;
2480
2729
  /**
2730
+ * @public
2481
2731
  * Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
2482
2732
  */
2483
2733
  FilterStrength?: number;
2484
2734
  /**
2735
+ * @public
2485
2736
  * Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default.
2486
2737
  * 1) auto - filtering will be applied depending on input type/quality
2487
2738
  * 2) disabled - no filtering will be applied to the input
@@ -2489,24 +2740,29 @@ export interface InputSettings {
2489
2740
  */
2490
2741
  InputFilter?: InputFilter | string;
2491
2742
  /**
2743
+ * @public
2492
2744
  * Input settings.
2493
2745
  */
2494
2746
  NetworkInputSettings?: NetworkInputSettings;
2495
2747
  /**
2748
+ * @public
2496
2749
  * PID from which to read SCTE-35 messages. If left undefined, EML will select the first SCTE-35 PID found in the input.
2497
2750
  */
2498
2751
  Scte35Pid?: number;
2499
2752
  /**
2753
+ * @public
2500
2754
  * Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages.
2501
2755
  * - PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any).
2502
2756
  * - IGNORE: Never extract any ancillary data from SMPTE-2038.
2503
2757
  */
2504
2758
  Smpte2038DataPreference?: Smpte2038DataPreference | string;
2505
2759
  /**
2760
+ * @public
2506
2761
  * Loop input if it is a file. This allows a file input to be streamed indefinitely.
2507
2762
  */
2508
2763
  SourceEndBehavior?: InputSourceEndBehavior | string;
2509
2764
  /**
2765
+ * @public
2510
2766
  * Informs which video elementary stream to decode for input types that have multiple available.
2511
2767
  */
2512
2768
  VideoSelector?: VideoSelector;
@@ -2517,18 +2773,22 @@ export interface InputSettings {
2517
2773
  */
2518
2774
  export interface InputAttachment {
2519
2775
  /**
2776
+ * @public
2520
2777
  * User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input.
2521
2778
  */
2522
2779
  AutomaticInputFailoverSettings?: AutomaticInputFailoverSettings;
2523
2780
  /**
2781
+ * @public
2524
2782
  * User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
2525
2783
  */
2526
2784
  InputAttachmentName?: string;
2527
2785
  /**
2786
+ * @public
2528
2787
  * The ID of the input
2529
2788
  */
2530
2789
  InputId?: string;
2531
2790
  /**
2791
+ * @public
2532
2792
  * Settings of an input (caption selector, etc.)
2533
2793
  */
2534
2794
  InputSettings?: InputSettings;
@@ -2578,14 +2838,17 @@ export type InputResolution = (typeof InputResolution)[keyof typeof InputResolut
2578
2838
  */
2579
2839
  export interface InputSpecification {
2580
2840
  /**
2841
+ * @public
2581
2842
  * Input codec
2582
2843
  */
2583
2844
  Codec?: InputCodec | string;
2584
2845
  /**
2846
+ * @public
2585
2847
  * Maximum input bitrate, categorized coarsely
2586
2848
  */
2587
2849
  MaximumBitrate?: InputMaximumBitrate | string;
2588
2850
  /**
2851
+ * @public
2589
2852
  * Input resolution, categorized coarsely
2590
2853
  */
2591
2854
  Resolution?: InputResolution | string;
@@ -2628,18 +2891,22 @@ export type MaintenanceDay = (typeof MaintenanceDay)[keyof typeof MaintenanceDay
2628
2891
  */
2629
2892
  export interface MaintenanceStatus {
2630
2893
  /**
2894
+ * @public
2631
2895
  * The currently selected maintenance day.
2632
2896
  */
2633
2897
  MaintenanceDay?: MaintenanceDay | string;
2634
2898
  /**
2899
+ * @public
2635
2900
  * Maintenance is required by the displayed date and time. Date and time is in ISO.
2636
2901
  */
2637
2902
  MaintenanceDeadline?: string;
2638
2903
  /**
2904
+ * @public
2639
2905
  * The currently scheduled maintenance date and time. Date and time is in ISO.
2640
2906
  */
2641
2907
  MaintenanceScheduledDate?: string;
2642
2908
  /**
2909
+ * @public
2643
2910
  * The currently selected maintenance start time. Time is in UTC.
2644
2911
  */
2645
2912
  MaintenanceStartTime?: string;
@@ -2671,20 +2938,24 @@ export type ChannelState = (typeof ChannelState)[keyof typeof ChannelState];
2671
2938
  */
2672
2939
  export interface VpcOutputSettingsDescription {
2673
2940
  /**
2941
+ * @public
2674
2942
  * The Availability Zones where the vpc subnets are located.
2675
2943
  * The first Availability Zone applies to the first subnet in the list of subnets.
2676
2944
  * The second Availability Zone applies to the second subnet.
2677
2945
  */
2678
2946
  AvailabilityZones?: string[];
2679
2947
  /**
2948
+ * @public
2680
2949
  * A list of Elastic Network Interfaces created by MediaLive in the customer's VPC
2681
2950
  */
2682
2951
  NetworkInterfaceIds?: string[];
2683
2952
  /**
2953
+ * @public
2684
2954
  * A list of up EC2 VPC security group IDs attached to the Output VPC network interfaces.
2685
2955
  */
2686
2956
  SecurityGroupIds?: string[];
2687
2957
  /**
2958
+ * @public
2688
2959
  * A list of VPC subnet IDs from the same VPC.
2689
2960
  * If STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ).
2690
2961
  */
@@ -2696,68 +2967,84 @@ export interface VpcOutputSettingsDescription {
2696
2967
  */
2697
2968
  export interface ChannelSummary {
2698
2969
  /**
2970
+ * @public
2699
2971
  * The unique arn of the channel.
2700
2972
  */
2701
2973
  Arn?: string;
2702
2974
  /**
2975
+ * @public
2703
2976
  * Specification of CDI inputs for this channel
2704
2977
  */
2705
2978
  CdiInputSpecification?: CdiInputSpecification;
2706
2979
  /**
2980
+ * @public
2707
2981
  * The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
2708
2982
  */
2709
2983
  ChannelClass?: ChannelClass | string;
2710
2984
  /**
2985
+ * @public
2711
2986
  * A list of destinations of the channel. For UDP outputs, there is one
2712
2987
  * destination per output. For other types (HLS, for example), there is
2713
2988
  * one destination per packager.
2714
2989
  */
2715
2990
  Destinations?: OutputDestination[];
2716
2991
  /**
2992
+ * @public
2717
2993
  * The endpoints where outgoing connections initiate from
2718
2994
  */
2719
2995
  EgressEndpoints?: ChannelEgressEndpoint[];
2720
2996
  /**
2997
+ * @public
2721
2998
  * The unique id of the channel.
2722
2999
  */
2723
3000
  Id?: string;
2724
3001
  /**
3002
+ * @public
2725
3003
  * List of input attachments for channel.
2726
3004
  */
2727
3005
  InputAttachments?: InputAttachment[];
2728
3006
  /**
3007
+ * @public
2729
3008
  * Specification of network and file inputs for this channel
2730
3009
  */
2731
3010
  InputSpecification?: InputSpecification;
2732
3011
  /**
3012
+ * @public
2733
3013
  * The log level being written to CloudWatch Logs.
2734
3014
  */
2735
3015
  LogLevel?: LogLevel | string;
2736
3016
  /**
3017
+ * @public
2737
3018
  * Maintenance settings for this channel.
2738
3019
  */
2739
3020
  Maintenance?: MaintenanceStatus;
2740
3021
  /**
3022
+ * @public
2741
3023
  * The name of the channel. (user-mutable)
2742
3024
  */
2743
3025
  Name?: string;
2744
3026
  /**
3027
+ * @public
2745
3028
  * The number of currently healthy pipelines.
2746
3029
  */
2747
3030
  PipelinesRunningCount?: number;
2748
3031
  /**
3032
+ * @public
2749
3033
  * The Amazon Resource Name (ARN) of the role assumed when running the Channel.
2750
3034
  */
2751
3035
  RoleArn?: string;
2752
3036
  /**
3037
+ * @public
2753
3038
  * Placeholder documentation for ChannelState
2754
3039
  */
2755
3040
  State?: ChannelState | string;
2756
3041
  /**
3042
+ * @public
2757
3043
  * A collection of key-value pairs.
2758
3044
  */
2759
3045
  Tags?: Record<string, string>;
2760
3046
  /**
3047
+ * @public
2761
3048
  * Settings for any VPC outputs.
2762
3049
  */
2763
3050
  Vpc?: VpcOutputSettingsDescription;
@@ -2781,10 +3068,12 @@ export type HlsAdMarkers = (typeof HlsAdMarkers)[keyof typeof HlsAdMarkers];
2781
3068
  */
2782
3069
  export interface InputDestinationVpc {
2783
3070
  /**
3071
+ * @public
2784
3072
  * The availability zone of the Input destination.
2785
3073
  */
2786
3074
  AvailabilityZone?: string;
2787
3075
  /**
3076
+ * @public
2788
3077
  * The network interface ID of the Input destination in the VPC.
2789
3078
  */
2790
3079
  NetworkInterfaceId?: string;
@@ -2795,20 +3084,24 @@ export interface InputDestinationVpc {
2795
3084
  */
2796
3085
  export interface InputDestination {
2797
3086
  /**
3087
+ * @public
2798
3088
  * The system-generated static IP address of endpoint.
2799
3089
  * It remains fixed for the lifetime of the input.
2800
3090
  */
2801
3091
  Ip?: string;
2802
3092
  /**
3093
+ * @public
2803
3094
  * The port number for the input.
2804
3095
  */
2805
3096
  Port?: string;
2806
3097
  /**
3098
+ * @public
2807
3099
  * This represents the endpoint that the customer stream will be
2808
3100
  * pushed to.
2809
3101
  */
2810
3102
  Url?: string;
2811
3103
  /**
3104
+ * @public
2812
3105
  * The properties for a VPC type input destination.
2813
3106
  */
2814
3107
  Vpc?: InputDestinationVpc;
@@ -2831,6 +3124,7 @@ export type InputClass = (typeof InputClass)[keyof typeof InputClass];
2831
3124
  */
2832
3125
  export interface InputDeviceSettings {
2833
3126
  /**
3127
+ * @public
2834
3128
  * The unique ID for the device.
2835
3129
  */
2836
3130
  Id?: string;
@@ -2853,6 +3147,7 @@ export type InputSourceType = (typeof InputSourceType)[keyof typeof InputSourceT
2853
3147
  */
2854
3148
  export interface MediaConnectFlow {
2855
3149
  /**
3150
+ * @public
2856
3151
  * The unique ARN of the MediaConnect Flow being used as a source.
2857
3152
  */
2858
3153
  FlowArn?: string;
@@ -2863,15 +3158,18 @@ export interface MediaConnectFlow {
2863
3158
  */
2864
3159
  export interface InputSource {
2865
3160
  /**
3161
+ * @public
2866
3162
  * The key used to extract the password from EC2 Parameter store.
2867
3163
  */
2868
3164
  PasswordParam?: string;
2869
3165
  /**
3166
+ * @public
2870
3167
  * This represents the customer's source URL where stream is
2871
3168
  * pulled from.
2872
3169
  */
2873
3170
  Url?: string;
2874
3171
  /**
3172
+ * @public
2875
3173
  * The username for the input source.
2876
3174
  */
2877
3175
  Username?: string;
@@ -2917,68 +3215,84 @@ export type InputType = (typeof InputType)[keyof typeof InputType];
2917
3215
  */
2918
3216
  export interface Input {
2919
3217
  /**
3218
+ * @public
2920
3219
  * The Unique ARN of the input (generated, immutable).
2921
3220
  */
2922
3221
  Arn?: string;
2923
3222
  /**
3223
+ * @public
2924
3224
  * A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).
2925
3225
  */
2926
3226
  AttachedChannels?: string[];
2927
3227
  /**
3228
+ * @public
2928
3229
  * A list of the destinations of the input (PUSH-type).
2929
3230
  */
2930
3231
  Destinations?: InputDestination[];
2931
3232
  /**
3233
+ * @public
2932
3234
  * The generated ID of the input (unique for user account, immutable).
2933
3235
  */
2934
3236
  Id?: string;
2935
3237
  /**
3238
+ * @public
2936
3239
  * STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails.
2937
3240
  * SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.
2938
3241
  */
2939
3242
  InputClass?: InputClass | string;
2940
3243
  /**
3244
+ * @public
2941
3245
  * Settings for the input devices.
2942
3246
  */
2943
3247
  InputDevices?: InputDeviceSettings[];
2944
3248
  /**
3249
+ * @public
2945
3250
  * A list of IDs for all Inputs which are partners of this one.
2946
3251
  */
2947
3252
  InputPartnerIds?: string[];
2948
3253
  /**
3254
+ * @public
2949
3255
  * Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes
2950
3256
  * during input switch actions. Presently, this functionality only works with MP4_FILE and TS_FILE inputs.
2951
3257
  */
2952
3258
  InputSourceType?: InputSourceType | string;
2953
3259
  /**
3260
+ * @public
2954
3261
  * A list of MediaConnect Flows for this input.
2955
3262
  */
2956
3263
  MediaConnectFlows?: MediaConnectFlow[];
2957
3264
  /**
3265
+ * @public
2958
3266
  * The user-assigned name (This is a mutable value).
2959
3267
  */
2960
3268
  Name?: string;
2961
3269
  /**
3270
+ * @public
2962
3271
  * The Amazon Resource Name (ARN) of the role this input assumes during and after creation.
2963
3272
  */
2964
3273
  RoleArn?: string;
2965
3274
  /**
3275
+ * @public
2966
3276
  * A list of IDs for all the Input Security Groups attached to the input.
2967
3277
  */
2968
3278
  SecurityGroups?: string[];
2969
3279
  /**
3280
+ * @public
2970
3281
  * A list of the sources of the input (PULL-type).
2971
3282
  */
2972
3283
  Sources?: InputSource[];
2973
3284
  /**
3285
+ * @public
2974
3286
  * Placeholder documentation for InputState
2975
3287
  */
2976
3288
  State?: InputState | string;
2977
3289
  /**
3290
+ * @public
2978
3291
  * A collection of key-value pairs.
2979
3292
  */
2980
3293
  Tags?: Record<string, string>;
2981
3294
  /**
3295
+ * @public
2982
3296
  * The different types of inputs that AWS Elemental MediaLive supports.
2983
3297
  */
2984
3298
  Type?: InputType | string;
@@ -2989,6 +3303,7 @@ export interface Input {
2989
3303
  */
2990
3304
  export interface InputDestinationRequest {
2991
3305
  /**
3306
+ * @public
2992
3307
  * A unique name for the location the RTMP stream is being pushed
2993
3308
  * to.
2994
3309
  */
@@ -3000,6 +3315,7 @@ export interface InputDestinationRequest {
3000
3315
  */
3001
3316
  export interface InputDeviceRequest {
3002
3317
  /**
3318
+ * @public
3003
3319
  * The unique ID for the device.
3004
3320
  */
3005
3321
  Id?: string;
@@ -3096,38 +3412,47 @@ export type InputDeviceScanType = (typeof InputDeviceScanType)[keyof typeof Inpu
3096
3412
  */
3097
3413
  export interface InputDeviceHdSettings {
3098
3414
  /**
3415
+ * @public
3099
3416
  * If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI).
3100
3417
  */
3101
3418
  ActiveInput?: InputDeviceActiveInput | string;
3102
3419
  /**
3420
+ * @public
3103
3421
  * The source at the input device that is currently active. You can specify this source.
3104
3422
  */
3105
3423
  ConfiguredInput?: InputDeviceConfiguredInput | string;
3106
3424
  /**
3425
+ * @public
3107
3426
  * The state of the input device.
3108
3427
  */
3109
3428
  DeviceState?: InputDeviceState | string;
3110
3429
  /**
3430
+ * @public
3111
3431
  * The frame rate of the video source.
3112
3432
  */
3113
3433
  Framerate?: number;
3114
3434
  /**
3435
+ * @public
3115
3436
  * The height of the video source, in pixels.
3116
3437
  */
3117
3438
  Height?: number;
3118
3439
  /**
3440
+ * @public
3119
3441
  * The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum.
3120
3442
  */
3121
3443
  MaxBitrate?: number;
3122
3444
  /**
3445
+ * @public
3123
3446
  * The scan type of the video source.
3124
3447
  */
3125
3448
  ScanType?: InputDeviceScanType | string;
3126
3449
  /**
3450
+ * @public
3127
3451
  * The width of the video source, in pixels.
3128
3452
  */
3129
3453
  Width?: number;
3130
3454
  /**
3455
+ * @public
3131
3456
  * The Link device's buffer size (latency) in milliseconds (ms). You can specify this value.
3132
3457
  */
3133
3458
  LatencyMs?: number;
@@ -3150,22 +3475,27 @@ export type InputDeviceIpScheme = (typeof InputDeviceIpScheme)[keyof typeof Inpu
3150
3475
  */
3151
3476
  export interface InputDeviceNetworkSettings {
3152
3477
  /**
3478
+ * @public
3153
3479
  * The DNS addresses of the input device.
3154
3480
  */
3155
3481
  DnsAddresses?: string[];
3156
3482
  /**
3483
+ * @public
3157
3484
  * The network gateway IP address.
3158
3485
  */
3159
3486
  Gateway?: string;
3160
3487
  /**
3488
+ * @public
3161
3489
  * The IP address of the input device.
3162
3490
  */
3163
3491
  IpAddress?: string;
3164
3492
  /**
3493
+ * @public
3165
3494
  * Specifies whether the input device has been configured (outside of MediaLive) to use a dynamic IP address assignment (DHCP) or a static IP address.
3166
3495
  */
3167
3496
  IpScheme?: InputDeviceIpScheme | string;
3168
3497
  /**
3498
+ * @public
3169
3499
  * The subnet mask of the input device.
3170
3500
  */
3171
3501
  SubnetMask?: string;
@@ -3188,38 +3518,47 @@ export type InputDeviceType = (typeof InputDeviceType)[keyof typeof InputDeviceT
3188
3518
  */
3189
3519
  export interface InputDeviceUhdSettings {
3190
3520
  /**
3521
+ * @public
3191
3522
  * If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI).
3192
3523
  */
3193
3524
  ActiveInput?: InputDeviceActiveInput | string;
3194
3525
  /**
3526
+ * @public
3195
3527
  * The source at the input device that is currently active. You can specify this source.
3196
3528
  */
3197
3529
  ConfiguredInput?: InputDeviceConfiguredInput | string;
3198
3530
  /**
3531
+ * @public
3199
3532
  * The state of the input device.
3200
3533
  */
3201
3534
  DeviceState?: InputDeviceState | string;
3202
3535
  /**
3536
+ * @public
3203
3537
  * The frame rate of the video source.
3204
3538
  */
3205
3539
  Framerate?: number;
3206
3540
  /**
3541
+ * @public
3207
3542
  * The height of the video source, in pixels.
3208
3543
  */
3209
3544
  Height?: number;
3210
3545
  /**
3546
+ * @public
3211
3547
  * The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum.
3212
3548
  */
3213
3549
  MaxBitrate?: number;
3214
3550
  /**
3551
+ * @public
3215
3552
  * The scan type of the video source.
3216
3553
  */
3217
3554
  ScanType?: InputDeviceScanType | string;
3218
3555
  /**
3556
+ * @public
3219
3557
  * The width of the video source, in pixels.
3220
3558
  */
3221
3559
  Width?: number;
3222
3560
  /**
3561
+ * @public
3223
3562
  * The Link device's buffer size (latency) in milliseconds (ms). You can specify this value.
3224
3563
  */
3225
3564
  LatencyMs?: number;
@@ -3230,57 +3569,75 @@ export interface InputDeviceUhdSettings {
3230
3569
  */
3231
3570
  export interface InputDeviceSummary {
3232
3571
  /**
3572
+ * @public
3233
3573
  * The unique ARN of the input device.
3234
3574
  */
3235
3575
  Arn?: string;
3236
3576
  /**
3577
+ * @public
3237
3578
  * The state of the connection between the input device and AWS.
3238
3579
  */
3239
3580
  ConnectionState?: InputDeviceConnectionState | string;
3240
3581
  /**
3582
+ * @public
3241
3583
  * The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration.
3242
3584
  */
3243
3585
  DeviceSettingsSyncState?: DeviceSettingsSyncState | string;
3244
3586
  /**
3587
+ * @public
3245
3588
  * The status of software on the input device.
3246
3589
  */
3247
3590
  DeviceUpdateStatus?: DeviceUpdateStatus | string;
3248
3591
  /**
3592
+ * @public
3249
3593
  * Settings that describe an input device that is type HD.
3250
3594
  */
3251
3595
  HdDeviceSettings?: InputDeviceHdSettings;
3252
3596
  /**
3597
+ * @public
3253
3598
  * The unique ID of the input device.
3254
3599
  */
3255
3600
  Id?: string;
3256
3601
  /**
3602
+ * @public
3257
3603
  * The network MAC address of the input device.
3258
3604
  */
3259
3605
  MacAddress?: string;
3260
3606
  /**
3607
+ * @public
3261
3608
  * A name that you specify for the input device.
3262
3609
  */
3263
3610
  Name?: string;
3264
3611
  /**
3612
+ * @public
3265
3613
  * Network settings for the input device.
3266
3614
  */
3267
3615
  NetworkSettings?: InputDeviceNetworkSettings;
3268
3616
  /**
3617
+ * @public
3269
3618
  * The unique serial number of the input device.
3270
3619
  */
3271
3620
  SerialNumber?: string;
3272
3621
  /**
3622
+ * @public
3273
3623
  * The type of the input device.
3274
3624
  */
3275
3625
  Type?: InputDeviceType | string;
3276
3626
  /**
3627
+ * @public
3277
3628
  * Settings that describe an input device that is type UHD.
3278
3629
  */
3279
3630
  UhdDeviceSettings?: InputDeviceUhdSettings;
3280
3631
  /**
3632
+ * @public
3281
3633
  * A collection of key-value pairs.
3282
3634
  */
3283
3635
  Tags?: Record<string, string>;
3636
+ /**
3637
+ * @public
3638
+ * The Availability Zone associated with this input device.
3639
+ */
3640
+ AvailabilityZone?: string;
3284
3641
  }
3285
3642
  /**
3286
3643
  * @public
@@ -3302,6 +3659,7 @@ export type InputSecurityGroupState = (typeof InputSecurityGroupState)[keyof typ
3302
3659
  */
3303
3660
  export interface InputWhitelistRule {
3304
3661
  /**
3662
+ * @public
3305
3663
  * The IPv4 CIDR that's whitelisted.
3306
3664
  */
3307
3665
  Cidr?: string;
@@ -3312,26 +3670,32 @@ export interface InputWhitelistRule {
3312
3670
  */
3313
3671
  export interface InputSecurityGroup {
3314
3672
  /**
3673
+ * @public
3315
3674
  * Unique ARN of Input Security Group
3316
3675
  */
3317
3676
  Arn?: string;
3318
3677
  /**
3678
+ * @public
3319
3679
  * The Id of the Input Security Group
3320
3680
  */
3321
3681
  Id?: string;
3322
3682
  /**
3683
+ * @public
3323
3684
  * The list of inputs currently using this Input Security Group.
3324
3685
  */
3325
3686
  Inputs?: string[];
3326
3687
  /**
3688
+ * @public
3327
3689
  * The current state of the Input Security Group.
3328
3690
  */
3329
3691
  State?: InputSecurityGroupState | string;
3330
3692
  /**
3693
+ * @public
3331
3694
  * A collection of key-value pairs.
3332
3695
  */
3333
3696
  Tags?: Record<string, string>;
3334
3697
  /**
3698
+ * @public
3335
3699
  * Whitelist rules and their sync status
3336
3700
  */
3337
3701
  WhitelistRules?: InputWhitelistRule[];
@@ -3342,15 +3706,18 @@ export interface InputSecurityGroup {
3342
3706
  */
3343
3707
  export interface InputSourceRequest {
3344
3708
  /**
3709
+ * @public
3345
3710
  * The key used to extract the password from EC2 Parameter store.
3346
3711
  */
3347
3712
  PasswordParam?: string;
3348
3713
  /**
3714
+ * @public
3349
3715
  * This represents the customer's source URL where stream is
3350
3716
  * pulled from.
3351
3717
  */
3352
3718
  Url?: string;
3353
3719
  /**
3720
+ * @public
3354
3721
  * The username for the input source.
3355
3722
  */
3356
3723
  Username?: string;
@@ -3361,6 +3728,7 @@ export interface InputSourceRequest {
3361
3728
  */
3362
3729
  export interface InputWhitelistRuleCidr {
3363
3730
  /**
3731
+ * @public
3364
3732
  * The IPv4 CIDR to whitelist.
3365
3733
  */
3366
3734
  Cidr?: string;
@@ -3371,6 +3739,7 @@ export interface InputWhitelistRuleCidr {
3371
3739
  */
3372
3740
  export interface MediaConnectFlowRequest {
3373
3741
  /**
3742
+ * @public
3374
3743
  * The ARN of the MediaConnect Flow that you want to use as a source.
3375
3744
  */
3376
3745
  FlowArn?: string;
@@ -3381,6 +3750,7 @@ export interface MediaConnectFlowRequest {
3381
3750
  */
3382
3751
  export interface MultiplexMediaConnectOutputDestinationSettings {
3383
3752
  /**
3753
+ * @public
3384
3754
  * The MediaConnect entitlement ARN available as a Flow source.
3385
3755
  */
3386
3756
  EntitlementArn?: string;
@@ -3391,6 +3761,7 @@ export interface MultiplexMediaConnectOutputDestinationSettings {
3391
3761
  */
3392
3762
  export interface MultiplexOutputDestination {
3393
3763
  /**
3764
+ * @public
3394
3765
  * Multiplex MediaConnect output destination settings.
3395
3766
  */
3396
3767
  MediaConnectSettings?: MultiplexMediaConnectOutputDestinationSettings;
@@ -3401,10 +3772,12 @@ export interface MultiplexOutputDestination {
3401
3772
  */
3402
3773
  export interface MultiplexProgramPipelineDetail {
3403
3774
  /**
3775
+ * @public
3404
3776
  * Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex.
3405
3777
  */
3406
3778
  ActiveChannelPipeline?: string;
3407
3779
  /**
3780
+ * @public
3408
3781
  * Identifies a specific pipeline in the multiplex.
3409
3782
  */
3410
3783
  PipelineId?: string;
@@ -3415,10 +3788,12 @@ export interface MultiplexProgramPipelineDetail {
3415
3788
  */
3416
3789
  export interface MultiplexProgramSummary {
3417
3790
  /**
3791
+ * @public
3418
3792
  * The MediaLive Channel associated with the program.
3419
3793
  */
3420
3794
  ChannelId?: string;
3421
3795
  /**
3796
+ * @public
3422
3797
  * The name of the multiplex program.
3423
3798
  */
3424
3799
  ProgramName?: string;
@@ -3429,6 +3804,7 @@ export interface MultiplexProgramSummary {
3429
3804
  */
3430
3805
  export interface MultiplexSettingsSummary {
3431
3806
  /**
3807
+ * @public
3432
3808
  * Transport stream bit rate.
3433
3809
  */
3434
3810
  TransportStreamBitrate?: number;
@@ -3458,38 +3834,47 @@ export type MultiplexState = (typeof MultiplexState)[keyof typeof MultiplexState
3458
3834
  */
3459
3835
  export interface MultiplexSummary {
3460
3836
  /**
3837
+ * @public
3461
3838
  * The unique arn of the multiplex.
3462
3839
  */
3463
3840
  Arn?: string;
3464
3841
  /**
3842
+ * @public
3465
3843
  * A list of availability zones for the multiplex.
3466
3844
  */
3467
3845
  AvailabilityZones?: string[];
3468
3846
  /**
3847
+ * @public
3469
3848
  * The unique id of the multiplex.
3470
3849
  */
3471
3850
  Id?: string;
3472
3851
  /**
3852
+ * @public
3473
3853
  * Configuration for a multiplex event.
3474
3854
  */
3475
3855
  MultiplexSettings?: MultiplexSettingsSummary;
3476
3856
  /**
3857
+ * @public
3477
3858
  * The name of the multiplex.
3478
3859
  */
3479
3860
  Name?: string;
3480
3861
  /**
3862
+ * @public
3481
3863
  * The number of currently healthy pipelines.
3482
3864
  */
3483
3865
  PipelinesRunningCount?: number;
3484
3866
  /**
3867
+ * @public
3485
3868
  * The number of programs in the multiplex.
3486
3869
  */
3487
3870
  ProgramCount?: number;
3488
3871
  /**
3872
+ * @public
3489
3873
  * The current state of the multiplex.
3490
3874
  */
3491
3875
  State?: MultiplexState | string;
3492
3876
  /**
3877
+ * @public
3493
3878
  * A collection of key-value pairs.
3494
3879
  */
3495
3880
  Tags?: Record<string, string>;
@@ -3617,34 +4002,42 @@ export type ReservationVideoQuality = (typeof ReservationVideoQuality)[keyof typ
3617
4002
  */
3618
4003
  export interface ReservationResourceSpecification {
3619
4004
  /**
4005
+ * @public
3620
4006
  * Channel class, e.g. 'STANDARD'
3621
4007
  */
3622
4008
  ChannelClass?: ChannelClass | string;
3623
4009
  /**
4010
+ * @public
3624
4011
  * Codec, e.g. 'AVC'
3625
4012
  */
3626
4013
  Codec?: ReservationCodec | string;
3627
4014
  /**
4015
+ * @public
3628
4016
  * Maximum bitrate, e.g. 'MAX_20_MBPS'
3629
4017
  */
3630
4018
  MaximumBitrate?: ReservationMaximumBitrate | string;
3631
4019
  /**
4020
+ * @public
3632
4021
  * Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)
3633
4022
  */
3634
4023
  MaximumFramerate?: ReservationMaximumFramerate | string;
3635
4024
  /**
4025
+ * @public
3636
4026
  * Resolution, e.g. 'HD'
3637
4027
  */
3638
4028
  Resolution?: ReservationResolution | string;
3639
4029
  /**
4030
+ * @public
3640
4031
  * Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
3641
4032
  */
3642
4033
  ResourceType?: ReservationResourceType | string;
3643
4034
  /**
4035
+ * @public
3644
4036
  * Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)
3645
4037
  */
3646
4038
  SpecialFeature?: ReservationSpecialFeature | string;
3647
4039
  /**
4040
+ * @public
3648
4041
  * Video quality, e.g. 'STANDARD' (Outputs only)
3649
4042
  */
3650
4043
  VideoQuality?: ReservationVideoQuality | string;
@@ -3655,46 +4048,57 @@ export interface ReservationResourceSpecification {
3655
4048
  */
3656
4049
  export interface Offering {
3657
4050
  /**
4051
+ * @public
3658
4052
  * Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'
3659
4053
  */
3660
4054
  Arn?: string;
3661
4055
  /**
4056
+ * @public
3662
4057
  * Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
3663
4058
  */
3664
4059
  CurrencyCode?: string;
3665
4060
  /**
4061
+ * @public
3666
4062
  * Lease duration, e.g. '12'
3667
4063
  */
3668
4064
  Duration?: number;
3669
4065
  /**
4066
+ * @public
3670
4067
  * Units for duration, e.g. 'MONTHS'
3671
4068
  */
3672
4069
  DurationUnits?: OfferingDurationUnits | string;
3673
4070
  /**
4071
+ * @public
3674
4072
  * One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
3675
4073
  */
3676
4074
  FixedPrice?: number;
3677
4075
  /**
4076
+ * @public
3678
4077
  * Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
3679
4078
  */
3680
4079
  OfferingDescription?: string;
3681
4080
  /**
4081
+ * @public
3682
4082
  * Unique offering ID, e.g. '87654321'
3683
4083
  */
3684
4084
  OfferingId?: string;
3685
4085
  /**
4086
+ * @public
3686
4087
  * Offering type, e.g. 'NO_UPFRONT'
3687
4088
  */
3688
4089
  OfferingType?: OfferingType | string;
3689
4090
  /**
4091
+ * @public
3690
4092
  * AWS region, e.g. 'us-west-2'
3691
4093
  */
3692
4094
  Region?: string;
3693
4095
  /**
4096
+ * @public
3694
4097
  * Resource configuration details
3695
4098
  */
3696
4099
  ResourceSpecification?: ReservationResourceSpecification;
3697
4100
  /**
4101
+ * @public
3698
4102
  * Recurring usage charge for each reserved resource, e.g. '157.0'
3699
4103
  */
3700
4104
  UsagePrice?: number;
@@ -3789,14 +4193,17 @@ export type M2tsCcDescriptor = (typeof M2tsCcDescriptor)[keyof typeof M2tsCcDesc
3789
4193
  */
3790
4194
  export interface DvbNitSettings {
3791
4195
  /**
4196
+ * @public
3792
4197
  * The numeric value placed in the Network Information Table (NIT).
3793
4198
  */
3794
4199
  NetworkId: number | undefined;
3795
4200
  /**
4201
+ * @public
3796
4202
  * The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
3797
4203
  */
3798
4204
  NetworkName: string | undefined;
3799
4205
  /**
4206
+ * @public
3800
4207
  * The number of milliseconds between instances of this table in the output transport stream.
3801
4208
  */
3802
4209
  RepInterval?: number;
@@ -3821,18 +4228,22 @@ export type DvbSdtOutputSdt = (typeof DvbSdtOutputSdt)[keyof typeof DvbSdtOutput
3821
4228
  */
3822
4229
  export interface DvbSdtSettings {
3823
4230
  /**
4231
+ * @public
3824
4232
  * Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.
3825
4233
  */
3826
4234
  OutputSdt?: DvbSdtOutputSdt | string;
3827
4235
  /**
4236
+ * @public
3828
4237
  * The number of milliseconds between instances of this table in the output transport stream.
3829
4238
  */
3830
4239
  RepInterval?: number;
3831
4240
  /**
4241
+ * @public
3832
4242
  * The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
3833
4243
  */
3834
4244
  ServiceName?: string;
3835
4245
  /**
4246
+ * @public
3836
4247
  * The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
3837
4248
  */
3838
4249
  ServiceProviderName?: string;
@@ -3843,6 +4254,7 @@ export interface DvbSdtSettings {
3843
4254
  */
3844
4255
  export interface DvbTdtSettings {
3845
4256
  /**
4257
+ * @public
3846
4258
  * The number of milliseconds between instances of this table in the output transport stream.
3847
4259
  */
3848
4260
  RepInterval?: number;
@@ -4001,170 +4413,212 @@ export type M2tsTimedMetadataBehavior = (typeof M2tsTimedMetadataBehavior)[keyof
4001
4413
  */
4002
4414
  export interface M2tsSettings {
4003
4415
  /**
4416
+ * @public
4004
4417
  * When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream.
4005
4418
  */
4006
4419
  AbsentInputAudioBehavior?: M2tsAbsentInputAudioBehavior | string;
4007
4420
  /**
4421
+ * @public
4008
4422
  * When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.
4009
4423
  */
4010
4424
  Arib?: M2tsArib | string;
4011
4425
  /**
4426
+ * @public
4012
4427
  * Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
4013
4428
  */
4014
4429
  AribCaptionsPid?: string;
4015
4430
  /**
4431
+ * @public
4016
4432
  * If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number.
4017
4433
  */
4018
4434
  AribCaptionsPidControl?: M2tsAribCaptionsPidControl | string;
4019
4435
  /**
4436
+ * @public
4020
4437
  * When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.
4021
4438
  */
4022
4439
  AudioBufferModel?: M2tsAudioBufferModel | string;
4023
4440
  /**
4441
+ * @public
4024
4442
  * The number of audio frames to insert for each PES packet.
4025
4443
  */
4026
4444
  AudioFramesPerPes?: number;
4027
4445
  /**
4446
+ * @public
4028
4447
  * Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
4029
4448
  */
4030
4449
  AudioPids?: string;
4031
4450
  /**
4451
+ * @public
4032
4452
  * When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.
4033
4453
  */
4034
4454
  AudioStreamType?: M2tsAudioStreamType | string;
4035
4455
  /**
4456
+ * @public
4036
4457
  * The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
4037
4458
  */
4038
4459
  Bitrate?: number;
4039
4460
  /**
4461
+ * @public
4040
4462
  * Controls the timing accuracy for output network traffic. Leave as MULTIPLEX to ensure accurate network packet timing. Or set to NONE, which might result in lower latency but will result in more variability in output network packet timing. This variability might cause interruptions, jitter, or bursty behavior in your playback or receiving devices.
4041
4463
  */
4042
4464
  BufferModel?: M2tsBufferModel | string;
4043
4465
  /**
4466
+ * @public
4044
4467
  * When set to enabled, generates captionServiceDescriptor in PMT.
4045
4468
  */
4046
4469
  CcDescriptor?: M2tsCcDescriptor | string;
4047
4470
  /**
4471
+ * @public
4048
4472
  * Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
4049
4473
  */
4050
4474
  DvbNitSettings?: DvbNitSettings;
4051
4475
  /**
4476
+ * @public
4052
4477
  * Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
4053
4478
  */
4054
4479
  DvbSdtSettings?: DvbSdtSettings;
4055
4480
  /**
4481
+ * @public
4056
4482
  * Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
4057
4483
  */
4058
4484
  DvbSubPids?: string;
4059
4485
  /**
4486
+ * @public
4060
4487
  * Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
4061
4488
  */
4062
4489
  DvbTdtSettings?: DvbTdtSettings;
4063
4490
  /**
4491
+ * @public
4064
4492
  * Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
4065
4493
  */
4066
4494
  DvbTeletextPid?: string;
4067
4495
  /**
4496
+ * @public
4068
4497
  * If set to passthrough, passes any EBIF data from the input source to this output.
4069
4498
  */
4070
4499
  Ebif?: M2tsEbifControl | string;
4071
4500
  /**
4501
+ * @public
4072
4502
  * When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval.
4073
4503
  */
4074
4504
  EbpAudioInterval?: M2tsAudioInterval | string;
4075
4505
  /**
4506
+ * @public
4076
4507
  * When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
4077
4508
  */
4078
4509
  EbpLookaheadMs?: number;
4079
4510
  /**
4511
+ * @public
4080
4512
  * Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.
4081
4513
  */
4082
4514
  EbpPlacement?: M2tsEbpPlacement | string;
4083
4515
  /**
4516
+ * @public
4084
4517
  * This field is unused and deprecated.
4085
4518
  */
4086
4519
  EcmPid?: string;
4087
4520
  /**
4521
+ * @public
4088
4522
  * Include or exclude the ES Rate field in the PES header.
4089
4523
  */
4090
4524
  EsRateInPes?: M2tsEsRateInPes | string;
4091
4525
  /**
4526
+ * @public
4092
4527
  * Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
4093
4528
  */
4094
4529
  EtvPlatformPid?: string;
4095
4530
  /**
4531
+ * @public
4096
4532
  * Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
4097
4533
  */
4098
4534
  EtvSignalPid?: string;
4099
4535
  /**
4536
+ * @public
4100
4537
  * The length in seconds of each fragment. Only used with EBP markers.
4101
4538
  */
4102
4539
  FragmentTime?: number;
4103
4540
  /**
4541
+ * @public
4104
4542
  * If set to passthrough, passes any KLV data from the input source to this output.
4105
4543
  */
4106
4544
  Klv?: M2tsKlv | string;
4107
4545
  /**
4546
+ * @public
4108
4547
  * Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
4109
4548
  */
4110
4549
  KlvDataPids?: string;
4111
4550
  /**
4551
+ * @public
4112
4552
  * If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
4113
4553
  */
4114
4554
  NielsenId3Behavior?: M2tsNielsenId3Behavior | string;
4115
4555
  /**
4556
+ * @public
4116
4557
  * Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
4117
4558
  */
4118
4559
  NullPacketBitrate?: number;
4119
4560
  /**
4561
+ * @public
4120
4562
  * The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
4121
4563
  */
4122
4564
  PatInterval?: number;
4123
4565
  /**
4566
+ * @public
4124
4567
  * When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
4125
4568
  */
4126
4569
  PcrControl?: M2tsPcrControl | string;
4127
4570
  /**
4571
+ * @public
4128
4572
  * Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
4129
4573
  */
4130
4574
  PcrPeriod?: number;
4131
4575
  /**
4576
+ * @public
4132
4577
  * Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
4133
4578
  */
4134
4579
  PcrPid?: string;
4135
4580
  /**
4581
+ * @public
4136
4582
  * The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
4137
4583
  */
4138
4584
  PmtInterval?: number;
4139
4585
  /**
4586
+ * @public
4140
4587
  * Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
4141
4588
  */
4142
4589
  PmtPid?: string;
4143
4590
  /**
4591
+ * @public
4144
4592
  * The value of the program number field in the Program Map Table.
4145
4593
  */
4146
4594
  ProgramNum?: number;
4147
4595
  /**
4596
+ * @public
4148
4597
  * When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set.
4149
4598
  */
4150
4599
  RateMode?: M2tsRateMode | string;
4151
4600
  /**
4601
+ * @public
4152
4602
  * Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
4153
4603
  */
4154
4604
  Scte27Pids?: string;
4155
4605
  /**
4606
+ * @public
4156
4607
  * Optionally pass SCTE-35 signals from the input source to this output.
4157
4608
  */
4158
4609
  Scte35Control?: M2tsScte35Control | string;
4159
4610
  /**
4611
+ * @public
4160
4612
  * Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
4161
4613
  */
4162
4614
  Scte35Pid?: string;
4163
4615
  /**
4616
+ * @public
4164
4617
  * Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
4165
4618
  */
4166
4619
  SegmentationMarkers?: M2tsSegmentationMarkers | string;
4167
4620
  /**
4621
+ * @public
4168
4622
  * The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted.
4169
4623
  *
4170
4624
  * When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds.
@@ -4173,26 +4627,32 @@ export interface M2tsSettings {
4173
4627
  */
4174
4628
  SegmentationStyle?: M2tsSegmentationStyle | string;
4175
4629
  /**
4630
+ * @public
4176
4631
  * The length in seconds of each segment. Required unless markers is set to _none_.
4177
4632
  */
4178
4633
  SegmentationTime?: number;
4179
4634
  /**
4635
+ * @public
4180
4636
  * When set to passthrough, timed metadata will be passed through from input to output.
4181
4637
  */
4182
4638
  TimedMetadataBehavior?: M2tsTimedMetadataBehavior | string;
4183
4639
  /**
4640
+ * @public
4184
4641
  * Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
4185
4642
  */
4186
4643
  TimedMetadataPid?: string;
4187
4644
  /**
4645
+ * @public
4188
4646
  * The value of the transport stream ID field in the Program Map Table.
4189
4647
  */
4190
4648
  TransportStreamId?: number;
4191
4649
  /**
4650
+ * @public
4192
4651
  * Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
4193
4652
  */
4194
4653
  VideoPid?: string;
4195
4654
  /**
4655
+ * @public
4196
4656
  * Defines the amount SCTE-35 preroll will be increased (in milliseconds) on the output. Preroll is the amount of time between the presence of a SCTE-35 indication in a transport stream and the PTS of the video frame it references. Zero means don't add pullup (it doesn't mean set the preroll to zero). Negative pullup is not supported, which means that you can't make the preroll shorter. Be aware that latency in the output will increase by the pullup amount.
4197
4657
  */
4198
4658
  Scte35PrerollPullupMilliseconds?: number;
@@ -4209,10 +4669,12 @@ export interface RawSettings {
4209
4669
  */
4210
4670
  export interface ArchiveContainerSettings {
4211
4671
  /**
4672
+ * @public
4212
4673
  * M2ts Settings
4213
4674
  */
4214
4675
  M2tsSettings?: M2tsSettings;
4215
4676
  /**
4677
+ * @public
4216
4678
  * Raw Settings
4217
4679
  */
4218
4680
  RawSettings?: RawSettings;
@@ -4223,14 +4685,17 @@ export interface ArchiveContainerSettings {
4223
4685
  */
4224
4686
  export interface ArchiveOutputSettings {
4225
4687
  /**
4688
+ * @public
4226
4689
  * Settings specific to the container type of the file.
4227
4690
  */
4228
4691
  ContainerSettings: ArchiveContainerSettings | undefined;
4229
4692
  /**
4693
+ * @public
4230
4694
  * Output file extension. If excluded, this will be auto-selected from the container type.
4231
4695
  */
4232
4696
  Extension?: string;
4233
4697
  /**
4698
+ * @public
4234
4699
  * String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
4235
4700
  */
4236
4701
  NameModifier?: string;
@@ -4241,6 +4706,7 @@ export interface ArchiveOutputSettings {
4241
4706
  */
4242
4707
  export interface FrameCaptureOutputSettings {
4243
4708
  /**
4709
+ * @public
4244
4710
  * Required if the output group contains more than one output. This modifier forms part of the output file name.
4245
4711
  */
4246
4712
  NameModifier?: string;
@@ -4289,16 +4755,19 @@ export type AudioOnlyHlsSegmentType = (typeof AudioOnlyHlsSegmentType)[keyof typ
4289
4755
  */
4290
4756
  export interface AudioOnlyHlsSettings {
4291
4757
  /**
4758
+ * @public
4292
4759
  * Specifies the group to which the audio Rendition belongs.
4293
4760
  */
4294
4761
  AudioGroupId?: string;
4295
4762
  /**
4763
+ * @public
4296
4764
  * Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth.
4297
4765
  *
4298
4766
  * The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard.
4299
4767
  */
4300
4768
  AudioOnlyImage?: InputLocation;
4301
4769
  /**
4770
+ * @public
4302
4771
  * Four types of audio-only tracks are supported:
4303
4772
  *
4304
4773
  * Audio-Only Variant Stream
@@ -4315,6 +4784,7 @@ export interface AudioOnlyHlsSettings {
4315
4784
  */
4316
4785
  AudioTrackType?: AudioOnlyHlsTrackType | string;
4317
4786
  /**
4787
+ * @public
4318
4788
  * Specifies the segment type.
4319
4789
  */
4320
4790
  SegmentType?: AudioOnlyHlsSegmentType | string;
@@ -4349,14 +4819,17 @@ export type Fmp4TimedMetadataBehavior = (typeof Fmp4TimedMetadataBehavior)[keyof
4349
4819
  */
4350
4820
  export interface Fmp4HlsSettings {
4351
4821
  /**
4822
+ * @public
4352
4823
  * List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
4353
4824
  */
4354
4825
  AudioRenditionSets?: string;
4355
4826
  /**
4827
+ * @public
4356
4828
  * If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
4357
4829
  */
4358
4830
  NielsenId3Behavior?: Fmp4NielsenId3Behavior | string;
4359
4831
  /**
4832
+ * @public
4360
4833
  * When set to passthrough, timed metadata is passed through from input to output.
4361
4834
  */
4362
4835
  TimedMetadataBehavior?: Fmp4TimedMetadataBehavior | string;
@@ -4421,70 +4894,87 @@ export type M3u8TimedMetadataBehavior = (typeof M3u8TimedMetadataBehavior)[keyof
4421
4894
  */
4422
4895
  export interface M3u8Settings {
4423
4896
  /**
4897
+ * @public
4424
4898
  * The number of audio frames to insert for each PES packet.
4425
4899
  */
4426
4900
  AudioFramesPerPes?: number;
4427
4901
  /**
4902
+ * @public
4428
4903
  * Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
4429
4904
  */
4430
4905
  AudioPids?: string;
4431
4906
  /**
4907
+ * @public
4432
4908
  * This parameter is unused and deprecated.
4433
4909
  */
4434
4910
  EcmPid?: string;
4435
4911
  /**
4912
+ * @public
4436
4913
  * If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
4437
4914
  */
4438
4915
  NielsenId3Behavior?: M3u8NielsenId3Behavior | string;
4439
4916
  /**
4917
+ * @public
4440
4918
  * The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
4441
4919
  */
4442
4920
  PatInterval?: number;
4443
4921
  /**
4922
+ * @public
4444
4923
  * When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
4445
4924
  */
4446
4925
  PcrControl?: M3u8PcrControl | string;
4447
4926
  /**
4927
+ * @public
4448
4928
  * Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
4449
4929
  */
4450
4930
  PcrPeriod?: number;
4451
4931
  /**
4932
+ * @public
4452
4933
  * Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
4453
4934
  */
4454
4935
  PcrPid?: string;
4455
4936
  /**
4937
+ * @public
4456
4938
  * The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
4457
4939
  */
4458
4940
  PmtInterval?: number;
4459
4941
  /**
4942
+ * @public
4460
4943
  * Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
4461
4944
  */
4462
4945
  PmtPid?: string;
4463
4946
  /**
4947
+ * @public
4464
4948
  * The value of the program number field in the Program Map Table.
4465
4949
  */
4466
4950
  ProgramNum?: number;
4467
4951
  /**
4952
+ * @public
4468
4953
  * If set to passthrough, passes any SCTE-35 signals from the input source to this output.
4469
4954
  */
4470
4955
  Scte35Behavior?: M3u8Scte35Behavior | string;
4471
4956
  /**
4957
+ * @public
4472
4958
  * Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
4473
4959
  */
4474
4960
  Scte35Pid?: string;
4475
4961
  /**
4962
+ * @public
4476
4963
  * When set to passthrough, timed metadata is passed through from input to output.
4477
4964
  */
4478
4965
  TimedMetadataBehavior?: M3u8TimedMetadataBehavior | string;
4479
4966
  /**
4967
+ * @public
4480
4968
  * Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
4481
4969
  */
4482
4970
  TimedMetadataPid?: string;
4483
4971
  /**
4972
+ * @public
4484
4973
  * The value of the transport stream ID field in the Program Map Table.
4485
4974
  */
4486
4975
  TransportStreamId?: number;
4487
4976
  /**
4977
+ * @public
4488
4978
  * Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
4489
4979
  */
4490
4980
  VideoPid?: string;
@@ -4495,10 +4985,12 @@ export interface M3u8Settings {
4495
4985
  */
4496
4986
  export interface StandardHlsSettings {
4497
4987
  /**
4988
+ * @public
4498
4989
  * List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
4499
4990
  */
4500
4991
  AudioRenditionSets?: string;
4501
4992
  /**
4993
+ * @public
4502
4994
  * Settings information for the .m3u8 container
4503
4995
  */
4504
4996
  M3u8Settings: M3u8Settings | undefined;
@@ -4509,18 +5001,22 @@ export interface StandardHlsSettings {
4509
5001
  */
4510
5002
  export interface HlsSettings {
4511
5003
  /**
5004
+ * @public
4512
5005
  * Audio Only Hls Settings
4513
5006
  */
4514
5007
  AudioOnlyHlsSettings?: AudioOnlyHlsSettings;
4515
5008
  /**
5009
+ * @public
4516
5010
  * Fmp4 Hls Settings
4517
5011
  */
4518
5012
  Fmp4HlsSettings?: Fmp4HlsSettings;
4519
5013
  /**
5014
+ * @public
4520
5015
  * Frame Capture Hls Settings
4521
5016
  */
4522
5017
  FrameCaptureHlsSettings?: FrameCaptureHlsSettings;
4523
5018
  /**
5019
+ * @public
4524
5020
  * Standard Hls Settings
4525
5021
  */
4526
5022
  StandardHlsSettings?: StandardHlsSettings;
@@ -4531,19 +5027,23 @@ export interface HlsSettings {
4531
5027
  */
4532
5028
  export interface HlsOutputSettings {
4533
5029
  /**
5030
+ * @public
4534
5031
  * Only applicable when this output is referencing an H.265 video description.
4535
5032
  * Specifies whether MP4 segments should be packaged as HEV1 or HVC1.
4536
5033
  */
4537
5034
  H265PackagingType?: HlsH265PackagingType | string;
4538
5035
  /**
5036
+ * @public
4539
5037
  * Settings regarding the underlying stream. These settings are different for audio-only outputs.
4540
5038
  */
4541
5039
  HlsSettings: HlsSettings | undefined;
4542
5040
  /**
5041
+ * @public
4543
5042
  * String concatenated to the end of the destination filename. Accepts \"Format Identifiers\":#formatIdentifierParameters.
4544
5043
  */
4545
5044
  NameModifier?: string;
4546
5045
  /**
5046
+ * @public
4547
5047
  * String concatenated to end of segment filenames.
4548
5048
  */
4549
5049
  SegmentModifier?: string;
@@ -4572,11 +5072,13 @@ export type MsSmoothH265PackagingType = (typeof MsSmoothH265PackagingType)[keyof
4572
5072
  */
4573
5073
  export interface MsSmoothOutputSettings {
4574
5074
  /**
5075
+ * @public
4575
5076
  * Only applicable when this output is referencing an H.265 video description.
4576
5077
  * Specifies whether MP4 segments should be packaged as HEV1 or HVC1.
4577
5078
  */
4578
5079
  H265PackagingType?: MsSmoothH265PackagingType | string;
4579
5080
  /**
5081
+ * @public
4580
5082
  * String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
4581
5083
  */
4582
5084
  NameModifier?: string;
@@ -4587,6 +5089,7 @@ export interface MsSmoothOutputSettings {
4587
5089
  */
4588
5090
  export interface OutputLocationRef {
4589
5091
  /**
5092
+ * @public
4590
5093
  * Placeholder documentation for __string
4591
5094
  */
4592
5095
  DestinationRefId?: string;
@@ -4597,6 +5100,7 @@ export interface OutputLocationRef {
4597
5100
  */
4598
5101
  export interface MultiplexOutputSettings {
4599
5102
  /**
5103
+ * @public
4600
5104
  * Destination is a Multiplex.
4601
5105
  */
4602
5106
  Destination: OutputLocationRef | undefined;
@@ -4619,18 +5123,22 @@ export type RtmpOutputCertificateMode = (typeof RtmpOutputCertificateMode)[keyof
4619
5123
  */
4620
5124
  export interface RtmpOutputSettings {
4621
5125
  /**
5126
+ * @public
4622
5127
  * If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail.
4623
5128
  */
4624
5129
  CertificateMode?: RtmpOutputCertificateMode | string;
4625
5130
  /**
5131
+ * @public
4626
5132
  * Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
4627
5133
  */
4628
5134
  ConnectionRetryInterval?: number;
4629
5135
  /**
5136
+ * @public
4630
5137
  * The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
4631
5138
  */
4632
5139
  Destination: OutputLocationRef | undefined;
4633
5140
  /**
5141
+ * @public
4634
5142
  * Number of retry attempts.
4635
5143
  */
4636
5144
  NumRetries?: number;
@@ -4641,6 +5149,7 @@ export interface RtmpOutputSettings {
4641
5149
  */
4642
5150
  export interface UdpContainerSettings {
4643
5151
  /**
5152
+ * @public
4644
5153
  * M2ts Settings
4645
5154
  */
4646
5155
  M2tsSettings?: M2tsSettings;
@@ -4663,14 +5172,17 @@ export type FecOutputIncludeFec = (typeof FecOutputIncludeFec)[keyof typeof FecO
4663
5172
  */
4664
5173
  export interface FecOutputSettings {
4665
5174
  /**
5175
+ * @public
4666
5176
  * Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
4667
5177
  */
4668
5178
  ColumnDepth?: number;
4669
5179
  /**
5180
+ * @public
4670
5181
  * Enables column only or column and row based FEC
4671
5182
  */
4672
5183
  IncludeFec?: FecOutputIncludeFec | string;
4673
5184
  /**
5185
+ * @public
4674
5186
  * Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
4675
5187
  */
4676
5188
  RowLength?: number;
@@ -4681,18 +5193,22 @@ export interface FecOutputSettings {
4681
5193
  */
4682
5194
  export interface UdpOutputSettings {
4683
5195
  /**
5196
+ * @public
4684
5197
  * UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
4685
5198
  */
4686
5199
  BufferMsec?: number;
4687
5200
  /**
5201
+ * @public
4688
5202
  * Udp Container Settings
4689
5203
  */
4690
5204
  ContainerSettings: UdpContainerSettings | undefined;
4691
5205
  /**
5206
+ * @public
4692
5207
  * Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
4693
5208
  */
4694
5209
  Destination: OutputLocationRef | undefined;
4695
5210
  /**
5211
+ * @public
4696
5212
  * Settings for enabling and adjusting Forward Error Correction on UDP outputs.
4697
5213
  */
4698
5214
  FecOutputSettings?: FecOutputSettings;
@@ -4703,34 +5219,42 @@ export interface UdpOutputSettings {
4703
5219
  */
4704
5220
  export interface OutputSettings {
4705
5221
  /**
5222
+ * @public
4706
5223
  * Archive Output Settings
4707
5224
  */
4708
5225
  ArchiveOutputSettings?: ArchiveOutputSettings;
4709
5226
  /**
5227
+ * @public
4710
5228
  * Frame Capture Output Settings
4711
5229
  */
4712
5230
  FrameCaptureOutputSettings?: FrameCaptureOutputSettings;
4713
5231
  /**
5232
+ * @public
4714
5233
  * Hls Output Settings
4715
5234
  */
4716
5235
  HlsOutputSettings?: HlsOutputSettings;
4717
5236
  /**
5237
+ * @public
4718
5238
  * Media Package Output Settings
4719
5239
  */
4720
5240
  MediaPackageOutputSettings?: MediaPackageOutputSettings;
4721
5241
  /**
5242
+ * @public
4722
5243
  * Ms Smooth Output Settings
4723
5244
  */
4724
5245
  MsSmoothOutputSettings?: MsSmoothOutputSettings;
4725
5246
  /**
5247
+ * @public
4726
5248
  * Multiplex Output Settings
4727
5249
  */
4728
5250
  MultiplexOutputSettings?: MultiplexOutputSettings;
4729
5251
  /**
5252
+ * @public
4730
5253
  * Rtmp Output Settings
4731
5254
  */
4732
5255
  RtmpOutputSettings?: RtmpOutputSettings;
4733
5256
  /**
5257
+ * @public
4734
5258
  * Udp Output Settings
4735
5259
  */
4736
5260
  UdpOutputSettings?: UdpOutputSettings;
@@ -4741,22 +5265,27 @@ export interface OutputSettings {
4741
5265
  */
4742
5266
  export interface Output {
4743
5267
  /**
5268
+ * @public
4744
5269
  * The names of the AudioDescriptions used as audio sources for this output.
4745
5270
  */
4746
5271
  AudioDescriptionNames?: string[];
4747
5272
  /**
5273
+ * @public
4748
5274
  * The names of the CaptionDescriptions used as caption sources for this output.
4749
5275
  */
4750
5276
  CaptionDescriptionNames?: string[];
4751
5277
  /**
5278
+ * @public
4752
5279
  * The name used to identify an output.
4753
5280
  */
4754
5281
  OutputName?: string;
4755
5282
  /**
5283
+ * @public
4756
5284
  * Output type-specific settings.
4757
5285
  */
4758
5286
  OutputSettings: OutputSettings | undefined;
4759
5287
  /**
5288
+ * @public
4760
5289
  * The name of the VideoDescription used as the source for this output.
4761
5290
  */
4762
5291
  VideoDescriptionName?: string;
@@ -4781,6 +5310,7 @@ export type S3CannedAcl = (typeof S3CannedAcl)[keyof typeof S3CannedAcl];
4781
5310
  */
4782
5311
  export interface ArchiveS3Settings {
4783
5312
  /**
5313
+ * @public
4784
5314
  * Specify the canned ACL to apply to each S3 request. Defaults to none.
4785
5315
  */
4786
5316
  CannedAcl?: S3CannedAcl | string;
@@ -4791,6 +5321,7 @@ export interface ArchiveS3Settings {
4791
5321
  */
4792
5322
  export interface ArchiveCdnSettings {
4793
5323
  /**
5324
+ * @public
4794
5325
  * Archive S3 Settings
4795
5326
  */
4796
5327
  ArchiveS3Settings?: ArchiveS3Settings;
@@ -4801,14 +5332,17 @@ export interface ArchiveCdnSettings {
4801
5332
  */
4802
5333
  export interface ArchiveGroupSettings {
4803
5334
  /**
5335
+ * @public
4804
5336
  * Parameters that control interactions with the CDN.
4805
5337
  */
4806
5338
  ArchiveCdnSettings?: ArchiveCdnSettings;
4807
5339
  /**
5340
+ * @public
4808
5341
  * A directory and base filename where archive files should be written.
4809
5342
  */
4810
5343
  Destination: OutputLocationRef | undefined;
4811
5344
  /**
5345
+ * @public
4812
5346
  * Number of seconds to write to archive file before closing and starting a new one.
4813
5347
  */
4814
5348
  RolloverInterval?: number;
@@ -4819,6 +5353,7 @@ export interface ArchiveGroupSettings {
4819
5353
  */
4820
5354
  export interface FrameCaptureS3Settings {
4821
5355
  /**
5356
+ * @public
4822
5357
  * Specify the canned ACL to apply to each S3 request. Defaults to none.
4823
5358
  */
4824
5359
  CannedAcl?: S3CannedAcl | string;
@@ -4829,6 +5364,7 @@ export interface FrameCaptureS3Settings {
4829
5364
  */
4830
5365
  export interface FrameCaptureCdnSettings {
4831
5366
  /**
5367
+ * @public
4832
5368
  * Frame Capture S3 Settings
4833
5369
  */
4834
5370
  FrameCaptureS3Settings?: FrameCaptureS3Settings;
@@ -4839,10 +5375,12 @@ export interface FrameCaptureCdnSettings {
4839
5375
  */
4840
5376
  export interface FrameCaptureGroupSettings {
4841
5377
  /**
5378
+ * @public
4842
5379
  * The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling-) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling-). The final file names consist of the prefix from the destination field (for example, "curling-") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curling-low.00001.jpg
4843
5380
  */
4844
5381
  Destination: OutputLocationRef | undefined;
4845
5382
  /**
5383
+ * @public
4846
5384
  * Parameters that control interactions with the CDN.
4847
5385
  */
4848
5386
  FrameCaptureCdnSettings?: FrameCaptureCdnSettings;
@@ -4938,30 +5476,37 @@ export type HlsAkamaiHttpTransferMode = (typeof HlsAkamaiHttpTransferMode)[keyof
4938
5476
  */
4939
5477
  export interface HlsAkamaiSettings {
4940
5478
  /**
5479
+ * @public
4941
5480
  * Number of seconds to wait before retrying connection to the CDN if the connection is lost.
4942
5481
  */
4943
5482
  ConnectionRetryInterval?: number;
4944
5483
  /**
5484
+ * @public
4945
5485
  * Size in seconds of file cache for streaming outputs.
4946
5486
  */
4947
5487
  FilecacheDuration?: number;
4948
5488
  /**
5489
+ * @public
4949
5490
  * Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature.
4950
5491
  */
4951
5492
  HttpTransferMode?: HlsAkamaiHttpTransferMode | string;
4952
5493
  /**
5494
+ * @public
4953
5495
  * Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with "s3" or "mediastore". For other URIs, the value is always 3.
4954
5496
  */
4955
5497
  NumRetries?: number;
4956
5498
  /**
5499
+ * @public
4957
5500
  * If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
4958
5501
  */
4959
5502
  RestartDelay?: number;
4960
5503
  /**
5504
+ * @public
4961
5505
  * Salt for authenticated Akamai.
4962
5506
  */
4963
5507
  Salt?: string;
4964
5508
  /**
5509
+ * @public
4965
5510
  * Token parameter for authenticated akamai. If not specified, _gda_ is used.
4966
5511
  */
4967
5512
  Token?: string;
@@ -4972,18 +5517,22 @@ export interface HlsAkamaiSettings {
4972
5517
  */
4973
5518
  export interface HlsBasicPutSettings {
4974
5519
  /**
5520
+ * @public
4975
5521
  * Number of seconds to wait before retrying connection to the CDN if the connection is lost.
4976
5522
  */
4977
5523
  ConnectionRetryInterval?: number;
4978
5524
  /**
5525
+ * @public
4979
5526
  * Size in seconds of file cache for streaming outputs.
4980
5527
  */
4981
5528
  FilecacheDuration?: number;
4982
5529
  /**
5530
+ * @public
4983
5531
  * Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with "s3" or "mediastore". For other URIs, the value is always 3.
4984
5532
  */
4985
5533
  NumRetries?: number;
4986
5534
  /**
5535
+ * @public
4987
5536
  * If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
4988
5537
  */
4989
5538
  RestartDelay?: number;
@@ -5005,22 +5554,27 @@ export type HlsMediaStoreStorageClass = (typeof HlsMediaStoreStorageClass)[keyof
5005
5554
  */
5006
5555
  export interface HlsMediaStoreSettings {
5007
5556
  /**
5557
+ * @public
5008
5558
  * Number of seconds to wait before retrying connection to the CDN if the connection is lost.
5009
5559
  */
5010
5560
  ConnectionRetryInterval?: number;
5011
5561
  /**
5562
+ * @public
5012
5563
  * Size in seconds of file cache for streaming outputs.
5013
5564
  */
5014
5565
  FilecacheDuration?: number;
5015
5566
  /**
5567
+ * @public
5016
5568
  * When set to temporal, output files are stored in non-persistent memory for faster reading and writing.
5017
5569
  */
5018
5570
  MediaStoreStorageClass?: HlsMediaStoreStorageClass | string;
5019
5571
  /**
5572
+ * @public
5020
5573
  * Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with "s3" or "mediastore". For other URIs, the value is always 3.
5021
5574
  */
5022
5575
  NumRetries?: number;
5023
5576
  /**
5577
+ * @public
5024
5578
  * If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
5025
5579
  */
5026
5580
  RestartDelay?: number;
@@ -5031,6 +5585,7 @@ export interface HlsMediaStoreSettings {
5031
5585
  */
5032
5586
  export interface HlsS3Settings {
5033
5587
  /**
5588
+ * @public
5034
5589
  * Specify the canned ACL to apply to each S3 request. Defaults to none.
5035
5590
  */
5036
5591
  CannedAcl?: S3CannedAcl | string;
@@ -5053,22 +5608,27 @@ export type HlsWebdavHttpTransferMode = (typeof HlsWebdavHttpTransferMode)[keyof
5053
5608
  */
5054
5609
  export interface HlsWebdavSettings {
5055
5610
  /**
5611
+ * @public
5056
5612
  * Number of seconds to wait before retrying connection to the CDN if the connection is lost.
5057
5613
  */
5058
5614
  ConnectionRetryInterval?: number;
5059
5615
  /**
5616
+ * @public
5060
5617
  * Size in seconds of file cache for streaming outputs.
5061
5618
  */
5062
5619
  FilecacheDuration?: number;
5063
5620
  /**
5621
+ * @public
5064
5622
  * Specify whether or not to use chunked transfer encoding to WebDAV.
5065
5623
  */
5066
5624
  HttpTransferMode?: HlsWebdavHttpTransferMode | string;
5067
5625
  /**
5626
+ * @public
5068
5627
  * Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with "s3" or "mediastore". For other URIs, the value is always 3.
5069
5628
  */
5070
5629
  NumRetries?: number;
5071
5630
  /**
5631
+ * @public
5072
5632
  * If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
5073
5633
  */
5074
5634
  RestartDelay?: number;
@@ -5079,22 +5639,27 @@ export interface HlsWebdavSettings {
5079
5639
  */
5080
5640
  export interface HlsCdnSettings {
5081
5641
  /**
5642
+ * @public
5082
5643
  * Hls Akamai Settings
5083
5644
  */
5084
5645
  HlsAkamaiSettings?: HlsAkamaiSettings;
5085
5646
  /**
5647
+ * @public
5086
5648
  * Hls Basic Put Settings
5087
5649
  */
5088
5650
  HlsBasicPutSettings?: HlsBasicPutSettings;
5089
5651
  /**
5652
+ * @public
5090
5653
  * Hls Media Store Settings
5091
5654
  */
5092
5655
  HlsMediaStoreSettings?: HlsMediaStoreSettings;
5093
5656
  /**
5657
+ * @public
5094
5658
  * Hls S3 Settings
5095
5659
  */
5096
5660
  HlsS3Settings?: HlsS3Settings;
5097
5661
  /**
5662
+ * @public
5098
5663
  * Hls Webdav Settings
5099
5664
  */
5100
5665
  HlsWebdavSettings?: HlsWebdavSettings;
@@ -5177,10 +5742,12 @@ export type HlsIvSource = (typeof HlsIvSource)[keyof typeof HlsIvSource];
5177
5742
  */
5178
5743
  export interface StaticKeySettings {
5179
5744
  /**
5745
+ * @public
5180
5746
  * The URL of the license server used for protecting content.
5181
5747
  */
5182
5748
  KeyProviderServer?: InputLocation;
5183
5749
  /**
5750
+ * @public
5184
5751
  * Static key value as a 32 character hexadecimal string.
5185
5752
  */
5186
5753
  StaticKeyValue: string | undefined;
@@ -5191,6 +5758,7 @@ export interface StaticKeySettings {
5191
5758
  */
5192
5759
  export interface KeyProviderSettings {
5193
5760
  /**
5761
+ * @public
5194
5762
  * Static Key Settings
5195
5763
  */
5196
5764
  StaticKeySettings?: StaticKeySettings;