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

Class: Aws::MediaPackage::Types::HlsManifestCreateOrUpdateParameters

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 HlsManifestCreateOrUpdateParameters data as a hash:

{
  ad_markers: "NONE", # accepts NONE, SCTE35_ENHANCED, PASSTHROUGH
  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
  id: "__string", # required
  include_iframe_only_stream: false,
  manifest_name: "__string",
  playlist_type: "NONE", # accepts NONE, EVENT, VOD
  playlist_window_seconds: 1,
  program_date_time_interval_seconds: 1,
}

A HTTP Live Streaming (HLS) manifest configuration.

Instance Attribute Summary collapse

Instance Attribute Details

#ad_markersString

This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.

Returns:

  • (String)


1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1399

class HlsManifestCreateOrUpdateParameters < Struct.new(
  :ad_markers,
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :id,
  :include_iframe_only_stream,
  :manifest_name,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds)
  include Aws::Structure
end

#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>)


1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1399

class HlsManifestCreateOrUpdateParameters < Struct.new(
  :ad_markers,
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :id,
  :include_iframe_only_stream,
  :manifest_name,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds)
  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)


1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1399

class HlsManifestCreateOrUpdateParameters < Struct.new(
  :ad_markers,
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :id,
  :include_iframe_only_stream,
  :manifest_name,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds)
  include Aws::Structure
end

#idString

The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.

Returns:

  • (String)


1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1399

class HlsManifestCreateOrUpdateParameters < Struct.new(
  :ad_markers,
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :id,
  :include_iframe_only_stream,
  :manifest_name,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds)
  include Aws::Structure
end

#include_iframe_only_streamBoolean

When enabled, an I-Frame only stream will be included in the output.

Returns:

  • (Boolean)


1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1399

class HlsManifestCreateOrUpdateParameters < Struct.new(
  :ad_markers,
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :id,
  :include_iframe_only_stream,
  :manifest_name,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds)
  include Aws::Structure
end

#manifest_nameString

An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.

Returns:

  • (String)


1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1399

class HlsManifestCreateOrUpdateParameters < Struct.new(
  :ad_markers,
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :id,
  :include_iframe_only_stream,
  :manifest_name,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds)
  include Aws::Structure
end

#playlist_typeString

The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.

Returns:

  • (String)


1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1399

class HlsManifestCreateOrUpdateParameters < Struct.new(
  :ad_markers,
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :id,
  :include_iframe_only_stream,
  :manifest_name,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds)
  include Aws::Structure
end

#playlist_window_secondsInteger

Time window (in seconds) contained in each parent manifest.

Returns:

  • (Integer)


1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1399

class HlsManifestCreateOrUpdateParameters < Struct.new(
  :ad_markers,
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :id,
  :include_iframe_only_stream,
  :manifest_name,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds)
  include Aws::Structure
end

#program_date_time_interval_secondsInteger

The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.

Returns:

  • (Integer)


1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1399

class HlsManifestCreateOrUpdateParameters < Struct.new(
  :ad_markers,
  :ad_triggers,
  :ads_on_delivery_restrictions,
  :id,
  :include_iframe_only_stream,
  :manifest_name,
  :playlist_type,
  :playlist_window_seconds,
  :program_date_time_interval_seconds)
  include Aws::Structure
end