/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace KinesisVideoArchivedMedia { namespace Model { /** *

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.

See Also:

* AWS * API Reference

*/ class AWS_KINESISVIDEOARCHIVEDMEDIA_API HLSTimestampRange { public: HLSTimestampRange(); HLSTimestampRange(Aws::Utils::Json::JsonView jsonValue); HLSTimestampRange& operator=(Aws::Utils::Json::JsonView jsonValue); Aws::Utils::Json::JsonValue Jsonize() const; /** *

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.

*/ inline const Aws::Utils::DateTime& GetStartTimestamp() const{ return m_startTimestamp; } /** *

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.

*/ inline bool StartTimestampHasBeenSet() const { return m_startTimestampHasBeenSet; } /** *

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.

*/ inline void SetStartTimestamp(const Aws::Utils::DateTime& value) { m_startTimestampHasBeenSet = true; m_startTimestamp = value; } /** *

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.

*/ inline void SetStartTimestamp(Aws::Utils::DateTime&& value) { m_startTimestampHasBeenSet = true; m_startTimestamp = std::move(value); } /** *

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.

*/ inline HLSTimestampRange& WithStartTimestamp(const Aws::Utils::DateTime& value) { SetStartTimestamp(value); return *this;} /** *

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.

*/ inline HLSTimestampRange& WithStartTimestamp(Aws::Utils::DateTime&& value) { SetStartTimestamp(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::Utils::DateTime& GetEndTimestamp() const{ return m_endTimestamp; } /** *

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.

*/ inline bool EndTimestampHasBeenSet() const { return m_endTimestampHasBeenSet; } /** *

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.

*/ inline void SetEndTimestamp(const Aws::Utils::DateTime& value) { m_endTimestampHasBeenSet = true; m_endTimestamp = value; } /** *

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.

*/ inline void SetEndTimestamp(Aws::Utils::DateTime&& value) { m_endTimestampHasBeenSet = true; m_endTimestamp = std::move(value); } /** *

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.

*/ inline HLSTimestampRange& WithEndTimestamp(const Aws::Utils::DateTime& value) { SetEndTimestamp(value); return *this;} /** *

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.

*/ inline HLSTimestampRange& WithEndTimestamp(Aws::Utils::DateTime&& value) { SetEndTimestamp(std::move(value)); return *this;} private: Aws::Utils::DateTime m_startTimestamp; bool m_startTimestampHasBeenSet; Aws::Utils::DateTime m_endTimestamp; bool m_endTimestampHasBeenSet; }; } // namespace Model } // namespace KinesisVideoArchivedMedia } // namespace Aws