software.amazon.awssdk.services.medialive.model

Class VideoDescription

java.lang.Object

software.amazon.awssdk.services.medialive.model.VideoDescription

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<VideoDescription.Builder,VideoDescription>

@Generated(value="software.amazon.awssdk:codegen")
public class VideoDescription
extends Object
implements StructuredPojo, ToCopyableBuilder<VideoDescription.Builder,VideoDescription>

Video settings for this stream.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VideoDescription.Builder

Method Summary

Modifier and Type	Method and Description
static VideoDescription.Builder	builder()
VideoCodecSettings	codecSettings() Video codec settings.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	height() Output video height (in pixels).
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
String	name() The name of this VideoDescription.
VideoDescriptionRespondToAfd	respondToAfd() Indicates how to respond to the AFD values in the input stream.
String	respondToAfdAsString() Indicates how to respond to the AFD values in the input stream.
VideoDescriptionScalingBehavior	scalingBehavior() When set to "stretchToOutput", automatically configures the output position to stretch the video to the specified output resolution.
String	scalingBehaviorAsString() When set to "stretchToOutput", automatically configures the output position to stretch the video to the specified output resolution.
static Class<? extends VideoDescription.Builder>	serializableBuilderClass()
Integer	sharpness() Changes the width of the anti-alias filter kernel used for scaling.
VideoDescription.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Integer	width() Output video width (in pixels).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

codecSettings

public VideoCodecSettings codecSettings()

Video codec settings.

Returns:

Video codec settings.

height

public Integer height()

Output video height (in pixels). Leave blank to use source video height. If left blank, width must also be unspecified.

Returns:

Output video height (in pixels). Leave blank to use source video height. If left blank, width must also be unspecified.

name

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

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.

respondToAfd

public VideoDescriptionRespondToAfd respondToAfd()

Indicates how to respond to the AFD values in the input stream. Setting to "respond" causes input video to be clipped, depending on AFD value, input display aspect ratio and output display aspect ratio.

If the service returns an enum value that is not available in the current SDK version, respondToAfd will return VideoDescriptionRespondToAfd.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from respondToAfdAsString().

Returns:

Indicates how to respond to the AFD values in the input stream. Setting to "respond" causes input video to be clipped, depending on AFD value, input display aspect ratio and output display aspect ratio.

See Also:

VideoDescriptionRespondToAfd

respondToAfdAsString

public String respondToAfdAsString()

Indicates how to respond to the AFD values in the input stream. Setting to "respond" causes input video to be clipped, depending on AFD value, input display aspect ratio and output display aspect ratio.

If the service returns an enum value that is not available in the current SDK version, respondToAfd will return VideoDescriptionRespondToAfd.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from respondToAfdAsString().

Returns:

Indicates how to respond to the AFD values in the input stream. Setting to "respond" causes input video to be clipped, depending on AFD value, input display aspect ratio and output display aspect ratio.

See Also:

VideoDescriptionRespondToAfd

scalingBehavior

public VideoDescriptionScalingBehavior scalingBehavior()

When set to "stretchToOutput", automatically configures the output position to stretch the video to the specified output resolution. This option will override any position value.

If the service returns an enum value that is not available in the current SDK version, scalingBehavior will return VideoDescriptionScalingBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingBehaviorAsString().

Returns:

When set to "stretchToOutput", automatically configures the output position to stretch the video to the specified output resolution. This option will override any position value.

See Also:

VideoDescriptionScalingBehavior

scalingBehaviorAsString

public String scalingBehaviorAsString()

When set to "stretchToOutput", automatically configures the output position to stretch the video to the specified output resolution. This option will override any position value.

If the service returns an enum value that is not available in the current SDK version, scalingBehavior will return VideoDescriptionScalingBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingBehaviorAsString().

Returns:

When set to "stretchToOutput", automatically configures the output position to stretch the video to the specified output resolution. This option will override any position value.

See Also:

VideoDescriptionScalingBehavior

sharpness

public Integer sharpness()

Changes the width of the anti-alias filter kernel used for scaling. Only applies if scaling is being performed and antiAlias is set to true. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.

Returns:

Changes the width of the anti-alias filter kernel used for scaling. Only applies if scaling is being performed and antiAlias is set to true. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.

width

public Integer width()

Output video width (in pixels). Leave out to use source video width. If left out, height must also be left out. Display aspect ratio is always preserved by letterboxing or pillarboxing when necessary.

Returns:

Output video width (in pixels). Leave out to use source video width. If left out, height must also be left out. Display aspect ratio is always preserved by letterboxing or pillarboxing when necessary.

toBuilder

public VideoDescription.Builder 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 interface ToCopyableBuilder<VideoDescription.Builder,VideoDescription>

Returns:

a builder for type T

builder

public static VideoDescription.Builder builder()

serializableBuilderClass

public static Class<? extends VideoDescription.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

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.