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

Class: Aws::KinesisVideoArchivedMedia::Types::HLSTimestampRange

Inherits:

Struct

Object
Struct
Aws::KinesisVideoArchivedMedia::Types::HLSTimestampRange

show all

Defined in:: (unknown)

Overview

Note:

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

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

The start and end of the timestamp range for the requested media.

This value should not be present if PlaybackType is LIVE.

The values in the HLSTimestampRange 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::HLSFragmentSelector#timestamp_range

Instance Attribute Summary collapse

#end_timestamp ⇒ Time
The end of the timestamp range for the requested media.
#start_timestamp ⇒ Time
The start of the timestamp range for the requested media.

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.

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.

Returns:

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

#start_timestamp ⇒ `Time`

The start of the timestamp range for the requested media.

If the HLSTimestampRange value is specified, the StartTimestamp value is required.

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.