« blib/lib/Paws/MediaTailor/PutChannelPolicyResponse.pm
↑ Summary
blib/lib/Paws/MediaTailor/PutPlaybackConfigurationResponse.pm »
| 1 | |||
| 2 | package Paws::MediaTailor::PutPlaybackConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has AdDecisionServerUrl => (is => 'ro', isa => 'Str'); | ||
| 5 | has AvailSuppression => (is => 'ro', isa => 'Paws::MediaTailor::AvailSuppression'); | ||
| 6 | has Bumper => (is => 'ro', isa => 'Paws::MediaTailor::Bumper'); | ||
| 7 | has CdnConfiguration => (is => 'ro', isa => 'Paws::MediaTailor::CdnConfiguration'); | ||
| 8 | has ConfigurationAliases => (is => 'ro', isa => 'Paws::MediaTailor::ConfigurationAliasesRequest'); | ||
| 9 | has DashConfiguration => (is => 'ro', isa => 'Paws::MediaTailor::DashConfigurationForPut'); | ||
| 10 | has LivePreRollConfiguration => (is => 'ro', isa => 'Paws::MediaTailor::LivePreRollConfiguration'); | ||
| 11 | has ManifestProcessingRules => (is => 'ro', isa => 'Paws::MediaTailor::ManifestProcessingRules'); | ||
| 12 | has Name => (is => 'ro', isa => 'Str'); | ||
| 13 | has PersonalizationThresholdSeconds => (is => 'ro', isa => 'Int'); | ||
| 14 | has SlateAdUrl => (is => 'ro', isa => 'Str'); | ||
| 15 | has Tags => (is => 'ro', isa => 'Paws::MediaTailor::__mapOf__string', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 16 | has TranscodeProfileName => (is => 'ro', isa => 'Str'); | ||
| 17 | has VideoContentSourceUrl => (is => 'ro', isa => 'Str'); | ||
| 18 | |||
| 19 | use MooseX::ClassAttribute; | ||
| 20 | |||
| 21 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutPlaybackConfiguration'); | ||
| 22 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/playbackConfiguration'); | ||
| 23 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 24 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MediaTailor::PutPlaybackConfigurationResponse'); | ||
| 25 | 1; | ||
| 26 | |||
| 27 | ### main pod documentation begin ### | ||
| 28 | |||
| 29 | =head1 NAME | ||
| 30 | |||
| 31 | Paws::MediaTailor::PutPlaybackConfiguration - Arguments for method PutPlaybackConfiguration on L<Paws::MediaTailor> | ||
| 32 | |||
| 33 | =head1 DESCRIPTION | ||
| 34 | |||
| 35 | This class represents the parameters used for calling the method PutPlaybackConfiguration on the | ||
| 36 | L<AWS MediaTailor|Paws::MediaTailor> service. Use the attributes of this class | ||
| 37 | as arguments to method PutPlaybackConfiguration. | ||
| 38 | |||
| 39 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutPlaybackConfiguration. | ||
| 40 | |||
| 41 | =head1 SYNOPSIS | ||
| 42 | |||
| 43 | my $api.mediatailor = Paws->service('MediaTailor'); | ||
| 44 | my $PutPlaybackConfigurationResponse = | ||
| 45 | $api . mediatailor->PutPlaybackConfiguration( | ||
| 46 | AdDecisionServerUrl => 'My__string', # OPTIONAL | ||
| 47 | AvailSuppression => { | ||
| 48 | Mode => 'OFF', # values: OFF, BEHIND_LIVE_EDGE; OPTIONAL | ||
| 49 | Value => 'My__string', | ||
| 50 | }, # OPTIONAL | ||
| 51 | Bumper => { | ||
| 52 | EndUrl => 'My__string', | ||
| 53 | StartUrl => 'My__string', | ||
| 54 | }, # OPTIONAL | ||
| 55 | CdnConfiguration => { | ||
| 56 | AdSegmentUrlPrefix => 'My__string', | ||
| 57 | ContentSegmentUrlPrefix => 'My__string', | ||
| 58 | }, # OPTIONAL | ||
| 59 | ConfigurationAliases => | ||
| 60 | { 'My__string' => { 'My__string' => 'My__string', }, }, # OPTIONAL | ||
| 61 | DashConfiguration => { | ||
| 62 | MpdLocation => 'My__string', | ||
| 63 | OriginManifestType => | ||
| 64 | 'SINGLE_PERIOD', # values: SINGLE_PERIOD, MULTI_PERIOD; OPTIONAL | ||
| 65 | }, # OPTIONAL | ||
| 66 | LivePreRollConfiguration => { | ||
| 67 | AdDecisionServerUrl => 'My__string', | ||
| 68 | MaxDurationSeconds => 1, # OPTIONAL | ||
| 69 | }, # OPTIONAL | ||
| 70 | ManifestProcessingRules => { | ||
| 71 | AdMarkerPassthrough => { | ||
| 72 | Enabled => 1, # OPTIONAL | ||
| 73 | }, # OPTIONAL | ||
| 74 | }, # OPTIONAL | ||
| 75 | Name => 'My__string', # OPTIONAL | ||
| 76 | PersonalizationThresholdSeconds => 1, # OPTIONAL | ||
| 77 | SlateAdUrl => 'My__string', # OPTIONAL | ||
| 78 | Tags => { 'My__string' => 'My__string', }, # OPTIONAL | ||
| 79 | TranscodeProfileName => 'My__string', # OPTIONAL | ||
| 80 | VideoContentSourceUrl => 'My__string', # OPTIONAL | ||
| 81 | ); | ||
| 82 | |||
| 83 | # Results: | ||
| 84 | my $AdDecisionServerUrl = | ||
| 85 | $PutPlaybackConfigurationResponse->AdDecisionServerUrl; | ||
| 86 | my $AvailSuppression = $PutPlaybackConfigurationResponse->AvailSuppression; | ||
| 87 | my $Bumper = $PutPlaybackConfigurationResponse->Bumper; | ||
| 88 | my $CdnConfiguration = $PutPlaybackConfigurationResponse->CdnConfiguration; | ||
| 89 | my $ConfigurationAliases = | ||
| 90 | $PutPlaybackConfigurationResponse->ConfigurationAliases; | ||
| 91 | my $DashConfiguration = | ||
| 92 | $PutPlaybackConfigurationResponse->DashConfiguration; | ||
| 93 | my $HlsConfiguration = $PutPlaybackConfigurationResponse->HlsConfiguration; | ||
| 94 | my $LivePreRollConfiguration = | ||
| 95 | $PutPlaybackConfigurationResponse->LivePreRollConfiguration; | ||
| 96 | my $ManifestProcessingRules = | ||
| 97 | $PutPlaybackConfigurationResponse->ManifestProcessingRules; | ||
| 98 | my $Name = $PutPlaybackConfigurationResponse->Name; | ||
| 99 | my $PersonalizationThresholdSeconds = | ||
| 100 | $PutPlaybackConfigurationResponse->PersonalizationThresholdSeconds; | ||
| 101 | my $PlaybackConfigurationArn = | ||
| 102 | $PutPlaybackConfigurationResponse->PlaybackConfigurationArn; | ||
| 103 | my $PlaybackEndpointPrefix = | ||
| 104 | $PutPlaybackConfigurationResponse->PlaybackEndpointPrefix; | ||
| 105 | my $SessionInitializationEndpointPrefix = | ||
| 106 | $PutPlaybackConfigurationResponse->SessionInitializationEndpointPrefix; | ||
| 107 | my $SlateAdUrl = $PutPlaybackConfigurationResponse->SlateAdUrl; | ||
| 108 | my $Tags = $PutPlaybackConfigurationResponse->Tags; | ||
| 109 | my $TranscodeProfileName = | ||
| 110 | $PutPlaybackConfigurationResponse->TranscodeProfileName; | ||
| 111 | my $VideoContentSourceUrl = | ||
| 112 | $PutPlaybackConfigurationResponse->VideoContentSourceUrl; | ||
| 113 | |||
| 114 | # Returns a L<Paws::MediaTailor::PutPlaybackConfigurationResponse> object. | ||
| 115 | |||
| 116 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 117 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.mediatailor/PutPlaybackConfiguration> | ||
| 118 | |||
| 119 | =head1 ATTRIBUTES | ||
| 120 | |||
| 121 | |||
| 122 | =head2 AdDecisionServerUrl => Str | ||
| 123 | |||
| 124 | The URL for the ad decision server (ADS). This includes the | ||
| 125 | specification of static parameters and placeholders for dynamic | ||
| 126 | parameters. AWS Elemental MediaTailor substitutes player-specific and | ||
| 127 | session-specific parameters as needed when calling the ADS. | ||
| 128 | Alternately, for testing you can provide a static VAST URL. The maximum | ||
| 129 | length is 25,000 characters. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head2 AvailSuppression => L<Paws::MediaTailor::AvailSuppression> | ||
| 134 | |||
| 135 | The configuration for avail suppression, also known as ad suppression. | ||
| 136 | For more information about ad suppression, see Ad Suppression | ||
| 137 | (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html). | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head2 Bumper => L<Paws::MediaTailor::Bumper> | ||
| 142 | |||
| 143 | The configuration for bumpers. Bumpers are short audio or video clips | ||
| 144 | that play at the start or before the end of an ad break. To learn more | ||
| 145 | about bumpers, see Bumpers | ||
| 146 | (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html). | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 CdnConfiguration => L<Paws::MediaTailor::CdnConfiguration> | ||
| 151 | |||
| 152 | The configuration for using a content delivery network (CDN), like | ||
| 153 | Amazon CloudFront, for content and ad segment management. | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | =head2 ConfigurationAliases => L<Paws::MediaTailor::ConfigurationAliasesRequest> | ||
| 158 | |||
| 159 | The player parameters and aliases used as dynamic variables during | ||
| 160 | session initialization. For more information, see Domain Variables | ||
| 161 | (https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html). | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head2 DashConfiguration => L<Paws::MediaTailor::DashConfigurationForPut> | ||
| 166 | |||
| 167 | The configuration for DASH content. | ||
| 168 | |||
| 169 | |||
| 170 | |||
| 171 | =head2 LivePreRollConfiguration => L<Paws::MediaTailor::LivePreRollConfiguration> | ||
| 172 | |||
| 173 | The configuration for pre-roll ad insertion. | ||
| 174 | |||
| 175 | |||
| 176 | |||
| 177 | =head2 ManifestProcessingRules => L<Paws::MediaTailor::ManifestProcessingRules> | ||
| 178 | |||
| 179 | The configuration for manifest processing rules. Manifest processing | ||
| 180 | rules enable customization of the personalized manifests created by | ||
| 181 | MediaTailor. | ||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | =head2 Name => Str | ||
| 186 | |||
| 187 | The identifier for the playback configuration. | ||
| 188 | |||
| 189 | |||
| 190 | |||
| 191 | =head2 PersonalizationThresholdSeconds => Int | ||
| 192 | |||
| 193 | Defines the maximum duration of underfilled ad time (in seconds) | ||
| 194 | allowed in an ad break. If the duration of underfilled ad time exceeds | ||
| 195 | the personalization threshold, then the personalization of the ad break | ||
| 196 | is abandoned and the underlying content is shown. This feature applies | ||
| 197 | to I<ad replacement> in live and VOD streams, rather than ad insertion, | ||
| 198 | because it relies on an underlying content stream. For more information | ||
| 199 | about ad break behavior, including ad replacement and insertion, see Ad | ||
| 200 | Behavior in AWS Elemental MediaTailor | ||
| 201 | (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html). | ||
| 202 | |||
| 203 | |||
| 204 | |||
| 205 | =head2 SlateAdUrl => Str | ||
| 206 | |||
| 207 | The URL for a high-quality video asset to transcode and use to fill in | ||
| 208 | time that's not used by ads. AWS Elemental MediaTailor shows the slate | ||
| 209 | to fill in gaps in media content. Configuring the slate is optional for | ||
| 210 | non-VPAID configurations. For VPAID, the slate is required because | ||
| 211 | MediaTailor provides it in the slots that are designated for dynamic ad | ||
| 212 | content. The slate must be a high-quality asset that contains both | ||
| 213 | audio and video. | ||
| 214 | |||
| 215 | |||
| 216 | |||
| 217 | =head2 Tags => L<Paws::MediaTailor::__mapOf__string> | ||
| 218 | |||
| 219 | The tags to assign to the playback configuration. | ||
| 220 | |||
| 221 | |||
| 222 | |||
| 223 | =head2 TranscodeProfileName => Str | ||
| 224 | |||
| 225 | The name that is used to associate this playback configuration with a | ||
| 226 | custom transcode profile. This overrides the dynamic transcoding | ||
| 227 | defaults of MediaTailor. Use this only if you have already set up | ||
| 228 | custom profiles with the help of AWS Support. | ||
| 229 | |||
| 230 | |||
| 231 | |||
| 232 | =head2 VideoContentSourceUrl => Str | ||
| 233 | |||
| 234 | The URL prefix for the parent manifest for the stream, minus the asset | ||
| 235 | ID. The maximum length is 512 characters. | ||
| 236 | |||
| 237 | |||
| 238 | |||
| 239 | |||
| 240 | =head1 SEE ALSO | ||
| 241 | |||
| 242 | This class forms part of L<Paws>, documenting arguments for method PutPlaybackConfiguration in L<Paws::MediaTailor> | ||
| 243 | |||
| 244 | =head1 BUGS and CONTRIBUTIONS | ||
| 245 | |||
| 246 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 247 | |||
| 248 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 249 | |||
| 250 | =cut | ||
| 251 |