@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface KinesisVideoArchivedMediaAsyncClient extends AwsClient
builder() method.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static KinesisVideoArchivedMediaAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
KinesisVideoArchivedMediaAsyncClient. |
static KinesisVideoArchivedMediaAsyncClient |
create()
Create a
KinesisVideoArchivedMediaAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default <ReturnT> CompletableFuture<ReturnT> |
getClip(Consumer<GetClipRequest.Builder> getClipRequest,
AsyncResponseTransformer<GetClipResponse,ReturnT> asyncResponseTransformer)
Downloads an MP4 file (clip) containing the archived, on-demand media from the specified video stream over the
specified time range.
|
default CompletableFuture<GetClipResponse> |
getClip(Consumer<GetClipRequest.Builder> getClipRequest,
Path destinationPath)
Downloads an MP4 file (clip) containing the archived, on-demand media from the specified video stream over the
specified time range.
|
default <ReturnT> CompletableFuture<ReturnT> |
getClip(GetClipRequest getClipRequest,
AsyncResponseTransformer<GetClipResponse,ReturnT> asyncResponseTransformer)
Downloads an MP4 file (clip) containing the archived, on-demand media from the specified video stream over the
specified time range.
|
default CompletableFuture<GetClipResponse> |
getClip(GetClipRequest getClipRequest,
Path destinationPath)
Downloads an MP4 file (clip) containing the archived, on-demand media from the specified video stream over the
specified time range.
|
default CompletableFuture<GetDashStreamingSessionUrlResponse> |
getDASHStreamingSessionURL(Consumer<GetDashStreamingSessionUrlRequest.Builder> getDashStreamingSessionUrlRequest)
Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream.
|
default CompletableFuture<GetDashStreamingSessionUrlResponse> |
getDASHStreamingSessionURL(GetDashStreamingSessionUrlRequest getDashStreamingSessionUrlRequest)
Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream.
|
default CompletableFuture<GetHlsStreamingSessionUrlResponse> |
getHLSStreamingSessionURL(Consumer<GetHlsStreamingSessionUrlRequest.Builder> getHlsStreamingSessionUrlRequest)
Retrieves an HTTP Live Streaming (HLS) URL for the stream.
|
default CompletableFuture<GetHlsStreamingSessionUrlResponse> |
getHLSStreamingSessionURL(GetHlsStreamingSessionUrlRequest getHlsStreamingSessionUrlRequest)
Retrieves an HTTP Live Streaming (HLS) URL for the stream.
|
default CompletableFuture<GetImagesResponse> |
getImages(Consumer<GetImagesRequest.Builder> getImagesRequest)
Retrieves a list of Images corresponding to each timestamp for a given time range, sampling interval, and image
format configuration.
|
default CompletableFuture<GetImagesResponse> |
getImages(GetImagesRequest getImagesRequest)
Retrieves a list of Images corresponding to each timestamp for a given time range, sampling interval, and image
format configuration.
|
default GetImagesPublisher |
getImagesPaginator(Consumer<GetImagesRequest.Builder> getImagesRequest)
Retrieves a list of Images corresponding to each timestamp for a given time range, sampling interval, and image
format configuration.
|
default GetImagesPublisher |
getImagesPaginator(GetImagesRequest getImagesRequest)
Retrieves a list of Images corresponding to each timestamp for a given time range, sampling interval, and image
format configuration.
|
default <ReturnT> CompletableFuture<ReturnT> |
getMediaForFragmentList(Consumer<GetMediaForFragmentListRequest.Builder> getMediaForFragmentListRequest,
AsyncResponseTransformer<GetMediaForFragmentListResponse,ReturnT> asyncResponseTransformer)
Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis
video stream.
|
default CompletableFuture<GetMediaForFragmentListResponse> |
getMediaForFragmentList(Consumer<GetMediaForFragmentListRequest.Builder> getMediaForFragmentListRequest,
Path destinationPath)
Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis
video stream.
|
default <ReturnT> CompletableFuture<ReturnT> |
getMediaForFragmentList(GetMediaForFragmentListRequest getMediaForFragmentListRequest,
AsyncResponseTransformer<GetMediaForFragmentListResponse,ReturnT> asyncResponseTransformer)
Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis
video stream.
|
default CompletableFuture<GetMediaForFragmentListResponse> |
getMediaForFragmentList(GetMediaForFragmentListRequest getMediaForFragmentListRequest,
Path destinationPath)
Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis
video stream.
|
default CompletableFuture<ListFragmentsResponse> |
listFragments(Consumer<ListFragmentsRequest.Builder> listFragmentsRequest)
Returns a list of Fragment objects from the specified stream and timestamp range within the archived data.
|
default CompletableFuture<ListFragmentsResponse> |
listFragments(ListFragmentsRequest listFragmentsRequest)
Returns a list of Fragment objects from the specified stream and timestamp range within the archived data.
|
default ListFragmentsPublisher |
listFragmentsPaginator(Consumer<ListFragmentsRequest.Builder> listFragmentsRequest)
Returns a list of Fragment objects from the specified stream and timestamp range within the archived data.
|
default ListFragmentsPublisher |
listFragmentsPaginator(ListFragmentsRequest listFragmentsRequest)
Returns a list of Fragment objects from the specified stream and timestamp range within the archived data.
|
default KinesisVideoArchivedMediaServiceClientConfiguration |
serviceClientConfiguration() |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default <ReturnT> CompletableFuture<ReturnT> getClip(GetClipRequest getClipRequest, AsyncResponseTransformer<GetClipResponse,ReturnT> asyncResponseTransformer)
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 either the StreamName or the StreamARN when invoking this API operation.
As a prerequisite to using GetCLip API, you must obtain an endpoint using GetDataEndpoint,
specifying GET_CLIP for the APIName parameter.
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 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.
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 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 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.
getClipRequest - asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
Traditional MP4 file that contains the media clip from the specified video stream. The output will contain the first 100 MB or the first 200 fragments from the specified start timestamp. For more information, see Kinesis Video Streams Limits.
'.GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
V_MPEG/ISO/AVC and, optionally, the
codec ID for track 2 should be A_AAC.DataRetentionInHours of 0).default <ReturnT> CompletableFuture<ReturnT> getClip(Consumer<GetClipRequest.Builder> getClipRequest, AsyncResponseTransformer<GetClipResponse,ReturnT> asyncResponseTransformer)
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 either the StreamName or the StreamARN when invoking this API operation.
As a prerequisite to using GetCLip API, you must obtain an endpoint using GetDataEndpoint,
specifying GET_CLIP for the APIName parameter.
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 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.
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 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 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.
This is a convenience which creates an instance of the GetClipRequest.Builder avoiding the need to create
one manually via GetClipRequest.builder()
getClipRequest - A Consumer that will call methods on GetClipInput.Builder to create a request.asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
Traditional MP4 file that contains the media clip from the specified video stream. The output will contain the first 100 MB or the first 200 fragments from the specified start timestamp. For more information, see Kinesis Video Streams Limits.
'.GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
V_MPEG/ISO/AVC and, optionally, the
codec ID for track 2 should be A_AAC.DataRetentionInHours of 0).default CompletableFuture<GetClipResponse> getClip(GetClipRequest getClipRequest, Path destinationPath)
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 either the StreamName or the StreamARN when invoking this API operation.
As a prerequisite to using GetCLip API, you must obtain an endpoint using GetDataEndpoint,
specifying GET_CLIP for the APIName parameter.
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 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.
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 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 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.
getClipRequest - destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
Traditional MP4 file that contains the media clip from the specified video stream. The output will contain the first 100 MB or the first 200 fragments from the specified start timestamp. For more information, see Kinesis Video Streams Limits.
'.GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
V_MPEG/ISO/AVC and, optionally, the
codec ID for track 2 should be A_AAC.DataRetentionInHours of 0).default CompletableFuture<GetClipResponse> getClip(Consumer<GetClipRequest.Builder> getClipRequest, Path destinationPath)
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 either the StreamName or the StreamARN when invoking this API operation.
As a prerequisite to using GetCLip API, you must obtain an endpoint using GetDataEndpoint,
specifying GET_CLIP for the APIName parameter.
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 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.
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 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 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.
This is a convenience which creates an instance of the GetClipRequest.Builder avoiding the need to create
one manually via GetClipRequest.builder()
getClipRequest - A Consumer that will call methods on GetClipInput.Builder to create a request.destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
Traditional MP4 file that contains the media clip from the specified video stream. The output will contain the first 100 MB or the first 200 fragments from the specified start timestamp. For more information, see Kinesis Video Streams Limits.
'.GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
V_MPEG/ISO/AVC and, optionally, the
codec ID for track 2 should be A_AAC.DataRetentionInHours of 0).default CompletableFuture<GetDashStreamingSessionUrlResponse> getDASHStreamingSessionURL(GetDashStreamingSessionUrlRequest getDashStreamingSessionUrlRequest)
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 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 through MPEG-DASH:
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.
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 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:
Get an endpoint using GetDataEndpoint,
specifying GET_DASH_STREAMING_SESSION_URL for the APIName parameter.
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 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 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 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 for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain encoded video frames or encoded audio samples.
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 manifest, which contains the metadata for the media that you want to playback.
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 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 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 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
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 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 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 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 conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.
For more information, see the Errors section at the bottom of this topic, as well as Common Errors.
getDashStreamingSessionUrlRequest - GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
V_MPEG/ISO/AVC and, optionally, the
codec ID for track 2 should be A_AAC.DataRetentionInHours of 0).default CompletableFuture<GetDashStreamingSessionUrlResponse> getDASHStreamingSessionURL(Consumer<GetDashStreamingSessionUrlRequest.Builder> getDashStreamingSessionUrlRequest)
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 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 through MPEG-DASH:
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.
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 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:
Get an endpoint using GetDataEndpoint,
specifying GET_DASH_STREAMING_SESSION_URL for the APIName parameter.
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 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 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 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 for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain encoded video frames or encoded audio samples.
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 manifest, which contains the metadata for the media that you want to playback.
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 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 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 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
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 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 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 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 conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.
For more information, see the Errors section at the bottom of this topic, as well as Common Errors.
This is a convenience which creates an instance of the GetDashStreamingSessionUrlRequest.Builder avoiding
the need to create one manually via GetDashStreamingSessionUrlRequest.builder()
getDashStreamingSessionUrlRequest - A Consumer that will call methods on GetDASHStreamingSessionURLInput.Builder to create a
request.GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
V_MPEG/ISO/AVC and, optionally, the
codec ID for track 2 should be A_AAC.DataRetentionInHours of 0).default CompletableFuture<GetHlsStreamingSessionUrlResponse> getHLSStreamingSessionURL(GetHlsStreamingSessionUrlRequest getHlsStreamingSessionUrlRequest)
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 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 through HLS:
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.
Data retention must be greater than 0.
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 in the AAC format (AAC specification ISO/IEC 13818-7).
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:
Get an endpoint using GetDataEndpoint,
specifying GET_HLS_STREAMING_SESSION_URL for the APIName parameter.
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 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 credentials.
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 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 the codec private data for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain H.264-encoded video frames or AAC-encoded audio samples.
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 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 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 actions. The HLS media playlist also contains metadata about
the stream that the player needs to play it, such as whether the PlaybackMode is LIVE
or ON_DEMAND. The HLS media playlist is typically static for sessions with a
PlaybackType of ON_DEMAND. The HLS media playlist is continually updated with new
fragments for sessions with a PlaybackType of LIVE. There is 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 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 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 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.
GetTSFragment: Retrieves MPEG TS fragments containing both initialization and media data for all tracks in the stream.
If the 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 Kinesis Video Streams pricing.
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
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 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 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 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 conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.
For more information, see the Errors section at the bottom of this topic, as well as Common Errors.
getHlsStreamingSessionUrlRequest - GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
V_MPEG/ISO/AVC and, optionally, the
codec ID for track 2 should be A_AAC.DataRetentionInHours of 0).default CompletableFuture<GetHlsStreamingSessionUrlResponse> getHLSStreamingSessionURL(Consumer<GetHlsStreamingSessionUrlRequest.Builder> getHlsStreamingSessionUrlRequest)
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 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 through HLS:
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.
Data retention must be greater than 0.
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 in the AAC format (AAC specification ISO/IEC 13818-7).
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:
Get an endpoint using GetDataEndpoint,
specifying GET_HLS_STREAMING_SESSION_URL for the APIName parameter.
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 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 credentials.
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 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 the codec private data for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain H.264-encoded video frames or AAC-encoded audio samples.
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 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 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 actions. The HLS media playlist also contains metadata about
the stream that the player needs to play it, such as whether the PlaybackMode is LIVE
or ON_DEMAND. The HLS media playlist is typically static for sessions with a
PlaybackType of ON_DEMAND. The HLS media playlist is continually updated with new
fragments for sessions with a PlaybackType of LIVE. There is 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 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 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 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.
GetTSFragment: Retrieves MPEG TS fragments containing both initialization and media data for all tracks in the stream.
If the 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 Kinesis Video Streams pricing.
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
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 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 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 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 conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.
For more information, see the Errors section at the bottom of this topic, as well as Common Errors.
This is a convenience which creates an instance of the GetHlsStreamingSessionUrlRequest.Builder avoiding
the need to create one manually via GetHlsStreamingSessionUrlRequest.builder()
getHlsStreamingSessionUrlRequest - A Consumer that will call methods on GetHLSStreamingSessionURLInput.Builder to create a
request.GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
V_MPEG/ISO/AVC and, optionally, the
codec ID for track 2 should be A_AAC.DataRetentionInHours of 0).default CompletableFuture<GetImagesResponse> getImages(GetImagesRequest getImagesRequest)
Retrieves a list of Images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.
getImagesRequest - GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
default CompletableFuture<GetImagesResponse> getImages(Consumer<GetImagesRequest.Builder> getImagesRequest)
Retrieves a list of Images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.
This is a convenience which creates an instance of the GetImagesRequest.Builder avoiding the need to
create one manually via GetImagesRequest.builder()
getImagesRequest - A Consumer that will call methods on GetImagesInput.Builder to create a request.GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
default GetImagesPublisher getImagesPaginator(GetImagesRequest getImagesRequest)
Retrieves a list of Images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.
This is a variant of
getImages(software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.GetImagesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kinesisvideoarchivedmedia.paginators.GetImagesPublisher publisher = client.getImagesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kinesisvideoarchivedmedia.paginators.GetImagesPublisher publisher = client.getImagesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.GetImagesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.GetImagesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getImages(software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.GetImagesRequest)
operation.
getImagesRequest - GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
default GetImagesPublisher getImagesPaginator(Consumer<GetImagesRequest.Builder> getImagesRequest)
Retrieves a list of Images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.
This is a variant of
getImages(software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.GetImagesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kinesisvideoarchivedmedia.paginators.GetImagesPublisher publisher = client.getImagesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kinesisvideoarchivedmedia.paginators.GetImagesPublisher publisher = client.getImagesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.GetImagesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.GetImagesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getImages(software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.GetImagesRequest)
operation.
This is a convenience which creates an instance of the GetImagesRequest.Builder avoiding the need to
create one manually via GetImagesRequest.builder()
getImagesRequest - A Consumer that will call methods on GetImagesInput.Builder to create a request.GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
default <ReturnT> CompletableFuture<ReturnT> getMediaForFragmentList(GetMediaForFragmentListRequest getMediaForFragmentListRequest, AsyncResponseTransformer<GetMediaForFragmentListResponse,ReturnT> asyncResponseTransformer)
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 GetDataEndpoint API to get an endpoint. Then send the
GetMediaForFragmentList requests to this endpoint using the --endpoint-url parameter.
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:
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 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 conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.
For more information, see the Errors section at the bottom of this topic, as well as Common Errors.
getMediaForFragmentListRequest - asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
The payload that Kinesis Video Streams returns is a sequence of chunks from the 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 chunk.
AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the fragment.
AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp of the fragment.
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_EXCEPTION_ERROR_CODE - The integer code of the exception
AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception
GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
default <ReturnT> CompletableFuture<ReturnT> getMediaForFragmentList(Consumer<GetMediaForFragmentListRequest.Builder> getMediaForFragmentListRequest, AsyncResponseTransformer<GetMediaForFragmentListResponse,ReturnT> asyncResponseTransformer)
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 GetDataEndpoint API to get an endpoint. Then send the
GetMediaForFragmentList requests to this endpoint using the --endpoint-url parameter.
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:
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 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 conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.
For more information, see the Errors section at the bottom of this topic, as well as Common Errors.
This is a convenience which creates an instance of the GetMediaForFragmentListRequest.Builder avoiding
the need to create one manually via GetMediaForFragmentListRequest.builder()
getMediaForFragmentListRequest - A Consumer that will call methods on GetMediaForFragmentListInput.Builder to create a
request.asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
The payload that Kinesis Video Streams returns is a sequence of chunks from the 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 chunk.
AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the fragment.
AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp of the fragment.
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_EXCEPTION_ERROR_CODE - The integer code of the exception
AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception
GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
default CompletableFuture<GetMediaForFragmentListResponse> getMediaForFragmentList(GetMediaForFragmentListRequest getMediaForFragmentListRequest, Path destinationPath)
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 GetDataEndpoint API to get an endpoint. Then send the
GetMediaForFragmentList requests to this endpoint using the --endpoint-url parameter.
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:
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 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 conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.
For more information, see the Errors section at the bottom of this topic, as well as Common Errors.
getMediaForFragmentListRequest - destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
The payload that Kinesis Video Streams returns is a sequence of chunks from the 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 chunk.
AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the fragment.
AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp of the fragment.
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_EXCEPTION_ERROR_CODE - The integer code of the exception
AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception
GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
default CompletableFuture<GetMediaForFragmentListResponse> getMediaForFragmentList(Consumer<GetMediaForFragmentListRequest.Builder> getMediaForFragmentListRequest, Path destinationPath)
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 GetDataEndpoint API to get an endpoint. Then send the
GetMediaForFragmentList requests to this endpoint using the --endpoint-url parameter.
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:
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 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 conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.
For more information, see the Errors section at the bottom of this topic, as well as Common Errors.
This is a convenience which creates an instance of the GetMediaForFragmentListRequest.Builder avoiding
the need to create one manually via GetMediaForFragmentListRequest.builder()
getMediaForFragmentListRequest - A Consumer that will call methods on GetMediaForFragmentListInput.Builder to create a
request.destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
The payload that Kinesis Video Streams returns is a sequence of chunks from the 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 chunk.
AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the fragment.
AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp of the fragment.
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_EXCEPTION_ERROR_CODE - The integer code of the exception
AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception
GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
default CompletableFuture<ListFragmentsResponse> listFragments(ListFragmentsRequest listFragmentsRequest)
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 receives an acknowledgment that
a fragment is persisted, the result might not be returned immediately from a request to
ListFragments. However, results are typically available in less than one second.
You must first call the GetDataEndpoint API to get an endpoint. Then send the
ListFragments requests to this endpoint using the --endpoint-url parameter.
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 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 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 conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.
For more information, see the Errors section at the bottom of this topic, as well as Common Errors.
listFragmentsRequest - GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
default CompletableFuture<ListFragmentsResponse> listFragments(Consumer<ListFragmentsRequest.Builder> listFragmentsRequest)
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 receives an acknowledgment that
a fragment is persisted, the result might not be returned immediately from a request to
ListFragments. However, results are typically available in less than one second.
You must first call the GetDataEndpoint API to get an endpoint. Then send the
ListFragments requests to this endpoint using the --endpoint-url parameter.
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 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 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 conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.
For more information, see the Errors section at the bottom of this topic, as well as Common Errors.
This is a convenience which creates an instance of the ListFragmentsRequest.Builder avoiding the need to
create one manually via ListFragmentsRequest.builder()
listFragmentsRequest - A Consumer that will call methods on ListFragmentsInput.Builder to create a request.GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
default ListFragmentsPublisher listFragmentsPaginator(ListFragmentsRequest listFragmentsRequest)
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 receives an acknowledgment that
a fragment is persisted, the result might not be returned immediately from a request to
ListFragments. However, results are typically available in less than one second.
You must first call the GetDataEndpoint API to get an endpoint. Then send the
ListFragments requests to this endpoint using the --endpoint-url parameter.
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 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 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 conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.
For more information, see the Errors section at the bottom of this topic, as well as Common Errors.
This is a variant of
listFragments(software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.ListFragmentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kinesisvideoarchivedmedia.paginators.ListFragmentsPublisher publisher = client.listFragmentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kinesisvideoarchivedmedia.paginators.ListFragmentsPublisher publisher = client.listFragmentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.ListFragmentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.ListFragmentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFragments(software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.ListFragmentsRequest)
operation.
listFragmentsRequest - GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
default ListFragmentsPublisher listFragmentsPaginator(Consumer<ListFragmentsRequest.Builder> listFragmentsRequest)
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 receives an acknowledgment that
a fragment is persisted, the result might not be returned immediately from a request to
ListFragments. However, results are typically available in less than one second.
You must first call the GetDataEndpoint API to get an endpoint. Then send the
ListFragments requests to this endpoint using the --endpoint-url parameter.
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 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 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 conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.
For more information, see the Errors section at the bottom of this topic, as well as Common Errors.
This is a variant of
listFragments(software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.ListFragmentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kinesisvideoarchivedmedia.paginators.ListFragmentsPublisher publisher = client.listFragmentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kinesisvideoarchivedmedia.paginators.ListFragmentsPublisher publisher = client.listFragmentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.ListFragmentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.ListFragmentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFragments(software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.ListFragmentsRequest)
operation.
This is a convenience which creates an instance of the ListFragmentsRequest.Builder avoiding the need to
create one manually via ListFragmentsRequest.builder()
listFragmentsRequest - A Consumer that will call methods on ListFragmentsInput.Builder to create a request.GetMedia throws 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_REPLAYis
requested for a stream that has no fragments within the requested time range, or if a session with a
PlaybackMode of LIVE is requested for a stream that has no fragments within the
last 30 seconds.
default KinesisVideoArchivedMediaServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic KinesisVideoArchivedMediaAsyncClient create()
KinesisVideoArchivedMediaAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static KinesisVideoArchivedMediaAsyncClientBuilder builder()
KinesisVideoArchivedMediaAsyncClient.Copyright © 2023. All rights reserved.