software.amazon.awssdk.services.mediaconvert.model.InputTimecodeSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
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

There is a newer version: 2.29.15

Show newest version

/*
 * 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.util.EnumSet;
import java.util.Map;
import java.util.Set;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.utils.internal.EnumUtils;

/**
 * Use this Timecode source setting, located under the input settings, to specify how the service counts input video
 * frames. This input frame count affects only the behavior of features that apply to a single input at a time, such as
 * input clipping and synchronizing some captions formats. Choose Embedded to use the timecodes in your input video.
 * Choose Start at zero to start the first frame at zero. Choose Specified start to start the first frame at the
 * timecode that you specify in the setting Start timecode. If you don't specify a value for Timecode source, the
 * service will use Embedded by default. For more information about timecodes, see
 * https://docs.aws.amazon.com/console/mediaconvert/timecode.
 */
@Generated("software.amazon.awssdk:codegen")
public enum InputTimecodeSource {
    EMBEDDED("EMBEDDED"),

    ZEROBASED("ZEROBASED"),

    SPECIFIEDSTART("SPECIFIEDSTART"),

    UNKNOWN_TO_SDK_VERSION(null);

    private static final Map VALUE_MAP = EnumUtils.uniqueIndex(InputTimecodeSource.class,
            InputTimecodeSource::toString);

    private final String value;

    private InputTimecodeSource(String value) {
        this.value = value;
    }

    @Override
    public String toString() {
        return String.valueOf(value);
    }

    /**
     * Use this in place of valueOf to convert the raw string returned by the service into the enum value.
     *
     * @param value
     *        real value
     * @return InputTimecodeSource corresponding to the value
     */
    public static InputTimecodeSource fromValue(String value) {
        if (value == null) {
            return null;
        }
        return VALUE_MAP.getOrDefault(value, UNKNOWN_TO_SDK_VERSION);
    }

    /**
     * Use this in place of {@link #values()} to return a {@link Set} of all values known to the SDK. This will return
     * all known enum values except {@link #UNKNOWN_TO_SDK_VERSION}.
     *
     * @return a {@link Set} of known {@link InputTimecodeSource}s
     */
    public static Set knownValues() {
        Set knownValues = EnumSet.allOf(InputTimecodeSource.class);
        knownValues.remove(UNKNOWN_TO_SDK_VERSION);
        return knownValues;
    }
}