Class: Aws::MediaConvert::Types::OutputGroupSettings

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb

Overview

Note:

When making an API call, you may pass OutputGroupSettings data as a hash:

{
  cmaf_group_settings: {
    additional_manifests: [
      {
        manifest_name_modifier: "__stringMin1",
        selected_outputs: ["__stringMin1"],
      },
    ],
    base_url: "__string",
    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_encryption_context: "__stringPatternAZaZ0902",
          kms_key_arn: "__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912MrkAFAF0932",
        },
      },
    },
    encryption: {
      constant_initialization_vector: "__stringMin32Max32Pattern09aFAF32",
      encryption_method: "SAMPLE_AES", # accepts SAMPLE_AES, AES_CTR
      initialization_vector_in_manifest: "INCLUDE", # accepts INCLUDE, EXCLUDE
      speke_key_provider: {
        certificate_arn: "__stringPatternArnAwsUsGovAcm",
        dash_signaled_system_ids: ["__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12"],
        hls_signaled_system_ids: ["__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12"],
        resource_id: "__stringPatternW",
        url: "__stringPatternHttps",
      },
      static_key_provider: {
        key_format: "__stringPatternIdentityAZaZ26AZaZ09163",
        key_format_versions: "__stringPatternDD",
        static_key_value: "__stringPatternAZaZ0932",
        url: "__string",
      },
      type: "SPEKE", # accepts SPEKE, STATIC_KEY
    },
    fragment_length: 1,
    image_based_trick_play: "NONE", # accepts NONE, THUMBNAIL, THUMBNAIL_AND_FULLFRAME, ADVANCED
    image_based_trick_play_settings: {
      interval_cadence: "FOLLOW_IFRAME", # accepts FOLLOW_IFRAME, FOLLOW_CUSTOM
      thumbnail_height: 1,
      thumbnail_interval: 1.0,
      thumbnail_width: 1,
      tile_height: 1,
      tile_width: 1,
    },
    manifest_compression: "GZIP", # accepts GZIP, NONE
    manifest_duration_format: "FLOATING_POINT", # accepts FLOATING_POINT, INTEGER
    min_buffer_time: 1,
    min_final_segment_length: 1.0,
    mpd_profile: "MAIN_PROFILE", # accepts MAIN_PROFILE, ON_DEMAND_PROFILE
    pts_offset_handling_for_b_frames: "ZERO_BASED", # accepts ZERO_BASED, MATCH_INITIAL_PTS
    segment_control: "SINGLE_FILE", # accepts SINGLE_FILE, SEGMENTED_FILES
    segment_length: 1,
    segment_length_control: "EXACT", # accepts EXACT, GOP_MULTIPLE
    stream_inf_resolution: "INCLUDE", # accepts INCLUDE, EXCLUDE
    target_duration_compatibility_mode: "LEGACY", # accepts LEGACY, SPEC_COMPLIANT
    write_dash_manifest: "DISABLED", # accepts DISABLED, ENABLED
    write_hls_manifest: "DISABLED", # accepts DISABLED, ENABLED
    write_segment_timeline_in_representation: "ENABLED", # accepts ENABLED, DISABLED
  },
  dash_iso_group_settings: {
    additional_manifests: [
      {
        manifest_name_modifier: "__stringMin1",
        selected_outputs: ["__stringMin1"],
      },
    ],
    audio_channel_config_scheme_id_uri: "MPEG_CHANNEL_CONFIGURATION", # accepts MPEG_CHANNEL_CONFIGURATION, DOLBY_CHANNEL_CONFIGURATION
    base_url: "__string",
    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_encryption_context: "__stringPatternAZaZ0902",
          kms_key_arn: "__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912MrkAFAF0932",
        },
      },
    },
    encryption: {
      playback_device_compatibility: "CENC_V1", # accepts CENC_V1, UNENCRYPTED_SEI
      speke_key_provider: {
        certificate_arn: "__stringPatternArnAwsUsGovAcm",
        resource_id: "__string",
        system_ids: ["__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12"],
        url: "__stringPatternHttps",
      },
    },
    fragment_length: 1,
    hbbtv_compliance: "HBBTV_1_5", # accepts HBBTV_1_5, NONE
    image_based_trick_play: "NONE", # accepts NONE, THUMBNAIL, THUMBNAIL_AND_FULLFRAME, ADVANCED
    image_based_trick_play_settings: {
      interval_cadence: "FOLLOW_IFRAME", # accepts FOLLOW_IFRAME, FOLLOW_CUSTOM
      thumbnail_height: 1,
      thumbnail_interval: 1.0,
      thumbnail_width: 1,
      tile_height: 1,
      tile_width: 1,
    },
    min_buffer_time: 1,
    min_final_segment_length: 1.0,
    mpd_profile: "MAIN_PROFILE", # accepts MAIN_PROFILE, ON_DEMAND_PROFILE
    pts_offset_handling_for_b_frames: "ZERO_BASED", # accepts ZERO_BASED, MATCH_INITIAL_PTS
    segment_control: "SINGLE_FILE", # accepts SINGLE_FILE, SEGMENTED_FILES
    segment_length: 1,
    segment_length_control: "EXACT", # accepts EXACT, GOP_MULTIPLE
    write_segment_timeline_in_representation: "ENABLED", # accepts ENABLED, DISABLED
  },
  file_group_settings: {
    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_encryption_context: "__stringPatternAZaZ0902",
          kms_key_arn: "__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912MrkAFAF0932",
        },
      },
    },
  },
  hls_group_settings: {
    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, SRP
        language_description: "__string",
      },
    ],
    caption_language_setting: "INSERT", # accepts INSERT, OMIT, NONE
    caption_segment_length_control: "LARGE_SEGMENTS", # accepts LARGE_SEGMENTS, MATCH_VIDEO
    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_encryption_context: "__stringPatternAZaZ0902",
          kms_key_arn: "__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912MrkAFAF0932",
        },
      },
    },
    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
    },
    image_based_trick_play: "NONE", # accepts NONE, THUMBNAIL, THUMBNAIL_AND_FULLFRAME, ADVANCED
    image_based_trick_play_settings: {
      interval_cadence: "FOLLOW_IFRAME", # accepts FOLLOW_IFRAME, FOLLOW_CUSTOM
      thumbnail_height: 1,
      thumbnail_interval: 1.0,
      thumbnail_width: 1,
      tile_height: 1,
      tile_width: 1,
    },
    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,
    segment_length_control: "EXACT", # accepts EXACT, GOP_MULTIPLE
    segments_per_subdirectory: 1,
    stream_inf_resolution: "INCLUDE", # accepts INCLUDE, EXCLUDE
    target_duration_compatibility_mode: "LEGACY", # accepts LEGACY, SPEC_COMPLIANT
    timed_metadata_id_3_frame: "NONE", # accepts NONE, PRIV, TDRL
    timed_metadata_id_3_period: 1,
    timestamp_delta_milliseconds: 1,
  },
  ms_smooth_group_settings: {
    additional_manifests: [
      {
        manifest_name_modifier: "__stringMin1",
        selected_outputs: ["__stringMin1"],
      },
    ],
    audio_deduplication: "COMBINE_DUPLICATE_STREAMS", # accepts COMBINE_DUPLICATE_STREAMS, NONE
    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_encryption_context: "__stringPatternAZaZ0902",
          kms_key_arn: "__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912MrkAFAF0932",
        },
      },
    },
    encryption: {
      speke_key_provider: {
        certificate_arn: "__stringPatternArnAwsUsGovAcm",
        resource_id: "__string",
        system_ids: ["__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12"],
        url: "__stringPatternHttps",
      },
    },
    fragment_length: 1,
    fragment_length_control: "EXACT", # accepts EXACT, GOP_MULTIPLE
    manifest_encoding: "UTF8", # accepts UTF8, UTF16
  },
  type: "HLS_GROUP_SETTINGS", # accepts HLS_GROUP_SETTINGS, DASH_ISO_GROUP_SETTINGS, FILE_GROUP_SETTINGS, MS_SMOOTH_GROUP_SETTINGS, CMAF_GROUP_SETTINGS
}

