blib/lib/Paws/KinesisVideoMedia/StartSelector.pm untested

filter: Statementstmt 0.0% 0 / 7 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 8 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::KinesisVideoMedia::StartSelector;
3 use Moose;
4 has AfterFragmentNumber => (is => 'ro', isa => 'Str');
5 has ContinuationToken => (is => 'ro', isa => 'Str');
6 has StartSelectorType => (is => 'ro', isa => 'Str', required => 1);
7 has StartTimestamp => (is => 'ro', isa => 'Str');
8  
9 1;
10  
11 ### main pod documentation begin ###
12  
13 =head1 NAME
14  
15 Paws::KinesisVideoMedia::StartSelector
16  
17 =head1 USAGE
18  
19 This class represents one of two things:
20  
21 =head3 Arguments in a call to a service
22  
23 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24 Each attribute should be used as a named argument in the calls that expect this type of object.
25  
26 As an example, if Att1 is expected to be a Paws::KinesisVideoMedia::StartSelector object:
27  
28 $service_obj->Method(Att1 => { AfterFragmentNumber => $value, ..., StartTimestamp => $value });
29  
30 =head3 Results returned from an API call
31  
32 Use accessors for each attribute. If Att1 is expected to be an Paws::KinesisVideoMedia::StartSelector object:
33  
34 $result = $service_obj->Method(...);
35 $result->Att1->AfterFragmentNumber
36  
37 =head1 DESCRIPTION
38  
39 Identifies the chunk on the Kinesis video stream where you want the
40 C<GetMedia> API to start returning media data. You have the following
41 options to identify the starting chunk:
42  
43 =over
44  
45 =item *
46  
47 Choose the latest (or oldest) chunk.
48  
49 =item *
50  
51 Identify a specific chunk. You can identify a specific chunk either by
52 providing a fragment number or timestamp (server or producer).
53  
54 =item *
55  
56 Each chunk's metadata includes a continuation token as a Matroska (MKV)
57 tag (C<AWS_KINESISVIDEO_CONTINUATION_TOKEN>). If your previous
58 C<GetMedia> request terminated, you can use this tag value in your next
59 C<GetMedia> request. The API then starts returning chunks starting
60 where the last API ended.
61  
62 =back
63  
64  
65 =head1 ATTRIBUTES
66  
67  
68 =head2 AfterFragmentNumber => Str
69  
70 Specifies the fragment number from where you want the C<GetMedia> API
71 to start returning the fragments.
72  
73  
74 =head2 ContinuationToken => Str
75  
76 Continuation token that Kinesis Video Streams returned in the previous
77 C<GetMedia> response. The C<GetMedia> API then starts with the chunk
78 identified by the continuation token.
79  
80  
81 =head2 B<REQUIRED> StartSelectorType => Str
82  
83 Identifies the fragment on the Kinesis video stream where you want to
84 start getting the data from.
85  
86 =over
87  
88 =item *
89  
90 NOW - Start with the latest chunk on the stream.
91  
92 =item *
93  
94 EARLIEST - Start with earliest available chunk on the stream.
95  
96 =item *
97  
98 FRAGMENT_NUMBER - Start with the chunk after a specific fragment. You
99 must also specify the C<AfterFragmentNumber> parameter.
100  
101 =item *
102  
103 PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk
104 containing a fragment with the specified producer or server timestamp.
105 You specify the timestamp by adding C<StartTimestamp>.
106  
107 =item *
108  
109 CONTINUATION_TOKEN - Read using the specified continuation token.
110  
111 =back
112  
113 If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the
114 C<startSelectorType>, you don't provide any additional information in
115 the C<startSelector>.
116  
117  
118 =head2 StartTimestamp => Str
119  
120 A timestamp value. This value is required if you choose the
121 PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the C<startSelectorType>.
122 The C<GetMedia> API then starts with the chunk containing the fragment
123 that has the specified timestamp.
124  
125  
126  
127 =head1 SEE ALSO
128  
129 This class forms part of L<Paws>, describing an object used in L<Paws::KinesisVideoMedia>
130  
131 =head1 BUGS and CONTRIBUTIONS
132  
133 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
134  
135 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
136  
137 =cut
138