« blib/lib/Paws/KinesisVideoMedia/GetMedia.pm
↑ Summary
blib/lib/Paws/KinesisVideoMedia/StartSelector.pm »
| 1 | |||
| 2 | package Paws::KinesisVideoMedia::GetMediaOutput; | ||
| 3 | use Moose; | ||
| 4 | has ContentType => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Content-Type'); | ||
| 5 | has Payload => (is => 'ro', isa => 'Str'); | ||
| 6 | use MooseX::ClassAttribute; | ||
| 7 | class_has _stream_param => (is => 'ro', default => 'Payload'); | ||
| 8 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::KinesisVideoMedia::GetMediaOutput | ||
| 16 | |||
| 17 | =head1 ATTRIBUTES | ||
| 18 | |||
| 19 | |||
| 20 | =head2 ContentType => Str | ||
| 21 | |||
| 22 | The content type of the requested media. | ||
| 23 | |||
| 24 | |||
| 25 | =head2 Payload => Str | ||
| 26 | |||
| 27 | The payload Kinesis Video Streams returns is a sequence of chunks from | ||
| 28 | the specified stream. For information about the chunks, see . The | ||
| 29 | chunks that Kinesis Video Streams returns in the C<GetMedia> call also | ||
| 30 | include the following additional Matroska (MKV) tags: | ||
| 31 | |||
| 32 | =over | ||
| 33 | |||
| 34 | =item * | ||
| 35 | |||
| 36 | AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 string) - In the event your | ||
| 37 | C<GetMedia> call terminates, you can use this continuation token in | ||
| 38 | your next request to get the next chunk where the last request | ||
| 39 | terminated. | ||
| 40 | |||
| 41 | =item * | ||
| 42 | |||
| 43 | AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - Client applications | ||
| 44 | can use this tag value to determine how far behind the chunk returned | ||
| 45 | in the response is from the latest chunk on the stream. | ||
| 46 | |||
| 47 | =item * | ||
| 48 | |||
| 49 | AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the | ||
| 50 | chunk. | ||
| 51 | |||
| 52 | =item * | ||
| 53 | |||
| 54 | AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server timestamp of the fragment. | ||
| 55 | |||
| 56 | =item * | ||
| 57 | |||
| 58 | AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer timestamp of the | ||
| 59 | fragment. | ||
| 60 | |||
| 61 | =back | ||
| 62 | |||
| 63 | The following tags will be present if an error occurs: | ||
| 64 | |||
| 65 | =over | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | AWS_KINESISVIDEO_ERROR_CODE - String description of an error that | ||
| 70 | caused GetMedia to stop. | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | AWS_KINESISVIDEO_ERROR_ID: Integer code of the error. | ||
| 75 | |||
| 76 | =back | ||
| 77 | |||
| 78 | The error codes are as follows: | ||
| 79 | |||
| 80 | =over | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | 3002 - Error writing to the stream | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | 4000 - Requested fragment is not found | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | 4500 - Access denied for the stream's KMS key | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | 4501 - Stream's KMS key is disabled | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | 4502 - Validation error on the stream's KMS key | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | 4503 - KMS key specified in the stream is unavailable | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | 4504 - Invalid usage of the KMS key specified in the stream | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | 4505 - Invalid state of the KMS key specified in the stream | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | 4506 - Unable to find the KMS key specified in the stream | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | 5000 - Internal error | ||
| 121 | |||
| 122 | =back | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 _request_id => Str | ||
| 127 | |||
| 128 | |||
| 129 | =cut | ||
| 130 |