Skip to content

Commit 5bbf9b2

Browse files
author
awstools
committed
feat(client-kinesis-video-archived-media): This release enables minimum of Images SamplingInterval to be as low as 200 milliseconds in Kinesis Video Stream Image feature.
1 parent 19047c8 commit 5bbf9b2

File tree

8 files changed

+336
-337
lines changed

8 files changed

+336
-337
lines changed

clients/client-kinesis-video-archived-media/src/commands/GetClipCommand.ts

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -46,45 +46,43 @@ export interface GetClipCommandOutput extends Omit<GetClipOutput, "Payload">, __
4646
* @public
4747
* <p>Downloads an MP4 file (clip) containing the archived, on-demand media from the
4848
* specified video stream over the specified time range. </p>
49-
* <p>Both the StreamName and the StreamARN parameters are optional, but you must specify
49+
* <p>Both the StreamName and the StreamARN parameters are optional, but you must specify
5050
* either the StreamName or the StreamARN when invoking this API operation. </p>
51-
*
52-
* <p>As a prerequisite to using GetCLip API, you must obtain an endpoint using
51+
* <p>As a prerequisite to using GetCLip API, you must obtain an endpoint using
5352
* <code>GetDataEndpoint</code>, specifying GET_CLIP for<code></code> the
5453
* <code>APIName</code> parameter. </p>
55-
* <p>An Amazon Kinesis video stream has the following requirements for providing data
54+
* <p>An Amazon Kinesis video stream has the following requirements for providing data
5655
* through MP4:</p>
57-
* <ul>
56+
* <ul>
5857
* <li>
59-
* <p>The media must contain h.264 or h.265 encoded video and, optionally, AAC or
58+
* <p>The media must contain h.264 or h.265 encoded video and, optionally, AAC or
6059
* G.711 encoded audio. Specifically, the codec ID of track 1 should be
6160
* <code>V_MPEG/ISO/AVC</code> (for h.264) or V_MPEGH/ISO/HEVC (for H.265).
6261
* Optionally, the codec ID of track 2 should be <code>A_AAC</code> (for AAC) or
6362
* A_MS/ACM (for G.711).</p>
6463
* </li>
6564
* <li>
66-
* <p>Data retention must be greater than 0.</p>
65+
* <p>Data retention must be greater than 0.</p>
6766
* </li>
6867
* <li>
69-
* <p>The video track of each fragment must contain codec private data in the
68+
* <p>The video track of each fragment must contain codec private data in the
7069
* Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more
7170
* information, see <a href="https://www.iso.org/standard/55980.html">MPEG-4
7271
* specification ISO/IEC 14496-15</a>. For information about adapting
7372
* stream data to a given format, see <a href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html">NAL Adaptation Flags</a>.</p>
7473
* </li>
7574
* <li>
76-
* <p>The audio track (if present) of each fragment must contain codec private data
75+
* <p>The audio track (if present) of each fragment must contain codec private data
7776
* in the AAC format (<a href="https://www.iso.org/standard/43345.html">AAC
7877
* specification ISO/IEC 13818-7</a>) or the <a href="http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html">MS
7978
* Wave format</a>.</p>
8079
* </li>
8180
* </ul>
82-
*
83-
* <p>You can monitor the amount of outgoing data by monitoring the
81+
* <p>You can monitor the amount of outgoing data by monitoring the
8482
* <code>GetClip.OutgoingBytes</code> Amazon CloudWatch metric. For information about
8583
* using CloudWatch to monitor Kinesis Video Streams, see <a href="http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html">Monitoring Kinesis Video Streams</a>. For pricing information, see <a href="https://aws.amazon.com/kinesis/video-streams/pricing/">Amazon Kinesis Video
86-
* Streams Pricing</a> and <a href="https://aws.amazon.com/pricing/">AWS
87-
* Pricing</a>. Charges for outgoing AWS data apply.</p>
84+
* Streams Pricing</a> and <a href="https://aws.amazon.com/pricing/"> Amazon Web Services
85+
* Pricing</a>. Charges for outgoing Amazon Web Services data apply.</p>
8886
* @example
8987
* Use a bare-bones client and the command you need to make an API call.
9088
* ```javascript
@@ -95,7 +93,7 @@ export interface GetClipCommandOutput extends Omit<GetClipOutput, "Payload">, __
9593
* StreamName: "STRING_VALUE",
9694
* StreamARN: "STRING_VALUE",
9795
* ClipFragmentSelector: { // ClipFragmentSelector
98-
* FragmentSelectorType: "STRING_VALUE", // required
96+
* FragmentSelectorType: "PRODUCER_TIMESTAMP" || "SERVER_TIMESTAMP", // required
9997
* TimestampRange: { // ClipTimestampRange
10098
* StartTimestamp: new Date("TIMESTAMP"), // required
10199
* EndTimestamp: new Date("TIMESTAMP"), // required
@@ -145,9 +143,9 @@ export interface GetClipCommandOutput extends Omit<GetClipOutput, "Payload">, __
145143
*
146144
* @throws {@link ResourceNotFoundException} (client fault)
147145
* <p>
148-
* <code>GetMedia</code> throws this error when Kinesis Video Streams can't find the stream
146+
* <code>GetImages</code> will throw this error when Kinesis Video Streams can't find the stream
149147
* that you specified.</p>
150-
* <p>
148+
* <p>
151149
* <code>GetHLSStreamingSessionURL</code> and <code>GetDASHStreamingSessionURL</code> throw
152150
* this error if a session with a <code>PlaybackMode</code> of <code>ON_DEMAND</code> or
153151
* <code>LIVE_REPLAY</code>is requested for a stream that has no fragments within the

0 commit comments

Comments
 (0)