Class: AWSCDK::MediaLive::CfnChannel::HlsGroupSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_live/cfn_channel.rb

Overview

The settings for an HLS output group.

The parent of this entity is OutputGroupSettings.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ad_markers: nil, base_url_content: nil, base_url_content1: nil, base_url_manifest: nil, base_url_manifest1: nil, caption_language_mappings: nil, caption_language_setting: nil, client_cache: nil, codec_specification: nil, constant_iv: nil, destination: nil, directory_structure: nil, discontinuity_tags: nil, encryption_type: nil, hls_cdn_settings: nil, hls_id3_segment_tagging: nil, i_frame_only_playlists: nil, incomplete_segment_behavior: nil, index_n_segments: nil, input_loss_action: nil, iv_in_manifest: nil, iv_source: nil, keep_segments: nil, key_format: nil, key_format_versions: nil, key_provider_settings: nil, manifest_compression: nil, manifest_duration_format: nil, min_segment_length: nil, mode: nil, output_selection: nil, program_date_time: nil, program_date_time_clock: nil, program_date_time_period: nil, redundant_manifest: nil, segmentation_mode: nil, segment_length: nil, segments_per_subdirectory: nil, stream_inf_resolution: nil, timed_metadata_id3_frame: nil, timed_metadata_id3_period: nil, timestamp_delta_milliseconds: nil, ts_file_mode: nil) ⇒ HlsGroupSettingsProperty

Returns a new instance of HlsGroupSettingsProperty.

Parameters:

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

    Chooses one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.

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

    A partial URI prefix that will be prepended to each output in the media .m3u8 file. The partial URI prefix can be used if the base manifest is delivered from a different URL than the main .m3u8 file.

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

    Optional.

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

    A partial URI prefix that will be prepended to each output in the media .m3u8 file. The partial URI prefix can be used if the base manifest is delivered from a different URL than the main .m3u8 file.

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

    Optional.

  • caption_language_mappings (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::MediaLive::CfnChannel::CaptionLanguageMappingProperty>, nil) (defaults to: nil) —

    A mapping of up to 4 captions channels to captions languages.

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

    Applies only to 608 embedded output captions.

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

    When set to "disabled," sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.

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

    The specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

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

    Used with encryptionType.

  • destination (AWSCDK::IResolvable, AWSCDK::MediaLive::CfnChannel::OutputLocationRefProperty, nil) (defaults to: nil) —

    A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).

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

    Places segments in subdirectories.

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

    Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group.

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

    Encrypts the segments with the specified encryption scheme.

  • hls_cdn_settings (AWSCDK::IResolvable, AWSCDK::MediaLive::CfnChannel::HlsCdnSettingsProperty, nil) (defaults to: nil) —

    The parameters that control interactions with the CDN.

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

    State of HLS ID3 Segment Tagging.

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

    DISABLED: Don't create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).

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

    Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline.

  • index_n_segments (Numeric, nil) (defaults to: nil) —

    Applies only if the Mode field is LIVE.

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

    A parameter that controls output group behavior on an input loss.

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

    Used with encryptionType.

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

    Used with encryptionType.

  • keep_segments (Numeric, nil) (defaults to: nil) —

    Applies only if the Mode field is LIVE.

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

    Specifies how the key is represented in the resource identified by the URI.

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

    Either a single positive integer version value or a slash-delimited list of version values (1/2/3).

  • key_provider_settings (AWSCDK::IResolvable, AWSCDK::MediaLive::CfnChannel::KeyProviderSettingsProperty, nil) (defaults to: nil) —

    The key provider settings.

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

    When set to gzip, compresses HLS playlist.

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

    Indicates whether the output manifest should use a floating point or integer values for segment duration.

  • min_segment_length (Numeric, nil) (defaults to: nil) —

    When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.

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

    If "vod," all segments are indexed and kept permanently in the destination and manifest.

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

    MANIFESTSANDSEGMENTS: Generates manifests (the master manifest, if applicable, and media manifests) for this output group.

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

    Includes or excludes the EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: Either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.

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

    Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock.

  • program_date_time_period (Numeric, nil) (defaults to: nil) —

    The period of insertion of the EXT-X-PROGRAM-DATE-TIME entry, in seconds.

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

    ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows a playout device that supports stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players, so a redundant manifest from MediaLive is irrelevant.

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

    useInputSegmentation has been deprecated.

  • segment_length (Numeric, nil) (defaults to: nil) —

    The length of the MPEG-2 Transport Stream segments to create, in seconds.

  • segments_per_subdirectory (Numeric, nil) (defaults to: nil) —

    The number of segments to write to a subdirectory before starting a new one.

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

    The include or exclude RESOLUTION attribute for a video in the EXT-X-STREAM-INF tag of a variant manifest.

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

    Indicates the ID3 frame that has the timecode.

  • timed_metadata_id3_period (Numeric, nil) (defaults to: nil) —

    The timed metadata interval, in seconds.

  • timestamp_delta_milliseconds (Numeric, nil) (defaults to: nil) —

    Provides an extra millisecond delta offset to fine tune the timestamps.

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

    SEGMENTEDFILES: Emits the program as segments -multiple .ts media files. SINGLEFILE: Applies only if the Mode field is VOD. Emits the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.



