Class CaptionDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CaptionDescription.Builder,
CaptionDescription>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AccessibilityType
Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds.final String
Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds.static CaptionDescription.Builder
builder()
final List
<DashRoleCaption> Identifies the DASH roles to assign to this captions output.Identifies the DASH roles to assign to this captions output.final String
Specifies which input caption selector to use as a caption source when generating output captions.Additional settings for captions destination that depend on the destination type.final DvbDashAccessibility
Identifies DVB DASH accessibility signaling in this captions output.final String
Identifies DVB DASH accessibility signaling in this captions output.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the CaptionDashRoles property.final int
hashCode()
final String
ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/final String
Human readable information to indicate captions available for players (eg.final String
name()
Name of the caption description.static Class
<? extends CaptionDescription.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
accessibility
Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.If the service returns an enum value that is not available in the current SDK version,
accessibility
will returnAccessibilityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaccessibilityAsString()
.- Returns:
- Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.
- See Also:
-
accessibilityAsString
Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.If the service returns an enum value that is not available in the current SDK version,
accessibility
will returnAccessibilityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaccessibilityAsString()
.- Returns:
- Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.
- See Also:
-
destinationSettings
Additional settings for captions destination that depend on the destination type.- Returns:
- Additional settings for captions destination that depend on the destination type.
-
languageCode
ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/- Returns:
- ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
-
languageDescription
Human readable information to indicate captions available for players (eg. English, or Spanish).- Returns:
- Human readable information to indicate captions available for players (eg. English, or Spanish).
-
name
Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.- Returns:
- Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
-
hasCaptionDashRoles
public final boolean hasCaptionDashRoles()For responses, this returns true if the service returned a value for the CaptionDashRoles property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
dvbDashAccessibility
Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.If the service returns an enum value that is not available in the current SDK version,
dvbDashAccessibility
will returnDvbDashAccessibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdvbDashAccessibilityAsString()
.- Returns:
- Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.
- See Also:
-
dvbDashAccessibilityAsString
Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.If the service returns an enum value that is not available in the current SDK version,
dvbDashAccessibility
will returnDvbDashAccessibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdvbDashAccessibilityAsString()
.- Returns:
- Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.
- See Also:
-
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 interfaceToCopyableBuilder<CaptionDescription.Builder,
CaptionDescription> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-