software.amazon.awssdk.services.mediaconvert.model.CaptionSourceByteRateLimit 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;

/**
 * Choose whether to limit the byte rate at which your SCC input captions are inserted into your output. To not limit
 * the caption rate: We recommend that you keep the default value, Disabled. MediaConvert inserts captions in your
 * output according to the byte rates listed in the EIA-608 specification, typically 2 or 3 caption bytes per frame
 * depending on your output frame rate. To limit your output caption rate: Choose Enabled. Choose this option if your
 * downstream systems require a maximum of 2 caption bytes per frame. Note that this setting has no effect when your
 * output frame rate is 30 or 60.
 */
@Generated("software.amazon.awssdk:codegen")
public enum CaptionSourceByteRateLimit {
    ENABLED("ENABLED"),

    DISABLED("DISABLED"),

    UNKNOWN_TO_SDK_VERSION(null);

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

    private final String value;

    private CaptionSourceByteRateLimit(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 CaptionSourceByteRateLimit corresponding to the value
     */
    public static CaptionSourceByteRateLimit 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 CaptionSourceByteRateLimit}s
     */
    public static Set knownValues() {
        Set knownValues = EnumSet.allOf(CaptionSourceByteRateLimit.class);
        knownValues.remove(UNKNOWN_TO_SDK_VERSION);
        return knownValues;
    }
}