You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::KinesisVideoArchivedMedia::Types::ClipTimestampRange

Inherits:

Struct

Object
Struct
Aws::KinesisVideoArchivedMedia::Types::ClipTimestampRange

show all

Defined in:: (unknown)

Overview

Note:

When passing ClipTimestampRange as input to an Aws::Client method, you can use a vanilla Hash:

{
  start_timestamp: Time.now, # required
  end_timestamp: Time.now, # required
}

The range of timestamps for which to return fragments.

The values in the ClipTimestampRange are inclusive. Fragments that begin before the start time but continue past it, or fragments that begin before the end time but continue past it, are included in the session.

Returned by:

Aws::KinesisVideoArchivedMedia::Types::ClipFragmentSelector#timestamp_range

Instance Attribute Summary collapse

#end_timestamp ⇒ Time
The end of the timestamp range for the requested media.
#start_timestamp ⇒ Time
The starting timestamp in the range of timestamps for which to return fragments.

Instance Attribute Details

#end_timestamp ⇒ `Time`

The end of the timestamp range for the requested media.

This value must be within 3 hours of the specified 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.

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.

Returns:

(Time) —
The end of the timestamp range for the requested media.

#start_timestamp ⇒ `Time`

The starting timestamp in the range of timestamps for which to return fragments.

This value is inclusive. Fragments that start before the StartTimestamp and continue past it are included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head.