« blib/lib/Paws/MediaTailor/ManifestProcessingRules.pm
↑ Summary
blib/lib/Paws/MediaTailor/PutChannelPolicy.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaTailor::PlaybackConfiguration; | ||
| 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::ConfigurationAliasesResponse'); | ||
| 9 | has DashConfiguration => (is => 'ro', isa => 'Paws::MediaTailor::DashConfiguration'); | ||
| 10 | has HlsConfiguration => (is => 'ro', isa => 'Paws::MediaTailor::HlsConfiguration'); | ||
| 11 | has LivePreRollConfiguration => (is => 'ro', isa => 'Paws::MediaTailor::LivePreRollConfiguration'); | ||
| 12 | has ManifestProcessingRules => (is => 'ro', isa => 'Paws::MediaTailor::ManifestProcessingRules'); | ||
| 13 | has Name => (is => 'ro', isa => 'Str'); | ||
| 14 | has PersonalizationThresholdSeconds => (is => 'ro', isa => 'Int'); | ||
| 15 | has PlaybackConfigurationArn => (is => 'ro', isa => 'Str'); | ||
| 16 | has PlaybackEndpointPrefix => (is => 'ro', isa => 'Str'); | ||
| 17 | has SessionInitializationEndpointPrefix => (is => 'ro', isa => 'Str'); | ||
| 18 | has SlateAdUrl => (is => 'ro', isa => 'Str'); | ||
| 19 | has Tags => (is => 'ro', isa => 'Paws::MediaTailor::__mapOf__string', request_name => 'tags', traits => ['NameInRequest']); | ||
| 20 | has TranscodeProfileName => (is => 'ro', isa => 'Str'); | ||
| 21 | has VideoContentSourceUrl => (is => 'ro', isa => 'Str'); | ||
| 22 | |||
| 23 | 1; | ||
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::MediaTailor::PlaybackConfiguration | ||
| 30 | |||
| 31 | =head1 USAGE | ||
| 32 | |||
| 33 | This class represents one of two things: | ||
| 34 | |||
| 35 | =head3 Arguments in a call to a service | ||
| 36 | |||
| 37 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 38 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 39 | |||
| 40 | As an example, if Att1 is expected to be a Paws::MediaTailor::PlaybackConfiguration object: | ||
| 41 | |||
| 42 | $service_obj->Method(Att1 => { AdDecisionServerUrl => $value, ..., VideoContentSourceUrl => $value }); | ||
| 43 | |||
| 44 | =head3 Results returned from an API call | ||
| 45 | |||
| 46 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaTailor::PlaybackConfiguration object: | ||
| 47 | |||
| 48 | $result = $service_obj->Method(...); | ||
| 49 | $result->Att1->AdDecisionServerUrl | ||
| 50 | |||
| 51 | =head1 DESCRIPTION | ||
| 52 | |||
| 53 | Creates a playback configuration. For information about MediaTailor | ||
| 54 | configurations, see Working with configurations in AWS Elemental | ||
| 55 | MediaTailor | ||
| 56 | (https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html). | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 AdDecisionServerUrl => Str | ||
| 62 | |||
| 63 | The URL for the ad decision server (ADS). This includes the | ||
| 64 | specification of static parameters and placeholders for dynamic | ||
| 65 | parameters. AWS Elemental MediaTailor substitutes player-specific and | ||
| 66 | session-specific parameters as needed when calling the ADS. | ||
| 67 | Alternately, for testing you can provide a static VAST URL. The maximum | ||
| 68 | length is 25,000 characters. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 AvailSuppression => L<Paws::MediaTailor::AvailSuppression> | ||
| 72 | |||
| 73 | The configuration for avail suppression, also known as ad suppression. | ||
| 74 | For more information about ad suppression, see Ad Suppression | ||
| 75 | (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html). | ||
| 76 | |||
| 77 | |||
| 78 | =head2 Bumper => L<Paws::MediaTailor::Bumper> | ||
| 79 | |||
| 80 | The configuration for bumpers. Bumpers are short audio or video clips | ||
| 81 | that play at the start or before the end of an ad break. To learn more | ||
| 82 | about bumpers, see Bumpers | ||
| 83 | (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html). | ||
| 84 | |||
| 85 | |||
| 86 | =head2 CdnConfiguration => L<Paws::MediaTailor::CdnConfiguration> | ||
| 87 | |||
| 88 | The configuration for using a content delivery network (CDN), like | ||
| 89 | Amazon CloudFront, for content and ad segment management. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 ConfigurationAliases => L<Paws::MediaTailor::ConfigurationAliasesResponse> | ||
| 93 | |||
| 94 | The player parameters and aliases used as dynamic variables during | ||
| 95 | session initialization. For more information, see Domain Variables | ||
| 96 | (https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html). | ||
| 97 | |||
| 98 | |||
| 99 | =head2 DashConfiguration => L<Paws::MediaTailor::DashConfiguration> | ||
| 100 | |||
| 101 | The configuration for a DASH source. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 HlsConfiguration => L<Paws::MediaTailor::HlsConfiguration> | ||
| 105 | |||
| 106 | The configuration for HLS content. | ||
| 107 | |||
| 108 | |||
| 109 | =head2 LivePreRollConfiguration => L<Paws::MediaTailor::LivePreRollConfiguration> | ||
| 110 | |||
| 111 | The configuration for pre-roll ad insertion. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 ManifestProcessingRules => L<Paws::MediaTailor::ManifestProcessingRules> | ||
| 115 | |||
| 116 | The configuration for manifest processing rules. Manifest processing | ||
| 117 | rules enable customization of the personalized manifests created by | ||
| 118 | MediaTailor. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 Name => Str | ||
| 122 | |||
| 123 | The identifier for the playback configuration. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 PersonalizationThresholdSeconds => Int | ||
| 127 | |||
| 128 | Defines the maximum duration of underfilled ad time (in seconds) | ||
| 129 | allowed in an ad break. If the duration of underfilled ad time exceeds | ||
| 130 | the personalization threshold, then the personalization of the ad break | ||
| 131 | is abandoned and the underlying content is shown. This feature applies | ||
| 132 | to I<ad replacement> in live and VOD streams, rather than ad insertion, | ||
| 133 | because it relies on an underlying content stream. For more information | ||
| 134 | about ad break behavior, including ad replacement and insertion, see Ad | ||
| 135 | Behavior in AWS Elemental MediaTailor | ||
| 136 | (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html). | ||
| 137 | |||
| 138 | |||
| 139 | =head2 PlaybackConfigurationArn => Str | ||
| 140 | |||
| 141 | The Amazon Resource Name (ARN) for the playback configuration. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 PlaybackEndpointPrefix => Str | ||
| 145 | |||
| 146 | The URL that the player accesses to get a manifest from AWS Elemental | ||
| 147 | MediaTailor. | ||
| 148 | |||
| 149 | |||
| 150 | =head2 SessionInitializationEndpointPrefix => Str | ||
| 151 | |||
| 152 | The URL that the player uses to initialize a session that uses | ||
| 153 | client-side reporting. | ||
| 154 | |||
| 155 | |||
| 156 | =head2 SlateAdUrl => Str | ||
| 157 | |||
| 158 | The URL for a video asset to transcode and use to fill in time that's | ||
| 159 | not used by ads. AWS Elemental MediaTailor shows the slate to fill in | ||
| 160 | gaps in media content. Configuring the slate is optional for non-VPAID | ||
| 161 | playback configurations. For VPAID, the slate is required because | ||
| 162 | MediaTailor provides it in the slots designated for dynamic ad content. | ||
| 163 | The slate must be a high-quality asset that contains both audio and | ||
| 164 | video. | ||
| 165 | |||
| 166 | |||
| 167 | =head2 Tags => L<Paws::MediaTailor::__mapOf__string> | ||
| 168 | |||
| 169 | The tags to assign to the playback configuration. | ||
| 170 | |||
| 171 | |||
| 172 | =head2 TranscodeProfileName => Str | ||
| 173 | |||
| 174 | The name that is used to associate this playback configuration with a | ||
| 175 | custom transcode profile. This overrides the dynamic transcoding | ||
| 176 | defaults of MediaTailor. Use this only if you have already set up | ||
| 177 | custom profiles with the help of AWS Support. | ||
| 178 | |||
| 179 | |||
| 180 | =head2 VideoContentSourceUrl => Str | ||
| 181 | |||
| 182 | The URL prefix for the parent manifest for the stream, minus the asset | ||
| 183 | ID. The maximum length is 512 characters. | ||
| 184 | |||
| 185 | |||
| 186 | |||
| 187 | =head1 SEE ALSO | ||
| 188 | |||
| 189 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaTailor> | ||
| 190 | |||
| 191 | =head1 BUGS and CONTRIBUTIONS | ||
| 192 | |||
| 193 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 194 | |||
| 195 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 196 | |||
| 197 | =cut | ||
| 198 |