@aws-sdk/client-kinesis-video-archived-media 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.
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
2
5
|
export interface ClientInputEndpointParameters {
|
|
3
6
|
region?: string | Provider<string>;
|
|
4
7
|
useDualstackEndpoint?: boolean | Provider<boolean>;
|
package/dist-types/index.d.ts
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
*/
|
|
6
6
|
export * from "./KinesisVideoArchivedMediaClient";
|
|
7
7
|
export * from "./KinesisVideoArchivedMedia";
|
|
8
|
+
export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
|
|
8
9
|
export * from "./commands";
|
|
9
10
|
export * from "./models";
|
|
10
11
|
export { KinesisVideoArchivedMediaServiceException } from "./models/KinesisVideoArchivedMediaServiceException";
|
|
@@ -32,6 +32,7 @@ export type ClipFragmentSelectorType = (typeof ClipFragmentSelectorType)[keyof t
|
|
|
32
32
|
*/
|
|
33
33
|
export interface ClipTimestampRange {
|
|
34
34
|
/**
|
|
35
|
+
* @public
|
|
35
36
|
* <p>The starting timestamp in the range of timestamps for which to return fragments. </p>
|
|
36
37
|
* <p>Only fragments that start exactly at or after <code>StartTimestamp</code> are included
|
|
37
38
|
* in the session. Fragments that start before <code>StartTimestamp</code> and continue
|
|
@@ -41,6 +42,7 @@ export interface ClipTimestampRange {
|
|
|
41
42
|
*/
|
|
42
43
|
StartTimestamp: Date | undefined;
|
|
43
44
|
/**
|
|
45
|
+
* @public
|
|
44
46
|
* <p>The end of the timestamp range for the requested media.</p>
|
|
45
47
|
* <p>This value must be within 24 hours of the specified <code>StartTimestamp</code>, and
|
|
46
48
|
* it must be later than the <code>StartTimestamp</code> value. If
|
|
@@ -64,10 +66,12 @@ export interface ClipTimestampRange {
|
|
|
64
66
|
*/
|
|
65
67
|
export interface ClipFragmentSelector {
|
|
66
68
|
/**
|
|
69
|
+
* @public
|
|
67
70
|
* <p>The origin of the timestamps to use (Server or Producer).</p>
|
|
68
71
|
*/
|
|
69
72
|
FragmentSelectorType: ClipFragmentSelectorType | string | undefined;
|
|
70
73
|
/**
|
|
74
|
+
* @public
|
|
71
75
|
* <p>The range of timestamps to return.</p>
|
|
72
76
|
*/
|
|
73
77
|
TimestampRange: ClipTimestampRange | undefined;
|
|
@@ -77,16 +81,19 @@ export interface ClipFragmentSelector {
|
|
|
77
81
|
*/
|
|
78
82
|
export interface GetClipInput {
|
|
79
83
|
/**
|
|
84
|
+
* @public
|
|
80
85
|
* <p>The name of the stream for which to retrieve the media clip. </p>
|
|
81
86
|
* <p>You must specify either the StreamName or the StreamARN. </p>
|
|
82
87
|
*/
|
|
83
88
|
StreamName?: string;
|
|
84
89
|
/**
|
|
90
|
+
* @public
|
|
85
91
|
* <p>The Amazon Resource Name (ARN) of the stream for which to retrieve the media clip. </p>
|
|
86
92
|
* <p>You must specify either the StreamName or the StreamARN. </p>
|
|
87
93
|
*/
|
|
88
94
|
StreamARN?: string;
|
|
89
95
|
/**
|
|
96
|
+
* @public
|
|
90
97
|
* <p>The time range of the requested clip and the source of the timestamps.</p>
|
|
91
98
|
*/
|
|
92
99
|
ClipFragmentSelector: ClipFragmentSelector | undefined;
|
|
@@ -96,10 +103,12 @@ export interface GetClipInput {
|
|
|
96
103
|
*/
|
|
97
104
|
export interface GetClipOutput {
|
|
98
105
|
/**
|
|
106
|
+
* @public
|
|
99
107
|
* <p>The content type of the media in the requested clip.</p>
|
|
100
108
|
*/
|
|
101
109
|
ContentType?: string;
|
|
102
110
|
/**
|
|
111
|
+
* @public
|
|
103
112
|
* <p>Traditional MP4 file that contains the media clip from the specified video stream. The
|
|
104
113
|
* output will contain the first 100 MB or the first 200 fragments from the specified start
|
|
105
114
|
* timestamp. For more information, see <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html">Kinesis
|
|
@@ -251,6 +260,7 @@ export type DASHFragmentSelectorType = (typeof DASHFragmentSelectorType)[keyof t
|
|
|
251
260
|
*/
|
|
252
261
|
export interface DASHTimestampRange {
|
|
253
262
|
/**
|
|
263
|
+
* @public
|
|
254
264
|
* <p>The start of the timestamp range for the requested media.</p>
|
|
255
265
|
* <p>If the <code>DASHTimestampRange</code> value is specified, the
|
|
256
266
|
* <code>StartTimestamp</code> value is required.</p>
|
|
@@ -262,6 +272,7 @@ export interface DASHTimestampRange {
|
|
|
262
272
|
*/
|
|
263
273
|
StartTimestamp?: Date;
|
|
264
274
|
/**
|
|
275
|
+
* @public
|
|
265
276
|
* <p>The end of the timestamp range for the requested media. This value must be within 24
|
|
266
277
|
* hours of the specified <code>StartTimestamp</code>, and it must be later than the
|
|
267
278
|
* <code>StartTimestamp</code> value.</p>
|
|
@@ -288,6 +299,7 @@ export interface DASHTimestampRange {
|
|
|
288
299
|
*/
|
|
289
300
|
export interface DASHFragmentSelector {
|
|
290
301
|
/**
|
|
302
|
+
* @public
|
|
291
303
|
* <p>The source of the timestamps for the requested media.</p>
|
|
292
304
|
* <p>When <code>FragmentSelectorType</code> is set to <code>PRODUCER_TIMESTAMP</code> and
|
|
293
305
|
* <a>GetDASHStreamingSessionURLInput$PlaybackMode</a> is
|
|
@@ -312,6 +324,7 @@ export interface DASHFragmentSelector {
|
|
|
312
324
|
*/
|
|
313
325
|
FragmentSelectorType?: DASHFragmentSelectorType | string;
|
|
314
326
|
/**
|
|
327
|
+
* @public
|
|
315
328
|
* <p>The start and end of the timestamp range for the requested media.</p>
|
|
316
329
|
* <p>This value should not be present if <code>PlaybackType</code> is
|
|
317
330
|
* <code>LIVE</code>.</p>
|
|
@@ -360,12 +373,14 @@ export type DASHPlaybackMode = (typeof DASHPlaybackMode)[keyof typeof DASHPlayba
|
|
|
360
373
|
*/
|
|
361
374
|
export interface GetDASHStreamingSessionURLInput {
|
|
362
375
|
/**
|
|
376
|
+
* @public
|
|
363
377
|
* <p>The name of the stream for which to retrieve the MPEG-DASH manifest URL.</p>
|
|
364
378
|
* <p>You must specify either the <code>StreamName</code> or the
|
|
365
379
|
* <code>StreamARN</code>.</p>
|
|
366
380
|
*/
|
|
367
381
|
StreamName?: string;
|
|
368
382
|
/**
|
|
383
|
+
* @public
|
|
369
384
|
* <p>The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH
|
|
370
385
|
* manifest URL.</p>
|
|
371
386
|
* <p>You must specify either the <code>StreamName</code> or the
|
|
@@ -373,6 +388,7 @@ export interface GetDASHStreamingSessionURLInput {
|
|
|
373
388
|
*/
|
|
374
389
|
StreamARN?: string;
|
|
375
390
|
/**
|
|
391
|
+
* @public
|
|
376
392
|
* <p>Whether to retrieve live, live replay, or archived, on-demand data.</p>
|
|
377
393
|
* <p>Features of the three types of sessions include the following:</p>
|
|
378
394
|
* <ul>
|
|
@@ -436,6 +452,7 @@ export interface GetDASHStreamingSessionURLInput {
|
|
|
436
452
|
*/
|
|
437
453
|
PlaybackMode?: DASHPlaybackMode | string;
|
|
438
454
|
/**
|
|
455
|
+
* @public
|
|
439
456
|
* <p>Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file
|
|
440
457
|
* can be derived using attributes in the manifest itself. However, typically, MPEG-DASH
|
|
441
458
|
* compatible media players do not properly handle gaps in the media timeline. Kinesis
|
|
@@ -453,6 +470,7 @@ export interface GetDASHStreamingSessionURLInput {
|
|
|
453
470
|
*/
|
|
454
471
|
DisplayFragmentTimestamp?: DASHDisplayFragmentTimestamp | string;
|
|
455
472
|
/**
|
|
473
|
+
* @public
|
|
456
474
|
* <p>Fragments are identified in the manifest file based on their sequence number in the
|
|
457
475
|
* session. If DisplayFragmentNumber is set to <code>ALWAYS</code>, the Kinesis Video
|
|
458
476
|
* Streams fragment number is added to each S element in the manifest file with the
|
|
@@ -464,6 +482,7 @@ export interface GetDASHStreamingSessionURLInput {
|
|
|
464
482
|
*/
|
|
465
483
|
DisplayFragmentNumber?: DASHDisplayFragmentNumber | string;
|
|
466
484
|
/**
|
|
485
|
+
* @public
|
|
467
486
|
* <p>The time range of the requested fragment and the source of the timestamps.</p>
|
|
468
487
|
* <p>This parameter is required if <code>PlaybackMode</code> is <code>ON_DEMAND</code> or
|
|
469
488
|
* <code>LIVE_REPLAY</code>. This parameter is optional if PlaybackMode is<code></code>
|
|
@@ -475,6 +494,7 @@ export interface GetDASHStreamingSessionURLInput {
|
|
|
475
494
|
*/
|
|
476
495
|
DASHFragmentSelector?: DASHFragmentSelector;
|
|
477
496
|
/**
|
|
497
|
+
* @public
|
|
478
498
|
* <p>The time in seconds until the requested session expires. This value can be between 300
|
|
479
499
|
* (5 minutes) and 43200 (12 hours).</p>
|
|
480
500
|
* <p>When a session expires, no new calls to <code>GetDashManifest</code>,
|
|
@@ -484,6 +504,7 @@ export interface GetDASHStreamingSessionURLInput {
|
|
|
484
504
|
*/
|
|
485
505
|
Expires?: number;
|
|
486
506
|
/**
|
|
507
|
+
* @public
|
|
487
508
|
* <p>The maximum number of fragments that are returned in the MPEG-DASH manifest.</p>
|
|
488
509
|
* <p>When the <code>PlaybackMode</code> is <code>LIVE</code>, the most recent fragments are
|
|
489
510
|
* returned up to this value. When the <code>PlaybackMode</code> is <code>ON_DEMAND</code>,
|
|
@@ -507,6 +528,7 @@ export interface GetDASHStreamingSessionURLInput {
|
|
|
507
528
|
*/
|
|
508
529
|
export interface GetDASHStreamingSessionURLOutput {
|
|
509
530
|
/**
|
|
531
|
+
* @public
|
|
510
532
|
* <p>The URL (containing the session token) that a media player can use to retrieve the
|
|
511
533
|
* MPEG-DASH manifest.</p>
|
|
512
534
|
*/
|
|
@@ -569,6 +591,7 @@ export type HLSFragmentSelectorType = (typeof HLSFragmentSelectorType)[keyof typ
|
|
|
569
591
|
*/
|
|
570
592
|
export interface HLSTimestampRange {
|
|
571
593
|
/**
|
|
594
|
+
* @public
|
|
572
595
|
* <p>The start of the timestamp range for the requested media.</p>
|
|
573
596
|
* <p>If the <code>HLSTimestampRange</code> value is specified, the
|
|
574
597
|
* <code>StartTimestamp</code> value is required. </p>
|
|
@@ -580,6 +603,7 @@ export interface HLSTimestampRange {
|
|
|
580
603
|
*/
|
|
581
604
|
StartTimestamp?: Date;
|
|
582
605
|
/**
|
|
606
|
+
* @public
|
|
583
607
|
* <p>The end of the timestamp range for the requested media. This value must be within 24
|
|
584
608
|
* hours of the specified <code>StartTimestamp</code>, and it must be later than the
|
|
585
609
|
* <code>StartTimestamp</code> value.</p>
|
|
@@ -605,6 +629,7 @@ export interface HLSTimestampRange {
|
|
|
605
629
|
*/
|
|
606
630
|
export interface HLSFragmentSelector {
|
|
607
631
|
/**
|
|
632
|
+
* @public
|
|
608
633
|
* <p>The source of the timestamps for the requested media.</p>
|
|
609
634
|
* <p>When <code>FragmentSelectorType</code> is set to <code>PRODUCER_TIMESTAMP</code> and
|
|
610
635
|
* <a>GetHLSStreamingSessionURLInput$PlaybackMode</a> is
|
|
@@ -629,6 +654,7 @@ export interface HLSFragmentSelector {
|
|
|
629
654
|
*/
|
|
630
655
|
FragmentSelectorType?: HLSFragmentSelectorType | string;
|
|
631
656
|
/**
|
|
657
|
+
* @public
|
|
632
658
|
* <p>The start and end of the timestamp range for the requested media.</p>
|
|
633
659
|
* <p>This value should not be present if <code>PlaybackType</code> is
|
|
634
660
|
* <code>LIVE</code>.</p>
|
|
@@ -653,12 +679,14 @@ export type HLSPlaybackMode = (typeof HLSPlaybackMode)[keyof typeof HLSPlaybackM
|
|
|
653
679
|
*/
|
|
654
680
|
export interface GetHLSStreamingSessionURLInput {
|
|
655
681
|
/**
|
|
682
|
+
* @public
|
|
656
683
|
* <p>The name of the stream for which to retrieve the HLS master playlist URL.</p>
|
|
657
684
|
* <p>You must specify either the <code>StreamName</code> or the
|
|
658
685
|
* <code>StreamARN</code>.</p>
|
|
659
686
|
*/
|
|
660
687
|
StreamName?: string;
|
|
661
688
|
/**
|
|
689
|
+
* @public
|
|
662
690
|
* <p>The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master
|
|
663
691
|
* playlist URL.</p>
|
|
664
692
|
* <p>You must specify either the <code>StreamName</code> or the
|
|
@@ -666,6 +694,7 @@ export interface GetHLSStreamingSessionURLInput {
|
|
|
666
694
|
*/
|
|
667
695
|
StreamARN?: string;
|
|
668
696
|
/**
|
|
697
|
+
* @public
|
|
669
698
|
* <p>Whether to retrieve live, live replay, or archived, on-demand data.</p>
|
|
670
699
|
* <p>Features of the three types of sessions include the following:</p>
|
|
671
700
|
* <ul>
|
|
@@ -729,6 +758,7 @@ export interface GetHLSStreamingSessionURLInput {
|
|
|
729
758
|
*/
|
|
730
759
|
PlaybackMode?: HLSPlaybackMode | string;
|
|
731
760
|
/**
|
|
761
|
+
* @public
|
|
732
762
|
* <p>The time range of the requested fragment and the source of the timestamps.</p>
|
|
733
763
|
* <p>This parameter is required if <code>PlaybackMode</code> is <code>ON_DEMAND</code> or
|
|
734
764
|
* <code>LIVE_REPLAY</code>. This parameter is optional if PlaybackMode is<code></code>
|
|
@@ -740,6 +770,7 @@ export interface GetHLSStreamingSessionURLInput {
|
|
|
740
770
|
*/
|
|
741
771
|
HLSFragmentSelector?: HLSFragmentSelector;
|
|
742
772
|
/**
|
|
773
|
+
* @public
|
|
743
774
|
* <p>Specifies which format should be used for packaging the media. Specifying the
|
|
744
775
|
* <code>FRAGMENTED_MP4</code> container format packages the media into MP4 fragments
|
|
745
776
|
* (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging
|
|
@@ -751,6 +782,7 @@ export interface GetHLSStreamingSessionURLInput {
|
|
|
751
782
|
*/
|
|
752
783
|
ContainerFormat?: ContainerFormat | string;
|
|
753
784
|
/**
|
|
785
|
+
* @public
|
|
754
786
|
* <p>Specifies when flags marking discontinuities between fragments are added to the media
|
|
755
787
|
* playlists.</p>
|
|
756
788
|
* <p>Media players typically build a timeline of media content to play, based on the
|
|
@@ -792,6 +824,7 @@ export interface GetHLSStreamingSessionURLInput {
|
|
|
792
824
|
*/
|
|
793
825
|
DiscontinuityMode?: HLSDiscontinuityMode | string;
|
|
794
826
|
/**
|
|
827
|
+
* @public
|
|
795
828
|
* <p>Specifies when the fragment start timestamps should be included in the HLS media
|
|
796
829
|
* playlist. Typically, media players report the playhead position as a time relative to
|
|
797
830
|
* the start of the first fragment in the playback session. However, when the start
|
|
@@ -807,6 +840,7 @@ export interface GetHLSStreamingSessionURLInput {
|
|
|
807
840
|
*/
|
|
808
841
|
DisplayFragmentTimestamp?: HLSDisplayFragmentTimestamp | string;
|
|
809
842
|
/**
|
|
843
|
+
* @public
|
|
810
844
|
* <p>The time in seconds until the requested session expires. This value can be between 300
|
|
811
845
|
* (5 minutes) and 43200 (12 hours).</p>
|
|
812
846
|
* <p>When a session expires, no new calls to <code>GetHLSMasterPlaylist</code>,
|
|
@@ -817,6 +851,7 @@ export interface GetHLSStreamingSessionURLInput {
|
|
|
817
851
|
*/
|
|
818
852
|
Expires?: number;
|
|
819
853
|
/**
|
|
854
|
+
* @public
|
|
820
855
|
* <p>The maximum number of fragments that are returned in the HLS media playlists.</p>
|
|
821
856
|
* <p>When the <code>PlaybackMode</code> is <code>LIVE</code>, the most recent fragments are
|
|
822
857
|
* returned up to this value. When the <code>PlaybackMode</code> is <code>ON_DEMAND</code>,
|
|
@@ -840,6 +875,7 @@ export interface GetHLSStreamingSessionURLInput {
|
|
|
840
875
|
*/
|
|
841
876
|
export interface GetHLSStreamingSessionURLOutput {
|
|
842
877
|
/**
|
|
878
|
+
* @public
|
|
843
879
|
* <p>The URL (containing the session token) that a media player can use to retrieve the HLS
|
|
844
880
|
* master playlist.</p>
|
|
845
881
|
*/
|
|
@@ -885,26 +921,32 @@ export type ImageSelectorType = (typeof ImageSelectorType)[keyof typeof ImageSel
|
|
|
885
921
|
*/
|
|
886
922
|
export interface GetImagesInput {
|
|
887
923
|
/**
|
|
924
|
+
* @public
|
|
888
925
|
* <p>The name of the stream from which to retrieve the images. You must specify either the <code>StreamName</code> or the <code>StreamARN</code>.</p>
|
|
889
926
|
*/
|
|
890
927
|
StreamName?: string;
|
|
891
928
|
/**
|
|
929
|
+
* @public
|
|
892
930
|
* <p>The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the <code>StreamName</code> or the <code>StreamARN</code>.</p>
|
|
893
931
|
*/
|
|
894
932
|
StreamARN?: string;
|
|
895
933
|
/**
|
|
934
|
+
* @public
|
|
896
935
|
* <p>The origin of the Server or Producer timestamps to use to generate the images.</p>
|
|
897
936
|
*/
|
|
898
937
|
ImageSelectorType: ImageSelectorType | string | undefined;
|
|
899
938
|
/**
|
|
939
|
+
* @public
|
|
900
940
|
* <p>The starting point from which the images should be generated. This <code>StartTimestamp</code> must be within an inclusive range of timestamps for an image to be returned.</p>
|
|
901
941
|
*/
|
|
902
942
|
StartTimestamp: Date | undefined;
|
|
903
943
|
/**
|
|
944
|
+
* @public
|
|
904
945
|
* <p>The end timestamp for the range of images to be generated.</p>
|
|
905
946
|
*/
|
|
906
947
|
EndTimestamp: Date | undefined;
|
|
907
948
|
/**
|
|
949
|
+
* @public
|
|
908
950
|
* <p>The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 3000 ms. If the timestamp range is less than the sampling interval, the Image from the <code>startTimestamp</code> will be returned if available.
|
|
909
951
|
* </p>
|
|
910
952
|
* <note>
|
|
@@ -913,28 +955,33 @@ export interface GetImagesInput {
|
|
|
913
955
|
*/
|
|
914
956
|
SamplingInterval: number | undefined;
|
|
915
957
|
/**
|
|
958
|
+
* @public
|
|
916
959
|
* <p>The format that will be used to encode the image.</p>
|
|
917
960
|
*/
|
|
918
961
|
Format: Format | string | undefined;
|
|
919
962
|
/**
|
|
963
|
+
* @public
|
|
920
964
|
* <p>The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The <code>FormatConfig</code> key is the <code>JPEGQuality</code>, which indicates the JPEG quality key to be used to generate the image.
|
|
921
965
|
* The <code>FormatConfig</code> value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression.
|
|
922
966
|
* If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the <code>JPEGQuality</code> key will be set to 80.</p>
|
|
923
967
|
*/
|
|
924
968
|
FormatConfig?: Record<string, string>;
|
|
925
969
|
/**
|
|
970
|
+
* @public
|
|
926
971
|
* <p>The width of the output image that is used in conjunction with the <code>HeightPixels</code> parameter. When both <code>WidthPixels</code> and <code>HeightPixels</code> parameters are provided,
|
|
927
972
|
* the image will be stretched to fit the specified aspect ratio. If only the <code>WidthPixels</code> parameter is provided or if only the <code>HeightPixels</code> is provided, a <code>ValidationException</code> will be thrown.
|
|
928
973
|
* If neither parameter is provided, the original image size from the stream will be returned.</p>
|
|
929
974
|
*/
|
|
930
975
|
WidthPixels?: number;
|
|
931
976
|
/**
|
|
977
|
+
* @public
|
|
932
978
|
* <p>The height of the output image that is used in conjunction with the <code>WidthPixels</code> parameter. When both <code>HeightPixels</code> and <code>WidthPixels</code> parameters are provided, the image will be stretched to fit the
|
|
933
979
|
* specified aspect ratio. If only the <code>HeightPixels</code> parameter is provided, its original aspect ratio will be used to calculate the <code>WidthPixels</code> ratio. If neither parameter is provided,
|
|
934
980
|
* the original image size will be returned.</p>
|
|
935
981
|
*/
|
|
936
982
|
HeightPixels?: number;
|
|
937
983
|
/**
|
|
984
|
+
* @public
|
|
938
985
|
* <p>The maximum number of images to be returned by the API. </p>
|
|
939
986
|
* <note>
|
|
940
987
|
* <p>The default limit is 100 images per API response. The additional results will be paginated. </p>
|
|
@@ -942,6 +989,7 @@ export interface GetImagesInput {
|
|
|
942
989
|
*/
|
|
943
990
|
MaxResults?: number;
|
|
944
991
|
/**
|
|
992
|
+
* @public
|
|
945
993
|
* <p>A token that specifies where to start paginating the next set of Images. This is the <code>GetImages:NextToken</code> from a previously truncated response.</p>
|
|
946
994
|
*/
|
|
947
995
|
NextToken?: string;
|
|
@@ -964,11 +1012,13 @@ export type ImageError = (typeof ImageError)[keyof typeof ImageError];
|
|
|
964
1012
|
*/
|
|
965
1013
|
export interface Image {
|
|
966
1014
|
/**
|
|
1015
|
+
* @public
|
|
967
1016
|
* <p>An attribute of the <code>Image</code> object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination
|
|
968
1017
|
* window.</p>
|
|
969
1018
|
*/
|
|
970
1019
|
TimeStamp?: Date;
|
|
971
1020
|
/**
|
|
1021
|
+
* @public
|
|
972
1022
|
* <p>The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if: </p>
|
|
973
1023
|
* <ul>
|
|
974
1024
|
* <li>
|
|
@@ -984,6 +1034,7 @@ export interface Image {
|
|
|
984
1034
|
*/
|
|
985
1035
|
Error?: ImageError | string;
|
|
986
1036
|
/**
|
|
1037
|
+
* @public
|
|
987
1038
|
* <p>An attribute of the <code>Image</code> object that is Base64 encoded.</p>
|
|
988
1039
|
*/
|
|
989
1040
|
ImageContent?: string;
|
|
@@ -993,11 +1044,13 @@ export interface Image {
|
|
|
993
1044
|
*/
|
|
994
1045
|
export interface GetImagesOutput {
|
|
995
1046
|
/**
|
|
1047
|
+
* @public
|
|
996
1048
|
* <p>The list of images generated from the video stream. If there is no media available for the given timestamp, the <code>NO_MEDIA</code> error will be listed in the output.
|
|
997
1049
|
* If an error occurs while the image is being generated, the <code>MEDIA_ERROR</code> will be listed in the output as the cause of the missing image. </p>
|
|
998
1050
|
*/
|
|
999
1051
|
Images?: Image[];
|
|
1000
1052
|
/**
|
|
1053
|
+
* @public
|
|
1001
1054
|
* <p>The encrypted token that was used in the request to get more images.</p>
|
|
1002
1055
|
*/
|
|
1003
1056
|
NextToken?: string;
|
|
@@ -1007,14 +1060,17 @@ export interface GetImagesOutput {
|
|
|
1007
1060
|
*/
|
|
1008
1061
|
export interface GetMediaForFragmentListInput {
|
|
1009
1062
|
/**
|
|
1063
|
+
* @public
|
|
1010
1064
|
* <p>The name of the stream from which to retrieve fragment media. Specify either this parameter or the <code>StreamARN</code> parameter.</p>
|
|
1011
1065
|
*/
|
|
1012
1066
|
StreamName?: string;
|
|
1013
1067
|
/**
|
|
1068
|
+
* @public
|
|
1014
1069
|
* <p>The Amazon Resource Name (ARN) of the stream from which to retrieve fragment media. Specify either this parameter or the <code>StreamName</code> parameter.</p>
|
|
1015
1070
|
*/
|
|
1016
1071
|
StreamARN?: string;
|
|
1017
1072
|
/**
|
|
1073
|
+
* @public
|
|
1018
1074
|
* <p>A list of the numbers of fragments for which to retrieve media. You retrieve these
|
|
1019
1075
|
* values with <a>ListFragments</a>.</p>
|
|
1020
1076
|
*/
|
|
@@ -1025,10 +1081,12 @@ export interface GetMediaForFragmentListInput {
|
|
|
1025
1081
|
*/
|
|
1026
1082
|
export interface GetMediaForFragmentListOutput {
|
|
1027
1083
|
/**
|
|
1084
|
+
* @public
|
|
1028
1085
|
* <p>The content type of the requested media.</p>
|
|
1029
1086
|
*/
|
|
1030
1087
|
ContentType?: string;
|
|
1031
1088
|
/**
|
|
1089
|
+
* @public
|
|
1032
1090
|
* <p>The payload that Kinesis Video Streams returns is a sequence of chunks from the
|
|
1033
1091
|
* specified stream. For information about the chunks, see <a href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html">PutMedia</a>. The chunks that Kinesis Video Streams returns in the
|
|
1034
1092
|
* <code>GetMediaForFragmentList</code> call also include the following additional
|
|
@@ -1083,11 +1141,13 @@ export type FragmentSelectorType = (typeof FragmentSelectorType)[keyof typeof Fr
|
|
|
1083
1141
|
*/
|
|
1084
1142
|
export interface TimestampRange {
|
|
1085
1143
|
/**
|
|
1144
|
+
* @public
|
|
1086
1145
|
* <p>The starting timestamp in the range of timestamps for which to return
|
|
1087
1146
|
* fragments.</p>
|
|
1088
1147
|
*/
|
|
1089
1148
|
StartTimestamp: Date | undefined;
|
|
1090
1149
|
/**
|
|
1150
|
+
* @public
|
|
1091
1151
|
* <p>The ending timestamp in the range of timestamps for which to return fragments.</p>
|
|
1092
1152
|
*/
|
|
1093
1153
|
EndTimestamp: Date | undefined;
|
|
@@ -1117,10 +1177,12 @@ export interface TimestampRange {
|
|
|
1117
1177
|
*/
|
|
1118
1178
|
export interface FragmentSelector {
|
|
1119
1179
|
/**
|
|
1180
|
+
* @public
|
|
1120
1181
|
* <p>The origin of the timestamps to use (Server or Producer).</p>
|
|
1121
1182
|
*/
|
|
1122
1183
|
FragmentSelectorType: FragmentSelectorType | string | undefined;
|
|
1123
1184
|
/**
|
|
1185
|
+
* @public
|
|
1124
1186
|
* <p>The range of timestamps to return.</p>
|
|
1125
1187
|
*/
|
|
1126
1188
|
TimestampRange: TimestampRange | undefined;
|
|
@@ -1130,25 +1192,30 @@ export interface FragmentSelector {
|
|
|
1130
1192
|
*/
|
|
1131
1193
|
export interface ListFragmentsInput {
|
|
1132
1194
|
/**
|
|
1195
|
+
* @public
|
|
1133
1196
|
* <p>The name of the stream from which to retrieve a fragment list. Specify either this parameter or the <code>StreamARN</code> parameter.</p>
|
|
1134
1197
|
*/
|
|
1135
1198
|
StreamName?: string;
|
|
1136
1199
|
/**
|
|
1200
|
+
* @public
|
|
1137
1201
|
* <p>The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment list. Specify either this parameter or the <code>StreamName</code> parameter.</p>
|
|
1138
1202
|
*/
|
|
1139
1203
|
StreamARN?: string;
|
|
1140
1204
|
/**
|
|
1205
|
+
* @public
|
|
1141
1206
|
* <p>The total number of fragments to return. If the total number of fragments available is
|
|
1142
1207
|
* more than the value specified in <code>max-results</code>, then a <a>ListFragmentsOutput$NextToken</a> is provided in the output that you can use
|
|
1143
1208
|
* to resume pagination.</p>
|
|
1144
1209
|
*/
|
|
1145
1210
|
MaxResults?: number;
|
|
1146
1211
|
/**
|
|
1212
|
+
* @public
|
|
1147
1213
|
* <p>A token to specify where to start paginating. This is the <a>ListFragmentsOutput$NextToken</a> from a previously truncated
|
|
1148
1214
|
* response.</p>
|
|
1149
1215
|
*/
|
|
1150
1216
|
NextToken?: string;
|
|
1151
1217
|
/**
|
|
1218
|
+
* @public
|
|
1152
1219
|
* <p>Describes the timestamp range and timestamp origin for the range of fragments to
|
|
1153
1220
|
* return.</p>
|
|
1154
1221
|
*/
|
|
@@ -1160,24 +1227,29 @@ export interface ListFragmentsInput {
|
|
|
1160
1227
|
*/
|
|
1161
1228
|
export interface Fragment {
|
|
1162
1229
|
/**
|
|
1230
|
+
* @public
|
|
1163
1231
|
* <p>The unique identifier of the fragment. This value monotonically increases based on the
|
|
1164
1232
|
* ingestion order.</p>
|
|
1165
1233
|
*/
|
|
1166
1234
|
FragmentNumber?: string;
|
|
1167
1235
|
/**
|
|
1236
|
+
* @public
|
|
1168
1237
|
* <p>The total fragment size, including information about the fragment and contained media
|
|
1169
1238
|
* data.</p>
|
|
1170
1239
|
*/
|
|
1171
1240
|
FragmentSizeInBytes?: number;
|
|
1172
1241
|
/**
|
|
1242
|
+
* @public
|
|
1173
1243
|
* <p>The timestamp from the producer corresponding to the fragment.</p>
|
|
1174
1244
|
*/
|
|
1175
1245
|
ProducerTimestamp?: Date;
|
|
1176
1246
|
/**
|
|
1247
|
+
* @public
|
|
1177
1248
|
* <p>The timestamp from the AWS server corresponding to the fragment.</p>
|
|
1178
1249
|
*/
|
|
1179
1250
|
ServerTimestamp?: Date;
|
|
1180
1251
|
/**
|
|
1252
|
+
* @public
|
|
1181
1253
|
* <p>The playback duration or other time value associated with the fragment.</p>
|
|
1182
1254
|
*/
|
|
1183
1255
|
FragmentLengthInMilliseconds?: number;
|
|
@@ -1187,11 +1259,13 @@ export interface Fragment {
|
|
|
1187
1259
|
*/
|
|
1188
1260
|
export interface ListFragmentsOutput {
|
|
1189
1261
|
/**
|
|
1262
|
+
* @public
|
|
1190
1263
|
* <p>A list of archived <a>Fragment</a> objects from the stream that meet the
|
|
1191
1264
|
* selector criteria. Results are in no specific order, even across pages.</p>
|
|
1192
1265
|
*/
|
|
1193
1266
|
Fragments?: Fragment[];
|
|
1194
1267
|
/**
|
|
1268
|
+
* @public
|
|
1195
1269
|
* <p>If the returned list is truncated, the operation returns this token to use to retrieve
|
|
1196
1270
|
* the next page of results. This value is <code>null</code> when there are no more results
|
|
1197
1271
|
* to return.</p>
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export * from "./KinesisVideoArchivedMediaClient";
|
|
2
2
|
export * from "./KinesisVideoArchivedMedia";
|
|
3
|
+
export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
|
|
3
4
|
export * from "./commands";
|
|
4
5
|
export * from "./models";
|
|
5
6
|
export { KinesisVideoArchivedMediaServiceException } from "./models/KinesisVideoArchivedMediaServiceException";
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-kinesis-video-archived-media",
|
|
3
3
|
"description": "AWS SDK for JavaScript Kinesis Video Archived Media Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.382.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,15 +21,15 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.382.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.382.0",
|
|
26
|
+
"@aws-sdk/middleware-host-header": "3.379.1",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.378.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.378.0",
|
|
29
|
-
"@aws-sdk/middleware-signing": "3.
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
29
|
+
"@aws-sdk/middleware-signing": "3.379.1",
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.382.0",
|
|
31
31
|
"@aws-sdk/types": "3.378.0",
|
|
32
|
-
"@aws-sdk/util-endpoints": "3.
|
|
32
|
+
"@aws-sdk/util-endpoints": "3.382.0",
|
|
33
33
|
"@aws-sdk/util-user-agent-browser": "3.378.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-node": "3.378.0",
|
|
35
35
|
"@smithy/config-resolver": "^2.0.1",
|