« blib/lib/Paws/MediaConnect/ListedFlow.pm
↑ Summary
blib/lib/Paws/MediaConnect/MediaStreamAttributes.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConnect::MediaStream; | ||
| 3 | use Moose; | ||
| 4 | has Attributes => (is => 'ro', isa => 'Paws::MediaConnect::MediaStreamAttributes', request_name => 'attributes', traits => ['NameInRequest']); | ||
| 5 | has ClockRate => (is => 'ro', isa => 'Int', request_name => 'clockRate', traits => ['NameInRequest']); | ||
| 6 | has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest']); | ||
| 7 | has Fmt => (is => 'ro', isa => 'Int', request_name => 'fmt', traits => ['NameInRequest'], required => 1); | ||
| 8 | has MediaStreamId => (is => 'ro', isa => 'Int', request_name => 'mediaStreamId', traits => ['NameInRequest'], required => 1); | ||
| 9 | has MediaStreamName => (is => 'ro', isa => 'Str', request_name => 'mediaStreamName', traits => ['NameInRequest'], required => 1); | ||
| 10 | has MediaStreamType => (is => 'ro', isa => 'Str', request_name => 'mediaStreamType', traits => ['NameInRequest'], required => 1); | ||
| 11 | has VideoFormat => (is => 'ro', isa => 'Str', request_name => 'videoFormat', traits => ['NameInRequest']); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::MediaConnect::MediaStream | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::MediaConnect::MediaStream object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { Attributes => $value, ..., VideoFormat => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConnect::MediaStream object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->Attributes | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | A single track or stream of media that contains video, audio, or | ||
| 44 | ancillary data. After you add a media stream to a flow, you can | ||
| 45 | associate it with sources and outputs on that flow, as long as they use | ||
| 46 | the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output | ||
| 47 | can consist of one or many media streams. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 Attributes => L<Paws::MediaConnect::MediaStreamAttributes> | ||
| 53 | |||
| 54 | Attributes that are related to the media stream. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 ClockRate => Int | ||
| 58 | |||
| 59 | The sample rate for the stream. This value is measured in Hz. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 Description => Str | ||
| 63 | |||
| 64 | A description that can help you quickly identify what your media stream | ||
| 65 | is used for. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> Fmt => Int | ||
| 69 | |||
| 70 | The format type number (sometimes referred to as RTP payload type) of | ||
| 71 | the media stream. MediaConnect assigns this value to the media stream. | ||
| 72 | For ST 2110 JPEG XS outputs, you need to provide this value to the | ||
| 73 | receiver. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> MediaStreamId => Int | ||
| 77 | |||
| 78 | A unique identifier for the media stream. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> MediaStreamName => Str | ||
| 82 | |||
| 83 | A name that helps you distinguish one media stream from another. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 B<REQUIRED> MediaStreamType => Str | ||
| 87 | |||
| 88 | The type of media stream. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 VideoFormat => Str | ||
| 92 | |||
| 93 | The resolution of the video. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head1 SEE ALSO | ||
| 98 | |||
| 99 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConnect> | ||
| 100 | |||
| 101 | =head1 BUGS and CONTRIBUTIONS | ||
| 102 | |||
| 103 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 104 | |||
| 105 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 106 | |||
| 107 | =cut | ||
| 108 |