Package software.amazon.awssdk.services.elastictranscoder.model

Interface JobInput.Builder

All Superinterfaces:
Buildable, CopyableBuilder<JobInput.Builder,JobInput>, SdkBuilder<JobInput.Builder,JobInput>, SdkPojo
Enclosing class:
JobInput
public static interface JobInput.Builder extends SdkPojo, CopyableBuilder<JobInput.Builder,JobInput>

  • Method Details

    • key

      JobInput.Builder key(String key)

      The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The InputBucket object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.

      If the file name includes a prefix, such as cooking/lasagna.mpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

      Parameters:
      key - The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The InputBucket object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.

      If the file name includes a prefix, such as cooking/lasagna.mpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • frameRate

      JobInput.Builder frameRate(String frameRate)

      The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify auto. If you want to specify the frame rate for the input file, enter one of the following values:

      10, 15, 23.97, 24, 25, 29.97, 30, 60

      If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame rate.

      Parameters:
      frameRate - The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify auto. If you want to specify the frame rate for the input file, enter one of the following values:

      10, 15, 23.97, 24, 25, 29.97, 30, 60

      If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame rate.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resolution

      JobInput.Builder resolution(String resolution)

      This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.

      Parameters:
      resolution - This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • aspectRatio

      JobInput.Builder aspectRatio(String aspectRatio)

      The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify auto. If you want to specify the aspect ratio for the output file, enter one of the following values:

      1:1, 4:3, 3:2, 16:9

      If you specify a value other than auto, Elastic Transcoder disables automatic detection of the aspect ratio.

      Parameters:
      aspectRatio - The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify auto. If you want to specify the aspect ratio for the output file, enter one of the following values:

      1:1, 4:3, 3:2, 16:9

      If you specify a value other than auto, Elastic Transcoder disables automatic detection of the aspect ratio.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • interlaced

      JobInput.Builder interlaced(String interlaced)

      Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify auto. If you want to specify whether the input file is interlaced, enter one of the following values:

      true, false

      If you specify a value other than auto, Elastic Transcoder disables automatic detection of interlacing.

      Parameters:
      interlaced - Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify auto. If you want to specify whether the input file is interlaced, enter one of the following values:

      true, false

      If you specify a value other than auto, Elastic Transcoder disables automatic detection of interlacing.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • container

      JobInput.Builder container(String container)

      The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify auto. If you want to specify the container type for the input file, enter one of the following values:

      3gp, aac, asf, avi, divx, flv, m4a, mkv, mov, mp3, mp4, mpeg, mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm

      Parameters:
      container - The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify auto. If you want to specify the container type for the input file, enter one of the following values:

      3gp, aac, asf, avi, divx, flv, m4a, mkv, mov, mp3, mp4, mpeg, mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryption

      JobInput.Builder encryption(Encryption encryption)

      The encryption settings, if any, that are used for decrypting your input files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file.

      Parameters:
      encryption - The encryption settings, if any, that are used for decrypting your input files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryption

      default JobInput.Builder encryption(Consumer<Encryption.Builder> encryption)

      The encryption settings, if any, that are used for decrypting your input files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file.

      This is a convenience method that creates an instance of the Encryption.Builder avoiding the need to create one manually via Encryption.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryption(Encryption).

      Parameters:
      encryption - a consumer that will call methods on Encryption.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timeSpan

      JobInput.Builder timeSpan(TimeSpan timeSpan)

      Settings for clipping an input. Each input can have different clip settings.

      Parameters:
      timeSpan - Settings for clipping an input. Each input can have different clip settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeSpan

      default JobInput.Builder timeSpan(Consumer<TimeSpan.Builder> timeSpan)

      Settings for clipping an input. Each input can have different clip settings.

      This is a convenience method that creates an instance of the TimeSpan.Builder avoiding the need to create one manually via TimeSpan.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timeSpan(TimeSpan).

      Parameters:
      timeSpan - a consumer that will call methods on TimeSpan.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • inputCaptions

      JobInput.Builder inputCaptions(InputCaptions inputCaptions)

      You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

      • Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.

        Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text

        Valid outputs include: mov-text

        Elastic Transcoder supports a maximum of one embedded format per output.

      • Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.

        Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt

        Valid outputs include: dfxp (first div element only), scc, srt, and webvtt.

      If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

      Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.

      To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.

      For more information on embedded files, see the Subtitles Wikipedia page.

      For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

      Parameters:
      inputCaptions - You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

      • Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.

        Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text

        Valid outputs include: mov-text

        Elastic Transcoder supports a maximum of one embedded format per output.

      • Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.

        Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt

        Valid outputs include: dfxp (first div element only), scc, srt, and webvtt.

      If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

      Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.

      To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.

      For more information on embedded files, see the Subtitles Wikipedia page.

      For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputCaptions

      default JobInput.Builder inputCaptions(Consumer<InputCaptions.Builder> inputCaptions)

      You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

      • Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.

        Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text

        Valid outputs include: mov-text

        Elastic Transcoder supports a maximum of one embedded format per output.

      • Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.

        Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt

        Valid outputs include: dfxp (first div element only), scc, srt, and webvtt.

      If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

      Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.

      To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.

      For more information on embedded files, see the Subtitles Wikipedia page.

      For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

      This is a convenience method that creates an instance of the InputCaptions.Builder avoiding the need to create one manually via InputCaptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputCaptions(InputCaptions).

      Parameters:
      inputCaptions - a consumer that will call methods on InputCaptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • detectedProperties

      JobInput.Builder detectedProperties(DetectedProperties detectedProperties)

      The detected properties of the input file.

      Parameters:
      detectedProperties - The detected properties of the input file.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • detectedProperties

      default JobInput.Builder detectedProperties(Consumer<DetectedProperties.Builder> detectedProperties)

      The detected properties of the input file.

      This is a convenience method that creates an instance of the DetectedProperties.Builder avoiding the need to create one manually via DetectedProperties.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to detectedProperties(DetectedProperties).

      Parameters:
      detectedProperties - a consumer that will call methods on DetectedProperties.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: