com.amazonaws.services.medialive.model.VideoDescription Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-medialive Show documentation
Show all versions of aws-java-sdk-medialive Show documentation
The AWS Java SDK for AWS Elemental MediaLive module holds the client classes that are used for communicating with AWS Elemental MediaLive Service
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.medialive.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
* Video settings for this stream.
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class VideoDescription implements Serializable, Cloneable, StructuredPojo {
/** Video codec settings. */
private VideoCodecSettings codecSettings;
/**
* 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.
*/
private Integer height;
/**
* The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description
* names should be unique within this Live Event.
*/
private String name;
/**
* 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
*/
private String respondToAfd;
/**
* 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.
*/
private String scalingBehavior;
/**
* 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.
*/
private Integer sharpness;
/**
* 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.
*/
private Integer width;
/**
* Video codec settings.
*
* @param codecSettings
* Video codec settings.
*/
public void setCodecSettings(VideoCodecSettings codecSettings) {
this.codecSettings = codecSettings;
}
/**
* Video codec settings.
*
* @return Video codec settings.
*/
public VideoCodecSettings getCodecSettings() {
return this.codecSettings;
}
/**
* Video codec settings.
*
* @param codecSettings
* Video codec settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public VideoDescription withCodecSettings(VideoCodecSettings codecSettings) {
setCodecSettings(codecSettings);
return this;
}
/**
* 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.
*
* @param 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.
*/
public void setHeight(Integer height) {
this.height = 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.
*
* @return 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.
*/
public Integer getHeight() {
return this.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.
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public VideoDescription withHeight(Integer height) {
setHeight(height);
return this;
}
/**
* The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description
* names should be unique within this Live Event.
*
* @param 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.
*/
public void setName(String name) {
this.name = 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.
*
* @return The name of this VideoDescription. Outputs will use this name to uniquely identify this Description.
* Description names should be unique within this Live Event.
*/
public String getName() {
return this.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.
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public VideoDescription withName(String name) {
setName(name);
return this;
}
/**
* 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
*
* @param 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
* @see VideoDescriptionRespondToAfd
*/
public void setRespondToAfd(String respondToAfd) {
this.respondToAfd = 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
*
* @return 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 VideoDescriptionRespondToAfd
*/
public String getRespondToAfd() {
return this.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
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
* @see VideoDescriptionRespondToAfd
*/
public VideoDescription withRespondToAfd(String respondToAfd) {
setRespondToAfd(respondToAfd);
return this;
}
/**
* 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
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
* @see VideoDescriptionRespondToAfd
*/
public VideoDescription withRespondToAfd(VideoDescriptionRespondToAfd respondToAfd) {
this.respondToAfd = respondToAfd.toString();
return this;
}
/**
* 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.
*
* @param 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 VideoDescriptionScalingBehavior
*/
public void setScalingBehavior(String scalingBehavior) {
this.scalingBehavior = 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.
*
* @return 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 VideoDescriptionScalingBehavior
*/
public String getScalingBehavior() {
return this.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.
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VideoDescriptionScalingBehavior
*/
public VideoDescription withScalingBehavior(String scalingBehavior) {
setScalingBehavior(scalingBehavior);
return this;
}
/**
* 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.
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VideoDescriptionScalingBehavior
*/
public VideoDescription withScalingBehavior(VideoDescriptionScalingBehavior scalingBehavior) {
this.scalingBehavior = scalingBehavior.toString();
return this;
}
/**
* 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.
*
* @param 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.
*/
public void setSharpness(Integer sharpness) {
this.sharpness = 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.
*
* @return 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.
*/
public Integer getSharpness() {
return this.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.
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public VideoDescription withSharpness(Integer sharpness) {
setSharpness(sharpness);
return this;
}
/**
* 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.
*
* @param 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.
*/
public void setWidth(Integer width) {
this.width = 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.
*
* @return 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.
*/
public Integer getWidth() {
return this.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.
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public VideoDescription withWidth(Integer width) {
setWidth(width);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCodecSettings() != null)
sb.append("CodecSettings: ").append(getCodecSettings()).append(",");
if (getHeight() != null)
sb.append("Height: ").append(getHeight()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getRespondToAfd() != null)
sb.append("RespondToAfd: ").append(getRespondToAfd()).append(",");
if (getScalingBehavior() != null)
sb.append("ScalingBehavior: ").append(getScalingBehavior()).append(",");
if (getSharpness() != null)
sb.append("Sharpness: ").append(getSharpness()).append(",");
if (getWidth() != null)
sb.append("Width: ").append(getWidth());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof VideoDescription == false)
return false;
VideoDescription other = (VideoDescription) obj;
if (other.getCodecSettings() == null ^ this.getCodecSettings() == null)
return false;
if (other.getCodecSettings() != null && other.getCodecSettings().equals(this.getCodecSettings()) == false)
return false;
if (other.getHeight() == null ^ this.getHeight() == null)
return false;
if (other.getHeight() != null && other.getHeight().equals(this.getHeight()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getRespondToAfd() == null ^ this.getRespondToAfd() == null)
return false;
if (other.getRespondToAfd() != null && other.getRespondToAfd().equals(this.getRespondToAfd()) == false)
return false;
if (other.getScalingBehavior() == null ^ this.getScalingBehavior() == null)
return false;
if (other.getScalingBehavior() != null && other.getScalingBehavior().equals(this.getScalingBehavior()) == false)
return false;
if (other.getSharpness() == null ^ this.getSharpness() == null)
return false;
if (other.getSharpness() != null && other.getSharpness().equals(this.getSharpness()) == false)
return false;
if (other.getWidth() == null ^ this.getWidth() == null)
return false;
if (other.getWidth() != null && other.getWidth().equals(this.getWidth()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCodecSettings() == null) ? 0 : getCodecSettings().hashCode());
hashCode = prime * hashCode + ((getHeight() == null) ? 0 : getHeight().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getRespondToAfd() == null) ? 0 : getRespondToAfd().hashCode());
hashCode = prime * hashCode + ((getScalingBehavior() == null) ? 0 : getScalingBehavior().hashCode());
hashCode = prime * hashCode + ((getSharpness() == null) ? 0 : getSharpness().hashCode());
hashCode = prime * hashCode + ((getWidth() == null) ? 0 : getWidth().hashCode());
return hashCode;
}
@Override
public VideoDescription clone() {
try {
return (VideoDescription) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.medialive.model.transform.VideoDescriptionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}