« blib/lib/Paws/KinesisVideoArchivedMedia/DASHFragmentSelector.pm
↑ Summary
blib/lib/Paws/KinesisVideoArchivedMedia/Fragment.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::KinesisVideoArchivedMedia::DASHTimestampRange; | ||
| 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::DASHTimestampRange | ||
| 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::DASHTimestampRange 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::DASHTimestampRange 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 | The values in C<DASHimestampRange> are inclusive. Fragments that start | ||
| 42 | exactly at or after the start time are included in the session. | ||
| 43 | Fragments that start before the start time and continue past it are not | ||
| 44 | included in the session. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 EndTimestamp => Str | ||
| 50 | |||
| 51 | The end of the timestamp range for the requested media. This value must | ||
| 52 | be within 24 hours of the specified C<StartTimestamp>, and it must be | ||
| 53 | later than the C<StartTimestamp> value. | ||
| 54 | |||
| 55 | If C<FragmentSelectorType> for the request is C<SERVER_TIMESTAMP>, this | ||
| 56 | value must be in the past. | ||
| 57 | |||
| 58 | The C<EndTimestamp> value is required for C<ON_DEMAND> mode, but | ||
| 59 | optional for C<LIVE_REPLAY> mode. If the C<EndTimestamp> is not set for | ||
| 60 | C<LIVE_REPLAY> mode then the session will continue to include newly | ||
| 61 | ingested fragments until the session expires. | ||
| 62 | |||
| 63 | This value is inclusive. The C<EndTimestamp> is compared to the | ||
| 64 | (starting) timestamp of the fragment. Fragments that start before the | ||
| 65 | C<EndTimestamp> value and continue past it are included in the session. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 StartTimestamp => Str | ||
| 69 | |||
| 70 | The start of the timestamp range for the requested media. | ||
| 71 | |||
| 72 | If the C<DASHTimestampRange> value is specified, the C<StartTimestamp> | ||
| 73 | value is required. | ||
| 74 | |||
| 75 | Only fragments that start exactly at or after C<StartTimestamp> are | ||
| 76 | included in the session. Fragments that start before C<StartTimestamp> | ||
| 77 | and continue past it aren't included in the session. If | ||
| 78 | C<FragmentSelectorType> is C<SERVER_TIMESTAMP>, the C<StartTimestamp> | ||
| 79 | must be later than the stream head. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head1 SEE ALSO | ||
| 84 | |||
| 85 | This class forms part of L<Paws>, describing an object used in L<Paws::KinesisVideoArchivedMedia> | ||
| 86 | |||
| 87 | =head1 BUGS and CONTRIBUTIONS | ||
| 88 | |||
| 89 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 90 | |||
| 91 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 92 | |||
| 93 | =cut | ||
| 94 |