lib/aws-sdk-kinesisvideoarchivedmedia/client.rb in aws-sdk-kinesisvideoarchivedmedia-1.55.0 vs lib/aws-sdk-kinesisvideoarchivedmedia/client.rb in aws-sdk-kinesisvideoarchivedmedia-1.56.0
- old
+ new
@@ -1197,11 +1197,11 @@
def get_hls_streaming_session_url(params = {}, options = {})
req = build_request(:get_hls_streaming_session_url, params)
req.send_request(options)
end
- # Retrieves a list of Images corresponding to each timestamp for a given
+ # Retrieves a list of images corresponding to each timestamp for a given
# time range, sampling interval, and image format configuration.
#
# @option params [String] :stream_name
# The name of the stream from which to retrieve the images. You must
# specify either the `StreamName` or the `StreamARN`.
@@ -1226,19 +1226,15 @@
# seconds above `StartTimestamp`, you will receive an
# `IllegalArgumentException`.
#
# @option params [Integer] :sampling_interval
# 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.
+ # generated from the stream. The minimum value that can be provided is
+ # 200 ms (5 images per second). If the timestamp range is less than the
+ # sampling interval, the image from the `startTimestamp` will be
+ # returned if available.
#
- # <note markdown="1"> The minimum value of 200 ms is a hard limit.
- #
- # </note>
- #
# @option params [required, String] :format
# The format that will be used to encode the image.
#
# @option params [Hash<String,String>] :format_config
# The list of a key-value pair structure that contains extra parameters
@@ -1466,10 +1462,14 @@
#
# @option params [Types::FragmentSelector] :fragment_selector
# Describes the timestamp range and timestamp origin for the range of
# fragments to return.
#
+ # <note markdown="1"> This is only required when the `NextToken` isn't passed in the API.
+ #
+ # </note>
+ #
# @return [Types::ListFragmentsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListFragmentsOutput#fragments #fragments} => Array<Types::Fragment>
# * {Types::ListFragmentsOutput#next_token #next_token} => String
#
@@ -1521,10 +1521,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-kinesisvideoarchivedmedia'
- context[:gem_version] = '1.55.0'
+ context[:gem_version] = '1.56.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated