Class: Aws::MediaTailor::Types::PlaybackConfiguration

Inherits:

Struct

Object
Struct
Aws::MediaTailor::Types::PlaybackConfiguration

show all

Includes:: Structure

Defined in:: lib/aws-sdk-mediatailor/types.rb

Overview

A playback configuration. For information about MediaTailor configurations, see [Working with configurations in AWS Elemental MediaTailor].

[1]: docs.aws.amazon.com/mediatailor/latest/ug/configurations.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#ad_decision_server_url ⇒ String

The URL for the ad decision server (ADS).
#avail_suppression ⇒ Types::AvailSuppression

The configuration for avail suppression, also known as ad suppression.
#bumper ⇒ Types::Bumper

The configuration for bumpers.
#cdn_configuration ⇒ Types::CdnConfiguration

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
#configuration_aliases ⇒ Hash<String,Hash<String,String>>

The player parameters and aliases used as dynamic variables during session initialization.
#dash_configuration ⇒ Types::DashConfiguration

The configuration for a DASH source.
#hls_configuration ⇒ Types::HlsConfiguration

The configuration for HLS content.
#insertion_mode ⇒ String

The setting that controls whether players can use stitched or guided ad insertion.
#live_pre_roll_configuration ⇒ Types::LivePreRollConfiguration

The configuration for pre-roll ad insertion.
#log_configuration ⇒ Types::LogConfiguration

The Amazon CloudWatch log settings for a playback configuration.
#manifest_processing_rules ⇒ Types::ManifestProcessingRules

The configuration for manifest processing rules.
#name ⇒ String

The identifier for the playback configuration.
#personalization_threshold_seconds ⇒ Integer

Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.
#playback_configuration_arn ⇒ String

The Amazon Resource Name (ARN) for the playback configuration.
#playback_endpoint_prefix ⇒ String

The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.
#session_initialization_endpoint_prefix ⇒ String

The URL that the player uses to initialize a session that uses client-side reporting.
#slate_ad_url ⇒ String

The URL for a video asset to transcode and use to fill in time that’s not used by ads.
#tags ⇒ Hash<String,String>

The tags to assign to the playback configuration.
#transcode_profile_name ⇒ String

The name that is used to associate this playback configuration with a custom transcode profile.
#video_content_source_url ⇒ String

The URL prefix for the parent manifest for the stream, minus the asset ID.

Instance Attribute Details

#ad_decision_server_url ⇒ `String`

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)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#avail_suppression ⇒ `Types::AvailSuppression`

The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see [Ad Suppression].

[1]: docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html

Returns:

(Types::AvailSuppression)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#bumper ⇒ `Types::Bumper`

The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see [Bumpers].

[1]: docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html

Returns:

(Types::Bumper)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#cdn_configuration ⇒ `Types::CdnConfiguration`

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

Returns:

(Types::CdnConfiguration)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_aliases ⇒ `Hash<String,Hash<String,String>>`

The player parameters and aliases used as dynamic variables during session initialization. For more information, see [Domain Variables].

[1]: docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html

Returns:

(Hash<String,Hash<String,String>>)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#dash_configuration ⇒ `Types::DashConfiguration`

The configuration for a DASH source.

Returns:

(Types::DashConfiguration)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#hls_configuration ⇒ `Types::HlsConfiguration`

The configuration for HLS content.

Returns:

(Types::HlsConfiguration)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#insertion_mode ⇒ `String`

The setting that controls whether players can use stitched or guided ad insertion. The default, ‘STITCHED_ONLY`, forces all player sessions to use stitched (server-side) ad insertion. Choosing `PLAYER_SELECT` allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.

Returns:

(String)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#live_pre_roll_configuration ⇒ `Types::LivePreRollConfiguration`

The configuration for pre-roll ad insertion.

Returns:

(Types::LivePreRollConfiguration)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#log_configuration ⇒ `Types::LogConfiguration`

The Amazon CloudWatch log settings for a playback configuration.

Returns:

(Types::LogConfiguration)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#manifest_processing_rules ⇒ `Types::ManifestProcessingRules`

The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

Returns:

(Types::ManifestProcessingRules)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The identifier for the playback configuration.

Returns:

(String)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#personalization_threshold_seconds ⇒ `Integer`

Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to *ad replacement* in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see [Ad Behavior in AWS Elemental MediaTailor].

[1]: docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html

Returns:

(Integer)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#playback_configuration_arn ⇒ `String`

The Amazon Resource Name (ARN) for the playback configuration.

Returns:

(String)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#playback_endpoint_prefix ⇒ `String`

The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.

Returns:

(String)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#session_initialization_endpoint_prefix ⇒ `String`

The URL that the player uses to initialize a session that uses client-side reporting.

Returns:

(String)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#slate_ad_url ⇒ `String`

The URL for a 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 playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

Returns:

(String)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources].

[1]: docs.aws.amazon.com/mediatailor/latest/ug/tagging.html

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#transcode_profile_name ⇒ `String`

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)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#video_content_source_url ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-mediatailor/types.rb', line 3047

class PlaybackConfiguration < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :insertion_mode,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::MediaTailor::Types::PlaybackConfiguration

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#ad_decision_server_url ⇒ String

#avail_suppression ⇒ Types::AvailSuppression

#bumper ⇒ Types::Bumper

#cdn_configuration ⇒ Types::CdnConfiguration

#configuration_aliases ⇒ Hash<String,Hash<String,String>>

#dash_configuration ⇒ Types::DashConfiguration

#hls_configuration ⇒ Types::HlsConfiguration

#insertion_mode ⇒ String

#live_pre_roll_configuration ⇒ Types::LivePreRollConfiguration

#log_configuration ⇒ Types::LogConfiguration

#manifest_processing_rules ⇒ Types::ManifestProcessingRules

#name ⇒ String

#personalization_threshold_seconds ⇒ Integer

#playback_configuration_arn ⇒ String

#playback_endpoint_prefix ⇒ String

#session_initialization_endpoint_prefix ⇒ String

#slate_ad_url ⇒ String

#tags ⇒ Hash<String,String>

#transcode_profile_name ⇒ String

#video_content_source_url ⇒ String

#ad_decision_server_url ⇒ `String`

#avail_suppression ⇒ `Types::AvailSuppression`

#bumper ⇒ `Types::Bumper`

#cdn_configuration ⇒ `Types::CdnConfiguration`

#configuration_aliases ⇒ `Hash<String,Hash<String,String>>`

#dash_configuration ⇒ `Types::DashConfiguration`

#hls_configuration ⇒ `Types::HlsConfiguration`

#insertion_mode ⇒ `String`

#live_pre_roll_configuration ⇒ `Types::LivePreRollConfiguration`

#log_configuration ⇒ `Types::LogConfiguration`

#manifest_processing_rules ⇒ `Types::ManifestProcessingRules`

#name ⇒ `String`

#personalization_threshold_seconds ⇒ `Integer`

#playback_configuration_arn ⇒ `String`

#playback_endpoint_prefix ⇒ `String`

#session_initialization_endpoint_prefix ⇒ `String`

#slate_ad_url ⇒ `String`

#tags ⇒ `Hash<String,String>`

#transcode_profile_name ⇒ `String`

#video_content_source_url ⇒ `String`