Class BlackoutSlate
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BlackoutSlate.Builder,
BlackoutSlate>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal InputLocation
Blackout slate image to be used.static BlackoutSlate.Builder
builder()
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 int
hashCode()
Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered.final String
Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered.final InputLocation
Path to local file to use as Network End Blackout image.final String
Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").static Class
<? extends BlackoutSlate.Builder> final BlackoutSlateState
state()
When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.final String
When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.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
-
blackoutSlateImage
Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.- Returns:
- Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
-
networkEndBlackout
Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".If the service returns an enum value that is not available in the current SDK version,
networkEndBlackout
will returnBlackoutSlateNetworkEndBlackout.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnetworkEndBlackoutAsString()
.- Returns:
- Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".
- See Also:
-
networkEndBlackoutAsString
Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".If the service returns an enum value that is not available in the current SDK version,
networkEndBlackout
will returnBlackoutSlateNetworkEndBlackout.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnetworkEndBlackoutAsString()
.- Returns:
- Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".
- See Also:
-
networkEndBlackoutImage
Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.- Returns:
- Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
-
networkId
Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").- Returns:
- Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
-
state
When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.If the service returns an enum value that is not available in the current SDK version,
state
will returnBlackoutSlateState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
- See Also:
-
stateAsString
When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.If the service returns an enum value that is not available in the current SDK version,
state
will returnBlackoutSlateState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
- 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<BlackoutSlate.Builder,
BlackoutSlate> - 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
-