Class: Aws::MediaPackage::Types::DashPackage

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

Overview

Note:

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

{
  ad_triggers: ["SPLICE_INSERT"], # accepts SPLICE_INSERT, BREAK, PROVIDER_ADVERTISEMENT, DISTRIBUTOR_ADVERTISEMENT, PROVIDER_PLACEMENT_OPPORTUNITY, DISTRIBUTOR_PLACEMENT_OPPORTUNITY, PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY, DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY
  ads_on_delivery_restrictions: "NONE", # accepts NONE, RESTRICTED, UNRESTRICTED, BOTH
  encryption: {
    key_rotation_interval_seconds: 1,
    speke_key_provider: { # required
      certificate_arn: "__string",
      resource_id: "__string", # required
      role_arn: "__string", # required
      system_ids: ["__string"], # required
      url: "__string", # required
    },
  },
  manifest_layout: "FULL", # accepts FULL, COMPACT
  manifest_window_seconds: 1,
  min_buffer_time_seconds: 1,
  min_update_period_seconds: 1,
  period_triggers: ["ADS"], # accepts ADS
  profile: "NONE", # accepts NONE, HBBTV_1_5
  segment_duration_seconds: 1,
  segment_template_format: "NUMBER_WITH_TIMELINE", # accepts NUMBER_WITH_TIMELINE, TIME_WITH_TIMELINE, NUMBER_WITH_DURATION
  stream_selection: {
    max_video_bits_per_second: 1,
    min_video_bits_per_second: 1,
    stream_order: "ORIGINAL", # accepts ORIGINAL, VIDEO_BITRATE_ASCENDING, VIDEO_BITRATE_DESCENDING
  },
  suggested_presentation_delay_seconds: 1,
  utc_timing: "NONE", # accepts NONE, HTTP-HEAD, HTTP-ISO
  utc_timing_uri: "__string",
}

A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ad_triggersArray<String>

A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.

Returns:

  • (Array<String>)


987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 987

class DashPackage < Struct.new(
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :encryption,
  :manifest_layout,
  :manifest_window_seconds,
  :min_buffer_time_seconds,
  :min_update_period_seconds,
  :period_triggers,
  :profile,
  :segment_duration_seconds,
  :segment_template_format,
  :stream_selection,
  :suggested_presentation_delay_seconds,
  :utc_timing,
  :utc_timing_uri)
  SENSITIVE = []
  include Aws::Structure
end

#ads_on_delivery_restrictionsString

This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.

Returns:

  • (String)


987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 987

class DashPackage < Struct.new(
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :encryption,
  :manifest_layout,
  :manifest_window_seconds,
  :min_buffer_time_seconds,
  :min_update_period_seconds,
  :period_triggers,
  :profile,
  :segment_duration_seconds,
  :segment_template_format,
  :stream_selection,
  :suggested_presentation_delay_seconds,
  :utc_timing,
  :utc_timing_uri)
  SENSITIVE = []
  include Aws::Structure
end

#encryptionTypes::DashEncryption

A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.



987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 987

class DashPackage < Struct.new(
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :encryption,
  :manifest_layout,
  :manifest_window_seconds,
  :min_buffer_time_seconds,
  :min_update_period_seconds,
  :period_triggers,
  :profile,
  :segment_duration_seconds,
  :segment_template_format,
  :stream_selection,
  :suggested_presentation_delay_seconds,
  :utc_timing,
  :utc_timing_uri)
  SENSITIVE = []
  include Aws::Structure
end

#manifest_layoutString

Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.

Returns:

  • (String)


987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 987

class DashPackage < Struct.new(
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :encryption,
  :manifest_layout,
  :manifest_window_seconds,
  :min_buffer_time_seconds,
  :min_update_period_seconds,
  :period_triggers,
  :profile,
  :segment_duration_seconds,
  :segment_template_format,
  :stream_selection,
  :suggested_presentation_delay_seconds,
  :utc_timing,
  :utc_timing_uri)
  SENSITIVE = []
  include Aws::Structure
end

#manifest_window_secondsInteger

Time window (in seconds) contained in each manifest.

Returns:

  • (Integer)


987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 987

class DashPackage < Struct.new(
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :encryption,
  :manifest_layout,
  :manifest_window_seconds,
  :min_buffer_time_seconds,
  :min_update_period_seconds,
  :period_triggers,
  :profile,
  :segment_duration_seconds,
  :segment_template_format,
  :stream_selection,
  :suggested_presentation_delay_seconds,
  :utc_timing,
  :utc_timing_uri)
  SENSITIVE = []
  include Aws::Structure
end

#min_buffer_time_secondsInteger

Minimum duration (in seconds) that a player will buffer media before starting the presentation.

Returns:

  • (Integer)


987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 987

class DashPackage < Struct.new(
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :encryption,
  :manifest_layout,
  :manifest_window_seconds,
  :min_buffer_time_seconds,
  :min_update_period_seconds,
  :period_triggers,
  :profile,
  :segment_duration_seconds,
  :segment_template_format,
  :stream_selection,
  :suggested_presentation_delay_seconds,
  :utc_timing,
  :utc_timing_uri)
  SENSITIVE = []
  include Aws::Structure
