JobInput (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elastictranscoder.model.JobInput

All Implemented Interfaces:

Serializable
```
public class JobInput
extends Object
implements Serializable
```
Information about the file that you're transcoding.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

JobInput()

Constructors
Constructor and Description
`JobInput()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAspectRatio()` The aspect ratio of the input file.
`String`	`getContainer()` The container type for the input file.
`String`	`getFrameRate()` The frame rate of the input file.
`String`	`getInterlaced()` Whether the input file is interlaced.
`String`	`getKey()` The name of the file to transcode.
`String`	`getResolution()` This value must be `auto`, which causes Elastic Transcoder to automatically detect the resolution of the input file.
`int`	`hashCode()`
`void`	`setAspectRatio(String aspectRatio)` The aspect ratio of the input file.
`void`	`setContainer(String container)` The container type for the input file.
`void`	`setFrameRate(String frameRate)` The frame rate of the input file.
`void`	`setInterlaced(String interlaced)` Whether the input file is interlaced.
`void`	`setKey(String key)` The name of the file to transcode.
`void`	`setResolution(String resolution)` This value must be `auto`, which causes Elastic Transcoder to automatically detect the resolution of the input file.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`JobInput`	`withAspectRatio(String aspectRatio)` The aspect ratio of the input file.
`JobInput`	`withContainer(String container)` The container type for the input file.
`JobInput`	`withFrameRate(String frameRate)` The frame rate of the input file.
`JobInput`	`withInterlaced(String interlaced)` Whether the input file is interlaced.
`JobInput`	`withKey(String key)` The name of the file to transcode.
`JobInput`	`withResolution(String resolution)` This value must be `auto`, which causes Elastic Transcoder to automatically detect the resolution of the input file.

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

- Constructor Detail
  - JobInput
```
public JobInput()
```
- Method Detail
  - getKey
```
public String getKey()
```
    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.
    Constraints:
    Length: 1 - 255
    
    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.
  - setKey
```
public void setKey(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.
    Constraints:
    Length: 1 - 255
    
    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.
  - withKey
```
public JobInput withKey(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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 255
    
    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:
    A reference to this updated object so that method calls can be chained together.
  - getFrameRate
```
public String getFrameRate()
```
    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.
    Constraints:
    Pattern: (^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)
    
    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.
  - setFrameRate
```
public void setFrameRate(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.
    Constraints:
    Pattern: (^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)
    
    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.
  - withFrameRate
```
public JobInput withFrameRate(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 a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: (^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)
    
    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:
    A reference to this updated object so that method calls can be chained together.
  - getResolution
```
public String getResolution()
```
    This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.
    Constraints:
    Pattern: (^auto$)|(^\d{1,5}x\d{1,5}$)
    
    Returns:
    This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.
  - setResolution
```
public void setResolution(String resolution)
```
    This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.
    Constraints:
    Pattern: (^auto$)|(^\d{1,5}x\d{1,5}$)
    
    Parameters:
    resolution - This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.
  - withResolution
```
public JobInput withResolution(String resolution)
```
    This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: (^auto$)|(^\d{1,5}x\d{1,5}$)
    
    Parameters:
    resolution - This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAspectRatio
```
public String getAspectRatio()
```
    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.
    Constraints:
    Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)
    
    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.
  - setAspectRatio
```
public void setAspectRatio(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.
    Constraints:
    Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)
    
    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.
  - withAspectRatio
```
public JobInput withAspectRatio(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 a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)
    
    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:
    A reference to this updated object so that method calls can be chained together.
  - getInterlaced
```
public String getInterlaced()
```
    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.
    Constraints:
    Pattern: (^auto$)|(^true$)|(^false$)
    
    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.
  - setInterlaced
```
public void setInterlaced(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.
    Constraints:
    Pattern: (^auto$)|(^true$)|(^false$)
    
    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.
  - withInterlaced
```
public JobInput withInterlaced(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 a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: (^auto$)|(^true$)|(^false$)
    
    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:
    A reference to this updated object so that method calls can be chained together.
  - getContainer
```
public String getContainer()
```
    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
    Constraints:
    Pattern: (^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)
    
    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
  - setContainer
```
public void setContainer(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
    Constraints:
    Pattern: (^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)
    
    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
  - withContainer
```
public JobInput withContainer(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 a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: (^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)
    
    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:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class JobInput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobInput

Method Detail

getKey

setKey

withKey

getFrameRate

setFrameRate

withFrameRate

getResolution

setResolution

withResolution

getAspectRatio

setAspectRatio

withAspectRatio

getInterlaced

setInterlaced

withInterlaced

getContainer

setContainer

withContainer

toString

hashCode

equals