com.amazonaws.services.mediaconvert.model.FrameCaptureSettings Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-mediaconvert Show documentation
Show all versions of aws-java-sdk-mediaconvert Show documentation
The AWS Java SDK for AWS Elemental MediaConvert module holds the client classes that are used for communicating with AWS Elemental MediaConvert Service
/*
* Copyright 2019-2024 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.mediaconvert.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
* Required when you set Codec to the value FRAME_CAPTURE.
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class FrameCaptureSettings implements Serializable, Cloneable, StructuredPojo {
/**
* Frame capture will encode the first frame of the output stream, then one frame every
* framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and
* framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s.
* Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.
*/
private Integer framerateDenominator;
/**
* Frame capture will encode the first frame of the output stream, then one frame every
* framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and
* framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s.
* Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal
* places.
*/
private Integer framerateNumerator;
/** Maximum number of captures (encoded jpg output files). */
private Integer maxCaptures;
/** JPEG Quality - a higher value equals higher quality. */
private Integer quality;
/**
* Frame capture will encode the first frame of the output stream, then one frame every
* framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and
* framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s.
* Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.
*
* @param framerateDenominator
* Frame capture will encode the first frame of the output stream, then one frame every
* framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and
* framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every
* 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.
*/
public void setFramerateDenominator(Integer framerateDenominator) {
this.framerateDenominator = framerateDenominator;
}
/**
* Frame capture will encode the first frame of the output stream, then one frame every
* framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and
* framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s.
* Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.
*
* @return Frame capture will encode the first frame of the output stream, then one frame every
* framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and
* framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame
* every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.
*/
public Integer getFramerateDenominator() {
return this.framerateDenominator;
}
/**
* Frame capture will encode the first frame of the output stream, then one frame every
* framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and
* framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s.
* Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.
*
* @param framerateDenominator
* Frame capture will encode the first frame of the output stream, then one frame every
* framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and
* framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every
* 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FrameCaptureSettings withFramerateDenominator(Integer framerateDenominator) {
setFramerateDenominator(framerateDenominator);
return this;
}
/**
* Frame capture will encode the first frame of the output stream, then one frame every
* framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and
* framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s.
* Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal
* places.
*
* @param framerateNumerator
* Frame capture will encode the first frame of the output stream, then one frame every
* framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and
* framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every
* 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded
* to 7 decimal places.
*/
public void setFramerateNumerator(Integer framerateNumerator) {
this.framerateNumerator = framerateNumerator;
}
/**
* Frame capture will encode the first frame of the output stream, then one frame every
* framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and
* framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s.
* Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal
* places.
*
* @return Frame capture will encode the first frame of the output stream, then one frame every
* framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and
* framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame
* every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero
* padded to 7 decimal places.
*/
public Integer getFramerateNumerator() {
return this.framerateNumerator;
}
/**
* Frame capture will encode the first frame of the output stream, then one frame every
* framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and
* framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s.
* Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal
* places.
*
* @param framerateNumerator
* Frame capture will encode the first frame of the output stream, then one frame every
* framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and
* framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every
* 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded
* to 7 decimal places.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FrameCaptureSettings withFramerateNumerator(Integer framerateNumerator) {
setFramerateNumerator(framerateNumerator);
return this;
}
/**
* Maximum number of captures (encoded jpg output files).
*
* @param maxCaptures
* Maximum number of captures (encoded jpg output files).
*/
public void setMaxCaptures(Integer maxCaptures) {
this.maxCaptures = maxCaptures;
}
/**
* Maximum number of captures (encoded jpg output files).
*
* @return Maximum number of captures (encoded jpg output files).
*/
public Integer getMaxCaptures() {
return this.maxCaptures;
}
/**
* Maximum number of captures (encoded jpg output files).
*
* @param maxCaptures
* Maximum number of captures (encoded jpg output files).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FrameCaptureSettings withMaxCaptures(Integer maxCaptures) {
setMaxCaptures(maxCaptures);
return this;
}
/**
* JPEG Quality - a higher value equals higher quality.
*
* @param quality
* JPEG Quality - a higher value equals higher quality.
*/
public void setQuality(Integer quality) {
this.quality = quality;
}
/**
* JPEG Quality - a higher value equals higher quality.
*
* @return JPEG Quality - a higher value equals higher quality.
*/
public Integer getQuality() {
return this.quality;
}
/**
* JPEG Quality - a higher value equals higher quality.
*
* @param quality
* JPEG Quality - a higher value equals higher quality.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FrameCaptureSettings withQuality(Integer quality) {
setQuality(quality);
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 (getFramerateDenominator() != null)
sb.append("FramerateDenominator: ").append(getFramerateDenominator()).append(",");
if (getFramerateNumerator() != null)
sb.append("FramerateNumerator: ").append(getFramerateNumerator()).append(",");
if (getMaxCaptures() != null)
sb.append("MaxCaptures: ").append(getMaxCaptures()).append(",");
if (getQuality() != null)
sb.append("Quality: ").append(getQuality());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof FrameCaptureSettings == false)
return false;
FrameCaptureSettings other = (FrameCaptureSettings) obj;
if (other.getFramerateDenominator() == null ^ this.getFramerateDenominator() == null)
return false;
if (other.getFramerateDenominator() != null && other.getFramerateDenominator().equals(this.getFramerateDenominator()) == false)
return false;
if (other.getFramerateNumerator() == null ^ this.getFramerateNumerator() == null)
return false;
if (other.getFramerateNumerator() != null && other.getFramerateNumerator().equals(this.getFramerateNumerator()) == false)
return false;
if (other.getMaxCaptures() == null ^ this.getMaxCaptures() == null)
return false;
if (other.getMaxCaptures() != null && other.getMaxCaptures().equals(this.getMaxCaptures()) == false)
return false;
if (other.getQuality() == null ^ this.getQuality() == null)
return false;
if (other.getQuality() != null && other.getQuality().equals(this.getQuality()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFramerateDenominator() == null) ? 0 : getFramerateDenominator().hashCode());
hashCode = prime * hashCode + ((getFramerateNumerator() == null) ? 0 : getFramerateNumerator().hashCode());
hashCode = prime * hashCode + ((getMaxCaptures() == null) ? 0 : getMaxCaptures().hashCode());
hashCode = prime * hashCode + ((getQuality() == null) ? 0 : getQuality().hashCode());
return hashCode;
}
@Override
public FrameCaptureSettings clone() {
try {
return (FrameCaptureSettings) 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.mediaconvert.model.transform.FrameCaptureSettingsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}