Class: AWSCDK::MediaPackagev2::CfnOriginEndpoint::ScteProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_packagev2/cfn_origin_endpoint.rb

Overview

The SCTE-35 configuration associated with the origin endpoint.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(custom_ad_types: nil, scte_filter: nil, scte_in_segments: nil) ⇒ ScteProperty

Returns a new instance of ScteProperty.

Parameters:

  • custom_ad_types (Array<String>, nil) (defaults to: nil) —

    A list of additional non-Ad SCTE-35 event types to treat as advertisements.

  • scte_filter (Array<String>, nil) (defaults to: nil) —

    The filter associated with the SCTE-35 configuration.

  • scte_in_segments (String, nil) (defaults to: nil) —

    Controls whether SCTE-35 messages are included in segment files.



2154
2155
2156
2157
2158
2159
2160
2161
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 2154

def initialize(custom_ad_types: nil, scte_filter: nil, scte_in_segments: nil)
  @custom_ad_types = custom_ad_types
  Jsii::Type.check_type(@custom_ad_types, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "customAdTypes") unless @custom_ad_types.nil?
  @scte_filter = scte_filter
  Jsii::Type.check_type(@scte_filter, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "scteFilter") unless @scte_filter.nil?
  @scte_in_segments = scte_in_segments
  Jsii::Type.check_type(@scte_in_segments, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scteInSegments") unless @scte_in_segments.nil?
end

Instance Attribute Details

#custom_ad_types ⇒ Array<String>? (readonly)

A list of additional non-Ad SCTE-35 event types to treat as advertisements. When configured, events matching these types produce ad markers (such as SCTE35-OUT and SCTE35-IN in HLS DATERANGE tags) in manifests.

Valid values: PROGRAM | CHAPTER | UNSCHEDULED_EVENT | ALTERNATE_CONTENT_OPPORTUNITY | NETWORK

If you don't specify any values, the default is empty (only default ad types are used).

Returns:

  • (Array<String>, nil)

See Also:



2169
2170
2171
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 2169

def custom_ad_types
  @custom_ad_types
end

#scte_filter ⇒ Array<String>? (readonly)

The filter associated with the SCTE-35 configuration.

Returns:

  • (Array<String>, nil)

See Also:



2174
2175
2176
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 2174

def scte_filter
  @scte_filter
end

#scte_in_segments ⇒ String? (readonly)

Controls whether SCTE-35 messages are included in segment files.

  • None – SCTE-35 messages are not included in segments (default)
  • All – SCTE-35 messages are embedded in segment data

For DASH manifests, when set to All , an InbandEventStream tag signals that SCTE messages are present in segments. This setting works independently of manifest ad markers.

Returns:

  • (String, nil)

See Also:



2184
2185
2186
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 2184

def scte_in_segments
  @scte_in_segments
end

Class Method Details

.jsii_properties ⇒ Object 



2186
2187
2188
2189
2190
2191
2192
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 2186

def self.jsii_properties
  {
    :custom_ad_types => "customAdTypes",
    :scte_filter => "scteFilter",
    :scte_in_segments => "scteInSegments",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2194
2195
2196
2197
2198
2199
2200
2201
2202
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 2194

def to_jsii
  result = {}
  result.merge!({
    "customAdTypes" => @custom_ad_types,
    "scteFilter" => @scte_filter,
    "scteInSegments" => @scte_in_segments,
  })
  result.compact
end