Skip to content

Commit

Permalink
feat(client-kinesis-video-archived-media): This release enables minim…
Browse files Browse the repository at this point in the history
…um of Images SamplingInterval to be as low as 200 milliseconds in Kinesis Video Stream Image feature.
  • Loading branch information
awstools committed Aug 7, 2023
1 parent 19047c8 commit 5bbf9b2
Show file tree
Hide file tree
Showing 8 changed files with 336 additions and 337 deletions.
Expand Up @@ -46,45 +46,43 @@ export interface GetClipCommandOutput extends Omit<GetClipOutput, "Payload">, __
* @public
* <p>Downloads an MP4 file (clip) containing the archived, on-demand media from the
* specified video stream over the specified time range. </p>
* <p>Both the StreamName and the StreamARN parameters are optional, but you must specify
* <p>Both the StreamName and the StreamARN parameters are optional, but you must specify
* either the StreamName or the StreamARN when invoking this API operation. </p>
*
* <p>As a prerequisite to using GetCLip API, you must obtain an endpoint using
* <p>As a prerequisite to using GetCLip API, you must obtain an endpoint using
* <code>GetDataEndpoint</code>, specifying GET_CLIP for<code></code> the
* <code>APIName</code> parameter. </p>
* <p>An Amazon Kinesis video stream has the following requirements for providing data
* <p>An Amazon Kinesis video stream has the following requirements for providing data
* through MP4:</p>
* <ul>
* <ul>
* <li>
* <p>The media must contain h.264 or h.265 encoded video and, optionally, AAC or
* <p>The media must contain h.264 or h.265 encoded video and, optionally, AAC or
* G.711 encoded audio. Specifically, the codec ID of track 1 should be
* <code>V_MPEG/ISO/AVC</code> (for h.264) or V_MPEGH/ISO/HEVC (for H.265).
* Optionally, the codec ID of track 2 should be <code>A_AAC</code> (for AAC) or
* A_MS/ACM (for G.711).</p>
* </li>
* <li>
* <p>Data retention must be greater than 0.</p>
* <p>Data retention must be greater than 0.</p>
* </li>
* <li>
* <p>The video track of each fragment must contain codec private data in the
* <p>The video track of each fragment must contain codec private data in the
* Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more
* information, see <a href="https://www.iso.org/standard/55980.html">MPEG-4
* specification ISO/IEC 14496-15</a>. For information about adapting
* 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>
* </li>
* <li>
* <p>The audio track (if present) of each fragment must contain codec private data
* <p>The audio track (if present) of each fragment must contain codec private data
* in the AAC format (<a href="https://www.iso.org/standard/43345.html">AAC
* specification ISO/IEC 13818-7</a>) or the <a href="http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html">MS
* Wave format</a>.</p>
* </li>
* </ul>
*
* <p>You can monitor the amount of outgoing data by monitoring the
* <p>You can monitor the amount of outgoing data by monitoring the
* <code>GetClip.OutgoingBytes</code> Amazon CloudWatch metric. For information about
* 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
* Streams Pricing</a> and <a href="https://aws.amazon.com/pricing/">AWS
* Pricing</a>. Charges for outgoing AWS data apply.</p>
* Streams Pricing</a> and <a href="https://aws.amazon.com/pricing/"> Amazon Web Services
* Pricing</a>. Charges for outgoing Amazon Web Services data apply.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand All @@ -95,7 +93,7 @@ export interface GetClipCommandOutput extends Omit<GetClipOutput, "Payload">, __
* StreamName: "STRING_VALUE",
* StreamARN: "STRING_VALUE",
* ClipFragmentSelector: { // ClipFragmentSelector
* FragmentSelectorType: "STRING_VALUE", // required
* FragmentSelectorType: "PRODUCER_TIMESTAMP" || "SERVER_TIMESTAMP", // required
* TimestampRange: { // ClipTimestampRange
* StartTimestamp: new Date("TIMESTAMP"), // required
* EndTimestamp: new Date("TIMESTAMP"), // required
Expand Down Expand Up @@ -145,9 +143,9 @@ export interface GetClipCommandOutput extends Omit<GetClipOutput, "Payload">, __
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>
* <code>GetMedia</code> throws this error when Kinesis Video Streams can't find the stream
* <code>GetImages</code> will throw this error when Kinesis Video Streams can't find the stream
* that you specified.</p>
* <p>
* <p>
* <code>GetHLSStreamingSessionURL</code> and <code>GetDASHStreamingSessionURL</code> throw
* this error if a session with a <code>PlaybackMode</code> of <code>ON_DEMAND</code> or
* <code>LIVE_REPLAY</code>is requested for a stream that has no fragments within the
Expand Down

0 comments on commit 5bbf9b2

Please sign in to comment.