You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MediaTailor::Types::PutPlaybackConfigurationRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb

Overview

Note:

When making an API call, you may pass PutPlaybackConfigurationRequest data as a hash:

{
  ad_decision_server_url: "__string",
  cdn_configuration: {
    ad_segment_url_prefix: "__string",
    content_segment_url_prefix: "__string",
  },
  dash_configuration: {
    mpd_location: "__string",
    origin_manifest_type: "SINGLE_PERIOD", # accepts SINGLE_PERIOD, MULTI_PERIOD
  },
  name: "__string",
  slate_ad_url: "__string",
  tags: {
    "__string" => "__string",
  },
  transcode_profile_name: "__string",
  video_content_source_url: "__string",
}

Instance Attribute Summary collapse

Instance Attribute Details

#ad_decision_server_urlString

The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.

Returns:

  • (String)


475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 475

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :cdn_configuration,
  :dash_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  include Aws::Structure
end

#cdn_configurationTypes::CdnConfiguration

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.



475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 475

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :cdn_configuration,
  :dash_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  include Aws::Structure
end

#dash_configurationTypes::DashConfigurationForPut

The configuration for DASH content.



475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 475

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :cdn_configuration,
  :dash_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  include Aws::Structure
end

#nameString

The identifier for the playback configuration.

Returns:

  • (String)


475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 475

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :cdn_configuration,
  :dash_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  include Aws::Structure
end

#slate_ad_urlString

The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

Returns:

  • (String)


475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 475

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :cdn_configuration,
  :dash_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  include Aws::Structure
end

#tagsHash<String,String>

The tags to assign to the playback configuration.

Returns:

  • (Hash<String,String>)


475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 475

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :cdn_configuration,
  :dash_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  include Aws::Structure
end

#transcode_profile_nameString

The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

Returns:

  • (String)


475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 475

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :cdn_configuration,
  :dash_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  include Aws::Structure
end

#video_content_source_urlString

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

Returns:

  • (String)


475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 475

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :cdn_configuration,
  :dash_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  include Aws::Structure
end