Output Group settings, including type

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cmaf_group_settingsTypes::CmafGroupSettings

Settings related to your CMAF output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work directly in your JSON job specification, include this object and any required children when you set Type, under OutputGroupSettings, to CMAF_GROUP_SETTINGS.



21176
21177
21178
21179
21180
21181
21182
21183
21184
21185
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 21176

class OutputGroupSettings < Struct.new(
  :cmaf_group_settings,
  :dash_iso_group_settings,
  :file_group_settings,
  :hls_group_settings,
  :ms_smooth_group_settings,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#dash_iso_group_settingsTypes::DashIsoGroupSettings

Settings related to your DASH output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work directly in your JSON job specification, include this object and any required children when you set Type, under OutputGroupSettings, to DASH_ISO_GROUP_SETTINGS.



21176
21177
21178
21179
21180
21181
21182
21183
21184
21185
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 21176

class OutputGroupSettings < Struct.new(
  :cmaf_group_settings,
  :dash_iso_group_settings,
  :file_group_settings,
  :hls_group_settings,
  :ms_smooth_group_settings,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#file_group_settingsTypes::FileGroupSettings

Settings related to your File output group. MediaConvert uses this group of settings to generate a single standalone file, rather than a streaming package. When you work directly in your JSON job specification, include this object and any required children when you set Type, under OutputGroupSettings, to FILE_GROUP_SETTINGS.



21176
21177
21178
21179
21180
21181
21182
21183
21184
21185
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 21176

class OutputGroupSettings < Struct.new(
  :cmaf_group_settings,
  :dash_iso_group_settings,
  :file_group_settings,
  :hls_group_settings,
  :ms_smooth_group_settings,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#hls_group_settingsTypes::HlsGroupSettings

Settings related to your HLS output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work directly in your JSON job specification, include this object and any required children when you set Type, under OutputGroupSettings, to HLS_GROUP_SETTINGS.



21176
21177
21178
21179
21180
21181
21182
21183
21184
21185
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 21176

class OutputGroupSettings < Struct.new(
  :cmaf_group_settings,
  :dash_iso_group_settings,
  :file_group_settings,
  :hls_group_settings,
  :ms_smooth_group_settings,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#ms_smooth_group_settingsTypes::MsSmoothGroupSettings

Settings related to your Microsoft Smooth Streaming output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work directly in your JSON job specification, include this object and any required children when you set Type, under OutputGroupSettings, to MS_SMOOTH_GROUP_SETTINGS.



21176
21177
21178
21179
21180
21181
21182
21183
21184
21185
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 21176

class OutputGroupSettings < Struct.new(
  :cmaf_group_settings,
  :dash_iso_group_settings,
  :file_group_settings,
  :hls_group_settings,
  :ms_smooth_group_settings,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

Type of output group (File group, Apple HLS, DASH ISO, Microsoft Smooth Streaming, CMAF)

Returns:

  • (String)


21176
21177
21178
21179
21180
21181
21182
21183
21184
21185
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 21176

class OutputGroupSettings < Struct.new(
  :cmaf_group_settings,
  :dash_iso_group_settings,
  :file_group_settings,
  :hls_group_settings,
  :ms_smooth_group_settings,
  :type)
  SENSITIVE = []
  include Aws::Structure
end