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

Class: Aws::MediaConvert::Types::HlsGroupSettings

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing HlsGroupSettings as input to an Aws::Client method, you can use a vanilla Hash:

{
  ad_markers: ["ELEMENTAL"], # accepts ELEMENTAL, ELEMENTAL_SCTE35
  additional_manifests: [
    {
      manifest_name_modifier: "__stringMin1",
      selected_outputs: ["__stringMin1"],
    },
  ],
  audio_only_header: "INCLUDE", # accepts INCLUDE, EXCLUDE
  base_url: "__string",
  caption_language_mappings: [
    {
      caption_channel: 1,
      custom_language_code: "__stringMin3Max3PatternAZaZ3",
      language_code: "ENG", # accepts ENG, SPA, FRA, DEU, GER, ZHO, ARA, HIN, JPN, RUS, POR, ITA, URD, VIE, KOR, PAN, ABK, AAR, AFR, AKA, SQI, AMH, ARG, HYE, ASM, AVA, AVE, AYM, AZE, BAM, BAK, EUS, BEL, BEN, BIH, BIS, BOS, BRE, BUL, MYA, CAT, KHM, CHA, CHE, NYA, CHU, CHV, COR, COS, CRE, HRV, CES, DAN, DIV, NLD, DZO, ENM, EPO, EST, EWE, FAO, FIJ, FIN, FRM, FUL, GLA, GLG, LUG, KAT, ELL, GRN, GUJ, HAT, HAU, HEB, HER, HMO, HUN, ISL, IDO, IBO, IND, INA, ILE, IKU, IPK, GLE, JAV, KAL, KAN, KAU, KAS, KAZ, KIK, KIN, KIR, KOM, KON, KUA, KUR, LAO, LAT, LAV, LIM, LIN, LIT, LUB, LTZ, MKD, MLG, MSA, MAL, MLT, GLV, MRI, MAR, MAH, MON, NAU, NAV, NDE, NBL, NDO, NEP, SME, NOR, NOB, NNO, OCI, OJI, ORI, ORM, OSS, PLI, FAS, POL, PUS, QUE, QAA, RON, ROH, RUN, SMO, SAG, SAN, SRD, SRB, SNA, III, SND, SIN, SLK, SLV, SOM, SOT, SUN, SWA, SSW, SWE, TGL, TAH, TGK, TAM, TAT, TEL, THA, BOD, TIR, TON, TSO, TSN, TUR, TUK, TWI, UIG, UKR, UZB, VEN, VOL, WLN, CYM, FRY, WOL, XHO, YID, YOR, ZHA, ZUL, ORJ, QPC, TNG
      language_description: "__string",
    },
  ],
  caption_language_setting: "INSERT", # accepts INSERT, OMIT, NONE
  client_cache: "DISABLED", # accepts DISABLED, ENABLED
  codec_specification: "RFC_6381", # accepts RFC_6381, RFC_4281
  destination: "__stringPatternS3",
  destination_settings: {
    s3_settings: {
      access_control: {
        canned_acl: "PUBLIC_READ", # accepts PUBLIC_READ, AUTHENTICATED_READ, BUCKET_OWNER_READ, BUCKET_OWNER_FULL_CONTROL
      },
      encryption: {
        encryption_type: "SERVER_SIDE_ENCRYPTION_S3", # accepts SERVER_SIDE_ENCRYPTION_S3, SERVER_SIDE_ENCRYPTION_KMS
        kms_key_arn: "__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912",
      },
    },
  },
  directory_structure: "SINGLE_DIRECTORY", # accepts SINGLE_DIRECTORY, SUBDIRECTORY_PER_STREAM
  encryption: {
    constant_initialization_vector: "__stringMin32Max32Pattern09aFAF32",
    encryption_method: "AES128", # accepts AES128, SAMPLE_AES
    initialization_vector_in_manifest: "INCLUDE", # accepts INCLUDE, EXCLUDE
    offline_encrypted: "ENABLED", # accepts ENABLED, DISABLED
    speke_key_provider: {
      certificate_arn: "__stringPatternArnAwsUsGovAcm",
      resource_id: "__string",
      system_ids: ["__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12"],
      url: "__stringPatternHttps",
    },
    static_key_provider: {
      key_format: "__stringPatternIdentityAZaZ26AZaZ09163",
      key_format_versions: "__stringPatternDD",
      static_key_value: "__stringPatternAZaZ0932",
      url: "__string",
    },
    type: "SPEKE", # accepts SPEKE, STATIC_KEY
  },
  manifest_compression: "GZIP", # accepts GZIP, NONE
  manifest_duration_format: "FLOATING_POINT", # accepts FLOATING_POINT, INTEGER
  min_final_segment_length: 1.0,
  min_segment_length: 1,
  output_selection: "MANIFESTS_AND_SEGMENTS", # accepts MANIFESTS_AND_SEGMENTS, SEGMENTS_ONLY
  program_date_time: "INCLUDE", # accepts INCLUDE, EXCLUDE
  program_date_time_period: 1,
  segment_control: "SINGLE_FILE", # accepts SINGLE_FILE, SEGMENTED_FILES
  segment_length: 1,
  segments_per_subdirectory: 1,
  stream_inf_resolution: "INCLUDE", # accepts INCLUDE, EXCLUDE
  timed_metadata_id_3_frame: "NONE", # accepts NONE, PRIV, TDRL
  timed_metadata_id_3_period: 1,
  timestamp_delta_milliseconds: 1,
}

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLS_GROUP_SETTINGS.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#ad_markers ⇒ Array<String>

Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.

