Struct aws_sdk_kinesisvideoarchivedmedia::model::HlsTimestampRange

#[non_exhaustive]
pub struct HlsTimestampRange {
    pub start_timestamp: Option<DateTime>,
    pub end_timestamp: Option<DateTime>,
}

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

This value should not be present if PlaybackType is LIVE.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

start_timestamp: Option<DateTime>

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.

end_timestamp: Option<DateTime>

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.

Implementations

impl HlsTimestampRange

pub fn start_timestamp(&self) -> Option<&DateTime>

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.

pub fn end_timestamp(&self) -> Option<&DateTime>

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.

impl HlsTimestampRange

pub fn builder() -> Builder

Creates a new builder-style object to manufacture HlsTimestampRange

Trait Implementations

impl Clone for HlsTimestampRange

fn clone(&self) -> HlsTimestampRange

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HlsTimestampRange

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<HlsTimestampRange> for HlsTimestampRange

fn eq(&self, other: &HlsTimestampRange) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &HlsTimestampRange) -> bool

This method tests for !=.

impl StructuralPartialEq for HlsTimestampRange