JobInput (AWS SDK for Java - 2.0.0-preview-11)

java.lang.Object
- software.amazon.awssdk.services.elastictranscoder.model.JobInput

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<JobInput.Builder,JobInput>

@Generated(value="software.amazon.awssdk:codegen")
public final class JobInput
extends Object
implements StructuredPojo, ToCopyableBuilder<JobInput.Builder,JobInput>

Information about the file that you're transcoding.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface JobInput.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`JobInput.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`aspectRatio()` The aspect ratio of the input file.
`static JobInput.Builder`	`builder()`
`String`	`container()` The container type for the input file.
`DetectedProperties`	`detectedProperties()` The detected properties of the input file.
`Encryption`	`encryption()` The encryption settings, if any, that are used for decrypting your input files.
`boolean`	`equals(Object obj)`
`String`	`frameRate()` The frame rate of the input file.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`InputCaptions`	`inputCaptions()` You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another.
`String`	`interlaced()` Whether the input file is interlaced.
`String`	`key()` The name of the file to transcode.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`String`	`resolution()` This value must be `auto`, which causes Elastic Transcoder to automatically detect the resolution of the input file.
`static Class<? extends JobInput.Builder>`	`serializableBuilderClass()`
`TimeSpan`	`timeSpan()` Settings for clipping an input.
`JobInput.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - key
```
public 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.
    
    Returns:
    
    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.
  - frameRate
```
public 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.
    
    Returns:
    
    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.
  - resolution
```
public String resolution()
```
    This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.
    
    Returns:
    
    This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.
  - aspectRatio
```
public 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.
    
    Returns:
    
    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.
  - interlaced
```
public 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.
    
    Returns:
    
    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.
  - container
```
public 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
    
    Returns:
    
    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
  - encryption
```
public 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.
    
    Returns:
    
    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.
  - timeSpan
```
public TimeSpan timeSpan()
```
    Settings for clipping an input. Each input can have different clip settings.
    
    Returns:
    
    Settings for clipping an input. Each input can have different clip settings.
  - inputCaptions
```
public 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.
    Returns:
    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.
  - detectedProperties
```
public DetectedProperties detectedProperties()
```
    The detected properties of the input file.
    
    Returns:
    
    The detected properties of the input file.
  - toBuilder
```
public JobInput.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<JobInput.Builder,JobInput>
    
    Returns:
    
    a builder for type T
  - builder
```
public static JobInput.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends JobInput.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Class JobInput

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

key

frameRate

resolution

aspectRatio

interlaced

container

encryption

timeSpan

inputCaptions

detectedProperties

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

marshall