Returns:

  • (Array<String>) —

    Choose one or more ad marker types to decorate your Apple HLS manifest.

#additional_manifests ⇒ Array<Types::HlsAdditionalManifest>

By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default manifest references every output in the output group. To create additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them here.

Returns:

  • (Array<Types::HlsAdditionalManifest>) —

    By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job.

#audio_only_header ⇒ String

Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include (INCLUDE), to output audio-only headers. Choose Exclude (EXCLUDE) to remove the audio-only headers from your audio segments.

Possible values:

  • INCLUDE
  • EXCLUDE

Returns:

  • (String) —

    Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues.

#base_url ⇒ String

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

Returns:

  • (String) —

    A partial URI prefix that will be prepended to each output in the media .m3u8 file.

#caption_language_mappings ⇒ Array<Types::HlsCaptionLanguageMapping>

Language to be used on Caption outputs

Returns:

#caption_language_setting ⇒ String

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 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 caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.

Possible values:

  • INSERT
  • OMIT
  • NONE

Returns:

  • (String) —

    Applies only to 608 Embedded output captions.

#client_cache ⇒ String

When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay.

Possible values:

  • DISABLED
  • ENABLED

Returns:

  • (String) —

    When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay.

#codec_specification ⇒ String

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

Possible values:

  • RFC_6381
  • RFC_4281

Returns:

  • (String) —

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

#destination ⇒ String

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

Returns:

  • (String) —

    Use Destination (Destination) to specify the S3 output location and the output filename base.

#destination_settings ⇒ Types::DestinationSettings

Settings associated with the destination. Will vary based on the type of destination

Returns:

#directory_structure ⇒ String

Indicates whether segments should be placed in subdirectories.

Possible values:

  • SINGLE_DIRECTORY
  • SUBDIRECTORY_PER_STREAM

Returns:

  • (String) —

    Indicates whether segments should be placed in subdirectories.

#encryption ⇒ Types::HlsEncryptionSettings

DRM settings.

Returns:

#manifest_compression ⇒ String

When set to GZIP, compresses HLS playlist.

Possible values:

  • GZIP
  • NONE

Returns:

  • (String) —

    When set to GZIP, compresses HLS playlist.

#manifest_duration_format ⇒ String

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

Possible values:

  • FLOATING_POINT
  • INTEGER

Returns:

  • (String) —

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

#min_final_segment_length ⇒ Float

Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds.

Returns:

  • (Float) —

    Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset.

#min_segment_length ⇒ Integer

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

Returns:

  • (Integer) —

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

#output_selection ⇒ String

Indicates whether the .m3u8 manifest file should be generated for this HLS output group.

Possible values:

  • MANIFESTS_AND_SEGMENTS
  • SEGMENTS_ONLY

Returns:

  • (String) —

    Indicates whether the .m3u8 manifest file should be generated for this HLS output group.

#program_date_time ⇒ String

Includes or excludes 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 timestamp_offset.

Possible values:

  • INCLUDE
  • EXCLUDE

Returns:

  • (String) —

    Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files.

#program_date_time_period ⇒ Integer

Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.

Returns:

  • (Integer) —

    Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.

#segment_control ⇒ String

When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.

Possible values:

  • SINGLE_FILE
  • SEGMENTED_FILES

Returns:

  • (String) —

    When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.

#segment_length ⇒ Integer

Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.

Returns:

  • (Integer) —

    Length of MPEG-2 Transport Stream segments to create (in seconds).

#segments_per_subdirectory ⇒ Integer

Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect.

Returns:

  • (Integer) —

    Number of segments to write to a subdirectory before starting a new one.

#stream_inf_resolution ⇒ String

Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.

Possible values:

  • INCLUDE
  • EXCLUDE

Returns:

  • (String) —

    Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.

#timed_metadata_id_3_frame ⇒ String

Indicates ID3 frame that has the timecode.

Possible values:

  • NONE
  • PRIV
  • TDRL

Returns:

  • (String) —

    Indicates ID3 frame that has the timecode.

#timed_metadata_id_3_period ⇒ Integer

Timed Metadata interval in seconds.

Returns:

  • (Integer) —

    Timed Metadata interval in seconds.

#timestamp_delta_milliseconds ⇒ Integer

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

Returns:

  • (Integer) —

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