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

Class: Aws::MediaConvert::Types::Input

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

Overview

Note:

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

{
  audio_selector_groups: {
    "__string" => {
      audio_selector_names: ["__stringMin1"],
    },
  },
  audio_selectors: {
    "__string" => {
      custom_language_code: "__stringMin3Max3PatternAZaZ3",
      default_selection: "DEFAULT", # accepts DEFAULT, NOT_DEFAULT
      external_audio_file_input: "__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE",
      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
      offset: 1,
      pids: [1],
      program_selection: 1,
      remix_settings: {
        channel_mapping: {
          output_channels: [
            {
              input_channels: [1],
            },
          ],
        },
        channels_in: 1,
        channels_out: 1,
      },
      selector_type: "PID", # accepts PID, TRACK, LANGUAGE_CODE
      tracks: [1],
    },
  },
  caption_selectors: {
    "__string" => {
      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
      source_settings: {
        ancillary_source_settings: {
          convert_608_to_708: "UPCONVERT", # accepts UPCONVERT, DISABLED
          source_ancillary_channel_number: 1,
          terminate_captions: "END_OF_INPUT", # accepts END_OF_INPUT, DISABLED
        },
        dvb_sub_source_settings: {
          pid: 1,
        },
        embedded_source_settings: {
          convert_608_to_708: "UPCONVERT", # accepts UPCONVERT, DISABLED
          source_608_channel_number: 1,
          source_608_track_number: 1,
          terminate_captions: "END_OF_INPUT", # accepts END_OF_INPUT, DISABLED
        },
        file_source_settings: {
          convert_608_to_708: "UPCONVERT", # accepts UPCONVERT, DISABLED
          framerate: {
            framerate_denominator: 1,
            framerate_numerator: 1,
          },
          source_file: "__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIHttpsSccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMI",
          time_delta: 1,
        },
        source_type: "ANCILLARY", # accepts ANCILLARY, DVB_SUB, EMBEDDED, SCTE20, SCC, TTML, STL, SRT, SMI, TELETEXT, NULL_SOURCE, IMSC
        teletext_source_settings: {
          page_number: "__stringMin3Max3Pattern1809aFAF09aEAE",
        },
        track_source_settings: {
          track_number: 1,
        },
      },
    },
  },
  crop: {
    height: 1,
    width: 1,
    x: 1,
    y: 1,
  },
  deblock_filter: "ENABLED", # accepts ENABLED, DISABLED
  decryption_settings: {
    decryption_mode: "AES_CTR", # accepts AES_CTR, AES_CBC, AES_GCM
    encrypted_decryption_key: "__stringMin24Max512PatternAZaZ0902",
    initialization_vector: "__stringMin16Max24PatternAZaZ0922AZaZ0916",
    kms_key_region: "__stringMin9Max19PatternAZ26EastWestCentralNorthSouthEastWest1912",
  },
  denoise_filter: "ENABLED", # accepts ENABLED, DISABLED
  file_input: "__stringPatternS3MM2PPMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL",
  filter_enable: "AUTO", # accepts AUTO, DISABLE, FORCE
  filter_strength: 1,
  image_inserter: {
    insertable_images: [
      {
        duration: 1,
        fade_in: 1,
        fade_out: 1,
        height: 1,
        image_inserter_input: "__stringMin14PatternS3BmpBMPPngPNGTgaTGAHttpsBmpBMPPngPNGTgaTGA",
        image_x: 1,
        image_y: 1,
        layer: 1,
        opacity: 1,
        start_time: "__stringPattern01D20305D205D",
        width: 1,
      },
    ],
  },
  input_clippings: [
    {
      end_timecode: "__stringPattern010920405090509092",
      start_timecode: "__stringPattern010920405090509092",
    },
  ],
  input_scan_type: "AUTO", # accepts AUTO, PSF
  position: {
    height: 1,
    width: 1,
    x: 1,
    y: 1,
  },
  program_number: 1,
  psi_control: "IGNORE_PSI", # accepts IGNORE_PSI, USE_PSI
  supplemental_imps: ["__stringPatternS3ASSETMAPXml"],
  timecode_source: "EMBEDDED", # accepts EMBEDDED, ZEROBASED, SPECIFIEDSTART
  timecode_start: "__stringMin11Max11Pattern01D20305D205D",
  video_selector: {
    alpha_behavior: "DISCARD", # accepts DISCARD, REMAP_TO_LUMA
    color_space: "FOLLOW", # accepts FOLLOW, REC_601, REC_709, HDR10, HLG_2020
    color_space_usage: "FORCE", # accepts FORCE, FALLBACK
    hdr_10_metadata: {
      blue_primary_x: 1,
      blue_primary_y: 1,
      green_primary_x: 1,
      green_primary_y: 1,
      max_content_light_level: 1,
      max_frame_average_light_level: 1,
      max_luminance: 1,
      min_luminance: 1,
      red_primary_x: 1,
      red_primary_y: 1,
      white_point_x: 1,
      white_point_y: 1,
    },
    pid: 1,
    program_number: 1,
    rotate: "DEGREE_0", # accepts DEGREE_0, DEGREES_90, DEGREES_180, DEGREES_270, AUTO
  },
}

Specifies media input

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#audio_selector_groups ⇒ Hash<String,Types::AudioSelectorGroup>

Specifies set of audio selectors within an input to combine. An input may have multiple audio selector groups. See \"Audio Selector Group\":#inputs-audio_selector_group for more information.

Returns:

#audio_selectors ⇒ Hash<String,Types::AudioSelector>

Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your outputs. You can use multiple Audio selectors per input.

