« blib/lib/Paws/MediaConvert/JobTemplateSettings.pm
↑ Summary
blib/lib/Paws/MediaConvert/ListJobTemplates.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConvert::KantarWatermarkSettings; | ||
| 3 | use Moose; | ||
| 4 | has ChannelName => (is => 'ro', isa => 'Str', request_name => 'channelName', traits => ['NameInRequest']); | ||
| 5 | has ContentReference => (is => 'ro', isa => 'Str', request_name => 'contentReference', traits => ['NameInRequest']); | ||
| 6 | has CredentialsSecretName => (is => 'ro', isa => 'Str', request_name => 'credentialsSecretName', traits => ['NameInRequest']); | ||
| 7 | has FileOffset => (is => 'ro', isa => 'Num', request_name => 'fileOffset', traits => ['NameInRequest']); | ||
| 8 | has KantarLicenseId => (is => 'ro', isa => 'Int', request_name => 'kantarLicenseId', traits => ['NameInRequest']); | ||
| 9 | has KantarServerUrl => (is => 'ro', isa => 'Str', request_name => 'kantarServerUrl', traits => ['NameInRequest']); | ||
| 10 | has LogDestination => (is => 'ro', isa => 'Str', request_name => 'logDestination', traits => ['NameInRequest']); | ||
| 11 | has Metadata3 => (is => 'ro', isa => 'Str', request_name => 'metadata3', traits => ['NameInRequest']); | ||
| 12 | has Metadata4 => (is => 'ro', isa => 'Str', request_name => 'metadata4', traits => ['NameInRequest']); | ||
| 13 | has Metadata5 => (is => 'ro', isa => 'Str', request_name => 'metadata5', traits => ['NameInRequest']); | ||
| 14 | has Metadata6 => (is => 'ro', isa => 'Str', request_name => 'metadata6', traits => ['NameInRequest']); | ||
| 15 | has Metadata7 => (is => 'ro', isa => 'Str', request_name => 'metadata7', traits => ['NameInRequest']); | ||
| 16 | has Metadata8 => (is => 'ro', isa => 'Str', request_name => 'metadata8', traits => ['NameInRequest']); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::MediaConvert::KantarWatermarkSettings | ||
| 25 | |||
| 26 | =head1 USAGE | ||
| 27 | |||
| 28 | This class represents one of two things: | ||
| 29 | |||
| 30 | =head3 Arguments in a call to a service | ||
| 31 | |||
| 32 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 33 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 34 | |||
| 35 | As an example, if Att1 is expected to be a Paws::MediaConvert::KantarWatermarkSettings object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { ChannelName => $value, ..., Metadata8 => $value }); | ||
| 38 | |||
| 39 | =head3 Results returned from an API call | ||
| 40 | |||
| 41 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConvert::KantarWatermarkSettings object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->ChannelName | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | Use these settings only when you use Kantar watermarking. Specify the | ||
| 49 | values that MediaConvert uses to generate and place Kantar watermarks | ||
| 50 | in your output audio. These settings apply to every output in your job. | ||
| 51 | In addition to specifying these values, you also need to store your | ||
| 52 | Kantar credentials in AWS Secrets Manager. For more information, see | ||
| 53 | https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 ChannelName => Str | ||
| 59 | |||
| 60 | Provide an audio channel name from your Kantar audio license. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 ContentReference => Str | ||
| 64 | |||
| 65 | Specify a unique identifier for Kantar to use for this piece of | ||
| 66 | content. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 CredentialsSecretName => Str | ||
| 70 | |||
| 71 | Provide the name of the AWS Secrets Manager secret where your Kantar | ||
| 72 | credentials are stored. Note that your MediaConvert service role must | ||
| 73 | provide access to this secret. For more information, see | ||
| 74 | https://docs.aws.amazon.com/mediaconvert/latest/ug/granting-permissions-for-mediaconvert-to-access-secrets-manager-secret.html. | ||
| 75 | For instructions on creating a secret, see | ||
| 76 | https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html, | ||
| 77 | in the AWS Secrets Manager User Guide. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 FileOffset => Num | ||
| 81 | |||
| 82 | Optional. Specify an offset, in whole seconds, from the start of your | ||
| 83 | output and the beginning of the watermarking. When you don't specify an | ||
| 84 | offset, Kantar defaults to zero. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 KantarLicenseId => Int | ||
| 88 | |||
| 89 | Provide your Kantar license ID number. You should get this number from | ||
| 90 | Kantar. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 KantarServerUrl => Str | ||
| 94 | |||
| 95 | Provide the HTTPS endpoint to the Kantar server. You should get this | ||
| 96 | endpoint from Kantar. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 LogDestination => Str | ||
| 100 | |||
| 101 | Optional. Specify the Amazon S3 bucket where you want MediaConvert to | ||
| 102 | store your Kantar watermark XML logs. When you don't specify a bucket, | ||
| 103 | MediaConvert doesn't save these logs. Note that your MediaConvert | ||
| 104 | service role must provide access to this location. For more | ||
| 105 | information, see | ||
| 106 | https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html | ||
| 107 | |||
| 108 | |||
| 109 | =head2 Metadata3 => Str | ||
| 110 | |||
| 111 | You can optionally use this field to specify the first timestamp that | ||
| 112 | Kantar embeds during watermarking. Kantar suggests that you be very | ||
| 113 | cautious when using this Kantar feature, and that you use it only on | ||
| 114 | channels that are managed specifically for use with this feature by | ||
| 115 | your Audience Measurement Operator. For more information about this | ||
| 116 | feature, contact Kantar technical support. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 Metadata4 => Str | ||
| 120 | |||
| 121 | Additional metadata that MediaConvert sends to Kantar. Maximum length | ||
| 122 | is 50 characters. | ||
| 123 | |||
| 124 | |||
| 125 | =head2 Metadata5 => Str | ||
| 126 | |||
| 127 | Additional metadata that MediaConvert sends to Kantar. Maximum length | ||
| 128 | is 50 characters. | ||
| 129 | |||
| 130 | |||
| 131 | =head2 Metadata6 => Str | ||
| 132 | |||
| 133 | Additional metadata that MediaConvert sends to Kantar. Maximum length | ||
| 134 | is 50 characters. | ||
| 135 | |||
| 136 | |||
| 137 | =head2 Metadata7 => Str | ||
| 138 | |||
| 139 | Additional metadata that MediaConvert sends to Kantar. Maximum length | ||
| 140 | is 50 characters. | ||
| 141 | |||
| 142 | |||
| 143 | =head2 Metadata8 => Str | ||
| 144 | |||
| 145 | Additional metadata that MediaConvert sends to Kantar. Maximum length | ||
| 146 | is 50 characters. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head1 SEE ALSO | ||
| 151 | |||
| 152 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConvert> | ||
| 153 | |||
| 154 | =head1 BUGS and CONTRIBUTIONS | ||
| 155 | |||
| 156 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 157 | |||
| 158 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 159 | |||
| 160 | =cut | ||
| 161 |