end

#min_update_period_secondsInteger

Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).

Returns:

  • (Integer)


987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 987

class DashPackage < Struct.new(
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :encryption,
  :manifest_layout,
  :manifest_window_seconds,
  :min_buffer_time_seconds,
  :min_update_period_seconds,
  :period_triggers,
  :profile,
  :segment_duration_seconds,
  :segment_template_format,
  :stream_selection,
  :suggested_presentation_delay_seconds,
  :utc_timing,
  :utc_timing_uri)
  SENSITIVE = []
  include Aws::Structure
end

#period_triggersArray<String>

A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.

Returns:

  • (Array<String>)


987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 987

class DashPackage < Struct.new(
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :encryption,
  :manifest_layout,
  :manifest_window_seconds,
  :min_buffer_time_seconds,
  :min_update_period_seconds,
  :period_triggers,
  :profile,
  :segment_duration_seconds,
  :segment_template_format,
  :stream_selection,
  :suggested_presentation_delay_seconds,
  :utc_timing,
  :utc_timing_uri)
  SENSITIVE = []
  include Aws::Structure
end

#profileString

The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled.

Returns:

  • (String)


987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 987

class DashPackage < Struct.new(
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :encryption,
  :manifest_layout,
  :manifest_window_seconds,
  :min_buffer_time_seconds,
  :min_update_period_seconds,
  :period_triggers,
  :profile,
  :segment_duration_seconds,
  :segment_template_format,
  :stream_selection,
  :suggested_presentation_delay_seconds,
  :utc_timing,
  :utc_timing_uri)
  SENSITIVE = []
  include Aws::Structure
end

#segment_duration_secondsInteger

Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.

Returns:

  • (Integer)


987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 987

class DashPackage < Struct.new(
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :encryption,
  :manifest_layout,
  :manifest_window_seconds,
  :min_buffer_time_seconds,
  :min_update_period_seconds,
  :period_triggers,
  :profile,
  :segment_duration_seconds,
  :segment_template_format,
  :stream_selection,
  :suggested_presentation_delay_seconds,
  :utc_timing,
  :utc_timing_uri)
  SENSITIVE = []
  include Aws::Structure
end

#segment_template_formatString

Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.

Returns:

  • (String)


987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 987

class DashPackage < Struct.new(
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :encryption,
  :manifest_layout,
  :manifest_window_seconds,
  :min_buffer_time_seconds,
  :min_update_period_seconds,
  :period_triggers,
  :profile,
  :segment_duration_seconds,
  :segment_template_format,
  :stream_selection,
  :suggested_presentation_delay_seconds,
  :utc_timing,
  :utc_timing_uri)
  SENSITIVE = []
  include Aws::Structure
end

#stream_selectionTypes::StreamSelection

A StreamSelection configuration.



987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 987

class DashPackage < Struct.new(
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :encryption,
  :manifest_layout,
  :manifest_window_seconds,
  :min_buffer_time_seconds,
  :min_update_period_seconds,
  :period_triggers,
  :profile,
  :segment_duration_seconds,
  :segment_template_format,
  :stream_selection,
  :suggested_presentation_delay_seconds,
  :utc_timing,
  :utc_timing_uri)
  SENSITIVE = []
  include Aws::Structure
end

#suggested_presentation_delay_secondsInteger

Duration (in seconds) to delay live content before presentation.

Returns:

  • (Integer)


987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 987

class DashPackage < Struct.new(
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :encryption,
  :manifest_layout,
  :manifest_window_seconds,
  :min_buffer_time_seconds,
  :min_update_period_seconds,
  :period_triggers,
  :profile,
  :segment_duration_seconds,
  :segment_template_format,
  :stream_selection,
  :suggested_presentation_delay_seconds,
  :utc_timing,
  :utc_timing_uri)
  SENSITIVE = []
  include Aws::Structure
end

#utc_timingString

Determines the type of UTCTiming included in the Media Presentation Description (MPD)

Returns:

  • (String)


987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 987

class DashPackage < Struct.new(
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :encryption,
  :manifest_layout,
  :manifest_window_seconds,
  :min_buffer_time_seconds,
  :min_update_period_seconds,
  :period_triggers,
  :profile,
  :segment_duration_seconds,
  :segment_template_format,
  :stream_selection,
  :suggested_presentation_delay_seconds,
  :utc_timing,
  :utc_timing_uri)
  SENSITIVE = []
  include Aws::Structure
end

#utc_timing_uriString

Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO or HTTP-HEAD

Returns:

  • (String)


987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 987

class DashPackage < Struct.new(
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :encryption,
  :manifest_layout,
  :manifest_window_seconds,
  :min_buffer_time_seconds,
  :min_update_period_seconds,
  :period_triggers,
  :profile,
  :segment_duration_seconds,
  :segment_template_format,
  :stream_selection,
  :suggested_presentation_delay_seconds,
  :utc_timing,
  :utc_timing_uri)
  SENSITIVE = []
  include Aws::Structure
end