Interface CaptionDescriptionPreset.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<CaptionDescriptionPreset.Builder,
,CaptionDescriptionPreset> SdkBuilder<CaptionDescriptionPreset.Builder,
,CaptionDescriptionPreset> SdkPojo
- Enclosing class:
CaptionDescriptionPreset
public static interface CaptionDescriptionPreset.Builder
extends SdkPojo, CopyableBuilder<CaptionDescriptionPreset.Builder,CaptionDescriptionPreset>
-
Method Summary
Modifier and TypeMethodDescriptioncustomLanguageCode
(String customLanguageCode) Specify the language for this captions output track.default CaptionDescriptionPreset.Builder
destinationSettings
(Consumer<CaptionDestinationSettings.Builder> destinationSettings) Settings related to one captions tab on the MediaConvert console.destinationSettings
(CaptionDestinationSettings destinationSettings) Settings related to one captions tab on the MediaConvert console.languageCode
(String languageCode) Specify the language of this captions output track.languageCode
(LanguageCode languageCode) Specify the language of this captions output track.languageDescription
(String languageDescription) Specify a label for this set of output captions.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
customLanguageCode
Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.- Parameters:
customLanguageCode
- Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinationSettings
CaptionDescriptionPreset.Builder destinationSettings(CaptionDestinationSettings destinationSettings) Settings related to one captions tab on the MediaConvert console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.- Parameters:
destinationSettings
- Settings related to one captions tab on the MediaConvert console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinationSettings
default CaptionDescriptionPreset.Builder destinationSettings(Consumer<CaptionDestinationSettings.Builder> destinationSettings) Settings related to one captions tab on the MediaConvert console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html. This is a convenience method that creates an instance of theCaptionDestinationSettings.Builder
avoiding the need to create one manually viaCaptionDestinationSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todestinationSettings(CaptionDestinationSettings)
.- Parameters:
destinationSettings
- a consumer that will call methods onCaptionDestinationSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
languageCode
Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.- Parameters:
languageCode
- Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
languageCode
Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.- Parameters:
languageCode
- Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
languageDescription
Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.- Parameters:
languageDescription
- Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-