Class AudioDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AudioDescription.Builder,
AudioDescription>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<DashRoleAudio> Identifies the DASH roles to assign to this audio output.Identifies the DASH roles to assign to this audio output.Advanced audio normalization settings.final String
The name of the AudioSelector used as the source for this AudioDescription.final AudioType
Applies only if audioTypeControl is useConfigured.final String
Applies only if audioTypeControl is useConfigured.Determines how audio type is determined.final String
Determines how audio type is determined.final AudioWatermarkSettings
Settings to configure one or more solutions that insert audio watermarks in the audio encodestatic AudioDescription.Builder
builder()
final AudioCodecSettings
Audio codec settings.final DvbDashAccessibility
Identifies DVB DASH accessibility signaling in this audio output.final String
Identifies DVB DASH accessibility signaling in this audio 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 AudioDashRoles property.final int
hashCode()
final String
RFC 5646 language code representing the language of the audio output track.Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input.final String
Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input.final String
name()
The name of this AudioDescription.final RemixSettings
Settings that control how input audio channels are remixed into the output audio channels.static Class
<? extends AudioDescription.Builder> final String
Used for MS Smooth and Apple HLS outputs.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
-
audioNormalizationSettings
Advanced audio normalization settings.- Returns:
- Advanced audio normalization settings.
-
audioSelectorName
The name of the AudioSelector used as the source for this AudioDescription.- Returns:
- The name of the AudioSelector used as the source for this AudioDescription.
-
audioType
Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.If the service returns an enum value that is not available in the current SDK version,
audioType
will returnAudioType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaudioTypeAsString()
.- Returns:
- Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
- See Also:
-
audioTypeAsString
Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.If the service returns an enum value that is not available in the current SDK version,
audioType
will returnAudioType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaudioTypeAsString()
.- Returns:
- Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
- See Also:
-
audioTypeControl
Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.If the service returns an enum value that is not available in the current SDK version,
audioTypeControl
will returnAudioDescriptionAudioTypeControl.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaudioTypeControlAsString()
.- Returns:
- Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.
- See Also:
-
audioTypeControlAsString
Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.If the service returns an enum value that is not available in the current SDK version,
audioTypeControl
will returnAudioDescriptionAudioTypeControl.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaudioTypeControlAsString()
.- Returns:
- Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.
- See Also:
-
audioWatermarkingSettings
Settings to configure one or more solutions that insert audio watermarks in the audio encode- Returns:
- Settings to configure one or more solutions that insert audio watermarks in the audio encode
-
codecSettings
Audio codec settings.- Returns:
- Audio codec settings.
-
languageCode
RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.- Returns:
- RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
-
languageCodeControl
Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.If the service returns an enum value that is not available in the current SDK version,
languageCodeControl
will returnAudioDescriptionLanguageCodeControl.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeControlAsString()
.- Returns:
- Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.
- See Also:
-
languageCodeControlAsString
Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.If the service returns an enum value that is not available in the current SDK version,
languageCodeControl
will returnAudioDescriptionLanguageCodeControl.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeControlAsString()
.- Returns:
- Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.
- See Also:
-
name
The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.- Returns:
- The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
-
remixSettings
Settings that control how input audio channels are remixed into the output audio channels.- Returns:
- Settings that control how input audio channels are remixed into the output audio channels.
-
streamName
Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).- Returns:
- Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
-
audioDashRoles
Identifies the DASH roles to assign to this audio output. Applies only when the audio output is configured for DVB DASH accessibility signaling.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAudioDashRoles()
method.- Returns:
- Identifies the DASH roles to assign to this audio output. Applies only when the audio output is configured for DVB DASH accessibility signaling.
-
hasAudioDashRoles
public final boolean hasAudioDashRoles()For responses, this returns true if the service returned a value for the AudioDashRoles 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. -
audioDashRolesAsStrings
Identifies the DASH roles to assign to this audio output. Applies only when the audio output is configured for DVB DASH accessibility signaling.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAudioDashRoles()
method.- Returns:
- Identifies the DASH roles to assign to this audio output. Applies only when the audio output is configured for DVB DASH accessibility signaling.
-
dvbDashAccessibility
Identifies DVB DASH accessibility signaling in this audio 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 audio output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.
- See Also:
-
dvbDashAccessibilityAsString
Identifies DVB DASH accessibility signaling in this audio 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 audio 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<AudioDescription.Builder,
AudioDescription> - 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
-