Returns:

  • (Hash<String,Types::AudioSelector>) —

    Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your outputs.

#caption_selectors ⇒ Hash<String,Types::CaptionSelector>

Use captions selectors to specify the captions data from your input that you use in your outputs. You can use up to 20 captions selectors per input.

Returns:

  • (Hash<String,Types::CaptionSelector>) —

    Use captions selectors to specify the captions data from your input that you use in your outputs.

#crop ⇒ Types::Rectangle

Use Cropping selection (crop) to specify the video area that the service will include in the output video frame. If you specify a value here, it will override any value that you specify in the output setting Cropping selection (crop).

Returns:

  • (Types::Rectangle) —

    Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.

#deblock_filter ⇒ String

Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manually controllable for MPEG2 and uncompressed video inputs.

Possible values:

  • ENABLED
  • DISABLED

Returns:

  • (String) —

    Enable Deblock (InputDeblockFilter) to produce smoother motion in the output.

#decryption_settings ⇒ Types::InputDecryptionSettings

Settings for decrypting any input files that you encrypt before you upload them to Amazon S3. MediaConvert can decrypt files only when you use AWS Key Management Service (KMS) to encrypt the data key that you use to encrypt your content.

Returns:

#denoise_filter ⇒ String

Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs.

Possible values:

  • ENABLED
  • DISABLED

Returns:

  • (String) —

    Enable Denoise (InputDenoiseFilter) to filter noise from the input.

#file_input ⇒ String

Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input format is IMF, specify your input by providing the path to your CPL. For example, \"s3://bucket/vf/cpl.xml\". If the CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps) to specify any supplemental IMPs that contain assets referenced by the CPL.

Returns:

  • (String) —

    Specify the source file for your transcoding job.

#filter_enable ⇒ String

Specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The input is filtered regardless of input type.

Possible values:

  • AUTO
  • DISABLE
  • FORCE

Returns:

  • (String) —

    Specify how the transcoding service applies the denoise and deblock filters.

#filter_strength ⇒ Integer

Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0.

Returns:

  • (Integer) —

    Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise).

#image_inserter ⇒ Types::ImageInserter

Enable the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each input individually. This setting is disabled by default.

Returns:

  • (Types::ImageInserter) —

    Enable the image inserter feature to include a graphic overlay on your video.

#input_clippings ⇒ Array<Types::InputClipping>

(InputClippings) contains sets of start and end times that together specify a portion of the input to be used in the outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If you provide only an end time, it will be the entire input up to that point. When you specify more than one input clip, the transcoding service creates the job outputs by stringing the clips together in the order you specify them.

Returns:

  • (Array<Types::InputClipping>) —

    (InputClippings) contains sets of start and end times that together specify a portion of the input to be used in the outputs.

#input_scan_type ⇒ String

When you have a progressive segmented frame (PsF) input, use this setting to flag the input as PsF. MediaConvert doesn\'t automatically detect PsF. Therefore, flagging your input as PsF results in better preservation of video quality when you do deinterlacing and frame rate conversion. If you don\'t specify, the default value is Auto (AUTO). Auto is the correct setting for all inputs that are not PsF. Don\'t set this value to PsF when your input is interlaced. Doing so creates horizontal interlacing artifacts.

Possible values:

  • AUTO
  • PSF

Returns:

  • (String) —

    When you have a progressive segmented frame (PsF) input, use this setting to flag the input as PsF.

#position ⇒ Types::Rectangle

Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black. If you specify a value here, it will override any value that you specify in the output setting Selection placement (position). If you specify a value here, this will override any AFD values in your input, even if you set Respond to AFD (RespondToAfd) to Respond (RESPOND). If you specify a value here, this will ignore anything that you specify for the setting Scaling Behavior (scalingBehavior).

Returns:

  • (Types::Rectangle) —

    Use Selection placement (position) to define the video area in your output frame.

#program_number ⇒ Integer

Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn\'t exist, the transcoding service will use this default.

Returns:

  • (Integer) —

    Use Program (programNumber) to select a specific program from within a multi-program transport stream.

#psi_control ⇒ String

Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data.

Possible values:

  • IGNORE_PSI
  • USE_PSI

Returns:

  • (String) —

    Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans.

#supplemental_imps ⇒ Array<String>

Provide a list of any necessary supplemental IMPs. You need supplemental IMPs if the CPL that you\'re using for your input is in an incomplete IMP. Specify either the supplemental IMP directories with a trailing slash or the ASSETMAP.xml files. For example [\"s3://bucket/ov/\", \"s3://bucket/vf2/ASSETMAP.xml\"]. You don\'t need to specify the IMP that contains your input CPL, because the service automatically detects it.

Returns:

  • (Array<String>) —

    Provide a list of any necessary supplemental IMPs.

#timecode_source ⇒ String

Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the service counts input video frames. This input frame count affects only the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded (EMBEDDED) to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero. Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting Start timecode (timecodeStart). If you don\'t specify a value for Timecode source, the service will use Embedded by default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.

Possible values:

  • EMBEDDED
  • ZEROBASED
  • SPECIFIEDSTART

Returns:

  • (String) —

    Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the service counts input video frames.

#timecode_start ⇒ String

Specify the timecode that you want the service to use for this input\'s initial frame. To use this setting, you must set the Timecode source setting, located under the input settings (InputTimecodeSource), to Specified start (SPECIFIEDSTART). For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.

Returns:

  • (String) —

    Specify the timecode that you want the service to use for this input\'s initial frame.

#video_selector ⇒ Types::VideoSelector

Selector for video.

Returns: