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

Class: Aws::MediaLive::Types::EncoderSettings

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

Overview

Note:

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

{
  audio_descriptions: [ # required
    {
      audio_normalization_settings: {
        algorithm: "ITU_1770_1", # accepts ITU_1770_1, ITU_1770_2
        algorithm_control: "CORRECT_AUDIO", # accepts CORRECT_AUDIO
        target_lkfs: 1.0,
      },
      audio_selector_name: "__string", # required
      audio_type: "CLEAN_EFFECTS", # accepts CLEAN_EFFECTS, HEARING_IMPAIRED, UNDEFINED, VISUAL_IMPAIRED_COMMENTARY
      audio_type_control: "FOLLOW_INPUT", # accepts FOLLOW_INPUT, USE_CONFIGURED
      codec_settings: {
        aac_settings: {
          bitrate: 1.0,
          coding_mode: "AD_RECEIVER_MIX", # accepts AD_RECEIVER_MIX, CODING_MODE_1_0, CODING_MODE_1_1, CODING_MODE_2_0, CODING_MODE_5_1
          input_type: "BROADCASTER_MIXED_AD", # accepts BROADCASTER_MIXED_AD, NORMAL
          profile: "HEV1", # accepts HEV1, HEV2, LC
          rate_control_mode: "CBR", # accepts CBR, VBR
          raw_format: "LATM_LOAS", # accepts LATM_LOAS, NONE
          sample_rate: 1.0,
          spec: "MPEG2", # accepts MPEG2, MPEG4
          vbr_quality: "HIGH", # accepts HIGH, LOW, MEDIUM_HIGH, MEDIUM_LOW
        },
        ac_3_settings: {
          bitrate: 1.0,
          bitstream_mode: "COMMENTARY", # accepts COMMENTARY, COMPLETE_MAIN, DIALOGUE, EMERGENCY, HEARING_IMPAIRED, MUSIC_AND_EFFECTS, VISUALLY_IMPAIRED, VOICE_OVER
          coding_mode: "CODING_MODE_1_0", # accepts CODING_MODE_1_0, CODING_MODE_1_1, CODING_MODE_2_0, CODING_MODE_3_2_LFE
          dialnorm: 1,
          drc_profile: "FILM_STANDARD", # accepts FILM_STANDARD, NONE
          lfe_filter: "DISABLED", # accepts DISABLED, ENABLED
          metadata_control: "FOLLOW_INPUT", # accepts FOLLOW_INPUT, USE_CONFIGURED
        },
        eac_3_settings: {
          attenuation_control: "ATTENUATE_3_DB", # accepts ATTENUATE_3_DB, NONE
          bitrate: 1.0,
          bitstream_mode: "COMMENTARY", # accepts COMMENTARY, COMPLETE_MAIN, EMERGENCY, HEARING_IMPAIRED, VISUALLY_IMPAIRED
          coding_mode: "CODING_MODE_1_0", # accepts CODING_MODE_1_0, CODING_MODE_2_0, CODING_MODE_3_2
          dc_filter: "DISABLED", # accepts DISABLED, ENABLED
          dialnorm: 1,
          drc_line: "FILM_LIGHT", # accepts FILM_LIGHT, FILM_STANDARD, MUSIC_LIGHT, MUSIC_STANDARD, NONE, SPEECH
          drc_rf: "FILM_LIGHT", # accepts FILM_LIGHT, FILM_STANDARD, MUSIC_LIGHT, MUSIC_STANDARD, NONE, SPEECH
          lfe_control: "LFE", # accepts LFE, NO_LFE
          lfe_filter: "DISABLED", # accepts DISABLED, ENABLED
          lo_ro_center_mix_level: 1.0,
          lo_ro_surround_mix_level: 1.0,
          lt_rt_center_mix_level: 1.0,
          lt_rt_surround_mix_level: 1.0,
          metadata_control: "FOLLOW_INPUT", # accepts FOLLOW_INPUT, USE_CONFIGURED
          passthrough_control: "NO_PASSTHROUGH", # accepts NO_PASSTHROUGH, WHEN_POSSIBLE
          phase_control: "NO_SHIFT", # accepts NO_SHIFT, SHIFT_90_DEGREES
          stereo_downmix: "DPL2", # accepts DPL2, LO_RO, LT_RT, NOT_INDICATED
          surround_ex_mode: "DISABLED", # accepts DISABLED, ENABLED, NOT_INDICATED
          surround_mode: "DISABLED", # accepts DISABLED, ENABLED, NOT_INDICATED
        },
        mp_2_settings: {
          bitrate: 1.0,
          coding_mode: "CODING_MODE_1_0", # accepts CODING_MODE_1_0, CODING_MODE_2_0
          sample_rate: 1.0,
        },
        pass_through_settings: {
        },
        wav_settings: {
          bit_depth: 1.0,
          coding_mode: "CODING_MODE_1_0", # accepts CODING_MODE_1_0, CODING_MODE_2_0, CODING_MODE_4_0, CODING_MODE_8_0
          sample_rate: 1.0,
        },
      },
      language_code: "__stringMin1Max35",
      language_code_control: "FOLLOW_INPUT", # accepts FOLLOW_INPUT, USE_CONFIGURED
      name: "__string", # required
      remix_settings: {
        channel_mappings: [ # required
          {
            input_channel_levels: [ # required
              {
                gain: 1, # required
                input_channel: 1, # required
              },
            ],
            output_channel: 1, # required
          },
        ],
        channels_in: 1,
        channels_out: 1,
      },
      stream_name: "__string",
    },
  ],
  avail_blanking: {
    avail_blanking_image: {
      password_param: "__string",
      uri: "__string", # required
      username: "__string",
    },
    state: "DISABLED", # accepts DISABLED, ENABLED
  },
  avail_configuration: {
    avail_settings: {
      scte_35_splice_insert: {
        ad_avail_offset: 1,
        no_regional_blackout_flag: "FOLLOW", # accepts FOLLOW, IGNORE
        web_delivery_allowed_flag: "FOLLOW", # accepts FOLLOW, IGNORE
      },
      scte_35_time_signal_apos: {
        ad_avail_offset: 1,
        no_regional_blackout_flag: "FOLLOW", # accepts FOLLOW, IGNORE
        web_delivery_allowed_flag: "FOLLOW", # accepts FOLLOW, IGNORE
      },
    },
  },
  blackout_slate: {
    blackout_slate_image: {
      password_param: "__string",
      uri: "__string", # required
      username: "__string",
    },
    network_end_blackout: "DISABLED", # accepts DISABLED, ENABLED
    network_end_blackout_image: {
      password_param: "__string",
      uri: "__string", # required
      username: "__string",
    },
    network_id: "__stringMin34Max34",
    state: "DISABLED", # accepts DISABLED, ENABLED
  },
  caption_descriptions: [
    {
      caption_selector_name: "__string", # required
      destination_settings: {
        arib_destination_settings: {
        },
        burn_in_destination_settings: {
          alignment: "CENTERED", # accepts CENTERED, LEFT, SMART
          background_color: "BLACK", # accepts BLACK, NONE, WHITE
          background_opacity: 1,
          font: {
            password_param: "__string",
            uri: "__string", # required
            username: "__string",
          },
          font_color: "BLACK", # accepts BLACK, BLUE, GREEN, RED, WHITE, YELLOW
          font_opacity: 1,
          font_resolution: 1,
          font_size: "__string",
          outline_color: "BLACK", # accepts BLACK, BLUE, GREEN, RED, WHITE, YELLOW
          outline_size: 1,
          shadow_color: "BLACK", # accepts BLACK, NONE, WHITE
          shadow_opacity: 1,
          shadow_x_offset: 1,
          shadow_y_offset: 1,
          teletext_grid_control: "FIXED", # accepts FIXED, SCALED
          x_position: 1,
          y_position: 1,
        },
        dvb_sub_destination_settings: {
          alignment: "CENTERED", # accepts CENTERED, LEFT, SMART
          background_color: "BLACK", # accepts BLACK, NONE, WHITE
          background_opacity: 1,
          font: {
            password_param: "__string",
            uri: "__string", # required
            username: "__string",
          },
          font_color: "BLACK", # accepts BLACK, BLUE, GREEN, RED, WHITE, YELLOW
          font_opacity: 1,
          font_resolution: 1,
          font_size: "__string",
          outline_color: "BLACK", # accepts BLACK, BLUE, GREEN, RED, WHITE, YELLOW
          outline_size: 1,
          shadow_color: "BLACK", # accepts BLACK, NONE, WHITE
          shadow_opacity: 1,
          shadow_x_offset: 1,
          shadow_y_offset: 1,
          teletext_grid_control: "FIXED", # accepts FIXED, SCALED
          x_position: 1,
          y_position: 1,
        },
        ebu_tt_d_destination_settings: {
          fill_line_gap: "DISABLED", # accepts DISABLED, ENABLED
          font_family: "__string",
          style_control: "EXCLUDE", # accepts EXCLUDE, INCLUDE
        },
        embedded_destination_settings: {
        },
        embedded_plus_scte_20_destination_settings: {
        },
        rtmp_caption_info_destination_settings: {
        },
        scte_20_plus_embedded_destination_settings: {
        },
        scte_27_destination_settings: {
        },
        smpte_tt_destination_settings: {
        },
        teletext_destination_settings: {
        },
        ttml_destination_settings: {
          style_control: "PASSTHROUGH", # accepts PASSTHROUGH, USE_CONFIGURED
        },
        webvtt_destination_settings: {
        },
      },
      language_code: "__string",
      language_description: "__string",
      name: "__string", # required
    },
  ],
  feature_activations: {
    input_prepare_schedule_actions: "DISABLED", # accepts DISABLED, ENABLED
  },
  global_configuration: {
    initial_audio_gain: 1,
    input_end_action: "NONE", # accepts NONE, SWITCH_AND_LOOP_INPUTS
    input_loss_behavior: {
      black_frame_msec: 1,
      input_loss_image_color: "__stringMin6Max6",
      input_loss_image_slate: {
        password_param: "__string",
        uri: "__string", # required
        username: "__string",
      },
      input_loss_image_type: "COLOR", # accepts COLOR, SLATE
      repeat_frame_msec: 1,
    },
    output_locking_mode: "EPOCH_LOCKING", # accepts EPOCH_LOCKING, PIPELINE_LOCKING
    output_timing_source: "INPUT_CLOCK", # accepts INPUT_CLOCK, SYSTEM_CLOCK
    support_low_framerate_inputs: "DISABLED", # accepts DISABLED, ENABLED
  },
  nielsen_configuration: {
    distributor_id: "__string",
    nielsen_pcm_to_id_3_tagging: "DISABLED", # accepts DISABLED, ENABLED
  },
  output_groups: [ # required
    {
      name: "__stringMax32",
      output_group_settings: { # required
        archive_group_settings: {
          destination: { # required
            destination_ref_id: "__string",
          },
          rollover_interval: 1,
        },
        frame_capture_group_settings: {
          destination: { # required
            destination_ref_id: "__string",
          },
        },
        hls_group_settings: {
          ad_markers: ["ADOBE"], # accepts ADOBE, ELEMENTAL, ELEMENTAL_SCTE35
          base_url_content: "__string",
          base_url_content_1: "__string",
          base_url_manifest: "__string",
          base_url_manifest_1: "__string",
          caption_language_mappings: [
            {
              caption_channel: 1, # required
              language_code: "__stringMin3Max3", # required
              language_description: "__stringMin1", # required
            },
          ],
          caption_language_setting: "INSERT", # accepts INSERT, NONE, OMIT
          client_cache: "DISABLED", # accepts DISABLED, ENABLED
          codec_specification: "RFC_4281", # accepts RFC_4281, RFC_6381
          constant_iv: "__stringMin32Max32",
          destination: { # required
            destination_ref_id: "__string",
          },
          directory_structure: "SINGLE_DIRECTORY", # accepts SINGLE_DIRECTORY, SUBDIRECTORY_PER_STREAM
          discontinuity_tags: "INSERT", # accepts INSERT, NEVER_INSERT
          encryption_type: "AES128", # accepts AES128, SAMPLE_AES
          hls_cdn_settings: {
            hls_akamai_settings: {
              connection_retry_interval: 1,
              filecache_duration: 1,
              http_transfer_mode: "CHUNKED", # accepts CHUNKED, NON_CHUNKED
              num_retries: 1,
              restart_delay: 1,
              salt: "__string",
              token: "__string",
            },
            hls_basic_put_settings: {
              connection_retry_interval: 1,
              filecache_duration: 1,
              num_retries: 1,
              restart_delay: 1,
            },
            hls_media_store_settings: {
              connection_retry_interval: 1,
              filecache_duration: 1,
              media_store_storage_class: "TEMPORAL", # accepts TEMPORAL
              num_retries: 1,
              restart_delay: 1,
            },
            hls_webdav_settings: {
              connection_retry_interval: 1,
              filecache_duration: 1,
              http_transfer_mode: "CHUNKED", # accepts CHUNKED, NON_CHUNKED
              num_retries: 1,
              restart_delay: 1,
            },
          },
          hls_id_3_segment_tagging: "DISABLED", # accepts DISABLED, ENABLED
          i_frame_only_playlists: "DISABLED", # accepts DISABLED, STANDARD
          incomplete_segment_behavior: "AUTO", # accepts AUTO, SUPPRESS
          index_n_segments: 1,
          input_loss_action: "EMIT_OUTPUT", # accepts EMIT_OUTPUT, PAUSE_OUTPUT
          iv_in_manifest: "EXCLUDE", # accepts EXCLUDE, INCLUDE
          iv_source: "EXPLICIT", # accepts EXPLICIT, FOLLOWS_SEGMENT_NUMBER
          keep_segments: 1,
          key_format: "__string",
          key_format_versions: "__string",
          key_provider_settings: {
            static_key_settings: {
              key_provider_server: {
                password_param: "__string",
                uri: "__string", # required
                username: "__string",
              },
              static_key_value: "__stringMin32Max32", # required
            },
          },
          manifest_compression: "GZIP", # accepts GZIP, NONE
          manifest_duration_format: "FLOATING_POINT", # accepts FLOATING_POINT, INTEGER
          min_segment_length: 1,
          mode: "LIVE", # accepts LIVE, VOD
          output_selection: "MANIFESTS_AND_SEGMENTS", # accepts MANIFESTS_AND_SEGMENTS, SEGMENTS_ONLY, VARIANT_MANIFESTS_AND_SEGMENTS
          program_date_time: "EXCLUDE", # accepts EXCLUDE, INCLUDE
          program_date_time_period: 1,
          redundant_manifest: "DISABLED", # accepts DISABLED, ENABLED
          segment_length: 1,
          segmentation_mode: "USE_INPUT_SEGMENTATION", # accepts USE_INPUT_SEGMENTATION, USE_SEGMENT_DURATION
          segments_per_subdirectory: 1,
          stream_inf_resolution: "EXCLUDE", # accepts EXCLUDE, INCLUDE
          timed_metadata_id_3_frame: "NONE", # accepts NONE, PRIV, TDRL
          timed_metadata_id_3_period: 1,
          timestamp_delta_milliseconds: 1,
          ts_file_mode: "SEGMENTED_FILES", # accepts SEGMENTED_FILES, SINGLE_FILE
        },
        media_package_group_settings: {
          destination: { # required
            destination_ref_id: "__string",
          },
        },
        ms_smooth_group_settings: {
          acquisition_point_id: "__string",
          audio_only_timecode_control: "PASSTHROUGH", # accepts PASSTHROUGH, USE_CONFIGURED_CLOCK
          certificate_mode: "SELF_SIGNED", # accepts SELF_SIGNED, VERIFY_AUTHENTICITY
          connection_retry_interval: 1,
          destination: { # required
            destination_ref_id: "__string",
          },
          event_id: "__string",
          event_id_mode: "NO_EVENT_ID", # accepts NO_EVENT_ID, USE_CONFIGURED, USE_TIMESTAMP
          event_stop_behavior: "NONE", # accepts NONE, SEND_EOS
          filecache_duration: 1,
          fragment_length: 1,
          input_loss_action: "EMIT_OUTPUT", # accepts EMIT_OUTPUT, PAUSE_OUTPUT
          num_retries: 1,
          restart_delay: 1,
          segmentation_mode: "USE_INPUT_SEGMENTATION", # accepts USE_INPUT_SEGMENTATION, USE_SEGMENT_DURATION
          send_delay_ms: 1,
          sparse_track_type: "NONE", # accepts NONE, SCTE_35, SCTE_35_WITHOUT_SEGMENTATION
          stream_manifest_behavior: "DO_NOT_SEND", # accepts DO_NOT_SEND, SEND
          timestamp_offset: "__string",
          timestamp_offset_mode: "USE_CONFIGURED_OFFSET", # accepts USE_CONFIGURED_OFFSET, USE_EVENT_START_DATE
        },
        multiplex_group_settings: {
        },
        rtmp_group_settings: {
          ad_markers: ["ON_CUE_POINT_SCTE35"], # accepts ON_CUE_POINT_SCTE35
          authentication_scheme: "AKAMAI", # accepts AKAMAI, COMMON
          cache_full_behavior: "DISCONNECT_IMMEDIATELY", # accepts DISCONNECT_IMMEDIATELY, WAIT_FOR_SERVER
          cache_length: 1,
          caption_data: "ALL", # accepts ALL, FIELD1_608, FIELD1_AND_FIELD2_608
          input_loss_action: "EMIT_OUTPUT", # accepts EMIT_OUTPUT, PAUSE_OUTPUT
          restart_delay: 1,
        },
        udp_group_settings: {
          input_loss_action: "DROP_PROGRAM", # accepts DROP_PROGRAM, DROP_TS, EMIT_PROGRAM
          timed_metadata_id_3_frame: "NONE", # accepts NONE, PRIV, TDRL
          timed_metadata_id_3_period: 1,
        },
      },
      outputs: [ # required
        {
          audio_description_names: ["__string"],
          caption_description_names: ["__string"],
          output_name: "__stringMin1Max255",
          output_settings: { # required
            archive_output_settings: {
              container_settings: { # required
                m2ts_settings: {
                  absent_input_audio_behavior: "DROP", # accepts DROP, ENCODE_SILENCE
                  arib: "DISABLED", # accepts DISABLED, ENABLED
                  arib_captions_pid: "__string",
                  arib_captions_pid_control: "AUTO", # accepts AUTO, USE_CONFIGURED
                  audio_buffer_model: "ATSC", # accepts ATSC, DVB
                  audio_frames_per_pes: 1,
                  audio_pids: "__string",
                  audio_stream_type: "ATSC", # accepts ATSC, DVB
                  bitrate: 1,
                  buffer_model: "MULTIPLEX", # accepts MULTIPLEX, NONE
                  cc_descriptor: "DISABLED", # accepts DISABLED, ENABLED
                  dvb_nit_settings: {
                    network_id: 1, # required
                    network_name: "__stringMin1Max256", # required
                    rep_interval: 1,
                  },
                  dvb_sdt_settings: {
                    output_sdt: "SDT_FOLLOW", # accepts SDT_FOLLOW, SDT_FOLLOW_IF_PRESENT, SDT_MANUAL, SDT_NONE
                    rep_interval: 1,
                    service_name: "__stringMin1Max256",
                    service_provider_name: "__stringMin1Max256",
                  },
                  dvb_sub_pids: "__string",
                  dvb_tdt_settings: {
                    rep_interval: 1,
                  },
                  dvb_teletext_pid: "__string",
                  ebif: "NONE", # accepts NONE, PASSTHROUGH
                  ebp_audio_interval: "VIDEO_AND_FIXED_INTERVALS", # accepts VIDEO_AND_FIXED_INTERVALS, VIDEO_INTERVAL
                  ebp_lookahead_ms: 1,
                  ebp_placement: "VIDEO_AND_AUDIO_PIDS", # accepts VIDEO_AND_AUDIO_PIDS, VIDEO_PID
                  ecm_pid: "__string",
                  es_rate_in_pes: "EXCLUDE", # accepts EXCLUDE, INCLUDE
                  etv_platform_pid: "__string",
                  etv_signal_pid: "__string",
                  fragment_time: 1.0,
                  klv: "NONE", # accepts NONE, PASSTHROUGH
                  klv_data_pids: "__string",
                  nielsen_id_3_behavior: "NO_PASSTHROUGH", # accepts NO_PASSTHROUGH, PASSTHROUGH
                  null_packet_bitrate: 1.0,
                  pat_interval: 1,
                  pcr_control: "CONFIGURED_PCR_PERIOD", # accepts CONFIGURED_PCR_PERIOD, PCR_EVERY_PES_PACKET
                  pcr_period: 1,
                  pcr_pid: "__string",
                  pmt_interval: 1,
                  pmt_pid: "__string",
                  program_num: 1,
                  rate_mode: "CBR", # accepts CBR, VBR
                  scte_27_pids: "__string",
                  scte_35_control: "NONE", # accepts NONE, PASSTHROUGH
                  scte_35_pid: "__string",
                  segmentation_markers: "EBP", # accepts EBP, EBP_LEGACY, NONE, PSI_SEGSTART, RAI_ADAPT, RAI_SEGSTART
                  segmentation_style: "MAINTAIN_CADENCE", # accepts MAINTAIN_CADENCE, RESET_CADENCE
                  segmentation_time: 1.0,
                  timed_metadata_behavior: "NO_PASSTHROUGH", # accepts NO_PASSTHROUGH, PASSTHROUGH
                  timed_metadata_pid: "__string",
                  transport_stream_id: 1,
                  video_pid: "__string",
                },
                raw_settings: {
                },
              },
              extension: "__string",
              name_modifier: "__string",
            },
            frame_capture_output_settings: {
              name_modifier: "__string",
            },
            hls_output_settings: {
              h265_packaging_type: "HEV1", # accepts HEV1, HVC1
              hls_settings: { # required
                audio_only_hls_settings: {
                  audio_group_id: "__string",
                  audio_only_image: {
                    password_param: "__string",
                    uri: "__string", # required
                    username: "__string",
                  },
                  audio_track_type: "ALTERNATE_AUDIO_AUTO_SELECT", # accepts ALTERNATE_AUDIO_AUTO_SELECT, ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT, ALTERNATE_AUDIO_NOT_AUTO_SELECT, AUDIO_ONLY_VARIANT_STREAM
                  segment_type: "AAC", # accepts AAC, FMP4
                },
                fmp_4_hls_settings: {
                  audio_rendition_sets: "__string",
                  nielsen_id_3_behavior: "NO_PASSTHROUGH", # accepts NO_PASSTHROUGH, PASSTHROUGH
                  timed_metadata_behavior: "NO_PASSTHROUGH", # accepts NO_PASSTHROUGH, PASSTHROUGH
                },
                standard_hls_settings: {
                  audio_rendition_sets: "__string",
                  m3u_8_settings: { # required
                    audio_frames_per_pes: 1,
                    audio_pids: "__string",
                    ecm_pid: "__string",
                    nielsen_id_3_behavior: "NO_PASSTHROUGH", # accepts NO_PASSTHROUGH, PASSTHROUGH
                    pat_interval: 1,
                    pcr_control: "CONFIGURED_PCR_PERIOD", # accepts CONFIGURED_PCR_PERIOD, PCR_EVERY_PES_PACKET
                    pcr_period: 1,
                    pcr_pid: "__string",
                    pmt_interval: 1,
                    pmt_pid: "__string",
                    program_num: 1,
                    scte_35_behavior: "NO_PASSTHROUGH", # accepts NO_PASSTHROUGH, PASSTHROUGH
                    scte_35_pid: "__string",
                    timed_metadata_behavior: "NO_PASSTHROUGH", # accepts NO_PASSTHROUGH, PASSTHROUGH
                    timed_metadata_pid: "__string",
                    transport_stream_id: 1,
                    video_pid: "__string",
                  },
                },
              },
              name_modifier: "__stringMin1",
              segment_modifier: "__string",
            },
            media_package_output_settings: {
            },
            ms_smooth_output_settings: {
              h265_packaging_type: "HEV1", # accepts HEV1, HVC1
              name_modifier: "__string",
            },
            multiplex_output_settings: {
              destination: { # required
                destination_ref_id: "__string",
              },
            },
            rtmp_output_settings: {
              certificate_mode: "SELF_SIGNED", # accepts SELF_SIGNED, VERIFY_AUTHENTICITY
              connection_retry_interval: 1,
              destination: { # required
                destination_ref_id: "__string",
              },
              num_retries: 1,
            },
            udp_output_settings: {
              buffer_msec: 1,
              container_settings: { # required
                m2ts_settings: {
                  absent_input_audio_behavior: "DROP", # accepts DROP, ENCODE_SILENCE
                  arib: "DISABLED", # accepts DISABLED, ENABLED
                  arib_captions_pid: "__string",
                  arib_captions_pid_control: "AUTO", # accepts AUTO, USE_CONFIGURED
                  audio_buffer_model: "ATSC", # accepts ATSC, DVB
                  audio_frames_per_pes: 1,
                  audio_pids: "__string",
                  audio_stream_type: "ATSC", # accepts ATSC, DVB
                  bitrate: 1,
                  buffer_model: "MULTIPLEX", # accepts MULTIPLEX, NONE
                  cc_descriptor: "DISABLED", # accepts DISABLED, ENABLED
                  dvb_nit_settings: {
                    network_id: 1, # required
                    network_name: "__stringMin1Max256", # required
                    rep_interval: 1,
                  },
                  dvb_sdt_settings: {
                    output_sdt: "SDT_FOLLOW", # accepts SDT_FOLLOW, SDT_FOLLOW_IF_PRESENT, SDT_MANUAL, SDT_NONE
                    rep_interval: 1,
                    service_name: "__stringMin1Max256",
                    service_provider_name: "__stringMin1Max256",
                  },
                  dvb_sub_pids: "__string",
                  dvb_tdt_settings: {
                    rep_interval: 1,
                  },
                  dvb_teletext_pid: "__string",
                  ebif: "NONE", # accepts NONE, PASSTHROUGH
                  ebp_audio_interval: "VIDEO_AND_FIXED_INTERVALS", # accepts VIDEO_AND_FIXED_INTERVALS, VIDEO_INTERVAL
                  ebp_lookahead_ms: 1,
                  ebp_placement: "VIDEO_AND_AUDIO_PIDS", # accepts VIDEO_AND_AUDIO_PIDS, VIDEO_PID
                  ecm_pid: "__string",
                  es_rate_in_pes: "EXCLUDE", # accepts EXCLUDE, INCLUDE
                  etv_platform_pid: "__string",
                  etv_signal_pid: "__string",
                  fragment_time: 1.0,
                  klv: "NONE", # accepts NONE, PASSTHROUGH
                  klv_data_pids: "__string",
                  nielsen_id_3_behavior: "NO_PASSTHROUGH", # accepts NO_PASSTHROUGH, PASSTHROUGH
                  null_packet_bitrate: 1.0,
                  pat_interval: 1,
                  pcr_control: "CONFIGURED_PCR_PERIOD", # accepts CONFIGURED_PCR_PERIOD, PCR_EVERY_PES_PACKET
                  pcr_period: 1,
                  pcr_pid: "__string",
                  pmt_interval: 1,
                  pmt_pid: "__string",
                  program_num: 1,
                  rate_mode: "CBR", # accepts CBR, VBR
                  scte_27_pids: "__string",
                  scte_35_control: "NONE", # accepts NONE, PASSTHROUGH
                  scte_35_pid: "__string",
                  segmentation_markers: "EBP", # accepts EBP, EBP_LEGACY, NONE, PSI_SEGSTART, RAI_ADAPT, RAI_SEGSTART
                  segmentation_style: "MAINTAIN_CADENCE", # accepts MAINTAIN_CADENCE, RESET_CADENCE
                  segmentation_time: 1.0,
                  timed_metadata_behavior: "NO_PASSTHROUGH", # accepts NO_PASSTHROUGH, PASSTHROUGH
                  timed_metadata_pid: "__string",
                  transport_stream_id: 1,
                  video_pid: "__string",
                },
              },
              destination: { # required
                destination_ref_id: "__string",
              },
              fec_output_settings: {
                column_depth: 1,
                include_fec: "COLUMN", # accepts COLUMN, COLUMN_AND_ROW
                row_length: 1,
              },
            },
          },
          video_description_name: "__string",
        },
      ],
    },
  ],
  timecode_config: { # required
    source: "EMBEDDED", # required, accepts EMBEDDED, SYSTEMCLOCK, ZEROBASED
    sync_threshold: 1,
  },
  video_descriptions: [ # required
    {
      codec_settings: {
        frame_capture_settings: {
          capture_interval: 1, # required
          capture_interval_units: "MILLISECONDS", # accepts MILLISECONDS, SECONDS
        },
        h264_settings: {
          adaptive_quantization: "HIGH", # accepts HIGH, HIGHER, LOW, MAX, MEDIUM, OFF
          afd_signaling: "AUTO", # accepts AUTO, FIXED, NONE
          bitrate: 1,
          buf_fill_pct: 1,
          buf_size: 1,
          color_metadata: "IGNORE", # accepts IGNORE, INSERT
          color_space_settings: {
            color_space_passthrough_settings: {
            },
            rec_601_settings: {
            },
            rec_709_settings: {
            },
          },
          entropy_encoding: "CABAC", # accepts CABAC, CAVLC
          filter_settings: {
            temporal_filter_settings: {
              post_filter_sharpening: "AUTO", # accepts AUTO, DISABLED, ENABLED
              strength: "AUTO", # accepts AUTO, STRENGTH_1, STRENGTH_2, STRENGTH_3, STRENGTH_4, STRENGTH_5, STRENGTH_6, STRENGTH_7, STRENGTH_8, STRENGTH_9, STRENGTH_10, STRENGTH_11, STRENGTH_12, STRENGTH_13, STRENGTH_14, STRENGTH_15, STRENGTH_16
            },
          },
          fixed_afd: "AFD_0000", # accepts AFD_0000, AFD_0010, AFD_0011, AFD_0100, AFD_1000, AFD_1001, AFD_1010, AFD_1011, AFD_1101, AFD_1110, AFD_1111
          flicker_aq: "DISABLED", # accepts DISABLED, ENABLED
          force_field_pictures: "DISABLED", # accepts DISABLED, ENABLED
          framerate_control: "INITIALIZE_FROM_SOURCE", # accepts INITIALIZE_FROM_SOURCE, SPECIFIED
          framerate_denominator: 1,
          framerate_numerator: 1,
          gop_b_reference: "DISABLED", # accepts DISABLED, ENABLED
          gop_closed_cadence: 1,
          gop_num_b_frames: 1,
          gop_size: 1.0,
          gop_size_units: "FRAMES", # accepts FRAMES, SECONDS
          level: "H264_LEVEL_1", # accepts H264_LEVEL_1, H264_LEVEL_1_1, H264_LEVEL_1_2, H264_LEVEL_1_3, H264_LEVEL_2, H264_LEVEL_2_1, H264_LEVEL_2_2, H264_LEVEL_3, H264_LEVEL_3_1, H264_LEVEL_3_2, H264_LEVEL_4, H264_LEVEL_4_1, H264_LEVEL_4_2, H264_LEVEL_5, H264_LEVEL_5_1, H264_LEVEL_5_2, H264_LEVEL_AUTO
          look_ahead_rate_control: "HIGH", # accepts HIGH, LOW, MEDIUM
          max_bitrate: 1,
          min_i_interval: 1,
          num_ref_frames: 1,
          par_control: "INITIALIZE_FROM_SOURCE", # accepts INITIALIZE_FROM_SOURCE, SPECIFIED
          par_denominator: 1,
          par_numerator: 1,
          profile: "BASELINE", # accepts BASELINE, HIGH, HIGH_10BIT, HIGH_422, HIGH_422_10BIT, MAIN
          quality_level: "ENHANCED_QUALITY", # accepts ENHANCED_QUALITY, STANDARD_QUALITY
          qvbr_quality_level: 1,
          rate_control_mode: "CBR", # accepts CBR, MULTIPLEX, QVBR, VBR
          scan_type: "INTERLACED", # accepts INTERLACED, PROGRESSIVE
          scene_change_detect: "DISABLED", # accepts DISABLED, ENABLED
          slices: 1,
          softness: 1,
          spatial_aq: "DISABLED", # accepts DISABLED, ENABLED
          subgop_length: "DYNAMIC", # accepts DYNAMIC, FIXED
          syntax: "DEFAULT", # accepts DEFAULT, RP2027
          temporal_aq: "DISABLED", # accepts DISABLED, ENABLED
          timecode_insertion: "DISABLED", # accepts DISABLED, PIC_TIMING_SEI
        },
        h265_settings: {
          adaptive_quantization: "HIGH", # accepts HIGH, HIGHER, LOW, MAX, MEDIUM, OFF
          afd_signaling: "AUTO", # accepts AUTO, FIXED, NONE
          alternative_transfer_function: "INSERT", # accepts INSERT, OMIT
          bitrate: 1,
          buf_size: 1,
          color_metadata: "IGNORE", # accepts IGNORE, INSERT
          color_space_settings: {
            color_space_passthrough_settings: {
            },
            hdr_10_settings: {
              max_cll: 1,
              max_fall: 1,
            },
            rec_601_settings: {
            },
            rec_709_settings: {
            },
          },
          filter_settings: {
            temporal_filter_settings: {
              post_filter_sharpening: "AUTO", # accepts AUTO, DISABLED, ENABLED
              strength: "AUTO", # accepts AUTO, STRENGTH_1, STRENGTH_2, STRENGTH_3, STRENGTH_4, STRENGTH_5, STRENGTH_6, STRENGTH_7, STRENGTH_8, STRENGTH_9, STRENGTH_10, STRENGTH_11, STRENGTH_12, STRENGTH_13, STRENGTH_14, STRENGTH_15, STRENGTH_16
            },
          },
          fixed_afd: "AFD_0000", # accepts AFD_0000, AFD_0010, AFD_0011, AFD_0100, AFD_1000, AFD_1001, AFD_1010, AFD_1011, AFD_1101, AFD_1110, AFD_1111
          flicker_aq: "DISABLED", # accepts DISABLED, ENABLED
          framerate_denominator: 1, # required
          framerate_numerator: 1, # required
          gop_closed_cadence: 1,
          gop_size: 1.0,
          gop_size_units: "FRAMES", # accepts FRAMES, SECONDS
          level: "H265_LEVEL_1", # accepts H265_LEVEL_1, H265_LEVEL_2, H265_LEVEL_2_1, H265_LEVEL_3, H265_LEVEL_3_1, H265_LEVEL_4, H265_LEVEL_4_1, H265_LEVEL_5, H265_LEVEL_5_1, H265_LEVEL_5_2, H265_LEVEL_6, H265_LEVEL_6_1, H265_LEVEL_6_2, H265_LEVEL_AUTO
          look_ahead_rate_control: "HIGH", # accepts HIGH, LOW, MEDIUM
          max_bitrate: 1,
          min_i_interval: 1,
          par_denominator: 1,
          par_numerator: 1,
          profile: "MAIN", # accepts MAIN, MAIN_10BIT
          qvbr_quality_level: 1,
          rate_control_mode: "CBR", # accepts CBR, MULTIPLEX, QVBR
          scan_type: "INTERLACED", # accepts INTERLACED, PROGRESSIVE
          scene_change_detect: "DISABLED", # accepts DISABLED, ENABLED
          slices: 1,
          tier: "HIGH", # accepts HIGH, MAIN
          timecode_insertion: "DISABLED", # accepts DISABLED, PIC_TIMING_SEI
        },
        mpeg_2_settings: {
          adaptive_quantization: "AUTO", # accepts AUTO, HIGH, LOW, MEDIUM, OFF
          afd_signaling: "AUTO", # accepts AUTO, FIXED, NONE
          color_metadata: "IGNORE", # accepts IGNORE, INSERT
          color_space: "AUTO", # accepts AUTO, PASSTHROUGH
          display_aspect_ratio: "DISPLAYRATIO16X9", # accepts DISPLAYRATIO16X9, DISPLAYRATIO4X3
          filter_settings: {
            temporal_filter_settings: {
              post_filter_sharpening: "AUTO", # accepts AUTO, DISABLED, ENABLED
              strength: "AUTO", # accepts AUTO, STRENGTH_1, STRENGTH_2, STRENGTH_3, STRENGTH_4, STRENGTH_5, STRENGTH_6, STRENGTH_7, STRENGTH_8, STRENGTH_9, STRENGTH_10, STRENGTH_11, STRENGTH_12, STRENGTH_13, STRENGTH_14, STRENGTH_15, STRENGTH_16
            },
          },
          fixed_afd: "AFD_0000", # accepts AFD_0000, AFD_0010, AFD_0011, AFD_0100, AFD_1000, AFD_1001, AFD_1010, AFD_1011, AFD_1101, AFD_1110, AFD_1111
          framerate_denominator: 1, # required
          framerate_numerator: 1, # required
          gop_closed_cadence: 1,
          gop_num_b_frames: 1,
          gop_size: 1.0,
          gop_size_units: "FRAMES", # accepts FRAMES, SECONDS
          scan_type: "INTERLACED", # accepts INTERLACED, PROGRESSIVE
          subgop_length: "DYNAMIC", # accepts DYNAMIC, FIXED
          timecode_insertion: "DISABLED", # accepts DISABLED, GOP_TIMECODE
        },
      },
      height: 1,
      name: "__string", # required
      respond_to_afd: "NONE", # accepts NONE, PASSTHROUGH, RESPOND
      scaling_behavior: "DEFAULT", # accepts DEFAULT, STRETCH_TO_OUTPUT
      sharpness: 1,
      width: 1,
    },
  ],
}

Encoder Settings

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#audio_descriptionsArray<Types::AudioDescription>

Returns:

#avail_blankingTypes::AvailBlanking

Settings for ad avail blanking.

Returns:

#avail_configurationTypes::AvailConfiguration

Event-wide configuration settings for ad avail insertion.

Returns:

#blackout_slateTypes::BlackoutSlate

Settings for blackout slate.

Returns:

#caption_descriptionsArray<Types::CaptionDescription>

Settings for caption decriptions

Returns:

#feature_activationsTypes::FeatureActivations

Feature Activations

Returns:

#global_configurationTypes::GlobalConfiguration

Configuration settings that apply to the event as a whole.

Returns:

#nielsen_configurationTypes::NielsenConfiguration

Nielsen configuration settings.

Returns:

#output_groupsArray<Types::OutputGroup>

Returns:

#timecode_configTypes::TimecodeConfig

Contains settings used to acquire and adjust timecode information from inputs.

Returns:

  • (Types::TimecodeConfig)

    Contains settings used to acquire and adjust timecode information from inputs.

#video_descriptionsArray<Types::VideoDescription>

Returns: