227 lines
12 KiB
C++
227 lines
12 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/kinesis-video-archived-media/KinesisVideoArchivedMedia_EXPORTS.h>
|
|
#include <aws/core/utils/DateTime.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Utils
|
|
{
|
|
namespace Json
|
|
{
|
|
class JsonValue;
|
|
class JsonView;
|
|
} // namespace Json
|
|
} // namespace Utils
|
|
namespace KinesisVideoArchivedMedia
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
* <p>The start and end of the timestamp range for the requested media.</p> <p>This
|
|
* value should not be present if <code>PlaybackType</code> is
|
|
* <code>LIVE</code>.</p> <p>The values in the
|
|
* <code>DASHimestampRange</code> 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.</p> <p><h3>See Also:</h3>
|
|
* <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/DASHTimestampRange">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class AWS_KINESISVIDEOARCHIVEDMEDIA_API DASHTimestampRange
|
|
{
|
|
public:
|
|
DASHTimestampRange();
|
|
DASHTimestampRange(Aws::Utils::Json::JsonView jsonValue);
|
|
DASHTimestampRange& operator=(Aws::Utils::Json::JsonView jsonValue);
|
|
Aws::Utils::Json::JsonValue Jsonize() const;
|
|
|
|
|
|
/**
|
|
* <p>The start of the timestamp range for the requested media.</p> <p>If the
|
|
* <code>DASHTimestampRange</code> value is specified, the
|
|
* <code>StartTimestamp</code> value is required.</p> <p>This value is
|
|
* inclusive. Fragments that start before the <code>StartTimestamp</code> and
|
|
* continue past it are included in the session. If
|
|
* <code>FragmentSelectorType</code> is <code>SERVER_TIMESTAMP</code>, the
|
|
* <code>StartTimestamp</code> must be later than the stream head.</p>
|
|
*/
|
|
inline const Aws::Utils::DateTime& GetStartTimestamp() const{ return m_startTimestamp; }
|
|
|
|
/**
|
|
* <p>The start of the timestamp range for the requested media.</p> <p>If the
|
|
* <code>DASHTimestampRange</code> value is specified, the
|
|
* <code>StartTimestamp</code> value is required.</p> <p>This value is
|
|
* inclusive. Fragments that start before the <code>StartTimestamp</code> and
|
|
* continue past it are included in the session. If
|
|
* <code>FragmentSelectorType</code> is <code>SERVER_TIMESTAMP</code>, the
|
|
* <code>StartTimestamp</code> must be later than the stream head.</p>
|
|
*/
|
|
inline bool StartTimestampHasBeenSet() const { return m_startTimestampHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The start of the timestamp range for the requested media.</p> <p>If the
|
|
* <code>DASHTimestampRange</code> value is specified, the
|
|
* <code>StartTimestamp</code> value is required.</p> <p>This value is
|
|
* inclusive. Fragments that start before the <code>StartTimestamp</code> and
|
|
* continue past it are included in the session. If
|
|
* <code>FragmentSelectorType</code> is <code>SERVER_TIMESTAMP</code>, the
|
|
* <code>StartTimestamp</code> must be later than the stream head.</p>
|
|
*/
|
|
inline void SetStartTimestamp(const Aws::Utils::DateTime& value) { m_startTimestampHasBeenSet = true; m_startTimestamp = value; }
|
|
|
|
/**
|
|
* <p>The start of the timestamp range for the requested media.</p> <p>If the
|
|
* <code>DASHTimestampRange</code> value is specified, the
|
|
* <code>StartTimestamp</code> value is required.</p> <p>This value is
|
|
* inclusive. Fragments that start before the <code>StartTimestamp</code> and
|
|
* continue past it are included in the session. If
|
|
* <code>FragmentSelectorType</code> is <code>SERVER_TIMESTAMP</code>, the
|
|
* <code>StartTimestamp</code> must be later than the stream head.</p>
|
|
*/
|
|
inline void SetStartTimestamp(Aws::Utils::DateTime&& value) { m_startTimestampHasBeenSet = true; m_startTimestamp = std::move(value); }
|
|
|
|
/**
|
|
* <p>The start of the timestamp range for the requested media.</p> <p>If the
|
|
* <code>DASHTimestampRange</code> value is specified, the
|
|
* <code>StartTimestamp</code> value is required.</p> <p>This value is
|
|
* inclusive. Fragments that start before the <code>StartTimestamp</code> and
|
|
* continue past it are included in the session. If
|
|
* <code>FragmentSelectorType</code> is <code>SERVER_TIMESTAMP</code>, the
|
|
* <code>StartTimestamp</code> must be later than the stream head.</p>
|
|
*/
|
|
inline DASHTimestampRange& WithStartTimestamp(const Aws::Utils::DateTime& value) { SetStartTimestamp(value); return *this;}
|
|
|
|
/**
|
|
* <p>The start of the timestamp range for the requested media.</p> <p>If the
|
|
* <code>DASHTimestampRange</code> value is specified, the
|
|
* <code>StartTimestamp</code> value is required.</p> <p>This value is
|
|
* inclusive. Fragments that start before the <code>StartTimestamp</code> and
|
|
* continue past it are included in the session. If
|
|
* <code>FragmentSelectorType</code> is <code>SERVER_TIMESTAMP</code>, the
|
|
* <code>StartTimestamp</code> must be later than the stream head.</p>
|
|
*/
|
|
inline DASHTimestampRange& WithStartTimestamp(Aws::Utils::DateTime&& value) { SetStartTimestamp(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The end of the timestamp range for the requested media. This value must be
|
|
* within 3 hours of the specified <code>StartTimestamp</code>, and it must be
|
|
* later than the <code>StartTimestamp</code> value.</p> <p>If
|
|
* <code>FragmentSelectorType</code> for the request is
|
|
* <code>SERVER_TIMESTAMP</code>, this value must be in the past.</p> <p>The
|
|
* <code>EndTimestamp</code> value is required for <code>ON_DEMAND</code> mode, but
|
|
* optional for <code>LIVE_REPLAY</code> mode. If the <code>EndTimestamp</code> is
|
|
* not set for <code>LIVE_REPLAY</code> mode then the session will continue to
|
|
* include newly ingested fragments until the session expires.</p> <p>This
|
|
* value is inclusive. The <code>EndTimestamp</code> is compared to the (starting)
|
|
* timestamp of the fragment. Fragments that start before the
|
|
* <code>EndTimestamp</code> value and continue past it are included in the
|
|
* session.</p>
|
|
*/
|
|
inline const Aws::Utils::DateTime& GetEndTimestamp() const{ return m_endTimestamp; }
|
|
|
|
/**
|
|
* <p>The end of the timestamp range for the requested media. This value must be
|
|
* within 3 hours of the specified <code>StartTimestamp</code>, and it must be
|
|
* later than the <code>StartTimestamp</code> value.</p> <p>If
|
|
* <code>FragmentSelectorType</code> for the request is
|
|
* <code>SERVER_TIMESTAMP</code>, this value must be in the past.</p> <p>The
|
|
* <code>EndTimestamp</code> value is required for <code>ON_DEMAND</code> mode, but
|
|
* optional for <code>LIVE_REPLAY</code> mode. If the <code>EndTimestamp</code> is
|
|
* not set for <code>LIVE_REPLAY</code> mode then the session will continue to
|
|
* include newly ingested fragments until the session expires.</p> <p>This
|
|
* value is inclusive. The <code>EndTimestamp</code> is compared to the (starting)
|
|
* timestamp of the fragment. Fragments that start before the
|
|
* <code>EndTimestamp</code> value and continue past it are included in the
|
|
* session.</p>
|
|
*/
|
|
inline bool EndTimestampHasBeenSet() const { return m_endTimestampHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The end of the timestamp range for the requested media. This value must be
|
|
* within 3 hours of the specified <code>StartTimestamp</code>, and it must be
|
|
* later than the <code>StartTimestamp</code> value.</p> <p>If
|
|
* <code>FragmentSelectorType</code> for the request is
|
|
* <code>SERVER_TIMESTAMP</code>, this value must be in the past.</p> <p>The
|
|
* <code>EndTimestamp</code> value is required for <code>ON_DEMAND</code> mode, but
|
|
* optional for <code>LIVE_REPLAY</code> mode. If the <code>EndTimestamp</code> is
|
|
* not set for <code>LIVE_REPLAY</code> mode then the session will continue to
|
|
* include newly ingested fragments until the session expires.</p> <p>This
|
|
* value is inclusive. The <code>EndTimestamp</code> is compared to the (starting)
|
|
* timestamp of the fragment. Fragments that start before the
|
|
* <code>EndTimestamp</code> value and continue past it are included in the
|
|
* session.</p>
|
|
*/
|
|
inline void SetEndTimestamp(const Aws::Utils::DateTime& value) { m_endTimestampHasBeenSet = true; m_endTimestamp = value; }
|
|
|
|
/**
|
|
* <p>The end of the timestamp range for the requested media. This value must be
|
|
* within 3 hours of the specified <code>StartTimestamp</code>, and it must be
|
|
* later than the <code>StartTimestamp</code> value.</p> <p>If
|
|
* <code>FragmentSelectorType</code> for the request is
|
|
* <code>SERVER_TIMESTAMP</code>, this value must be in the past.</p> <p>The
|
|
* <code>EndTimestamp</code> value is required for <code>ON_DEMAND</code> mode, but
|
|
* optional for <code>LIVE_REPLAY</code> mode. If the <code>EndTimestamp</code> is
|
|
* not set for <code>LIVE_REPLAY</code> mode then the session will continue to
|
|
* include newly ingested fragments until the session expires.</p> <p>This
|
|
* value is inclusive. The <code>EndTimestamp</code> is compared to the (starting)
|
|
* timestamp of the fragment. Fragments that start before the
|
|
* <code>EndTimestamp</code> value and continue past it are included in the
|
|
* session.</p>
|
|
*/
|
|
inline void SetEndTimestamp(Aws::Utils::DateTime&& value) { m_endTimestampHasBeenSet = true; m_endTimestamp = std::move(value); }
|
|
|
|
/**
|
|
* <p>The end of the timestamp range for the requested media. This value must be
|
|
* within 3 hours of the specified <code>StartTimestamp</code>, and it must be
|
|
* later than the <code>StartTimestamp</code> value.</p> <p>If
|
|
* <code>FragmentSelectorType</code> for the request is
|
|
* <code>SERVER_TIMESTAMP</code>, this value must be in the past.</p> <p>The
|
|
* <code>EndTimestamp</code> value is required for <code>ON_DEMAND</code> mode, but
|
|
* optional for <code>LIVE_REPLAY</code> mode. If the <code>EndTimestamp</code> is
|
|
* not set for <code>LIVE_REPLAY</code> mode then the session will continue to
|
|
* include newly ingested fragments until the session expires.</p> <p>This
|
|
* value is inclusive. The <code>EndTimestamp</code> is compared to the (starting)
|
|
* timestamp of the fragment. Fragments that start before the
|
|
* <code>EndTimestamp</code> value and continue past it are included in the
|
|
* session.</p>
|
|
*/
|
|
inline DASHTimestampRange& WithEndTimestamp(const Aws::Utils::DateTime& value) { SetEndTimestamp(value); return *this;}
|
|
|
|
/**
|
|
* <p>The end of the timestamp range for the requested media. This value must be
|
|
* within 3 hours of the specified <code>StartTimestamp</code>, and it must be
|
|
* later than the <code>StartTimestamp</code> value.</p> <p>If
|
|
* <code>FragmentSelectorType</code> for the request is
|
|
* <code>SERVER_TIMESTAMP</code>, this value must be in the past.</p> <p>The
|
|
* <code>EndTimestamp</code> value is required for <code>ON_DEMAND</code> mode, but
|
|
* optional for <code>LIVE_REPLAY</code> mode. If the <code>EndTimestamp</code> is
|
|
* not set for <code>LIVE_REPLAY</code> mode then the session will continue to
|
|
* include newly ingested fragments until the session expires.</p> <p>This
|
|
* value is inclusive. The <code>EndTimestamp</code> is compared to the (starting)
|
|
* timestamp of the fragment. Fragments that start before the
|
|
* <code>EndTimestamp</code> value and continue past it are included in the
|
|
* session.</p>
|
|
*/
|
|
inline DASHTimestampRange& 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
|