7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
 
# File 'media_live/cfn_channel.rb', line 7637

def initialize(ad_markers: nil, base_url_content: nil, base_url_content1: nil, base_url_manifest: nil, base_url_manifest1: nil, caption_language_mappings: nil, caption_language_setting: nil, client_cache: nil, codec_specification: nil, constant_iv: nil, destination: nil, directory_structure: nil, discontinuity_tags: nil, encryption_type: nil, hls_cdn_settings: nil, hls_id3_segment_tagging: nil, i_frame_only_playlists: nil, incomplete_segment_behavior: nil, index_n_segments: nil, input_loss_action: nil, iv_in_manifest: nil, iv_source: nil, keep_segments: nil, key_format: nil, key_format_versions: nil, key_provider_settings: nil, manifest_compression: nil, manifest_duration_format: nil, min_segment_length: nil, mode: nil, output_selection: nil, program_date_time: nil, program_date_time_clock: nil, program_date_time_period: nil, redundant_manifest: nil, segmentation_mode: nil, segment_length: nil, segments_per_subdirectory: nil, stream_inf_resolution: nil, timed_metadata_id3_frame: nil, timed_metadata_id3_period: nil, timestamp_delta_milliseconds: nil, ts_file_mode: nil)
  @ad_markers = ad_markers
  Jsii::Type.check_type(@ad_markers, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "adMarkers") unless @ad_markers.nil?
  @base_url_content = base_url_content
  Jsii::Type.check_type(@base_url_content, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "baseUrlContent") unless @base_url_content.nil?
  @base_url_content1 = base_url_content1
  Jsii::Type.check_type(@base_url_content1, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "baseUrlContent1") unless @base_url_content1.nil?
  @base_url_manifest = base_url_manifest
  Jsii::Type.check_type(@base_url_manifest, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "baseUrlManifest") unless @base_url_manifest.nil?
  @base_url_manifest1 = base_url_manifest1
  Jsii::Type.check_type(@base_url_manifest1, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "baseUrlManifest1") unless @base_url_manifest1.nil?
  @caption_language_mappings = caption_language_mappings
  Jsii::Type.check_type(@caption_language_mappings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFsaXZlLkNmbkNoYW5uZWwuQ2FwdGlvbkxhbmd1YWdlTWFwcGluZ1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "captionLanguageMappings") unless @caption_language_mappings.nil?
  @caption_language_setting = caption_language_setting
  Jsii::Type.check_type(@caption_language_setting, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "captionLanguageSetting") unless @caption_language_setting.nil?
  @client_cache = client_cache
  Jsii::Type.check_type(@client_cache, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientCache") unless @client_cache.nil?
  @codec_specification = codec_specification
  Jsii::Type.check_type(@codec_specification, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "codecSpecification") unless @codec_specification.nil?
  @constant_iv = constant_iv
  Jsii::Type.check_type(@constant_iv, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "constantIv") unless @constant_iv.nil?
  @destination = destination.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::OutputLocationRefProperty.new(**destination.transform_keys(&:to_sym)) : destination
  Jsii::Type.check_type(@destination, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5PdXRwdXRMb2NhdGlvblJlZlByb3BlcnR5In1dfX0=")), "destination") unless @destination.nil?
  @directory_structure = directory_structure
  Jsii::Type.check_type(@directory_structure, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "directoryStructure") unless @directory_structure.nil?
  @discontinuity_tags = discontinuity_tags
  Jsii::Type.check_type(@discontinuity_tags, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "discontinuityTags") unless @discontinuity_tags.nil?
  @encryption_type = encryption_type
  Jsii::Type.check_type(@encryption_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "encryptionType") unless @encryption_type.nil?
  @hls_cdn_settings = hls_cdn_settings.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::HlsCdnSettingsProperty.new(**hls_cdn_settings.transform_keys(&:to_sym)) : hls_cdn_settings
  Jsii::Type.check_type(@hls_cdn_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5IbHNDZG5TZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "hlsCdnSettings") unless @hls_cdn_settings.nil?
  @hls_id3_segment_tagging = hls_id3_segment_tagging
  Jsii::Type.check_type(@hls_id3_segment_tagging, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hlsId3SegmentTagging") unless @hls_id3_segment_tagging.nil?
  @i_frame_only_playlists = i_frame_only_playlists
  Jsii::Type.check_type(@i_frame_only_playlists, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "iFrameOnlyPlaylists") unless @i_frame_only_playlists.nil?
  @incomplete_segment_behavior = incomplete_segment_behavior
  Jsii::Type.check_type(@incomplete_segment_behavior, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "incompleteSegmentBehavior") unless @incomplete_segment_behavior.nil?
  @index_n_segments = index_n_segments
  Jsii::Type.check_type(@index_n_segments, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "indexNSegments") unless @index_n_segments.nil?
  @input_loss_action = input_loss_action
  Jsii::Type.check_type(@input_loss_action, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputLossAction") unless @input_loss_action.nil?
  @iv_in_manifest = iv_in_manifest
  Jsii::Type.check_type(@iv_in_manifest, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ivInManifest") unless @iv_in_manifest.nil?
  @iv_source = iv_source
  Jsii::Type.check_type(@iv_source, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ivSource") unless @iv_source.nil?
  @keep_segments = keep_segments
  Jsii::Type.check_type(@keep_segments, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "keepSegments") unless @keep_segments.nil?
  @key_format = key_format
  Jsii::Type.check_type(@key_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyFormat") unless @key_format.nil?
  @key_format_versions = key_format_versions
  Jsii::Type.check_type(@key_format_versions, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyFormatVersions") unless @key_format_versions.nil?
  @key_provider_settings = key_provider_settings.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::KeyProviderSettingsProperty.new(**key_provider_settings.transform_keys(&:to_sym)) : key_provider_settings
  Jsii::Type.check_type(@key_provider_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5LZXlQcm92aWRlclNldHRpbmdzUHJvcGVydHkifV19fQ==")), "keyProviderSettings") unless @key_provider_settings.nil?
  @manifest_compression = manifest_compression
  Jsii::Type.check_type(@manifest_compression, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "manifestCompression") unless @manifest_compression.nil?
  @manifest_duration_format = manifest_duration_format
  Jsii::Type.check_type(@manifest_duration_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "manifestDurationFormat") unless @manifest_duration_format.nil?
  @min_segment_length = min_segment_length
  Jsii::Type.check_type(@min_segment_length, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minSegmentLength") unless @min_segment_length.nil?
  @mode = mode
  Jsii::Type.check_type(@mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mode") unless @mode.nil?
  @output_selection = output_selection
  Jsii::Type.check_type(@output_selection, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputSelection") unless @output_selection.nil?
  @program_date_time = program_date_time
  Jsii::Type.check_type(@program_date_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "programDateTime") unless @program_date_time.nil?
  @program_date_time_clock = program_date_time_clock
  Jsii::Type.check_type(@program_date_time_clock, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "programDateTimeClock") unless @program_date_time_clock.nil?
  @program_date_time_period = program_date_time_period
  Jsii::Type.check_type(@program_date_time_period, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "programDateTimePeriod") unless @program_date_time_period.nil?
  @redundant_manifest = redundant_manifest
  Jsii::Type.check_type(@redundant_manifest, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "redundantManifest") unless @redundant_manifest.nil?
  @segmentation_mode = segmentation_mode
  Jsii::Type.check_type(@segmentation_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "segmentationMode") unless @segmentation_mode.nil?
  @segment_length = segment_length
  Jsii::Type.check_type(@segment_length, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "segmentLength") unless @segment_length.nil?
  @segments_per_subdirectory = segments_per_subdirectory
  Jsii::Type.check_type(@segments_per_subdirectory, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "segmentsPerSubdirectory") unless @segments_per_subdirectory.nil?
  @stream_inf_resolution = stream_inf_resolution
  Jsii::Type.check_type(@stream_inf_resolution, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "streamInfResolution") unless @stream_inf_resolution.nil?
  @timed_metadata_id3_frame = timed_metadata_id3_frame
  Jsii::Type.check_type(@timed_metadata_id3_frame, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timedMetadataId3Frame") unless @timed_metadata_id3_frame.nil?
  @timed_metadata_id3_period = timed_metadata_id3_period
  Jsii::Type.check_type(@timed_metadata_id3_period, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "timedMetadataId3Period") unless @timed_metadata_id3_period.nil?
  @timestamp_delta_milliseconds = timestamp_delta_milliseconds
  Jsii::Type.check_type(@timestamp_delta_milliseconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "timestampDeltaMilliseconds") unless @timestamp_delta_milliseconds.nil?
  @ts_file_mode = ts_file_mode
  Jsii::Type.check_type(@ts_file_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tsFileMode") unless @ts_file_mode.nil?
end

Instance Attribute Details

#ad_markers ⇒ Array<String>? (readonly)

Chooses one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.

Returns:

  • (Array<String>, nil)

See Also:



7730
7731
7732
 
# File 'media_live/cfn_channel.rb', line 7730

def ad_markers
  @ad_markers
end

#base_url_content ⇒ String? (readonly)

A partial URI prefix that will be prepended to each output in the media .m3u8 file. The partial URI prefix can be used if the base manifest is delivered from a different URL than the main .m3u8 file.

Returns:

  • (String, nil)

See Also:



7735
7736
7737
 
# File 'media_live/cfn_channel.rb', line 7735

def base_url_content
  @base_url_content
end

#base_url_content1 ⇒ String? (readonly)

Optional.

One value per output group. This field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0.

Returns:

  • (String, nil)

See Also:



7742
7743
7744
 
# File 'media_live/cfn_channel.rb', line 7742

def base_url_content1
  @base_url_content1
end

#base_url_manifest ⇒ String? (readonly)

A partial URI prefix that will be prepended to each output in the media .m3u8 file. The partial URI prefix can be used if the base manifest is delivered from a different URL than the main .m3u8 file.

Returns:

  • (String, nil)

See Also:



7747
7748
7749
 
# File 'media_live/cfn_channel.rb', line 7747

def base_url_manifest
  @base_url_manifest
end

#base_url_manifest1 ⇒ String? (readonly)

Optional.

One value per output group. Complete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0.

Returns:

  • (String, nil)

See Also:



7754
7755
7756
 
# File 'media_live/cfn_channel.rb', line 7754

def base_url_manifest1
  @base_url_manifest1
end

#caption_language_mappings ⇒ AWSCDK::IResolvable, ... (readonly)

A mapping of up to 4 captions channels to captions languages.

This is meaningful only if captionLanguageSetting is set to "insert."

Returns:

See Also:



7761
7762
7763
 
# File 'media_live/cfn_channel.rb', line 7761

def caption_language_mappings
  @caption_language_mappings
end

#caption_language_setting ⇒ String? (readonly)

Applies only to 608 embedded output captions.

Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code that you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the captions selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match properly with the output captions. None: Include the CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.

Returns:

  • (String, nil)

See Also:



7768
7769
7770
 
# File 'media_live/cfn_channel.rb', line 7768

def caption_language_setting
  @caption_language_setting
end

#client_cache ⇒ String? (readonly)

When set to "disabled," sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.

Returns:

  • (String, nil)

See Also:



7773
7774
7775
 
# File 'media_live/cfn_channel.rb', line 7773

def client_cache
  @client_cache
end

#codec_specification ⇒ String? (readonly)

The specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

Returns:

  • (String, nil)

See Also:



7778
7779
7780
 
# File 'media_live/cfn_channel.rb', line 7778

def codec_specification
  @codec_specification
end

#constant_iv ⇒ String? (readonly)

Used with encryptionType.

This is a 128-bit, 16-byte hex value that is represented by a 32-character text string. If ivSource is set to "explicit," this parameter is required and is used as the IV for encryption.

Returns:

  • (String, nil)

See Also:



7785
7786
7787
 
# File 'media_live/cfn_channel.rb', line 7785

def constant_iv
  @constant_iv
end

#destination ⇒ AWSCDK::IResolvable, ... (readonly)

A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).

Returns:

See Also:



7790
7791
7792
 
# File 'media_live/cfn_channel.rb', line 7790

def destination
  @destination
end

#directory_structure ⇒ String? (readonly)

Places segments in subdirectories.

Returns:

  • (String, nil)

See Also:



7795
7796
7797
 
# File 'media_live/cfn_channel.rb', line 7795

def directory_structure
  @directory_structure
end

#discontinuity_tags ⇒ String? (readonly)

Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group.

Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose. Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags.

Returns:

  • (String, nil)

See Also:



7803
7804
7805
 
# File 'media_live/cfn_channel.rb', line 7803

def discontinuity_tags
  @discontinuity_tags
end

#encryption_type ⇒ String? (readonly)

Encrypts the segments with the specified encryption scheme.

Exclude this parameter if you don't want encryption.

Returns:

  • (String, nil)

See Also:



7810
7811
7812
 
# File 'media_live/cfn_channel.rb', line 7810

def encryption_type
  @encryption_type
end

#hls_cdn_settings ⇒ AWSCDK::IResolvable, ... (readonly)

The parameters that control interactions with the CDN.

Returns:

See Also:



7815
7816
7817
 
# File 'media_live/cfn_channel.rb', line 7815

def hls_cdn_settings
  @hls_cdn_settings
end

#hls_id3_segment_tagging ⇒ String? (readonly)

State of HLS ID3 Segment Tagging.

Returns:

  • (String, nil)

See Also:



7820
7821
7822
 
# File 'media_live/cfn_channel.rb', line 7820

def hls_id3_segment_tagging
  @hls_id3_segment_tagging
end

#i_frame_only_playlists ⇒ String? (readonly)

DISABLED: Don't create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).

STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888".

Returns:

  • (String, nil)

See Also:



7827
7828
7829
 
# File 'media_live/cfn_channel.rb', line 7827

def i_frame_only_playlists
  @i_frame_only_playlists
end

#incomplete_segment_behavior ⇒ String? (readonly)

Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline.

Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups. Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior.

Returns:

  • (String, nil)

See Also:



7835
7836
7837
 
# File 'media_live/cfn_channel.rb', line 7835

def incomplete_segment_behavior
  @incomplete_segment_behavior
end

#index_n_segments ⇒ Numeric? (readonly)

Applies only if the Mode field is LIVE.

Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.

Returns:

  • (Numeric, nil)

See Also:



7842
7843
7844
 
# File 'media_live/cfn_channel.rb', line 7842

def index_n_segments
  @index_n_segments
end

#input_loss_action ⇒ String? (readonly)

A parameter that controls output group behavior on an input loss.

Returns:

  • (String, nil)

See Also:



7847
7848
7849
 
# File 'media_live/cfn_channel.rb', line 7847

def input_loss_action
  @input_loss_action
end

#iv_in_manifest ⇒ String? (readonly)

Used with encryptionType.

The IV (initialization vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include," the IV is listed in the manifest. Otherwise, the IV is not in the manifest.

Returns:

  • (String, nil)

See Also:



7854
7855
7856
 
# File 'media_live/cfn_channel.rb', line 7854

def iv_in_manifest
  @iv_in_manifest
end

#iv_source ⇒ String? (readonly)

Used with encryptionType.

The IV (initialization vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber," it causes the IV to change every segment (to match the segment number). If this is set to "explicit," you must enter a constantIv value.

Returns:

  • (String, nil)

See Also:



7861
7862
7863
 
# File 'media_live/cfn_channel.rb', line 7861

def iv_source
  @iv_source
end

#keep_segments ⇒ Numeric? (readonly)

Applies only if the Mode field is LIVE.

Specifies the number of media segments (.ts files) to retain in the destination directory.

Returns:

  • (Numeric, nil)

See Also:



7868
7869
7870
 
# File 'media_live/cfn_channel.rb', line 7868

def keep_segments
  @keep_segments
end

#key_format ⇒ String? (readonly)

Specifies how the key is represented in the resource identified by the URI.

If the parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be specified.

Returns:

  • (String, nil)

See Also:



7875
7876
7877
 
# File 'media_live/cfn_channel.rb', line 7875

def key_format
  @key_format
end

#key_format_versions ⇒ String? (readonly)

Either a single positive integer version value or a slash-delimited list of version values (1/2/3).

Returns:

  • (String, nil)

See Also:



7880
7881
7882
 
# File 'media_live/cfn_channel.rb', line 7880

def key_format_versions
  @key_format_versions
end

#key_provider_settings ⇒ AWSCDK::IResolvable, ... (readonly)

The key provider settings.

Returns:

See Also:



7885
7886
7887
 
# File 'media_live/cfn_channel.rb', line 7885

def key_provider_settings
  @key_provider_settings
end

#manifest_compression ⇒ String? (readonly)

When set to gzip, compresses HLS playlist.

Returns:

  • (String, nil)

See Also:



7890
7891
7892
 
# File 'media_live/cfn_channel.rb', line 7890

def manifest_compression
  @manifest_compression
end

#manifest_duration_format ⇒ String? (readonly)

Indicates whether the output manifest should use a floating point or integer values for segment duration.

Returns:

  • (String, nil)

See Also:



7895
7896
7897
 
# File 'media_live/cfn_channel.rb', line 7895

def manifest_duration_format
  @manifest_duration_format
end

#min_segment_length ⇒ Numeric? (readonly)

When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.

Returns:

  • (Numeric, nil)

See Also:



7900
7901
7902
 
# File 'media_live/cfn_channel.rb', line 7900

def min_segment_length
  @min_segment_length
end

#mode ⇒ String? (readonly)

If "vod," all segments are indexed and kept permanently in the destination and manifest.

If "live," only the number segments specified in keepSegments and indexNSegments are kept. Newer segments replace older segments, which might prevent players from rewinding all the way to the beginning of the channel. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.

Returns:

  • (String, nil)

See Also:



7907
7908
7909
 
# File 'media_live/cfn_channel.rb', line 7907

def mode
  @mode
end

#output_selection ⇒ String? (readonly)

MANIFESTSANDSEGMENTS: Generates manifests (the master manifest, if applicable, and media manifests) for this output group.

SEGMENTSONLY: Doesn't generate any manifests for this output group.

Returns:

  • (String, nil)

See Also:



7914
7915
7916
 
# File 'media_live/cfn_channel.rb', line 7914

def output_selection
  @output_selection
end

#program_date_time ⇒ String? (readonly)

Includes or excludes the EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: Either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.

Returns:

  • (String, nil)

See Also:



7919
7920
7921
 
# File 'media_live/cfn_channel.rb', line 7919

def program_date_time
  @program_date_time
end

#program_date_time_clock ⇒ String? (readonly)

Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock.

Options include: INITIALIZE_FROM_OUTPUT_TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment. SYSTEM_CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock.

Returns:

  • (String, nil)

See Also:



7926
7927
7928
 
# File 'media_live/cfn_channel.rb', line 7926

def program_date_time_clock
  @program_date_time_clock
end

#program_date_time_period ⇒ Numeric? (readonly)

The period of insertion of the EXT-X-PROGRAM-DATE-TIME entry, in seconds.

Returns:

  • (Numeric, nil)

See Also:



7931
7932
7933
 
# File 'media_live/cfn_channel.rb', line 7931

def program_date_time_period
  @program_date_time_period
end

#redundant_manifest ⇒ String? (readonly)

ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows a playout device that supports stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players, so a redundant manifest from MediaLive is irrelevant.

Returns:

  • (String, nil)

See Also:



7936
7937
7938
 
# File 'media_live/cfn_channel.rb', line 7936

def redundant_manifest
  @redundant_manifest
end

#segment_length ⇒ Numeric? (readonly)

The length of the MPEG-2 Transport Stream segments to create, in seconds.

Note that segments will end on the next keyframe after this number of seconds, so the actual segment length might be longer.

Returns:

  • (Numeric, nil)

See Also:



7950
7951
7952
 
# File 'media_live/cfn_channel.rb', line 7950

def segment_length
  @segment_length
end

#segmentation_mode ⇒ String? (readonly)

useInputSegmentation has been deprecated.

The configured segment size is always used.

Returns:

  • (String, nil)

See Also:



7943
7944
7945
 
# File 'media_live/cfn_channel.rb', line 7943

def segmentation_mode
  @segmentation_mode
end

#segments_per_subdirectory ⇒ Numeric? (readonly)

The number of segments to write to a subdirectory before starting a new one.

For this setting to have an effect, directoryStructure must be subdirectoryPerStream.

Returns:

  • (Numeric, nil)

See Also:



7957
7958
7959
 
# File 'media_live/cfn_channel.rb', line 7957

def segments_per_subdirectory
  @segments_per_subdirectory
end

#stream_inf_resolution ⇒ String? (readonly)

The include or exclude RESOLUTION attribute for a video in the EXT-X-STREAM-INF tag of a variant manifest.

Returns:

  • (String, nil)

See Also:



7962
7963
7964
 
# File 'media_live/cfn_channel.rb', line 7962

def stream_inf_resolution
  @stream_inf_resolution
end

#timed_metadata_id3_frame ⇒ String? (readonly)

Indicates the ID3 frame that has the timecode.

Returns:

  • (String, nil)

See Also:



7967
7968
7969
 
# File 'media_live/cfn_channel.rb', line 7967

def timed_metadata_id3_frame
  @timed_metadata_id3_frame
end

#timed_metadata_id3_period ⇒ Numeric? (readonly)

The timed metadata interval, in seconds.

Returns:

  • (Numeric, nil)

See Also:



7972
7973
7974
 
# File 'media_live/cfn_channel.rb', line 7972

def timed_metadata_id3_period
  @timed_metadata_id3_period
end

#timestamp_delta_milliseconds ⇒ Numeric? (readonly)

Provides an extra millisecond delta offset to fine tune the timestamps.

Returns:

  • (Numeric, nil)

See Also:



7977
7978
7979
 
# File 'media_live/cfn_channel.rb', line 7977

def timestamp_delta_milliseconds
  @timestamp_delta_milliseconds
end

#ts_file_mode ⇒ String? (readonly)

SEGMENTEDFILES: Emits the program as segments -multiple .ts media files. SINGLEFILE: Applies only if the Mode field is VOD. Emits the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.

Returns:

  • (String, nil)

See Also:



7982
7983
7984
 
# File 'media_live/cfn_channel.rb', line 7982

def ts_file_mode
  @ts_file_mode
end

Class Method Details

.jsii_properties ⇒ Object 



7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
 
# File 'media_live/cfn_channel.rb', line 7984

def self.jsii_properties
  {
    :ad_markers => "adMarkers",
    :base_url_content => "baseUrlContent",
    :base_url_content1 => "baseUrlContent1",
    :base_url_manifest => "baseUrlManifest",
    :base_url_manifest1 => "baseUrlManifest1",
    :caption_language_mappings => "captionLanguageMappings",
    :caption_language_setting => "captionLanguageSetting",
    :client_cache => "clientCache",
    :codec_specification => "codecSpecification",
    :constant_iv => "constantIv",
    :destination => "destination",
    :directory_structure => "directoryStructure",
    :discontinuity_tags => "discontinuityTags",
    :encryption_type => "encryptionType",
    :hls_cdn_settings => "hlsCdnSettings",
    :hls_id3_segment_tagging => "hlsId3SegmentTagging",
    :i_frame_only_playlists => "iFrameOnlyPlaylists",
    :incomplete_segment_behavior => "incompleteSegmentBehavior",
    :index_n_segments => "indexNSegments",
    :input_loss_action => "inputLossAction",
    :iv_in_manifest => "ivInManifest",
    :iv_source => "ivSource",
    :keep_segments => "keepSegments",
    :key_format => "keyFormat",
    :key_format_versions => "keyFormatVersions",
    :key_provider_settings => "keyProviderSettings",
    :manifest_compression => "manifestCompression",
    :manifest_duration_format => "manifestDurationFormat",
    :min_segment_length => "minSegmentLength",
    :mode => "mode",
    :output_selection => "outputSelection",
    :program_date_time => "programDateTime",
    :program_date_time_clock => "programDateTimeClock",
    :program_date_time_period => "programDateTimePeriod",
    :redundant_manifest => "redundantManifest",
    :segmentation_mode => "segmentationMode",
    :segment_length => "segmentLength",
    :segments_per_subdirectory => "segmentsPerSubdirectory",
    :stream_inf_resolution => "streamInfResolution",
    :timed_metadata_id3_frame => "timedMetadataId3Frame",
    :timed_metadata_id3_period => "timedMetadataId3Period",
    :timestamp_delta_milliseconds => "timestampDeltaMilliseconds",
    :ts_file_mode => "tsFileMode",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
 
# File 'media_live/cfn_channel.rb', line 8032

def to_jsii
  result = {}
  result.merge!({
    "adMarkers" => @ad_markers,
    "baseUrlContent" => @base_url_content,
    "baseUrlContent1" => @base_url_content1,
    "baseUrlManifest" => @base_url_manifest,
    "baseUrlManifest1" => @base_url_manifest1,
    "captionLanguageMappings" => @caption_language_mappings,
    "captionLanguageSetting" => @caption_language_setting,
    "clientCache" => @client_cache,
    "codecSpecification" => @codec_specification,
    "constantIv" => @constant_iv,
    "destination" => @destination,
    "directoryStructure" => @directory_structure,
    "discontinuityTags" => @discontinuity_tags,
    "encryptionType" => @encryption_type,
    "hlsCdnSettings" => @hls_cdn_settings,
    "hlsId3SegmentTagging" => @hls_id3_segment_tagging,
    "iFrameOnlyPlaylists" => @i_frame_only_playlists,
    "incompleteSegmentBehavior" => @incomplete_segment_behavior,
    "indexNSegments" => @index_n_segments,
    "inputLossAction" => @input_loss_action,
    "ivInManifest" => @iv_in_manifest,
    "ivSource" => @iv_source,
    "keepSegments" => @keep_segments,
    "keyFormat" => @key_format,
    "keyFormatVersions" => @key_format_versions,
    "keyProviderSettings" => @key_provider_settings,
    "manifestCompression" => @manifest_compression,
    "manifestDurationFormat" => @manifest_duration_format,
    "minSegmentLength" => @min_segment_length,
    "mode" => @mode,
    "outputSelection" => @output_selection,
    "programDateTime" => @program_date_time,
    "programDateTimeClock" => @program_date_time_clock,
    "programDateTimePeriod" => @program_date_time_period,
    "redundantManifest" => @redundant_manifest,
    "segmentationMode" => @segmentation_mode,
    "segmentLength" => @segment_length,
    "segmentsPerSubdirectory" => @segments_per_subdirectory,
    "streamInfResolution" => @stream_inf_resolution,
    "timedMetadataId3Frame" => @timed_metadata_id3_frame,
    "timedMetadataId3Period" => @timed_metadata_id3_period,
    "timestampDeltaMilliseconds" => @timestamp_delta_milliseconds,
    "tsFileMode" => @ts_file_mode,
  })
  result.compact
end