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

Class: Aws::MediaConvert::Types::CmafGroupSettings

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

{
  base_url: "__string",
  client_cache: "DISABLED", # accepts DISABLED, ENABLED
  codec_specification: "RFC_6381", # accepts RFC_6381, RFC_4281
  destination: "__stringPatternS3",
  destination_settings: {
    s3_settings: {
      encryption: {
        encryption_type: "SERVER_SIDE_ENCRYPTION_S3", # accepts SERVER_SIDE_ENCRYPTION_S3, SERVER_SIDE_ENCRYPTION_KMS
        kms_key_arn: "__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912",
      },
    },
  },
  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,
  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,
  segment_control: "SINGLE_FILE", # accepts SINGLE_FILE, SEGMENTED_FILES
  segment_length: 1,
  stream_inf_resolution: "INCLUDE", # accepts INCLUDE, EXCLUDE
  write_dash_manifest: "DISABLED", # accepts DISABLED, ENABLED
  write_hls_manifest: "DISABLED", # accepts DISABLED, ENABLED
}

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to CMAF_GROUP_SETTINGS. Each output in a CMAF Output Group may only contain a single video, audio, or caption output.

Instance Attribute Summary collapse

Instance Attribute Details

#base_urlString

A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.

Returns:

  • (String)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1883

class CmafGroupSettings < Struct.new(
  :base_url,
  :client_cache,
  :codec_specification,
  :destination,
  :destination_settings,
  :encryption,
  :fragment_length,
  :manifest_compression,
  :manifest_duration_format,
  :min_buffer_time,
  :min_final_segment_length,
  :segment_control,
  :segment_length,
  :stream_inf_resolution,
  :write_dash_manifest,
  :write_hls_manifest)
  include Aws::Structure
end

#client_cacheString

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

Returns:

  • (String)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1883

class CmafGroupSettings < Struct.new(
  :base_url,
  :client_cache,
  :codec_specification,
  :destination,
  :destination_settings,
  :encryption,
  :fragment_length,
  :manifest_compression,
  :manifest_duration_format,
  :min_buffer_time,
  :min_final_segment_length,
  :segment_control,
  :segment_length,
  :stream_inf_resolution,
  :write_dash_manifest,
  :write_hls_manifest)
  include Aws::Structure
end

#codec_specificationString

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

Returns:

  • (String)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1883

class CmafGroupSettings < Struct.new(
  :base_url,
  :client_cache,
  :codec_specification,
  :destination,
  :destination_settings,
  :encryption,
  :fragment_length,
  :manifest_compression,
  :manifest_duration_format,
  :min_buffer_time,
  :min_final_segment_length,
  :segment_control,
  :segment_length,
  :stream_inf_resolution,
  :write_dash_manifest,
  :write_hls_manifest)
  include Aws::Structure
end

#destinationString

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)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1883

class CmafGroupSettings < Struct.new(
  :base_url,
  :client_cache,
  :codec_specification,
  :destination,
  :destination_settings,
  :encryption,
  :fragment_length,
  :manifest_compression,
  :manifest_duration_format,
  :min_buffer_time,
  :min_final_segment_length,
  :segment_control,
  :segment_length,
  :stream_inf_resolution,
  :write_dash_manifest,
  :write_hls_manifest)
  include Aws::Structure
end

#destination_settingsTypes::DestinationSettings

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



1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1883

class CmafGroupSettings < Struct.new(
  :base_url,
  :client_cache,
  :codec_specification,
  :destination,
  :destination_settings,
  :encryption,
  :fragment_length,
  :manifest_compression,
  :manifest_duration_format,
  :min_buffer_time,
  :min_final_segment_length,
  :segment_control,
  :segment_length,
  :stream_inf_resolution,
  :write_dash_manifest,
  :write_hls_manifest)
  include Aws::Structure
end

#encryptionTypes::CmafEncryptionSettings

DRM settings.



1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1883

class CmafGroupSettings < Struct.new(
  :base_url,
  :client_cache,
  :codec_specification,
  :destination,
  :destination_settings,
  :encryption,
  :fragment_length,
  :manifest_compression,
  :manifest_duration_format,
  :min_buffer_time,
  :min_final_segment_length,
  :segment_control,
  :segment_length,
  :stream_inf_resolution,
  :write_dash_manifest,
  :write_hls_manifest)
  include Aws::Structure
end

#fragment_lengthInteger

Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.

Returns:

  • (Integer)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1883

class CmafGroupSettings < Struct.new(
  :base_url,
  :client_cache,
  :codec_specification,
  :destination,
  :destination_settings,
  :encryption,
  :fragment_length,
  :manifest_compression,
  :manifest_duration_format,
  :min_buffer_time,
  :min_final_segment_length,
  :segment_control,
  :segment_length,
  :stream_inf_resolution,
  :write_dash_manifest,
  :write_hls_manifest)
  include Aws::Structure
end

#manifest_compressionString

When set to GZIP, compresses HLS playlist.

Returns:

  • (String)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1883

