com.amazonaws.services.medialive.model

Class BlackoutSlate

java.lang.Object

com.amazonaws.services.medialive.model.BlackoutSlate

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BlackoutSlate
extends Object
implements Serializable, Cloneable, StructuredPojo

Blackout Slate

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
BlackoutSlate()

Method Summary

Modifier and Type	Method and Description
BlackoutSlate	clone()
boolean	equals(Object obj)
InputLocation	getBlackoutSlateImage() Blackout slate image to be used.
String	getNetworkEndBlackout() 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.
InputLocation	getNetworkEndBlackoutImage() Path to local file to use as Network End Blackout image.
String	getNetworkId() Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
String	getState() When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBlackoutSlateImage(InputLocation blackoutSlateImage) Blackout slate image to be used.
void	setNetworkEndBlackout(String 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.
void	setNetworkEndBlackoutImage(InputLocation networkEndBlackoutImage) Path to local file to use as Network End Blackout image.
void	setNetworkId(String networkId) Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
void	setState(String state) When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
String	toString() Returns a string representation of this object.
BlackoutSlate	withBlackoutSlateImage(InputLocation blackoutSlateImage) Blackout slate image to be used.
BlackoutSlate	withNetworkEndBlackout(BlackoutSlateNetworkEndBlackout 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.
BlackoutSlate	withNetworkEndBlackout(String 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.
BlackoutSlate	withNetworkEndBlackoutImage(InputLocation networkEndBlackoutImage) Path to local file to use as Network End Blackout image.
BlackoutSlate	withNetworkId(String networkId) Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
BlackoutSlate	withState(BlackoutSlateState state) When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
BlackoutSlate	withState(String state) When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BlackoutSlate

public BlackoutSlate()

Method Detail

setBlackoutSlateImage

public void setBlackoutSlateImage(InputLocation blackoutSlateImage)

Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.

Parameters:

blackoutSlateImage - Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.

getBlackoutSlateImage

public InputLocation getBlackoutSlateImage()

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.

withBlackoutSlateImage

public BlackoutSlate withBlackoutSlateImage(InputLocation blackoutSlateImage)

Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.

Parameters:

blackoutSlateImage - Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNetworkEndBlackout

public void setNetworkEndBlackout(String 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".

Parameters:

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".

See Also:

BlackoutSlateNetworkEndBlackout

getNetworkEndBlackout

public String getNetworkEndBlackout()

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".

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:

BlackoutSlateNetworkEndBlackout

withNetworkEndBlackout

public BlackoutSlate withNetworkEndBlackout(String 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".

Parameters:

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".

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BlackoutSlateNetworkEndBlackout

withNetworkEndBlackout

public BlackoutSlate withNetworkEndBlackout(BlackoutSlateNetworkEndBlackout 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".

Parameters:

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".

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BlackoutSlateNetworkEndBlackout

setNetworkEndBlackoutImage

public void setNetworkEndBlackoutImage(InputLocation networkEndBlackoutImage)

Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.

Parameters:

networkEndBlackoutImage - Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.

getNetworkEndBlackoutImage

public InputLocation getNetworkEndBlackoutImage()

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.

withNetworkEndBlackoutImage

public BlackoutSlate withNetworkEndBlackoutImage(InputLocation networkEndBlackoutImage)

Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.

Parameters:

networkEndBlackoutImage - Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNetworkId

public void setNetworkId(String networkId)

Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").

Parameters:

networkId - Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").

getNetworkId

public String getNetworkId()

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").

withNetworkId

public BlackoutSlate withNetworkId(String networkId)

Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").

Parameters:

networkId - Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").

Returns:

Returns a reference to this object so that method calls can be chained together.

setState

public void setState(String state)

When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

Parameters:

state - When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

See Also:

BlackoutSlateState

getState

public String getState()

When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

Returns:

When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

See Also:

BlackoutSlateState

withState

public BlackoutSlate withState(String state)

When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

Parameters:

state - When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BlackoutSlateState

withState

public BlackoutSlate withState(BlackoutSlateState state)

When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

Parameters:

state - When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BlackoutSlateState

toString

public String 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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public BlackoutSlate clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.