Class Captions
- java.lang.Object
-
- com.amazonaws.services.elastictranscoder.model.Captions
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class Captions extends Object implements Serializable, Cloneable
The captions to be created, if any.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Captions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Captions
clone()
boolean
equals(Object obj)
List<CaptionFormat>
getCaptionFormats()
The array of file formats for the output captions.List<CaptionSource>
getCaptionSources()
Source files for the input sidecar captions used during the transcoding process.String
getMergePolicy()
A policy that determines how Elastic Transcoder handles the existence of multiple captions.int
hashCode()
void
setCaptionFormats(Collection<CaptionFormat> captionFormats)
The array of file formats for the output captions.void
setCaptionSources(Collection<CaptionSource> captionSources)
Source files for the input sidecar captions used during the transcoding process.void
setMergePolicy(String mergePolicy)
A policy that determines how Elastic Transcoder handles the existence of multiple captions.String
toString()
Returns a string representation of this object; useful for testing and debugging.Captions
withCaptionFormats(CaptionFormat... captionFormats)
The array of file formats for the output captions.Captions
withCaptionFormats(Collection<CaptionFormat> captionFormats)
The array of file formats for the output captions.Captions
withCaptionSources(CaptionSource... captionSources)
Source files for the input sidecar captions used during the transcoding process.Captions
withCaptionSources(Collection<CaptionSource> captionSources)
Source files for the input sidecar captions used during the transcoding process.Captions
withMergePolicy(String mergePolicy)
A policy that determines how Elastic Transcoder handles the existence of multiple captions.
-
-
-
Method Detail
-
setMergePolicy
public void setMergePolicy(String mergePolicy)
A policy that determines how Elastic Transcoder handles the existence of multiple captions.
-
MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
-
MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If
CaptionSources
is empty, Elastic Transcoder omits all sidecar captions from the output files. -
Override: Elastic Transcoder transcodes only the sidecar captions that you specify in
CaptionSources
.
MergePolicy
cannot be null.- Parameters:
mergePolicy
- A policy that determines how Elastic Transcoder handles the existence of multiple captions.-
MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
-
MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If
CaptionSources
is empty, Elastic Transcoder omits all sidecar captions from the output files. -
Override: Elastic Transcoder transcodes only the sidecar captions that you specify in
CaptionSources
.
MergePolicy
cannot be null.-
-
-
getMergePolicy
public String getMergePolicy()
A policy that determines how Elastic Transcoder handles the existence of multiple captions.
-
MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
-
MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If
CaptionSources
is empty, Elastic Transcoder omits all sidecar captions from the output files. -
Override: Elastic Transcoder transcodes only the sidecar captions that you specify in
CaptionSources
.
MergePolicy
cannot be null.- Returns:
- A policy that determines how Elastic Transcoder handles the
existence of multiple captions.
-
MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
-
MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If
CaptionSources
is empty, Elastic Transcoder omits all sidecar captions from the output files. -
Override: Elastic Transcoder transcodes only the sidecar captions that you specify in
CaptionSources
.
MergePolicy
cannot be null. -
-
-
withMergePolicy
public Captions withMergePolicy(String mergePolicy)
A policy that determines how Elastic Transcoder handles the existence of multiple captions.
-
MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
-
MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If
CaptionSources
is empty, Elastic Transcoder omits all sidecar captions from the output files. -
Override: Elastic Transcoder transcodes only the sidecar captions that you specify in
CaptionSources
.
MergePolicy
cannot be null.- Parameters:
mergePolicy
- A policy that determines how Elastic Transcoder handles the existence of multiple captions.-
MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
-
MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If
CaptionSources
is empty, Elastic Transcoder omits all sidecar captions from the output files. -
Override: Elastic Transcoder transcodes only the sidecar captions that you specify in
CaptionSources
.
MergePolicy
cannot be null.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
getCaptionSources
public List<CaptionSource> getCaptionSources()
Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave
CaptionSources
blank.- Returns:
- Source files for the input sidecar captions used during the
transcoding process. To omit all sidecar captions, leave
CaptionSources
blank.
-
setCaptionSources
public void setCaptionSources(Collection<CaptionSource> captionSources)
Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave
CaptionSources
blank.- Parameters:
captionSources
- Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leaveCaptionSources
blank.
-
withCaptionSources
public Captions withCaptionSources(CaptionSource... captionSources)
Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave
CaptionSources
blank.NOTE: This method appends the values to the existing list (if any). Use
setCaptionSources(java.util.Collection)
orwithCaptionSources(java.util.Collection)
if you want to override the existing values.- Parameters:
captionSources
- Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leaveCaptionSources
blank.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withCaptionSources
public Captions withCaptionSources(Collection<CaptionSource> captionSources)
Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave
CaptionSources
blank.- Parameters:
captionSources
- Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leaveCaptionSources
blank.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getCaptionFormats
public List<CaptionFormat> getCaptionFormats()
The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.
- Returns:
- The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.
-
setCaptionFormats
public void setCaptionFormats(Collection<CaptionFormat> captionFormats)
The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.
- Parameters:
captionFormats
- The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.
-
withCaptionFormats
public Captions withCaptionFormats(CaptionFormat... captionFormats)
The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.
NOTE: This method appends the values to the existing list (if any). Use
setCaptionFormats(java.util.Collection)
orwithCaptionFormats(java.util.Collection)
if you want to override the existing values.- Parameters:
captionFormats
- The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withCaptionFormats
public Captions withCaptionFormats(Collection<CaptionFormat> captionFormats)
The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.
- Parameters:
captionFormats
- The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.- Returns:
- Returns a reference to this 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
-