From 5bbf9b203d41781aadd3d5f25eb030318468d76e Mon Sep 17 00:00:00 2001
From: awstools Downloads an MP4 file (clip) containing the archived, on-demand media from the
* specified video stream over the specified time range. Both the StreamName and the StreamARN parameters are optional, but you must specify
+ * Both the StreamName and the StreamARN parameters are optional, but you must specify
* either the StreamName or the StreamARN when invoking this API operation. As a prerequisite to using GetCLip API, you must obtain an endpoint using
+ * As a prerequisite to using GetCLip API, you must obtain an endpoint using
* An Amazon Kinesis video stream has the following requirements for providing data
+ * An Amazon Kinesis video stream has the following requirements for providing data
* through MP4: The media must contain h.264 or h.265 encoded video and, optionally, AAC or
+ * 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
* Data retention must be greater than 0. Data retention must be greater than 0. The video track of each fragment must contain codec private data in the
+ * 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 MPEG-4
* specification ISO/IEC 14496-15. For information about adapting
* stream data to a given format, see NAL Adaptation Flags. The audio track (if present) of each fragment must contain codec private data
+ * The audio track (if present) of each fragment must contain codec private data
* in the AAC format (AAC
* specification ISO/IEC 13818-7) or the MS
* Wave format. You can monitor the amount of outgoing data by monitoring the
+ * You can monitor the amount of outgoing data by monitoring the
* GetDataEndpoint
, specifying GET_CLIP for the
*
APIName
parameter.
+ *
*
- *
- * V_MPEG/ISO/AVC
(for h.264) or V_MPEGH/ISO/HEVC (for H.265).
* Optionally, the codec ID of track 2 should be A_AAC
(for AAC) or
* A_MS/ACM (for G.711).GetClip.OutgoingBytes
Amazon CloudWatch metric. For information about
* using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video
- * Streams Pricing and AWS
- * Pricing. Charges for outgoing AWS data apply.
- * GetMedia
throws this error when Kinesis Video Streams can't find the stream
+ * GetImages
will throw this error when Kinesis Video Streams can't find the stream
* that you specified.
+ *
* GetHLSStreamingSessionURL
and GetDASHStreamingSessionURL
throw
* this error if a session with a PlaybackMode
of ON_DEMAND
or
* LIVE_REPLAY
is requested for a stream that has no fragments within the
diff --git a/clients/client-kinesis-video-archived-media/src/commands/GetDASHStreamingSessionURLCommand.ts b/clients/client-kinesis-video-archived-media/src/commands/GetDASHStreamingSessionURLCommand.ts
index 8ed610020c01..4f6935f0aefb 100644
--- a/clients/client-kinesis-video-archived-media/src/commands/GetDASHStreamingSessionURLCommand.ts
+++ b/clients/client-kinesis-video-archived-media/src/commands/GetDASHStreamingSessionURLCommand.ts
@@ -42,64 +42,62 @@ export interface GetDASHStreamingSessionURLCommandOutput extends GetDASHStreamin
* @public
*
Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream. You * can then open the URL in a media player to view the stream contents.
- * - *Both the StreamName
and the StreamARN
parameters are
+ *
Both the StreamName
and the StreamARN
parameters are
* optional, but you must specify either the StreamName
or the
* StreamARN
when invoking this API operation.
An Amazon Kinesis video stream has the following requirements for providing data + *
An Amazon Kinesis video stream has the following requirements for providing data * through MPEG-DASH:
- *The media must contain h.264 or h.265 encoded video and, optionally, AAC or + *
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
* V_MPEG/ISO/AVC
(for h.264) or V_MPEGH/ISO/HEVC (for H.265).
* Optionally, the codec ID of track 2 should be A_AAC
(for AAC) or
* A_MS/ACM (for G.711).
Data retention must be greater than 0.
+ *Data retention must be greater than 0.
*The video track of each fragment must contain codec private data in the + *
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 MPEG-4 * specification ISO/IEC 14496-15. For information about adapting * stream data to a given format, see NAL Adaptation Flags.
*The audio track (if present) of each fragment must contain codec private data + *
The audio track (if present) of each fragment must contain codec private data * in the AAC format (AAC * specification ISO/IEC 13818-7) or the MS * Wave format.
*The following procedure shows how to use MPEG-DASH with Kinesis Video Streams:
- *The following procedure shows how to use MPEG-DASH with Kinesis Video Streams:
+ *Get an endpoint using GetDataEndpoint, specifying + *
Get an endpoint using GetDataEndpoint, specifying
* GET_DASH_STREAMING_SESSION_URL
for the APIName
* parameter.
Retrieve the MPEG-DASH URL using GetDASHStreamingSessionURL
.
+ *
Retrieve the MPEG-DASH URL using GetDASHStreamingSessionURL
.
* Kinesis Video Streams creates an MPEG-DASH streaming session to be used for
* accessing content in a stream using the MPEG-DASH protocol.
* GetDASHStreamingSessionURL
returns an authenticated URL (that
* includes an encrypted session token) for the session's MPEG-DASH
* manifest (the root resource needed for streaming with
* MPEG-DASH).
Don't share or store this token where an unauthorized entity can access
+ * Don't share or store this token where an unauthorized entity can access
* it. The token provides access to the content of the stream. Safeguard the
- * token with the same measures that you use with your AWS credentials.
The media that is made available through the manifest consists only of the + * token with the same measures that you use with your Amazon Web Services credentials.
+ *The media that is made available through the manifest consists only of the * requested stream, time range, and format. No other media data (such as frames * outside the requested window or alternate bitrates) is made available.
*Provide the URL (containing the encrypted session token) for the MPEG-DASH + *
Provide the URL (containing the encrypted session token) for the MPEG-DASH * manifest to a media player that supports the MPEG-DASH protocol. Kinesis Video * Streams makes the initialization fragment and media fragments available through * the manifest URL. The initialization fragment contains the codec private data @@ -108,76 +106,75 @@ export interface GetDASHStreamingSessionURLCommandOutput extends GetDASHStreamin * samples.
*The media player receives the authenticated URL and requests stream metadata + *
The media player receives the authenticated URL and requests stream metadata * and media data normally. When the media player requests data, it calls the * following actions:
- *- * GetDASHManifest: Retrieves an MPEG DASH + *
+ * GetDASHManifest: Retrieves an MPEG DASH * manifest, which contains the metadata for the media that you want to * playback.
- *- * GetMP4InitFragment: Retrieves the MP4 + *
+ * GetMP4InitFragment: Retrieves the MP4
* initialization fragment. The media player typically loads the
* initialization fragment before loading any media fragments. This
* fragment contains the "fytp
" and "moov
" MP4
* atoms, and the child atoms that are needed to initialize the media
* player decoder.
The initialization fragment does not correspond to a fragment in a + *
The initialization fragment does not correspond to a fragment in a * Kinesis video stream. It contains only the codec private data for the * stream and respective track, which the media player needs to decode the * media frames.
- *- * GetMP4MediaFragment: Retrieves MP4 + *
+ * GetMP4MediaFragment: Retrieves MP4
* media fragments. These fragments contain the "moof
" and
* "mdat
" MP4 atoms and their child atoms, containing the
* encoded fragment's media frames and their timestamps.
After the first media fragment is made available in a streaming
+ * After the first media fragment is made available in a streaming
* session, any fragments that don't contain the same codec private
* data cause an error to be returned when those different media
* fragments are loaded. Therefore, the codec private data should not
* change between fragments in a session. This also means that the
* session fails if the fragments in a stream change from having only
* video to having both audio and video.
Data retrieved with this action is billable. See Pricing for details.
- *Data retrieved with this action is billable. See Pricing for details.
+ * *For restrictions that apply to MPEG-DASH sessions, see Kinesis Video Streams Limits.
- *You can monitor the amount of data that the media player consumes by monitoring the + *
You can monitor the amount of data that the media player consumes by monitoring the
* GetMP4MediaFragment.OutgoingBytes
Amazon CloudWatch metric. For
* information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video
- * Streams Pricing and AWS
- * Pricing. Charges for both HLS sessions and outgoing AWS data apply.
For more information about HLS, see HTTP Live Streaming on the + * Streams Pricing and Amazon Web Services + * Pricing. Charges for both HLS sessions and outgoing Amazon Web Services data apply.
+ *For more information about HLS, see HTTP Live Streaming on the * Apple Developer site.
- * - *If an error is thrown after invoking a Kinesis Video Streams archived media API, * in addition to the HTTP status code and the response body, it includes the following * pieces of information:
*
- * x-amz-ErrorType
HTTP header – contains a more specific error
+ *
+ * x-amz-ErrorType
HTTP header – contains a more specific error
* type in addition to what the HTTP status code provides.
- * x-amz-RequestId
HTTP header – if you want to report an issue to
- * AWS, the support team can better diagnose the problem if given the Request
+ *
+ * x-amz-RequestId
HTTP header – if you want to report an issue to
+ * Amazon Web Services the support team can better diagnose the problem if given the Request
* Id.
Both the HTTP status code and the ErrorType header can be utilized to make * programmatic decisions about whether errors are retry-able and under what @@ -186,7 +183,7 @@ export interface GetDASHStreamingSessionURLCommandOutput extends GetDASHStreamin *
For more information, see the Errors section at * the bottom of this topic, as well as Common Errors. *
- *
- * GetMedia
throws this error when Kinesis Video Streams can't find the stream
+ * GetImages
will throw this error when Kinesis Video Streams can't find the stream
* that you specified.
+ *
* GetHLSStreamingSessionURL
and GetDASHStreamingSessionURL
throw
* this error if a session with a PlaybackMode
of ON_DEMAND
or
* LIVE_REPLAY
is requested for a stream that has no fragments within the
diff --git a/clients/client-kinesis-video-archived-media/src/commands/GetHLSStreamingSessionURLCommand.ts b/clients/client-kinesis-video-archived-media/src/commands/GetHLSStreamingSessionURLCommand.ts
index ed93e3153c13..bc33ff2ae201 100644
--- a/clients/client-kinesis-video-archived-media/src/commands/GetHLSStreamingSessionURLCommand.ts
+++ b/clients/client-kinesis-video-archived-media/src/commands/GetHLSStreamingSessionURLCommand.ts
@@ -42,64 +42,65 @@ export interface GetHLSStreamingSessionURLCommandOutput extends GetHLSStreamingS
* @public
*
Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL * in a browser or media player to view the stream contents.
- *Both the StreamName
and the StreamARN
parameters are
+ *
Both the StreamName
and the StreamARN
parameters are
* optional, but you must specify either the StreamName
or the
* StreamARN
when invoking this API operation.
An Amazon Kinesis video stream has the following requirements for providing data + *
An Amazon Kinesis video stream has the following requirements for providing data * through HLS:
- *The media must contain h.264 or h.265 encoded video and, optionally, AAC + *
For streaming video, the media must contain H.264 or H.265 encoded video and, optionally, AAC
* encoded audio. Specifically, the codec ID of track 1 should be
- * V_MPEG/ISO/AVC
(for h.264) or V_MPEG/ISO/HEVC
(for
- * h.265). Optionally, the codec ID of track 2 should be A_AAC
.
V_MPEG/ISO/AVC
(for H.264) or V_MPEG/ISO/HEVC
(for
+ * H.265). Optionally, the codec ID of track 2 should be A_AAC
. For audio only streaming, the codec ID of track 1 should be
+ * A_AAC
.
* Data retention must be greater than 0.
+ *Data retention must be greater than 0.
*The video track of each fragment must contain codec private data in the + *
The video track of each fragment must contain codec private data in the * Advanced Video Coding (AVC) for H.264 format or HEVC for H.265 format (MPEG-4 specification ISO/IEC * 14496-15). For information about adapting stream data to a given * format, see NAL Adaptation Flags.
*The audio track (if present) of each fragment must contain codec private data + *
The audio track (if present) of each fragment must contain codec private data * in the AAC format (AAC * specification ISO/IEC 13818-7).
*Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form + *
Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form * (also called fMP4 or CMAF) or the MPEG-2 form (also called TS chunks, which the HLS * specification also supports). For more information about HLS fragment types, see the * HLS * specification.
- *The following procedure shows how to use HLS with Kinesis Video Streams:
- *The following procedure shows how to use HLS with Kinesis Video Streams:
+ *Get an endpoint using GetDataEndpoint, specifying + *
Get an endpoint using GetDataEndpoint, specifying
* GET_HLS_STREAMING_SESSION_URL
for the APIName
* parameter.
Retrieve the HLS URL using GetHLSStreamingSessionURL
. Kinesis
+ *
Retrieve the HLS URL using GetHLSStreamingSessionURL
. Kinesis
* Video Streams creates an HLS streaming session to be used for accessing content
* in a stream using the HLS protocol. GetHLSStreamingSessionURL
* returns an authenticated URL (that includes an encrypted session token) for the
* session's HLS master playlist (the root resource needed for
* streaming with HLS).
Don't share or store this token where an unauthorized entity could access
+ * Don't share or store this token where an unauthorized entity could access
* it. The token provides access to the content of the stream. Safeguard the
- * token with the same measures that you would use with your AWS
+ * token with the same measures that you would use with your Amazon Web Services
* credentials.
The media that is made available through the playlist consists only of the + *
The media that is made available through the playlist consists only of the * requested stream, time range, and format. No other media data (such as frames * outside the requested window or alternate bitrates) is made available.
*Provide the URL (containing the encrypted session token) for the HLS master + *
Provide the URL (containing the encrypted session token) for the HLS master * playlist to a media player that supports the HLS protocol. Kinesis Video Streams * makes the HLS media playlist, initialization fragment, and media fragments * available through the master playlist URL. The initialization fragment contains @@ -108,21 +109,21 @@ export interface GetHLSStreamingSessionURLCommandOutput extends GetHLSStreamingS * frames or AAC-encoded audio samples.
*The media player receives the authenticated URL and requests stream metadata + *
The media player receives the authenticated URL and requests stream metadata * and media data normally. When the media player requests data, it calls the * following actions:
- *- * GetHLSMasterPlaylist: Retrieves an HLS + *
+ * GetHLSMasterPlaylist: Retrieves an HLS
* master playlist, which contains a URL for the
* GetHLSMediaPlaylist
action for each track, and
* additional metadata for the media player, including estimated bitrate
* and resolution.
- * GetHLSMediaPlaylist: Retrieves an HLS + *
+ * GetHLSMediaPlaylist: Retrieves an HLS
* media playlist, which contains a URL to access the MP4 initialization
* fragment with the GetMP4InitFragment
action, and URLs to
* access the MP4 media fragments with the GetMP4MediaFragment
@@ -136,81 +137,86 @@ export interface GetHLSStreamingSessionURLCommandOutput extends GetHLSStreamingS
* a distinct HLS media playlist for the video track and the audio track
* (if applicable) that contains MP4 media URLs for the specific track.
*
- * GetMP4InitFragment: Retrieves the MP4 + *
+ * GetMP4InitFragment: Retrieves the MP4
* initialization fragment. The media player typically loads the
* initialization fragment before loading any media fragments. This
* fragment contains the "fytp
" and "moov
" MP4
* atoms, and the child atoms that are needed to initialize the media
* player decoder.
The initialization fragment does not correspond to a fragment in a + *
The initialization fragment does not correspond to a fragment in a * Kinesis video stream. It contains only the codec private data for the * stream and respective track, which the media player needs to decode the * media frames.
- *- * GetMP4MediaFragment: Retrieves MP4 + *
+ * GetMP4MediaFragment: Retrieves MP4
* media fragments. These fragments contain the "moof
" and
* "mdat
" MP4 atoms and their child atoms, containing the
* encoded fragment's media frames and their timestamps.
After the first media fragment is made available in a streaming - * session, any fragments that don't contain the same codec private - * data cause an error to be returned when those different media - * fragments are loaded. Therefore, the codec private data should not - * change between fragments in a session. This also means that the - * session fails if the fragments in a stream change from having only - * video to having both audio and video.
- *Data retrieved with this action is billable. See Pricing for details.
- *For the HLS streaming session, in-track codec private data (CPD) + * changes are supported. After the first media fragment is made + * available in a streaming session, fragments can contain CPD changes + * for each track. Therefore, the fragments in a session can have a + * different resolution, bit rate, or other information in the CPD + * without interrupting playback. However, any change made in the track + * number or track codec format can return an error when those + * different media fragments are loaded. For example, streaming will + * fail if the fragments in the stream change from having only video to + * having both audio and video, or if an AAC audio track is changed to + * an ALAW audio track. For each streaming session, only 500 CPD + * changes are allowed.
+ *Data retrieved with this action is billable. For information, see + * Pricing.
+ * *- * GetTSFragment: Retrieves MPEG TS + *
+ * GetTSFragment: Retrieves MPEG TS * fragments containing both initialization and media data for all tracks * in the stream.
- *If the If the ContainerFormat
is MPEG_TS
, this
+ * ContainerFormat
is MPEG_TS
, this
* API is used instead of GetMP4InitFragment
and
* GetMP4MediaFragment
to retrieve stream
* media.
Data retrieved with this action is billable. For more information, see + *
Data retrieved with this action is billable. For more information, see * Kinesis Video Streams pricing.
- *A streaming session URL must not be shared between players. The service + *
A streaming session URL must not be shared between players. The service * might throttle a session if multiple media players are sharing it. For * connection limits, see Kinesis Video Streams Limits.
- *You can monitor the amount of data that the media player consumes by monitoring the + *
You can monitor the amount of data that the media player consumes by monitoring the
* GetMP4MediaFragment.OutgoingBytes
Amazon CloudWatch metric. For
* information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video
- * Streams Pricing and AWS
- * Pricing. Charges for both HLS sessions and outgoing AWS data apply.
For more information about HLS, see HTTP Live Streaming on the + * Streams Pricing and Amazon Web Services + * Pricing. Charges for both HLS sessions and outgoing Amazon Web Services data apply.
+ *For more information about HLS, see HTTP Live Streaming on the * Apple Developer site.
- * - *If an error is thrown after invoking a Kinesis Video Streams archived media API, * in addition to the HTTP status code and the response body, it includes the following * pieces of information:
*
- * x-amz-ErrorType
HTTP header – contains a more specific error
+ *
+ * x-amz-ErrorType
HTTP header – contains a more specific error
* type in addition to what the HTTP status code provides.
- * x-amz-RequestId
HTTP header – if you want to report an issue to
- * AWS, the support team can better diagnose the problem if given the Request
+ *
+ * x-amz-RequestId
HTTP header – if you want to report an issue to
+ * Amazon Web Services, the support team can better diagnose the problem if given the Request
* Id.
Both the HTTP status code and the ErrorType header can be utilized to make * programmatic decisions about whether errors are retry-able and under what @@ -219,7 +225,7 @@ export interface GetHLSStreamingSessionURLCommandOutput extends GetHLSStreamingS *
For more information, see the Errors section at * the bottom of this topic, as well as Common Errors. *
- *
- * GetMedia
throws this error when Kinesis Video Streams can't find the stream
+ * GetImages
will throw this error when Kinesis Video Streams can't find the stream
* that you specified.
+ *
*
- *
+ *
* Gets media for a list of fragments (specified by fragment number) from the archived
* data in an Amazon Kinesis video stream. You must first call the For limits, see Kinesis Video Streams Limits. For limits, see Kinesis Video Streams Limits. If an error is thrown after invoking a Kinesis Video Streams archived media API,
* in addition to the HTTP status code and the response body, it includes the following
* pieces of information:
- *
+ *
- *
+ * Both the HTTP status code and the ErrorType header can be utilized to make
* programmatic decisions about whether errors are retry-able and under what
@@ -86,7 +83,7 @@ export interface GetMediaForFragmentListCommandOutput
* For more information, see the Errors section at
* the bottom of this topic, as well as Common Errors.
*
- *
+ *
* Returns a list of Fragment objects from the specified stream and
* timestamp range within the archived data. Listing fragments is eventually consistent. This means that even if the producer
+ * Listing fragments is eventually consistent. This means that even if the producer
* receives an acknowledgment that a fragment is persisted, the result might not be
* returned immediately from a request to You must first call the If an error is thrown after invoking a Kinesis Video Streams archived media API,
* in addition to the HTTP status code and the response body, it includes the following
* pieces of information:
- *
+ *
- *
+ * Both the HTTP status code and the ErrorType header can be utilized to make
* programmatic decisions about whether errors are retry-able and under what
@@ -76,7 +75,7 @@ export interface ListFragmentsCommandOutput extends ListFragmentsOutput, __Metad
* For more information, see the Errors section at
* the bottom of this topic, as well as Common Errors.
*
- *
+ *
* The starting timestamp in the range of timestamps for which to return fragments. Only fragments that start exactly at or after Only fragments that start exactly at or after The end of the timestamp range for the requested media. This value must be within 24 hours of the specified This value must be within 24 hours of the specified This value is inclusive. The This value is inclusive. The Describes the timestamp range and timestamp origin of a range of fragments. Fragments that have duplicate producer timestamps are deduplicated. This means that if
+ * Fragments that have duplicate producer timestamps are deduplicated. This means that if
* producers are producing a stream of fragments with producer timestamps that are
* approximately equal to the true clock time, the clip will contain all of the fragments
* within the requested timestamp range. If some fragments are ingested within the same
@@ -101,14 +101,14 @@ export interface GetClipInput {
/**
* @public
* The name of the stream for which to retrieve the media clip. You must specify either the StreamName or the StreamARN. You must specify either the StreamName or the StreamARN. The Amazon Resource Name (ARN) of the stream for which to retrieve the media clip. You must specify either the StreamName or the StreamARN. You must specify either the StreamName or the StreamARN.
- *
+ *
* The start and end of the timestamp range for the requested media. This value should not be present if This value should not be present if The values in The values in The start of the timestamp range for the requested media. If the If the Only fragments that start exactly at or after Only fragments that start exactly at or after The end of the timestamp range for the requested media. This value must be within 24
* hours of the specified If If The The This value is inclusive. The The source of the timestamps for the requested media. When When Fragments that have duplicate producer timestamps are deduplicated. This means that if
+ * Fragments that have duplicate producer timestamps are deduplicated. This means that if
* producers are producing a stream of fragments with producer timestamps that are
* approximately equal to the true clock time, the MPEG-DASH manifest will contain all of
* the fragments within the requested timestamp range. If some fragments are ingested
* within the same time range and very different points in time, only the oldest ingested
* collection of fragments are returned. When When The default is The default is The start and end of the timestamp range for the requested media. This value should not be present if This value should not be present if The name of the stream for which to retrieve the MPEG-DASH manifest URL. You must specify either the You must specify either the The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH
* manifest URL. You must specify either the You must specify either the Whether to retrieve live, live replay, or archived, on-demand data. Features of the three types of sessions include the following: Features of the three types of sessions include the following:
- *
- *
+ *
+ * In In
- *
- *
+ *
+ *
- *
- *
+ *
+ * In all playback modes, if In all playback modes, if The default is The default is GetHLSStreamingSessionURL
and GetDASHStreamingSessionURL
throw
* this error if a session with a PlaybackMode
of ON_DEMAND
or
* LIVE_REPLAY
is requested for a stream that has no fragments within the
diff --git a/clients/client-kinesis-video-archived-media/src/commands/GetImagesCommand.ts b/clients/client-kinesis-video-archived-media/src/commands/GetImagesCommand.ts
index fd59e499409c..ae1fa5c38caa 100644
--- a/clients/client-kinesis-video-archived-media/src/commands/GetImagesCommand.ts
+++ b/clients/client-kinesis-video-archived-media/src/commands/GetImagesCommand.ts
@@ -50,11 +50,11 @@ export interface GetImagesCommandOutput extends GetImagesOutput, __MetadataBeare
* const input = { // GetImagesInput
* StreamName: "STRING_VALUE",
* StreamARN: "STRING_VALUE",
- * ImageSelectorType: "STRING_VALUE", // required
+ * ImageSelectorType: "PRODUCER_TIMESTAMP" || "SERVER_TIMESTAMP", // required
* StartTimestamp: new Date("TIMESTAMP"), // required
* EndTimestamp: new Date("TIMESTAMP"), // required
- * SamplingInterval: Number("int"), // required
- * Format: "STRING_VALUE", // required
+ * SamplingInterval: Number("int"),
+ * Format: "JPEG" || "PNG", // required
* FormatConfig: { // FormatConfig
* "GetMedia
throws this error when Kinesis Video Streams can't find the stream
+ * GetImages
will throw this error when Kinesis Video Streams can't find the stream
* that you specified.GetHLSStreamingSessionURL
and GetDASHStreamingSessionURL
throw
* this error if a session with a PlaybackMode
of ON_DEMAND
or
* LIVE_REPLAY
is requested for a stream that has no fragments within the
diff --git a/clients/client-kinesis-video-archived-media/src/commands/GetMediaForFragmentListCommand.ts b/clients/client-kinesis-video-archived-media/src/commands/GetMediaForFragmentListCommand.ts
index fd0e769ffce2..7847f34cab34 100644
--- a/clients/client-kinesis-video-archived-media/src/commands/GetMediaForFragmentListCommand.ts
+++ b/clients/client-kinesis-video-archived-media/src/commands/GetMediaForFragmentListCommand.ts
@@ -52,32 +52,29 @@ export interface GetMediaForFragmentListCommandOutput
* @public
* GetDataEndpoint
API to get an endpoint.
* Then send the GetMediaForFragmentList
requests to this endpoint using
* the --endpoint-url
* parameter.
*
* x-amz-ErrorType
HTTP header – contains a more specific error
+ * x-amz-ErrorType
HTTP header – contains a more specific error
* type in addition to what the HTTP status code provides. x-amz-RequestId
HTTP header – if you want to report an issue to
- * AWS, the support team can better diagnose the problem if given the Request
+ * x-amz-RequestId
HTTP header – if you want to report an issue to
+ * Amazon Web Services, the support team can better diagnose the problem if given the Request
* Id.GetMedia
throws this error when Kinesis Video Streams can't find the stream
+ * GetImages
will throw this error when Kinesis Video Streams can't find the stream
* that you specified.GetHLSStreamingSessionURL
and GetDASHStreamingSessionURL
throw
* this error if a session with a PlaybackMode
of ON_DEMAND
or
* LIVE_REPLAY
is requested for a stream that has no fragments within the
diff --git a/clients/client-kinesis-video-archived-media/src/commands/ListFragmentsCommand.ts b/clients/client-kinesis-video-archived-media/src/commands/ListFragmentsCommand.ts
index 6d793f026a35..0cc9718b81d3 100644
--- a/clients/client-kinesis-video-archived-media/src/commands/ListFragmentsCommand.ts
+++ b/clients/client-kinesis-video-archived-media/src/commands/ListFragmentsCommand.ts
@@ -42,32 +42,31 @@ export interface ListFragmentsCommandOutput extends ListFragmentsOutput, __Metad
* @public
* ListFragments
. However, results are
* typically available in less than one second.GetDataEndpoint
API to get an endpoint.
* Then send the ListFragments
requests to this endpoint using the --endpoint-url
* parameter.
*
* x-amz-ErrorType
HTTP header – contains a more specific error
+ * x-amz-ErrorType
HTTP header – contains a more specific error
* type in addition to what the HTTP status code provides. x-amz-RequestId
HTTP header – if you want to report an issue to
- * AWS, the support team can better diagnose the problem if given the Request
+ * x-amz-RequestId
HTTP header – if you want to report an issue to
+ * Amazon Web Services, the support team can better diagnose the problem if given the Request
* Id.GetMedia
throws this error when Kinesis Video Streams can't find the stream
+ * GetImages
will throw this error when Kinesis Video Streams can't find the stream
* that you specified.GetHLSStreamingSessionURL
and GetDASHStreamingSessionURL
throw
* this error if a session with a PlaybackMode
of ON_DEMAND
or
* LIVE_REPLAY
is requested for a stream that has no fragments within the
diff --git a/clients/client-kinesis-video-archived-media/src/endpoint/ruleset.ts b/clients/client-kinesis-video-archived-media/src/endpoint/ruleset.ts
index 470de5c246f1..d5e450b542fb 100644
--- a/clients/client-kinesis-video-archived-media/src/endpoint/ruleset.ts
+++ b/clients/client-kinesis-video-archived-media/src/endpoint/ruleset.ts
@@ -6,24 +6,25 @@ import { RuleSetObject } from "@smithy/types";
or see "smithy.rules#endpointRuleSet"
in codegen/sdk-codegen/aws-models/kinesis-video-archived-media.json */
-const p="required",
-q="fn",
-r="argv",
-s="ref";
-const a="PartitionResult",
+const q="required",
+r="fn",
+s="argv",
+t="ref";
+const a="isSet",
b="tree",
c="error",
d="endpoint",
-e={[p]:false,"type":"String"},
-f={[p]:true,"default":false,"type":"Boolean"},
-g={[s]:"Endpoint"},
-h={[q]:"booleanEquals",[r]:[{[s]:"UseFIPS"},true]},
-i={[q]:"booleanEquals",[r]:[{[s]:"UseDualStack"},true]},
-j={},
-k={[q]:"booleanEquals",[r]:[true,{[q]:"getAttr",[r]:[{[s]:a},"supportsFIPS"]}]},
-l={[q]:"booleanEquals",[r]:[true,{[q]:"getAttr",[r]:[{[s]:a},"supportsDualStack"]}]},
-m=[g],
-n=[h],
-o=[i];
-const _data={version:"1.0",parameters:{Region:e,UseDualStack:f,UseFIPS:f,Endpoint:e},rules:[{conditions:[{[q]:"aws.partition",[r]:[{[s]:"Region"}],assign:a}],type:b,rules:[{conditions:[{[q]:"isSet",[r]:m},{[q]:"parseURL",[r]:m,assign:"url"}],type:b,rules:[{conditions:n,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:g,properties:j,headers:j},type:d}]}]},{conditions:[h,i],type:b,rules:[{conditions:[k,l],type:b,rules:[{endpoint:{url:"https://kinesisvideo-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:j,headers:j},type:d}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:n,type:b,rules:[{conditions:[k],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://kinesisvideo-fips.{Region}.{PartitionResult#dnsSuffix}",properties:j,headers:j},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:o,type:b,rules:[{conditions:[l],type:b,rules:[{endpoint:{url:"https://kinesisvideo.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:j,headers:j},type:d}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{endpoint:{url:"https://kinesisvideo.{Region}.{PartitionResult#dnsSuffix}",properties:j,headers:j},type:d}]}]};
+e="PartitionResult",
+f={[q]:false,"type":"String"},
+g={[q]:true,"default":false,"type":"Boolean"},
+h={[t]:"Endpoint"},
+i={[r]:"booleanEquals",[s]:[{[t]:"UseFIPS"},true]},
+j={[r]:"booleanEquals",[s]:[{[t]:"UseDualStack"},true]},
+k={},
+l={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsFIPS"]}]},
+m={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsDualStack"]}]},
+n=[i],
+o=[j],
+p=[{[t]:"Region"}];
+const _data={version:"1.0",parameters:{Region:f,UseDualStack:g,UseFIPS:g,Endpoint:f},rules:[{conditions:[{[r]:a,[s]:[h]}],type:b,rules:[{conditions:n,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:h,properties:k,headers:k},type:d}]}]},{type:b,rules:[{conditions:[{[r]:a,[s]:p}],type:b,rules:[{conditions:[{[r]:"aws.partition",[s]:p,assign:e}],type:b,rules:[{conditions:[i,j],type:b,rules:[{conditions:[l,m],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://kinesisvideo-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:n,type:b,rules:[{conditions:[l],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://kinesisvideo-fips.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:o,type:b,rules:[{conditions:[m],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://kinesisvideo.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{type:b,rules:[{endpoint:{url:"https://kinesisvideo.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}]};
export const ruleSet: RuleSetObject = _data;
diff --git a/clients/client-kinesis-video-archived-media/src/models/models_0.ts b/clients/client-kinesis-video-archived-media/src/models/models_0.ts
index ccef3a19e7ba..35505dcef0eb 100644
--- a/clients/client-kinesis-video-archived-media/src/models/models_0.ts
+++ b/clients/client-kinesis-video-archived-media/src/models/models_0.ts
@@ -48,7 +48,7 @@ export interface ClipTimestampRange {
/**
* @public
* StartTimestamp
are included
+ * StartTimestamp
are included
* in the session. Fragments that start before StartTimestamp
and continue
* past it aren't included in the session. If FragmentSelectorType
is
* SERVER_TIMESTAMP
, the StartTimestamp
must be later than
@@ -59,11 +59,11 @@ export interface ClipTimestampRange {
/**
* @public
* StartTimestamp
, and
+ * StartTimestamp
, and
* it must be later than the StartTimestamp
value. If
* FragmentSelectorType
for the request is SERVER_TIMESTAMP
,
* this value must be in the past. EndTimestamp
is compared to the (starting)
+ * EndTimestamp
is compared to the (starting)
* timestamp of the fragment. Fragments that start before the EndTimestamp
* value and continue past it are included in the session. GetMedia
throws this error when Kinesis Video Streams can't find the stream
+ * GetImages
will throw this error when Kinesis Video Streams can't find the stream
* that you specified.GetHLSStreamingSessionURL
and GetDASHStreamingSessionURL
throw
* this error if a session with a PlaybackMode
of ON_DEMAND
or
* LIVE_REPLAY
is requested for a stream that has no fragments within the
@@ -349,9 +349,9 @@ export type DASHFragmentSelectorType = (typeof DASHFragmentSelectorType)[keyof t
/**
* @public
* PlaybackType
is
+ * PlaybackType
is
* LIVE
.DASHimestampRange
are inclusive. Fragments that start
+ * DASHimestampRange
are inclusive. Fragments that start
* exactly at or after the start time are included in the session. Fragments that start
* before the start time and continue past it are not included in the session.DASHTimestampRange
value is specified, the
+ * DASHTimestampRange
value is specified, the
* StartTimestamp
value is required.StartTimestamp
are included
+ * StartTimestamp
are included
* in the session. Fragments that start before StartTimestamp
and continue
* past it aren't included in the session. If FragmentSelectorType
is
* SERVER_TIMESTAMP
, the StartTimestamp
must be later than
@@ -374,19 +374,18 @@ export interface DASHTimestampRange {
* StartTimestamp
, and it must be later than the
* StartTimestamp
value.FragmentSelectorType
for the request is SERVER_TIMESTAMP
,
+ * FragmentSelectorType
for the request is SERVER_TIMESTAMP
,
* this value must be in the past.EndTimestamp
value is required for ON_DEMAND
mode, but
+ * EndTimestamp
value is required for ON_DEMAND
mode, but
* optional for LIVE_REPLAY
mode. If the EndTimestamp
is not set
* for LIVE_REPLAY
mode then the session will continue to include newly
* ingested fragments until the session expires.EndTimestamp
is compared to the
* (starting) timestamp of the fragment. Fragments that start before the
* EndTimestamp
value and continue past it are included in the
* session.FragmentSelectorType
is set to PRODUCER_TIMESTAMP
and
+ * FragmentSelectorType
is set to PRODUCER_TIMESTAMP
and
* GetDASHStreamingSessionURLInput$PlaybackMode is
* ON_DEMAND
or LIVE_REPLAY
, the first fragment ingested with
* a producer timestamp within the specified FragmentSelector$TimestampRange is included in the media playlist. In
* addition, the fragments with producer timestamps within the TimestampRange
* ingested immediately following the first fragment (up to the GetDASHStreamingSessionURLInput$MaxManifestFragmentResults value) are
* included. FragmentSelectorType
is set to PRODUCER_TIMESTAMP
and
+ * FragmentSelectorType
is set to PRODUCER_TIMESTAMP
and
* GetDASHStreamingSessionURLInput$PlaybackMode is LIVE
,
* the producer timestamps are used in the MP4 fragments and for deduplication. But the
* most recently ingested fragments based on server timestamps are included in the
* MPEG-DASH manifest. This means that even if fragments ingested in the past have producer
* timestamps with values now, they are not included in the HLS media playlist.SERVER_TIMESTAMP
.SERVER_TIMESTAMP
.PlaybackType
is
+ * PlaybackType
is
* LIVE
.StreamName
or the
+ * StreamName
or the
* StreamARN
.StreamName
or the
+ * StreamName
or the
* StreamARN
.
+ *
*
- * LIVE
- * : For sessions of this type, the MPEG-DASH manifest is continually
+ * LIVE
+ * : For sessions of this type, the MPEG-DASH manifest is continually
* updated with the latest fragments as they become available. We recommend that
* the media player retrieve a new manifest on a one-second interval. When this
* type of session is played in a media player, the user interface typically
* displays a "live" notification, with no scrubber control for choosing the
* position in the playback window to display.LIVE
mode, the newest available fragments are included in
+ * LIVE
mode, the newest available fragments are included in
* an MPEG-DASH manifest, even if there is a gap between fragments (that is, if
* a fragment is missing). A gap like this might cause a media player to halt
* or cause a jump in playback. In this mode, fragments are not added to the
@@ -521,13 +520,13 @@ export interface GetDASHStreamingSessionURLInput {
* playlist. If the missing fragment becomes available after a subsequent
* fragment is added to the manifest, the older fragment is not added, and the
* gap is not filled.LIVE_REPLAY
- * : For sessions of this type, the MPEG-DASH manifest is updated
+ * LIVE_REPLAY
+ * : For sessions of this type, the MPEG-DASH manifest is updated
* similarly to how it is updated for LIVE
mode except that it starts
* by including fragments from a given start time. Instead of fragments being added
* as they are ingested, fragments are added as the duration of the next fragment
@@ -540,10 +539,10 @@ export interface GetDASHStreamingSessionURLInput {
* ON_DEMAND
- * : For sessions of this type, the MPEG-DASH manifest contains all the
+ * ON_DEMAND
+ * : For sessions of this type, the MPEG-DASH manifest contains all the
* fragments for the session, up to the number that is specified in
* MaxManifestFragmentResults
. The manifest must be retrieved only
* once for each session. When this type of session is played in a media player,
@@ -551,14 +550,14 @@ export interface GetDASHStreamingSessionURLInput {
* position in the playback window to display.FragmentSelectorType
is
+ * FragmentSelectorType
is
* PRODUCER_TIMESTAMP
, and if there are multiple fragments with the same
* start timestamp, the fragment that has the larger fragment number (that is, the newer
* fragment) is included in the MPEG-DASH manifest. The other fragments are not included.
* Fragments that have different timestamps but have overlapping durations are still
* included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media
* player.LIVE
.LIVE
.
The default value is NEVER
. When DASHFragmentSelector
+ *
The default value is NEVER
. When DASHFragmentSelector
* is SERVER_TIMESTAMP
, the timestamps will be the server start timestamps.
* Similarly, when DASHFragmentSelector is
* PRODUCER_TIMESTAMP
, the timestamps will be the producer start
@@ -590,14 +589,14 @@ export interface GetDASHStreamingSessionURLInput {
* other APIs (e.g. GetMedia
and GetMediaForFragmentList
). A
* custom MPEG-DASH media player is necessary to leverage these this custom
* attribute.
The default value is NEVER
.
The default value is NEVER
.
The time range of the requested fragment and the source of the timestamps.
- *This parameter is required if PlaybackMode
is ON_DEMAND
or
+ *
This parameter is required if PlaybackMode
is ON_DEMAND
or
* LIVE_REPLAY
. This parameter is optional if PlaybackMode is
*
LIVE
. If PlaybackMode
is LIVE
, the
* FragmentSelectorType
can be set, but the TimestampRange
@@ -611,28 +610,28 @@ export interface GetDASHStreamingSessionURLInput {
* @public
*
The time in seconds until the requested session expires. This value can be between 300 * (5 minutes) and 43200 (12 hours).
- *When a session expires, no new calls to GetDashManifest
,
+ *
When a session expires, no new calls to GetDashManifest
,
* GetMP4InitFragment
, or GetMP4MediaFragment
can be made for
* that session.
The default is 300 (5 minutes).
+ *The default is 300 (5 minutes).
*/ Expires?: number; /** * @public *The maximum number of fragments that are returned in the MPEG-DASH manifest.
- *When the PlaybackMode
is LIVE
, the most recent fragments are
+ *
When the PlaybackMode
is LIVE
, the most recent fragments are
* returned up to this value. When the PlaybackMode
is ON_DEMAND
,
* the oldest fragments are returned, up to this maximum number.
When there are a higher number of fragments available in a live MPEG-DASH manifest, + *
When there are a higher number of fragments available in a live MPEG-DASH manifest, * video players often buffer content before starting playback. Increasing the buffer size * increases the playback latency, but it decreases the likelihood that rebuffering will * occur during playback. We recommend that a live MPEG-DASH manifest have a minimum of 3 * fragments and a maximum of 10 fragments.
- *The default is 5 fragments if PlaybackMode
is LIVE
or
+ *
The default is 5 fragments if PlaybackMode
is LIVE
or
* LIVE_REPLAY
, and 1,000 if PlaybackMode
is
* ON_DEMAND
.
The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on + *
The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on * streams with 1-second fragments, and more than 2 1/2 hours of video on streams with * 10-second fragments.
*/ @@ -712,16 +711,16 @@ export type HLSFragmentSelectorType = (typeof HLSFragmentSelectorType)[keyof typ /** * @public *The start and end of the timestamp range for the requested media.
- *This value should not be present if PlaybackType
is
+ *
This value should not be present if PlaybackType
is
* LIVE
.
The start of the timestamp range for the requested media.
- *If the HLSTimestampRange
value is specified, the
+ *
If the HLSTimestampRange
value is specified, the
* StartTimestamp
value is required.
Only fragments that start exactly at or after StartTimestamp
are included
+ *
Only fragments that start exactly at or after StartTimestamp
are included
* in the session. Fragments that start before StartTimestamp
and continue
* past it aren't included in the session. If FragmentSelectorType
is
* SERVER_TIMESTAMP
, the StartTimestamp
must be later than
@@ -734,18 +733,18 @@ export interface HLSTimestampRange {
*
The end of the timestamp range for the requested media. This value must be within 24
* hours of the specified StartTimestamp
, and it must be later than the
* StartTimestamp
value.
If FragmentSelectorType
for the request is SERVER_TIMESTAMP
,
+ *
If FragmentSelectorType
for the request is SERVER_TIMESTAMP
,
* this value must be in the past.
The EndTimestamp
value is required for ON_DEMAND
mode, but
+ *
The EndTimestamp
value is required for ON_DEMAND
mode, but
* optional for LIVE_REPLAY
mode. If the EndTimestamp
is not set
* for LIVE_REPLAY
mode then the session will continue to include newly
* ingested fragments until the session expires.
This value is inclusive. The EndTimestamp
is compared to the
* (starting) timestamp of the fragment. Fragments that start before the
* EndTimestamp
value and continue past it are included in the
* session.
The source of the timestamps for the requested media.
- *When FragmentSelectorType
is set to PRODUCER_TIMESTAMP
and
+ *
When FragmentSelectorType
is set to PRODUCER_TIMESTAMP
and
* GetHLSStreamingSessionURLInput$PlaybackMode is
* ON_DEMAND
or LIVE_REPLAY
, the first fragment ingested with
* a producer timestamp within the specified FragmentSelector$TimestampRange is included in the media playlist. In
* addition, the fragments with producer timestamps within the TimestampRange
* ingested immediately following the first fragment (up to the GetHLSStreamingSessionURLInput$MaxMediaPlaylistFragmentResults value)
* are included.
Fragments that have duplicate producer timestamps are deduplicated. This means that if + *
Fragments that have duplicate producer timestamps are deduplicated. This means that if * producers are producing a stream of fragments with producer timestamps that are * approximately equal to the true clock time, the HLS media playlists will contain all of * the fragments within the requested timestamp range. If some fragments are ingested * within the same time range and very different points in time, only the oldest ingested * collection of fragments are returned.
- *When FragmentSelectorType
is set to PRODUCER_TIMESTAMP
and
+ *
When FragmentSelectorType
is set to PRODUCER_TIMESTAMP
and
* GetHLSStreamingSessionURLInput$PlaybackMode is LIVE
,
* the producer timestamps are used in the MP4 fragments and for deduplication. But the
* most recently ingested fragments based on server timestamps are included in the HLS
* media playlist. This means that even if fragments ingested in the past have producer
* timestamps with values now, they are not included in the HLS media playlist.
The default is SERVER_TIMESTAMP
.
The default is SERVER_TIMESTAMP
.
The start and end of the timestamp range for the requested media.
- *This value should not be present if PlaybackType
is
+ *
This value should not be present if PlaybackType
is
* LIVE
.
The name of the stream for which to retrieve the HLS master playlist URL.
- *You must specify either the StreamName
or the
+ *
You must specify either the StreamName
or the
* StreamARN
.
The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master * playlist URL.
- *You must specify either the StreamName
or the
+ *
You must specify either the StreamName
or the
* StreamARN
.
Whether to retrieve live, live replay, or archived, on-demand data.
- *Features of the three types of sessions include the following:
- *Features of the three types of sessions include the following:
+ *
- *
- * LIVE
- * : For sessions of this type, the HLS media playlist is continually
+ *
+ *
+ * LIVE
+ * : For sessions of this type, the HLS media playlist is continually
* updated with the latest fragments as they become available. We recommend that
* the media player retrieve a new playlist on a one-second interval. When this
* type of session is played in a media player, the user interface typically
* displays a "live" notification, with no scrubber control for choosing the
* position in the playback window to display.
In In LIVE
mode, the newest available fragments are included in
+ * LIVE
mode, the newest available fragments are included in
* an HLS media playlist, even if there is a gap between fragments (that is, if
* a fragment is missing). A gap like this might cause a media player to halt
* or cause a jump in playback. In this mode, fragments are not added to the
@@ -851,13 +850,13 @@ export interface GetHLSStreamingSessionURLInput {
* playlist. If the missing fragment becomes available after a subsequent
* fragment is added to the playlist, the older fragment is not added, and the
* gap is not filled.
- *
- * LIVE_REPLAY
- * : For sessions of this type, the HLS media playlist is updated
+ *
+ *
+ * LIVE_REPLAY
+ * : For sessions of this type, the HLS media playlist is updated
* similarly to how it is updated for LIVE
mode except that it starts
* by including fragments from a given start time. Instead of fragments being added
* as they are ingested, fragments are added as the duration of the next fragment
@@ -870,10 +869,10 @@ export interface GetHLSStreamingSessionURLInput {
* mode.
- *
- * ON_DEMAND
- * : For sessions of this type, the HLS media playlist contains all the
+ *
+ *
+ * ON_DEMAND
+ * : For sessions of this type, the HLS media playlist contains all the
* fragments for the session, up to the number that is specified in
* MaxMediaPlaylistFragmentResults
. The playlist must be retrieved
* only once for each session. When this type of session is played in a media
@@ -881,21 +880,21 @@ export interface GetHLSStreamingSessionURLInput {
* the position in the playback window to display.
In all playback modes, if FragmentSelectorType
is
+ *
In all playback modes, if FragmentSelectorType
is
* PRODUCER_TIMESTAMP
, and if there are multiple fragments with the same
* start timestamp, the fragment that has the largest fragment number (that is, the newest
* fragment) is included in the HLS media playlist. The other fragments are not included.
* Fragments that have different timestamps but have overlapping durations are still
* included in the HLS media playlist. This can lead to unexpected behavior in the media
* player.
The default is LIVE
.
The default is LIVE
.
The time range of the requested fragment and the source of the timestamps.
- *This parameter is required if PlaybackMode
is ON_DEMAND
or
+ *
This parameter is required if PlaybackMode
is ON_DEMAND
or
* LIVE_REPLAY
. This parameter is optional if PlaybackMode is
*
LIVE
. If PlaybackMode
is LIVE
, the
* FragmentSelectorType
can be set, but the TimestampRange
@@ -914,7 +913,7 @@ export interface GetHLSStreamingSessionURLInput {
* MPEG TS chunks since it was released and is sometimes the only supported packaging on
* older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means
* MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4.
The default is FRAGMENTED_MP4
.
The default is FRAGMENTED_MP4
.
Specifies when flags marking discontinuities between fragments are added to the media * playlists.
- *Media players typically build a timeline of media content to play, based on the + *
Media players typically build a timeline of media content to play, based on the
* timestamps of each fragment. This means that if there is any overlap or gap between
* fragments (as is typical if HLSFragmentSelector is set to
* SERVER_TIMESTAMP
), the media player timeline will also have small gaps
@@ -931,23 +930,23 @@ export interface GetHLSStreamingSessionURLInput {
* jittery. When there are discontinuity flags between fragments, the media player is
* expected to reset the timeline, resulting in the next fragment being played immediately
* after the previous fragment.
The following modes are supported:
- *The following modes are supported:
+ *
- * ALWAYS
: a discontinuity marker is placed between every fragment in
+ *
+ * ALWAYS
: a discontinuity marker is placed between every fragment in
* the HLS media playlist. It is recommended to use a value of ALWAYS
* if the fragment timestamps are not accurate.
- * NEVER
: no discontinuity markers are placed anywhere. It is
+ *
+ * NEVER
: no discontinuity markers are placed anywhere. It is
* recommended to use a value of NEVER
to ensure the media player
* timeline most accurately maps to the producer timestamps.
- * ON_DISCONTINUITY
: a discontinuity marker is placed between
+ *
+ * ON_DISCONTINUITY
: a discontinuity marker is placed between
* fragments that have a gap or overlap of more than 50 milliseconds. For most
* playback scenarios, it is recommended to use a value of
* ON_DISCONTINUITY
so that the media player timeline is only
@@ -955,7 +954,7 @@ export interface GetHLSStreamingSessionURLInput {
* fragment).
The default is ALWAYS
when HLSFragmentSelector is set
+ *
The default is ALWAYS
when HLSFragmentSelector is set
* to SERVER_TIMESTAMP
, and NEVER
when it is set to
* PRODUCER_TIMESTAMP
.
The default is NEVER
. When HLSFragmentSelector is
+ *
The default is NEVER
. When HLSFragmentSelector is
* SERVER_TIMESTAMP
, the timestamps will be the server start timestamps.
* Similarly, when HLSFragmentSelector is
* PRODUCER_TIMESTAMP
, the timestamps will be the producer start timestamps.
@@ -982,29 +981,29 @@ export interface GetHLSStreamingSessionURLInput {
* @public
*
The time in seconds until the requested session expires. This value can be between 300 * (5 minutes) and 43200 (12 hours).
- *When a session expires, no new calls to GetHLSMasterPlaylist
,
+ *
When a session expires, no new calls to GetHLSMasterPlaylist
,
* GetHLSMediaPlaylist
, GetMP4InitFragment
,
* GetMP4MediaFragment
, or GetTSFragment
can be made for that
* session.
The default is 300 (5 minutes).
+ *The default is 300 (5 minutes).
*/ Expires?: number; /** * @public *The maximum number of fragments that are returned in the HLS media playlists.
- *When the PlaybackMode
is LIVE
, the most recent fragments are
+ *
When the PlaybackMode
is LIVE
, the most recent fragments are
* returned up to this value. When the PlaybackMode
is ON_DEMAND
,
* the oldest fragments are returned, up to this maximum number.
When there are a higher number of fragments available in a live HLS media playlist, + *
When there are a higher number of fragments available in a live HLS media playlist, * video players often buffer content before starting playback. Increasing the buffer size * increases the playback latency, but it decreases the likelihood that rebuffering will * occur during playback. We recommend that a live HLS media playlist have a minimum of 3 * fragments and a maximum of 10 fragments.
- *The default is 5 fragments if PlaybackMode
is LIVE
or
+ *
The default is 5 fragments if PlaybackMode
is LIVE
or
* LIVE_REPLAY
, and 1,000 if PlaybackMode
is
* ON_DEMAND
.
The maximum value of 5,000 fragments corresponds to more than 80 minutes of video on + *
The maximum value of 5,000 fragments corresponds to more than 80 minutes of video on * streams with 1-second fragments, and more than 13 hours of video on streams with * 10-second fragments.
*/ @@ -1094,19 +1093,21 @@ export interface GetImagesInput { /** * @public - *The end timestamp for the range of images to be generated.
+ *The end timestamp for the range of images to be generated. If the time range between StartTimestamp
and EndTimestamp
is more than 300 seconds above StartTimestamp
, you will receive an IllegalArgumentException
.
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 startTimestamp
will be returned if available.
- *
The minimum value of 3000 ms is a soft limit. If needed, a lower sampling frequency can be requested.
+ *The time interval in milliseconds (ms) at which the images need to be generated from
+ * the stream, with a default of 3000 ms. The minimum value that can be provided is 200 ms.
+ * If the timestamp range is less than the sampling interval, the Image from the
+ * startTimestamp
will be returned if available.
The minimum value of 200 ms is a hard limit.
*The maximum number of images to be returned by the API.
- *The default limit is 100 images per API response. The additional results will be paginated.
+ *The default limit is 25 images per API response. Providing a MaxResults
greater than this value will result in a page size of 25. Any additional results will be paginated.
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:
- *There is no media that exists for the specified Timestamp
.
The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect * media has been ingested.
@@ -1262,33 +1263,33 @@ export interface GetMediaForFragmentListOutput { * specified stream. For information about the chunks, see PutMedia. The chunks that Kinesis Video Streams returns in the *GetMediaForFragmentList
call also include the following additional
* Matroska (MKV) tags:
- * AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the + *
AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the * chunk.
*AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the + *
AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the * fragment.
*AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp of the + *
AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp of the * fragment.
*The following tags will be included if an exception occurs:
- *The following tags will be included if an exception occurs:
+ *AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the - * exception
+ *AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception + *
*AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the - * exception
+ *AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the + *
*AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the - * exception
+ *AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception + *
*Describes the timestamp range and timestamp origin of a range of fragments.
- *Only fragments with a start timestamp greater than or equal to the given start time + *
Only fragments with a start timestamp greater than or equal to the given start time * and less than or equal to the end time are returned. For example, if a stream contains * fragments with the following start timestamps:
- *00:00:00
+ *00:00:00
*00:00:02
+ *00:00:02
*00:00:04
+ *00:00:04
*00:00:06
+ *00:00:06
*A fragment selector range with a start time of 00:00:01 and end time of 00:00:04 + *
A fragment selector range with a start time of 00:00:01 and end time of 00:00:04 * would return the fragments with start times of 00:00:02 and 00:00:04.
*/ export interface FragmentSelector { @@ -1431,7 +1432,7 @@ export interface Fragment { /** * @public - *The timestamp from the AWS server corresponding to the fragment.
+ *The timestamp from the Amazon Web Services server corresponding to the fragment.
*/ ServerTimestamp?: Date;