001/*
002 * Copyright 2024 Vonage
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package com.vonage.client.voice;
017
018import com.fasterxml.jackson.annotation.JsonCreator;
019import com.fasterxml.jackson.annotation.JsonValue;
020
021/**
022 * Represents the timeout reason in {@link SpeechResults#getTimeoutReason()}.
023 *
024 * @since 8.2.0
025 */
026public enum SpeechTimeoutReason {
027    END_ON_SILENCE_TIMEOUT,
028    MAX_DURATION,
029    START_TIMEOUT,
030    UNKNOWN;
031
032    @JsonValue
033    @Override
034    public String toString() {
035        return name().toLowerCase();
036    }
037
038    @JsonCreator
039    public static SpeechTimeoutReason fromString(String name) {
040        try {
041            return SpeechTimeoutReason.valueOf(name.toUpperCase());
042        }
043        catch (IllegalArgumentException ex) {
044            return UNKNOWN;
045        }
046    }
047}