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

The 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;

/**
 * If the IMSC captions track is intended to provide accessibility for people who are deaf or hard of hearing: Set
 * Accessibility subtitles to Enabled. When you do, MediaConvert adds accessibility attributes to your output HLS or
 * DASH manifest. For HLS manifests, MediaConvert adds the following accessibility attributes under EXT-X-MEDIA for this
 * track: CHARACTERISTICS="public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound"
 * and AUTOSELECT="YES". For DASH manifests, MediaConvert adds the following in the adaptation set for this track:
 * . If the captions track is not intended to
 * provide such accessibility: Keep the default value, Disabled. When you do, for DASH manifests, MediaConvert instead
 * adds the following in the adaptation set for this track: .
 */
@Generated("software.amazon.awssdk:codegen")
public enum ImscAccessibilitySubs {
    DISABLED("DISABLED"),

    ENABLED("ENABLED"),

    UNKNOWN_TO_SDK_VERSION(null);

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

    private final String value;

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