Class: Aws::MediaPackageV2::Types::GetHlsManifestConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::MediaPackageV2::Types::GetHlsManifestConfiguration

Defined in:

gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb

Overview

Retrieve the HTTP live streaming (HLS) manifest configuration.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #child_manifest_name ⇒ String

  A short string that's appended to the endpoint URL.

• #filter_configuration ⇒ Types::FilterConfiguration

  Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

• #manifest_name ⇒ String

  A short short string that's appended to the endpoint URL.

• #manifest_window_seconds ⇒ Integer

  The total duration (in seconds) of the manifest's content.

• #program_date_time_interval_seconds ⇒ Integer

  Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify.

• #scte_hls ⇒ Types::ScteHls

  The SCTE configuration.

• #start_tag ⇒ Types::StartTag

  To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset.

• #url ⇒ String

  The egress domain URL for stream delivery from MediaPackage.

• #url_encode_child_manifest ⇒ Boolean

  When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol.

Instance Attribute Details

#child_manifest_name ⇒ String

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

Returns:

• (String)

# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 2332

class GetHlsManifestConfiguration < Struct.new(
  :manifest_name,
  :url,
  :child_manifest_name,
  :manifest_window_seconds,
  :program_date_time_interval_seconds,
  :scte_hls,
  :filter_configuration,
  :start_tag,
  :url_encode_child_manifest)
  SENSITIVE = []
  include Aws::Structure
end

#filter_configuration ⇒ Types::FilterConfiguration

Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

Returns:

• (Types::FilterConfiguration)

# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 2332

class GetHlsManifestConfiguration < Struct.new(
  :manifest_name,
  :url,
  :child_manifest_name,
  :manifest_window_seconds,
  :program_date_time_interval_seconds,
  :scte_hls,
  :filter_configuration,
  :start_tag,
  :url_encode_child_manifest)
  SENSITIVE = []
  include Aws::Structure
end

#manifest_name ⇒ String

A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

Returns:

• (String)

# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 2332

class GetHlsManifestConfiguration < Struct.new(
  :manifest_name,
  :url,
  :child_manifest_name,
  :manifest_window_seconds,
  :program_date_time_interval_seconds,
  :scte_hls,
  :filter_configuration,
  :start_tag,
  :url_encode_child_manifest)
  SENSITIVE = []
  include Aws::Structure
end

#manifest_window_seconds ⇒ Integer

The total duration (in seconds) of the manifest's content.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 2332

class GetHlsManifestConfiguration < Struct.new(
  :manifest_name,
  :url,
  :child_manifest_name,
  :manifest_window_seconds,
  :program_date_time_interval_seconds,
  :scte_hls,
  :filter_configuration,
  :start_tag,
  :url_encode_child_manifest)
  SENSITIVE = []
  include Aws::Structure
end

#program_date_time_interval_seconds ⇒ Integer

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 2332

class GetHlsManifestConfiguration < Struct.new(
  :manifest_name,
  :url,
  :child_manifest_name,
  :manifest_window_seconds,
  :program_date_time_interval_seconds,
  :scte_hls,
  :filter_configuration,
  :start_tag,
  :url_encode_child_manifest)
  SENSITIVE = []
  include Aws::Structure
end

#scte_hls ⇒ Types::ScteHls

The SCTE configuration.

Returns:

• (Types::ScteHls)

# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 2332

class GetHlsManifestConfiguration < Struct.new(
  :manifest_name,
  :url,
  :child_manifest_name,
  :manifest_window_seconds,
  :program_date_time_interval_seconds,
  :scte_hls,
  :filter_configuration,
  :start_tag,
  :url_encode_child_manifest)
  SENSITIVE = []
  include Aws::Structure
end

#start_tag ⇒ Types::StartTag

To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.

Returns:

• (Types::StartTag)

# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 2332

class GetHlsManifestConfiguration < Struct.new(
  :manifest_name,
  :url,
  :child_manifest_name,
  :manifest_window_seconds,
  :program_date_time_interval_seconds,
  :scte_hls,
  :filter_configuration,
  :start_tag,
  :url_encode_child_manifest)
  SENSITIVE = []
  include Aws::Structure
end

#url ⇒ String

The egress domain URL for stream delivery from MediaPackage.

Returns:

• (String)

# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 2332

class GetHlsManifestConfiguration < Struct.new(
  :manifest_name,
  :url,
  :child_manifest_name,
  :manifest_window_seconds,
  :program_date_time_interval_seconds,
  :scte_hls,
  :filter_configuration,
  :start_tag,
  :url_encode_child_manifest)
  SENSITIVE = []
  include Aws::Structure
end

#url_encode_child_manifest ⇒ Boolean

When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.

Returns:

• (Boolean)

# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 2332

class GetHlsManifestConfiguration < Struct.new(
  :manifest_name,
  :url,
  :child_manifest_name,
  :manifest_window_seconds,
  :program_date_time_interval_seconds,
  :scte_hls,
  :filter_configuration,
  :start_tag,
  :url_encode_child_manifest)
  SENSITIVE = []
  include Aws::Structure
end