« blib/lib/Paws/LexRuntimeV2/ActiveContextTimeToLive.pm
↑ Summary
blib/lib/Paws/LexRuntimeV2/AudioResponseEvent.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::LexRuntimeV2::AudioInputEvent; | ||
| 3 | use Moose; | ||
| 4 | has AudioChunk => (is => 'ro', isa => 'Str', request_name => 'audioChunk', traits => ['NameInRequest']); | ||
| 5 | has ClientTimestampMillis => (is => 'ro', isa => 'Int', request_name => 'clientTimestampMillis', traits => ['NameInRequest']); | ||
| 6 | has ContentType => (is => 'ro', isa => 'Str', request_name => 'contentType', traits => ['NameInRequest'], required => 1); | ||
| 7 | has EventId => (is => 'ro', isa => 'Str', request_name => 'eventId', traits => ['NameInRequest']); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::LexRuntimeV2::AudioInputEvent | ||
| 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::LexRuntimeV2::AudioInputEvent object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { AudioChunk => $value, ..., EventId => $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::LexRuntimeV2::AudioInputEvent object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->AudioChunk | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Represents a chunk of audio sent from the client application to Amazon | ||
| 40 | Lex V2. The audio is all or part of an utterance from the user. | ||
| 41 | |||
| 42 | Amazon Lex V2 accumulates audio chunks until it recognizes a natural | ||
| 43 | pause in speech before processing the input. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 AudioChunk => Str | ||
| 49 | |||
| 50 | An encoded stream of audio. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 ClientTimestampMillis => Int | ||
| 54 | |||
| 55 | A timestamp set by the client of the date and time that the event was | ||
| 56 | sent to Amazon Lex V2. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> ContentType => Str | ||
| 60 | |||
| 61 | The encoding used for the audio chunk. You must use 8 KHz PCM 16-bit | ||
| 62 | mono-channel little-endian format. The value of the field should be: | ||
| 63 | |||
| 64 | C<audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; | ||
| 65 | is-big-endian=false> | ||
| 66 | |||
| 67 | |||
| 68 | =head2 EventId => Str | ||
| 69 | |||
| 70 | A unique identifier that your application assigns to the event. You can | ||
| 71 | use this to identify events in logs. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, describing an object used in L<Paws::LexRuntimeV2> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |