« blib/lib/Paws/MediaLive/CancelInputDeviceTransferResponse.pm
↑ Summary
blib/lib/Paws/MediaLive/CaptionDestinationSettings.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaLive::CaptionDescription; | ||
| 3 | use Moose; | ||
| 4 | has CaptionSelectorName => (is => 'ro', isa => 'Str', request_name => 'captionSelectorName', traits => ['NameInRequest'], required => 1); | ||
| 5 | has DestinationSettings => (is => 'ro', isa => 'Paws::MediaLive::CaptionDestinationSettings', request_name => 'destinationSettings', traits => ['NameInRequest']); | ||
| 6 | has LanguageCode => (is => 'ro', isa => 'Str', request_name => 'languageCode', traits => ['NameInRequest']); | ||
| 7 | has LanguageDescription => (is => 'ro', isa => 'Str', request_name => 'languageDescription', traits => ['NameInRequest']); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest'], required => 1); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::MediaLive::CaptionDescription | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::MediaLive::CaptionDescription object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { CaptionSelectorName => $value, ..., Name => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaLive::CaptionDescription object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->CaptionSelectorName | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Caption Description | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> CaptionSelectorName => Str | ||
| 46 | |||
| 47 | Specifies which input caption selector to use as a caption source when | ||
| 48 | generating output captions. This field should match a captionSelector | ||
| 49 | name. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 DestinationSettings => L<Paws::MediaLive::CaptionDestinationSettings> | ||
| 53 | |||
| 54 | Additional settings for captions destination that depend on the | ||
| 55 | destination type. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 LanguageCode => Str | ||
| 59 | |||
| 60 | ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/ | ||
| 61 | |||
| 62 | |||
| 63 | =head2 LanguageDescription => Str | ||
| 64 | |||
| 65 | Human readable information to indicate captions available for players | ||
| 66 | (eg. English, or Spanish). | ||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> Name => Str | ||
| 70 | |||
| 71 | Name of the caption description. Used to associate a caption | ||
| 72 | description with an output. Names must be unique within an event. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head1 SEE ALSO | ||
| 77 | |||
| 78 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaLive> | ||
| 79 | |||
| 80 | =head1 BUGS and CONTRIBUTIONS | ||
| 81 | |||
| 82 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 83 | |||
| 84 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 85 | |||
| 86 | =cut | ||
| 87 |