« blib/lib/Paws/MediaConnect/EncodingParameters.pm
↑ Summary
blib/lib/Paws/MediaConnect/Encryption.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConnect::EncodingParametersRequest; | ||
| 3 | use Moose; | ||
| 4 | has CompressionFactor => (is => 'ro', isa => 'Num', request_name => 'compressionFactor', traits => ['NameInRequest'], required => 1); | ||
| 5 | has EncoderProfile => (is => 'ro', isa => 'Str', request_name => 'encoderProfile', traits => ['NameInRequest'], required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::MediaConnect::EncodingParametersRequest | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::MediaConnect::EncodingParametersRequest object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { CompressionFactor => $value, ..., EncoderProfile => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConnect::EncodingParametersRequest object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->CompressionFactor | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | A collection of parameters that determine how MediaConnect will convert | ||
| 38 | the content. These fields only apply to outputs on flows that have a | ||
| 39 | CDI source. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 B<REQUIRED> CompressionFactor => Num | ||
| 45 | |||
| 46 | A value that is used to calculate compression for an output. The | ||
| 47 | bitrate of the output is calculated as follows: Output bitrate = (1 / | ||
| 48 | compressionFactor) * (source bitrate) This property only applies to | ||
| 49 | outputs that use the ST 2110 JPEG XS protocol, with a flow source that | ||
| 50 | uses the CDI protocol. Valid values are floating point numbers in the | ||
| 51 | range of 3.0 to 10.0, inclusive. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> EncoderProfile => Str | ||
| 55 | |||
| 56 | A setting on the encoder that drives compression settings. This | ||
| 57 | property only applies to video media streams associated with outputs | ||
| 58 | that use the ST 2110 JPEG XS protocol, if at least one source on the | ||
| 59 | flow uses the CDI protocol. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head1 SEE ALSO | ||
| 64 | |||
| 65 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConnect> | ||
| 66 | |||
| 67 | =head1 BUGS and CONTRIBUTIONS | ||
| 68 | |||
| 69 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 70 | |||
| 71 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 72 | |||
| 73 | =cut | ||
| 74 |