class CmafGroupSettings < Struct.new(
  :base_url,
  :client_cache,
  :codec_specification,
  :destination,
  :destination_settings,
  :encryption,
  :fragment_length,
  :manifest_compression,
  :manifest_duration_format,
  :min_buffer_time,
  :min_final_segment_length,
  :segment_control,
  :segment_length,
  :stream_inf_resolution,
  :write_dash_manifest,
  :write_hls_manifest)
  include Aws::Structure
end

#manifest_duration_formatString

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

Returns:

  • (String)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1883

class CmafGroupSettings < Struct.new(
  :base_url,
  :client_cache,
  :codec_specification,
  :destination,
  :destination_settings,
  :encryption,
  :fragment_length,
  :manifest_compression,
  :manifest_duration_format,
  :min_buffer_time,
  :min_final_segment_length,
  :segment_control,
  :segment_length,
  :stream_inf_resolution,
  :write_dash_manifest,
  :write_hls_manifest)
  include Aws::Structure
end

#min_buffer_timeInteger

Minimum time of initially buffered media that is needed to ensure smooth playout.

Returns:

  • (Integer)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1883

class CmafGroupSettings < Struct.new(
  :base_url,
  :client_cache,
  :codec_specification,
  :destination,
  :destination_settings,
  :encryption,
  :fragment_length,
  :manifest_compression,
  :manifest_duration_format,
  :min_buffer_time,
  :min_final_segment_length,
  :segment_control,
  :segment_length,
  :stream_inf_resolution,
  :write_dash_manifest,
  :write_hls_manifest)
  include Aws::Structure
end

#min_final_segment_lengthFloat

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)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1883

class CmafGroupSettings < Struct.new(
  :base_url,
  :client_cache,
  :codec_specification,
  :destination,
  :destination_settings,
  :encryption,
  :fragment_length,
  :manifest_compression,
  :manifest_duration_format,
  :min_buffer_time,
  :min_final_segment_length,
  :segment_control,
  :segment_length,
  :stream_inf_resolution,
  :write_dash_manifest,
  :write_hls_manifest)
  include Aws::Structure
end

#segment_controlString

When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.

Returns:

  • (String)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1883

class CmafGroupSettings < Struct.new(
  :base_url,
  :client_cache,
  :codec_specification,
  :destination,
  :destination_settings,
  :encryption,
  :fragment_length,
  :manifest_compression,
  :manifest_duration_format,
  :min_buffer_time,
  :min_final_segment_length,
  :segment_control,
  :segment_length,
  :stream_inf_resolution,
  :write_dash_manifest,
  :write_hls_manifest)
  include Aws::Structure
end

#segment_lengthInteger

Use this setting to specify the length, in seconds, of each individual CMAF segment. This value applies to the whole package; that is, to every output in the output group. Note that segments end on the first keyframe after this number of seconds, so the actual segment length might be slightly longer. If you set Segment control (CmafSegmentControl) to single file, the service puts the content of each output in a single file that has metadata that marks these segments. If you set it to segmented files, the service creates multiple files for each output, each with the content of one segment.

Returns:

  • (Integer)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1883

class CmafGroupSettings < Struct.new(
  :base_url,
  :client_cache,
  :codec_specification,
  :destination,
  :destination_settings,
  :encryption,
  :fragment_length,
  :manifest_compression,
  :manifest_duration_format,
  :min_buffer_time,
  :min_final_segment_length,
  :segment_control,
  :segment_length,
  :stream_inf_resolution,
  :write_dash_manifest,
  :write_hls_manifest)
  include Aws::Structure
end

#stream_inf_resolutionString

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

Returns:

  • (String)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1883

class CmafGroupSettings < Struct.new(
  :base_url,
  :client_cache,
  :codec_specification,
  :destination,
  :destination_settings,
  :encryption,
  :fragment_length,
  :manifest_compression,
  :manifest_duration_format,
  :min_buffer_time,
  :min_final_segment_length,
  :segment_control,
  :segment_length,
  :stream_inf_resolution,
  :write_dash_manifest,
  :write_hls_manifest)
  include Aws::Structure
end

#write_dash_manifestString

When set to ENABLED, a DASH MPD manifest will be generated for this output.

Returns:

  • (String)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1883

class CmafGroupSettings < Struct.new(
  :base_url,
  :client_cache,
  :codec_specification,
  :destination,
  :destination_settings,
  :encryption,
  :fragment_length,
  :manifest_compression,
  :manifest_duration_format,
  :min_buffer_time,
  :min_final_segment_length,
  :segment_control,
  :segment_length,
  :stream_inf_resolution,
  :write_dash_manifest,
  :write_hls_manifest)
  include Aws::Structure
end

#write_hls_manifestString

When set to ENABLED, an Apple HLS manifest will be generated for this output.

Returns:

  • (String)


1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1883

class CmafGroupSettings < Struct.new(
  :base_url,
  :client_cache,
  :codec_specification,
  :destination,
  :destination_settings,
  :encryption,
  :fragment_length,
  :manifest_compression,
  :manifest_duration_format,
  :min_buffer_time,
  :min_final_segment_length,
  :segment_control,
  :segment_length,
  :stream_inf_resolution,
  :write_dash_manifest,
  :write_hls_manifest)
  include Aws::Structure
end