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

Class: Aws::MediaLive::Types::OutputGroup

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

Overview

Note:

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

{
  name: "__string",
  output_group_settings: {
    archive_group_settings: {
      destination: {
        destination_ref_id: "__string",
      },
      rollover_interval: 1,
    },
    hls_group_settings: {
      ad_markers: ["ADOBE"], # accepts ADOBE, ELEMENTAL, ELEMENTAL_SCTE35
      base_url_content: "__string",
      base_url_manifest: "__string",
      caption_language_mappings: [
        {
          caption_channel: 1,
          language_code: "__string",
          language_description: "__string",
        },
      ],
      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: "__string",
      destination: {
        destination_ref_id: "__string",
      },
      directory_structure: "SINGLE_DIRECTORY", # accepts SINGLE_DIRECTORY, SUBDIRECTORY_PER_STREAM
      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,
        },
      },
      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",
            username: "__string",
          },
          static_key_value: "__string",
        },
      },
      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
      program_date_time: "EXCLUDE", # accepts EXCLUDE, INCLUDE
      program_date_time_period: 1,
      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
    },
    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: {
        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
      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
    },
    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: [
    {
      audio_description_names: ["__string"],
      caption_description_names: ["__string"],
      output_name: "__string",
      output_settings: {
        archive_output_settings: {
          container_settings: {
            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,
                network_name: "__string",
                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: "__string",
                service_provider_name: "__string",
              },
              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",
              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",
            },
          },
          extension: "__string",
          name_modifier: "__string",
        },
        hls_output_settings: {
          hls_settings: {
            audio_only_hls_settings: {
              audio_group_id: "__string",
              audio_only_image: {
                password_param: "__string",
                uri: "__string",
                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
            },
            standard_hls_settings: {
              audio_rendition_sets: "__string",
              m3u_8_settings: {
                audio_frames_per_pes: 1,
                audio_pids: "__string",
                ecm_pid: "__string",
                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
                transport_stream_id: 1,
                video_pid: "__string",
              },
            },
          },
          name_modifier: "__string",
          segment_modifier: "__string",
        },
        ms_smooth_output_settings: {
          name_modifier: "__string",
        },
        udp_output_settings: {
          buffer_msec: 1,
          container_settings: {
            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,
                network_name: "__string",
                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: "__string",
                service_provider_name: "__string",
              },
              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",
              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: {
            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",
    },
  ],
}

Output groups for this Live Event. Output groups contain information about where streams should be distributed.

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.

Returns:

  • (String)


7340
7341
7342
7343
7344
7345
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 7340

class OutputGroup < Struct.new(
  :name,
  :output_group_settings,
  :outputs)
  include Aws::Structure
end

#output_group_settingsTypes::OutputGroupSettings

Settings associated with the output group.



7340
7341
7342
7343
7344
7345
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 7340

class OutputGroup < Struct.new(
  :name,
  :output_group_settings,
  :outputs)
  include Aws::Structure
end

#outputsArray<Types::Output>

Returns:



7340
7341
7342
7343
7344
7345
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 7340

class OutputGroup < Struct.new(
  :name,
  :output_group_settings,
  :outputs)
  include Aws::Structure
end