software.amazon.awssdk.services.mediaconvert.model.ChannelMapping Maven / Gradle / Ivy
Show all versions of mediaconvert Show documentation
/*
* 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.Collection;
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.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
* Channel mapping contains the group of fields that hold the remixing value for each channel, in dB. Specify remix
* values to indicate how much of the content from your input audio channel you want in your output audio channels. Each
* instance of the InputChannels or InputChannelsFineTune array specifies these values for one output channel. Use one
* instance of this array for each output channel. In the console, each array corresponds to a column in the graphical
* depiction of the mapping matrix. The rows of the graphical matrix correspond to input channels. Valid values are
* within the range from -60 (mute) through 6. A setting of 0 passes the input channel unchanged to the output channel
* (no attenuation or amplification). Use InputChannels or InputChannelsFineTune to specify your remix values. Don't use
* both.
*/
@Generated("software.amazon.awssdk:codegen")
public final class ChannelMapping implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> OUTPUT_CHANNELS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("OutputChannels")
.getter(getter(ChannelMapping::outputChannels))
.setter(setter(Builder::outputChannels))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("outputChannels").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(OutputChannelMapping::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(OUTPUT_CHANNELS_FIELD));
private static final long serialVersionUID = 1L;
private final List outputChannels;
private ChannelMapping(BuilderImpl builder) {
this.outputChannels = builder.outputChannels;
}
/**
* For responses, this returns true if the service returned a value for the OutputChannels property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasOutputChannels() {
return outputChannels != null && !(outputChannels instanceof SdkAutoConstructList);
}
/**
* In your JSON job specification, include one child of OutputChannels for each audio channel that you want in your
* output. Each child should contain one instance of InputChannels or InputChannelsFineTune.
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasOutputChannels} method.
*
*
* @return In your JSON job specification, include one child of OutputChannels for each audio channel that you want
* in your output. Each child should contain one instance of InputChannels or InputChannelsFineTune.
*/
public final List outputChannels() {
return outputChannels;
}
@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(hasOutputChannels() ? outputChannels() : null);
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 ChannelMapping)) {
return false;
}
ChannelMapping other = (ChannelMapping) obj;
return hasOutputChannels() == other.hasOutputChannels() && Objects.equals(outputChannels(), other.outputChannels());
}
/**
* 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("ChannelMapping").add("OutputChannels", hasOutputChannels() ? outputChannels() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "OutputChannels":
return Optional.ofNullable(clazz.cast(outputChannels()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ChannelMapping) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
* In your JSON job specification, include one child of OutputChannels for each audio channel that you want in
* your output. Each child should contain one instance of InputChannels or InputChannelsFineTune.
*
* @param outputChannels
* In your JSON job specification, include one child of OutputChannels for each audio channel that you
* want in your output. Each child should contain one instance of InputChannels or InputChannelsFineTune.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder outputChannels(Collection outputChannels);
/**
* In your JSON job specification, include one child of OutputChannels for each audio channel that you want in
* your output. Each child should contain one instance of InputChannels or InputChannelsFineTune.
*
* @param outputChannels
* In your JSON job specification, include one child of OutputChannels for each audio channel that you
* want in your output. Each child should contain one instance of InputChannels or InputChannelsFineTune.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder outputChannels(OutputChannelMapping... outputChannels);
/**
* In your JSON job specification, include one child of OutputChannels for each audio channel that you want in
* your output. Each child should contain one instance of InputChannels or InputChannelsFineTune. This is a
* convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.mediaconvert.model.OutputChannelMapping.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.mediaconvert.model.OutputChannelMapping#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.mediaconvert.model.OutputChannelMapping.Builder#build()} is called
* immediately and its result is passed to {@link #outputChannels(List)}.
*
* @param outputChannels
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.mediaconvert.model.OutputChannelMapping.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #outputChannels(java.util.Collection)
*/
Builder outputChannels(Consumer... outputChannels);
}
static final class BuilderImpl implements Builder {
private List outputChannels = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ChannelMapping model) {
outputChannels(model.outputChannels);
}
public final List getOutputChannels() {
List result = ___listOfOutputChannelMappingCopier.copyToBuilder(this.outputChannels);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setOutputChannels(Collection outputChannels) {
this.outputChannels = ___listOfOutputChannelMappingCopier.copyFromBuilder(outputChannels);
}
@Override
public final Builder outputChannels(Collection outputChannels) {
this.outputChannels = ___listOfOutputChannelMappingCopier.copy(outputChannels);
return this;
}
@Override
@SafeVarargs
public final Builder outputChannels(OutputChannelMapping... outputChannels) {
outputChannels(Arrays.asList(outputChannels));
return this;
}
@Override
@SafeVarargs
public final Builder outputChannels(Consumer... outputChannels) {
outputChannels(Stream.of(outputChannels).map(c -> OutputChannelMapping.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public ChannelMapping build() {
return new ChannelMapping(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}