software.amazon.awssdk.services.kinesisvideoarchivedmedia.model

Interface HLSTimestampRange.Builder

All Superinterfaces:

Buildable, CopyableBuilder<HLSTimestampRange.Builder,HLSTimestampRange>, SdkBuilder<HLSTimestampRange.Builder,HLSTimestampRange>, SdkPojo

Enclosing class:

HLSTimestampRange

public static interface HLSTimestampRange.Builder
extends SdkPojo, CopyableBuilder<HLSTimestampRange.Builder,HLSTimestampRange>

Method Summary

Modifier and Type	Method and Description
HLSTimestampRange.Builder	endTimestamp(Instant endTimestamp) The end of the timestamp range for the requested media.
HLSTimestampRange.Builder	startTimestamp(Instant startTimestamp) The start of the timestamp range for the requested media.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

startTimestamp

HLSTimestampRange.Builder startTimestamp(Instant startTimestamp)

The start of the timestamp range for the requested media.

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

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 the stream head.

Parameters:

startTimestamp - The start of the timestamp range for the requested media.

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

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 the stream head.

Returns:

Returns a reference to this object so that method calls can be chained together.

endTimestamp

HLSTimestampRange.Builder endTimestamp(Instant endTimestamp)

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, 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.

Parameters:

endTimestamp - 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, 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:

Returns a reference to this object so that method calls can be chained together.