« blib/lib/Paws/KinesisVideoArchivedMedia/HLSFragmentSelector.pm
↑ Summary
blib/lib/Paws/KinesisVideoArchivedMedia/ListFragments.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::KinesisVideoArchivedMedia::HLSTimestampRange; | ||
| 3 | use Moose; | ||
| 4 | has EndTimestamp => (is => 'ro', isa => 'Str'); | ||
| 5 | has StartTimestamp => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::KinesisVideoArchivedMedia::HLSTimestampRange | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::KinesisVideoArchivedMedia::HLSTimestampRange object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { EndTimestamp => $value, ..., StartTimestamp => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::KinesisVideoArchivedMedia::HLSTimestampRange object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->EndTimestamp | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | The start and end of the timestamp range for the requested media. | ||
| 38 | |||
| 39 | This value should not be present if C<PlaybackType> is C<LIVE>. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 EndTimestamp => Str | ||
| 45 | |||
| 46 | The end of the timestamp range for the requested media. This value must | ||
| 47 | be within 24 hours of the specified C<StartTimestamp>, and it must be | ||
| 48 | later than the C<StartTimestamp> value. | ||
| 49 | |||
| 50 | If C<FragmentSelectorType> for the request is C<SERVER_TIMESTAMP>, this | ||
| 51 | value must be in the past. | ||
| 52 | |||
| 53 | The C<EndTimestamp> value is required for C<ON_DEMAND> mode, but | ||
| 54 | optional for C<LIVE_REPLAY> mode. If the C<EndTimestamp> is not set for | ||
| 55 | C<LIVE_REPLAY> mode then the session will continue to include newly | ||
| 56 | ingested fragments until the session expires. | ||
| 57 | |||
| 58 | This value is inclusive. The C<EndTimestamp> is compared to the | ||
| 59 | (starting) timestamp of the fragment. Fragments that start before the | ||
| 60 | C<EndTimestamp> value and continue past it are included in the session. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 StartTimestamp => Str | ||
| 64 | |||
| 65 | The start of the timestamp range for the requested media. | ||
| 66 | |||
| 67 | If the C<HLSTimestampRange> value is specified, the C<StartTimestamp> | ||
| 68 | value is required. | ||
| 69 | |||
| 70 | Only fragments that start exactly at or after C<StartTimestamp> are | ||
| 71 | included in the session. Fragments that start before C<StartTimestamp> | ||
| 72 | and continue past it aren't included in the session. If | ||
| 73 | C<FragmentSelectorType> is C<SERVER_TIMESTAMP>, the C<StartTimestamp> | ||
| 74 | must be later than the stream head. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head1 SEE ALSO | ||
| 79 | |||
| 80 | This class forms part of L<Paws>, describing an object used in L<Paws::KinesisVideoArchivedMedia> | ||
| 81 | |||
| 82 | =head1 BUGS and CONTRIBUTIONS | ||
| 83 | |||
| 84 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 85 | |||
| 86 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 87 | |||
| 88 | =cut | ||
| 89 |