software.amazon.awssdk.services.mediaconvert.model.InputClipping Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mediaconvert Show documentation
Show all versions of 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 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 software.amazon.awssdk.services.mediaconvert.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
* To transcode only portions of your input, include one input clip for each part of your input that you want in your
* output. All input clips that you specify will be included in every output of the job. For more information, see
* https://docs.aws.amazon.com/mediaconvert/latest/ug/assembling-multiple-inputs-and-input-clips.html.
*/
@Generated("software.amazon.awssdk:codegen")
public final class InputClipping implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField END_TIMECODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EndTimecode").getter(getter(InputClipping::endTimecode)).setter(setter(Builder::endTimecode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("endTimecode").build()).build();
private static final SdkField START_TIMECODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StartTimecode").getter(getter(InputClipping::startTimecode)).setter(setter(Builder::startTimecode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("startTimecode").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(END_TIMECODE_FIELD,
START_TIMECODE_FIELD));
private static final long serialVersionUID = 1L;
private final String endTimecode;
private final String startTimecode;
private InputClipping(BuilderImpl builder) {
this.endTimecode = builder.endTimecode;
this.startTimecode = builder.startTimecode;
}
/**
* Set End timecode to the end of the portion of the input you are clipping. The frame corresponding to the End
* timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the
* format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame
* number. When choosing this value, take into account your setting for timecode source under input settings. For
* example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to end six minutes into
* the video, use 01:06:00:00.
*
* @return Set End timecode to the end of the portion of the input you are clipping. The frame corresponding to the
* End timecode value is included in the clip. Start timecode or End timecode may be left blank, but not
* both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the
* second, and FF is the frame number. When choosing this value, take into account your setting for timecode
* source under input settings. For example, if you have embedded timecodes that start at 01:00:00:00 and
* you want your clip to end six minutes into the video, use 01:06:00:00.
*/
public final String endTimecode() {
return endTimecode;
}
/**
* Set Start timecode to the beginning of the portion of the input you are clipping. The frame corresponding to the
* Start timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use
* the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the
* frame number. When choosing this value, take into account your setting for Input timecode source. For example, if
* you have embedded timecodes that start at 01:00:00:00 and you want your clip to begin five minutes into the
* video, use 01:05:00:00.
*
* @return Set Start timecode to the beginning of the portion of the input you are clipping. The frame corresponding
* to the Start timecode value is included in the clip. Start timecode or End timecode may be left blank,
* but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is
* the second, and FF is the frame number. When choosing this value, take into account your setting for
* Input timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want
* your clip to begin five minutes into the video, use 01:05:00:00.
*/
public final String startTimecode() {
return startTimecode;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(endTimecode());
hashCode = 31 * hashCode + Objects.hashCode(startTimecode());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof InputClipping)) {
return false;
}
InputClipping other = (InputClipping) obj;
return Objects.equals(endTimecode(), other.endTimecode()) && Objects.equals(startTimecode(), other.startTimecode());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("InputClipping").add("EndTimecode", endTimecode()).add("StartTimecode", startTimecode()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "EndTimecode":
return Optional.ofNullable(clazz.cast(endTimecode()));
case "StartTimecode":
return Optional.ofNullable(clazz.cast(startTimecode()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((InputClipping) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
* Set End timecode to the end of the portion of the input you are clipping. The frame corresponding to the End
* timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use
* the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is
* the frame number. When choosing this value, take into account your setting for timecode source under input
* settings. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to end
* six minutes into the video, use 01:06:00:00.
*
* @param endTimecode
* Set End timecode to the end of the portion of the input you are clipping. The frame corresponding to
* the End timecode value is included in the clip. Start timecode or End timecode may be left blank, but
* not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the
* second, and FF is the frame number. When choosing this value, take into account your setting for
* timecode source under input settings. For example, if you have embedded timecodes that start at
* 01:00:00:00 and you want your clip to end six minutes into the video, use 01:06:00:00.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endTimecode(String endTimecode);
/**
* Set Start timecode to the beginning of the portion of the input you are clipping. The frame corresponding to
* the Start timecode value is included in the clip. Start timecode or End timecode may be left blank, but not
* both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second,
* and FF is the frame number. When choosing this value, take into account your setting for Input timecode
* source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to begin
* five minutes into the video, use 01:05:00:00.
*
* @param startTimecode
* Set Start timecode to the beginning of the portion of the input you are clipping. The frame
* corresponding to the Start timecode value is included in the clip. Start timecode or End timecode may
* be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is
* the minute, SS is the second, and FF is the frame number. When choosing this value, take into account
* your setting for Input timecode source. For example, if you have embedded timecodes that start at
* 01:00:00:00 and you want your clip to begin five minutes into the video, use 01:05:00:00.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder startTimecode(String startTimecode);
}
static final class BuilderImpl implements Builder {
private String endTimecode;
private String startTimecode;
private BuilderImpl() {
}
private BuilderImpl(InputClipping model) {
endTimecode(model.endTimecode);
startTimecode(model.startTimecode);
}
public final String getEndTimecode() {
return endTimecode;
}
public final void setEndTimecode(String endTimecode) {
this.endTimecode = endTimecode;
}
@Override
public final Builder endTimecode(String endTimecode) {
this.endTimecode = endTimecode;
return this;
}
public final String getStartTimecode() {
return startTimecode;
}
public final void setStartTimecode(String startTimecode) {
this.startTimecode = startTimecode;
}
@Override
public final Builder startTimecode(String startTimecode) {
this.startTimecode = startTimecode;
return this;
}
@Override
public InputClipping build() {
return new InputClipping(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}