Class CaptionSource
- All Implemented Interfaces:
Serializable
,Cloneable
A source file for the input sidecar captions used during the transcoding process.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The encryption settings, if any, that you want Elastic Transcoder to apply to your caption sources.getKey()
The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.getLabel()
The label of the caption shown in the player when choosing a language.A string that specifies the language of the caption.For clip generation or captions that do not start at the same time as the associated video file, theTimeOffset
tells Elastic Transcoder how much of the video to encode before including captions.int
hashCode()
void
setEncryption
(Encryption encryption) The encryption settings, if any, that you want Elastic Transcoder to apply to your caption sources.void
The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.void
The label of the caption shown in the player when choosing a language.void
setLanguage
(String language) A string that specifies the language of the caption.void
setTimeOffset
(String timeOffset) For clip generation or captions that do not start at the same time as the associated video file, theTimeOffset
tells Elastic Transcoder how much of the video to encode before including captions.toString()
Returns a string representation of this object; useful for testing and debugging.withEncryption
(Encryption encryption) The encryption settings, if any, that you want Elastic Transcoder to apply to your caption sources.The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.The label of the caption shown in the player when choosing a language.withLanguage
(String language) A string that specifies the language of the caption.withTimeOffset
(String timeOffset) For clip generation or captions that do not start at the same time as the associated video file, theTimeOffset
tells Elastic Transcoder how much of the video to encode before including captions.
-
Constructor Details
-
CaptionSource
public CaptionSource()
-
-
Method Details
-
setKey
The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
- Parameters:
key
- The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
-
getKey
The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
- Returns:
- The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
-
withKey
The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
- Parameters:
key
- The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLanguage
A string that specifies the language of the caption. Specify this as one of:
-
2-character ISO 639-1 code
-
3-character ISO 639-2 code
For more information on ISO language codes and language names, see the List of ISO 639-1 codes.
- Parameters:
language
- A string that specifies the language of the caption. Specify this as one of:-
2-character ISO 639-1 code
-
3-character ISO 639-2 code
For more information on ISO language codes and language names, see the List of ISO 639-1 codes.
-
-
-
getLanguage
A string that specifies the language of the caption. Specify this as one of:
-
2-character ISO 639-1 code
-
3-character ISO 639-2 code
For more information on ISO language codes and language names, see the List of ISO 639-1 codes.
- Returns:
- A string that specifies the language of the caption. Specify this
as one of:
-
2-character ISO 639-1 code
-
3-character ISO 639-2 code
For more information on ISO language codes and language names, see the List of ISO 639-1 codes.
-
-
-
withLanguage
A string that specifies the language of the caption. Specify this as one of:
-
2-character ISO 639-1 code
-
3-character ISO 639-2 code
For more information on ISO language codes and language names, see the List of ISO 639-1 codes.
- Parameters:
language
- A string that specifies the language of the caption. Specify this as one of:-
2-character ISO 639-1 code
-
3-character ISO 639-2 code
For more information on ISO language codes and language names, see the List of ISO 639-1 codes.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
setTimeOffset
For clip generation or captions that do not start at the same time as the associated video file, the
TimeOffset
tells Elastic Transcoder how much of the video to encode before including captions.Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
- Parameters:
timeOffset
- For clip generation or captions that do not start at the same time as the associated video file, theTimeOffset
tells Elastic Transcoder how much of the video to encode before including captions.Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
-
getTimeOffset
For clip generation or captions that do not start at the same time as the associated video file, the
TimeOffset
tells Elastic Transcoder how much of the video to encode before including captions.Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
- Returns:
- For clip generation or captions that do not start at the same
time as the associated video file, the
TimeOffset
tells Elastic Transcoder how much of the video to encode before including captions.Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
-
withTimeOffset
For clip generation or captions that do not start at the same time as the associated video file, the
TimeOffset
tells Elastic Transcoder how much of the video to encode before including captions.Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
- Parameters:
timeOffset
- For clip generation or captions that do not start at the same time as the associated video file, theTimeOffset
tells Elastic Transcoder how much of the video to encode before including captions.Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLabel
The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.
- Parameters:
label
- The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.
-
getLabel
The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.
- Returns:
- The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.
-
withLabel
The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.
- Parameters:
label
- The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEncryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your caption sources.
- Parameters:
encryption
- The encryption settings, if any, that you want Elastic Transcoder to apply to your caption sources.
-
getEncryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your caption sources.
- Returns:
- The encryption settings, if any, that you want Elastic Transcoder to apply to your caption sources.
-
withEncryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your caption sources.
- Parameters:
encryption
- The encryption settings, if any, that you want Elastic Transcoder to apply to your caption sources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-