java.lang.Object
- software.amazon.awssdk.services.medialive.model.VideoDescription

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<VideoDescription.Builder,VideoDescription>

@Generated("software.amazon.awssdk:codegen")
public final class VideoDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<VideoDescription.Builder,VideoDescription>

Video settings for this stream.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface VideoDescription.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static VideoDescription.Builder`	`builder()`
`VideoCodecSettings`	`codecSettings()`	Video codec settings.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`height()`	Output video height, in pixels.
`String`	`name()`	The name of this VideoDescription.
`VideoDescriptionRespondToAfd`	`respondToAfd()`	Indicates how MediaLive will respond to the AFD values that might be in the input video.
`String`	`respondToAfdAsString()`	Indicates how MediaLive will respond to the AFD values that might be in the input video.
`VideoDescriptionScalingBehavior`	`scalingBehavior()`	STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width).
`String`	`scalingBehaviorAsString()`	STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width).
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends VideoDescription.Builder>`	`serializableBuilderClass()`
`Integer`	`sharpness()`	Changes the strength of the anti-alias filter used for scaling.
`VideoDescription.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Integer`	`width()`	Output video width, in pixels.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - codecSettings
```
public final VideoCodecSettings codecSettings()
```
    Video codec settings.
    
    Returns:
    
    Video codec settings.
  - height
```
public final 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.
    
    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.
  - name
```
public final 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 final VideoDescriptionRespondToAfd respondToAfd()
```
    Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH. RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME_CAPTURE. PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output. NONE: MediaLive does not clip the input video and does not include the AFD values in the output
    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 MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH. RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME_CAPTURE. PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output. NONE: MediaLive does not clip the input video and does not include the AFD values in the output
    
    See Also:
    
    VideoDescriptionRespondToAfd
  - respondToAfdAsString
```
public final String respondToAfdAsString()
```
    Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH. RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME_CAPTURE. PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output. NONE: MediaLive does not clip the input video and does not include the AFD values in the output
    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 MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH. RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME_CAPTURE. PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output. NONE: MediaLive does not clip the input video and does not include the AFD values in the output
    
    See Also:
    
    VideoDescriptionRespondToAfd
  - scalingBehavior
```
public final 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.
    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:
    
    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
  - scalingBehaviorAsString
```
public final String scalingBehaviorAsString()
```
    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.
    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:
    
    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
  - sharpness
```
public final 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.
    
    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.
  - width
```
public final 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.
    
    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.
  - toBuilder
```
public VideoDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<VideoDescription.Builder,VideoDescription>
  - builder
```
public static VideoDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends VideoDescription.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class VideoDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

codecSettings

height

name

respondToAfd

respondToAfdAsString

scalingBehavior

scalingBehaviorAsString

sharpness

width

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField