com.amazonaws.services.medialive.model

Class VideoDescription

java.lang.Object

com.amazonaws.services.medialive.model.VideoDescription

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Video settings for this stream.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
VideoDescription()

Method Summary

Modifier and Type	Method and Description
VideoDescription	clone()
boolean	equals(Object obj)
VideoCodecSettings	getCodecSettings() Video codec settings.
Integer	getHeight() Output video height, in pixels.
String	getName() The name of this VideoDescription.
String	getRespondToAfd() Indicates how to respond to the AFD values in the input stream.
String	getScalingBehavior() STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width).
Integer	getSharpness() Changes the strength of the anti-alias filter used for scaling.
Integer	getWidth() Output video width, in pixels.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCodecSettings(VideoCodecSettings codecSettings) Video codec settings.
void	setHeight(Integer height) Output video height, in pixels.
void	setName(String name) The name of this VideoDescription.
void	setRespondToAfd(String respondToAfd) Indicates how to respond to the AFD values in the input stream.
void	setScalingBehavior(String scalingBehavior) STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width).
void	setSharpness(Integer sharpness) Changes the strength of the anti-alias filter used for scaling.
void	setWidth(Integer width) Output video width, in pixels.
String	toString() Returns a string representation of this object.
VideoDescription	withCodecSettings(VideoCodecSettings codecSettings) Video codec settings.
VideoDescription	withHeight(Integer height) Output video height, in pixels.
VideoDescription	withName(String name) The name of this VideoDescription.
VideoDescription	withRespondToAfd(String respondToAfd) Indicates how to respond to the AFD values in the input stream.
VideoDescription	withRespondToAfd(VideoDescriptionRespondToAfd respondToAfd) Indicates how to respond to the AFD values in the input stream.
VideoDescription	withScalingBehavior(String scalingBehavior) STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width).
VideoDescription	withScalingBehavior(VideoDescriptionScalingBehavior scalingBehavior) STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width).
VideoDescription	withSharpness(Integer sharpness) Changes the strength of the anti-alias filter used for scaling.
VideoDescription	withWidth(Integer width) Output video width, in pixels.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VideoDescription

public VideoDescription()

Method Detail

setCodecSettings

public void setCodecSettings(VideoCodecSettings codecSettings)

Video codec settings.

Parameters:

codecSettings - Video codec settings.

getCodecSettings

public VideoCodecSettings getCodecSettings()

Video codec settings.

Returns:

Video codec settings.

withCodecSettings

public VideoDescription withCodecSettings(VideoCodecSettings codecSettings)

Video codec settings.

Parameters:

codecSettings - Video codec settings.

Returns:

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

setHeight

public void setHeight(Integer height)

Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.

Parameters:

height - Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.

getHeight

public Integer getHeight()

Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.

Returns:

Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.

withHeight

public VideoDescription withHeight(Integer height)

Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.

Parameters:

height - Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.

Returns:

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

setName

public void setName(String name)

The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.

Parameters:

name - The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.

getName

public String getName()

The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.

Returns:

The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.

withName

public VideoDescription withName(String name)

The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.

Parameters:

name - The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.

Returns:

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

setRespondToAfd

public void setRespondToAfd(String respondToAfd)

Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAME_CAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAME_CAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.

Parameters:

respondToAfd - Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAME_CAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAME_CAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.

See Also:

VideoDescriptionRespondToAfd

getRespondToAfd

public String getRespondToAfd()

Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAME_CAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAME_CAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.

Returns:

Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAME_CAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAME_CAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.

See Also:

VideoDescriptionRespondToAfd

withRespondToAfd

public VideoDescription withRespondToAfd(String respondToAfd)

Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAME_CAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAME_CAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.

Parameters:

respondToAfd - Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAME_CAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAME_CAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.

Returns:

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

See Also:

VideoDescriptionRespondToAfd

withRespondToAfd

public VideoDescription withRespondToAfd(VideoDescriptionRespondToAfd respondToAfd)

Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAME_CAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAME_CAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.

Parameters:

respondToAfd - Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAME_CAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAME_CAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped.

Returns:

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

See Also:

VideoDescriptionRespondToAfd

setScalingBehavior

public void setScalingBehavior(String scalingBehavior)

STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.

Parameters:

scalingBehavior - STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.

See Also:

VideoDescriptionScalingBehavior

getScalingBehavior

public String getScalingBehavior()

STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.

Returns:

STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.

See Also:

VideoDescriptionScalingBehavior

withScalingBehavior

public VideoDescription withScalingBehavior(String scalingBehavior)

STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.

Parameters:

scalingBehavior - STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.

Returns:

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

See Also:

VideoDescriptionScalingBehavior

withScalingBehavior

public VideoDescription withScalingBehavior(VideoDescriptionScalingBehavior scalingBehavior)

STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.

Parameters:

scalingBehavior - STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.

Returns:

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

See Also:

VideoDescriptionScalingBehavior

setSharpness

public void setSharpness(Integer sharpness)

Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.

Parameters:

sharpness - Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.

getSharpness

public Integer getSharpness()

Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.

Returns:

Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.

withSharpness

public VideoDescription withSharpness(Integer sharpness)

Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.

Parameters:

sharpness - Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.

Returns:

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

setWidth

public void setWidth(Integer width)

Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.

Parameters:

width - Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.

getWidth

public Integer getWidth()

Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.

Returns:

Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.

withWidth

public VideoDescription withWidth(Integer width)

Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.

Parameters:

width - Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.

Returns:

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

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