Scripts/Runtime/Data/Configuration/WitRuntimeConfiguration.cs

/*
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the license found in the
 * LICENSE file in the root directory of this source tree.
 */

using System;
using Facebook.WitAi.Data.Configuration;
using Facebook.WitAi.Interfaces;
using UnityEngine;
using UnityEngine.Serialization;

namespace Facebook.WitAi.Configuration
{
    [Serializable]
    public class WitRuntimeConfiguration
    {
        [Tooltip("Configuration for the application used in this instance of Wit.ai services")]
        [SerializeField]
        public WitConfiguration witConfiguration;

        [Header("Keepalive")]
        [Tooltip("The minimum volume from the mic needed to keep the activation alive")]
        [SerializeField]
        public float minKeepAliveVolume = .0005f;

        [FormerlySerializedAs("minKeepAliveTime")]
        [Tooltip(
            "The amount of time in seconds an activation will be kept open after volume is under the keep alive threshold")]
        [SerializeField]
        public float minKeepAliveTimeInSeconds = 2f;

        [FormerlySerializedAs("minTranscriptionKeepAliveTime")]
        [Tooltip(
            "The amount of time in seconds an activation will be kept open after words have been detected in the live transcription")]
        [SerializeField]
        public float minTranscriptionKeepAliveTimeInSeconds = 1f;

        [Tooltip("The maximum amount of time in seconds the mic will stay active")]
        [Range(0, 20f)]
        [SerializeField]
        public float maxRecordingTime = 20;

        [Header("Sound Activation")]
        [Tooltip("The minimum volume level needed to be heard to start collecting data from the audio source.")]
        [SerializeField] public float soundWakeThreshold = .0005f;

        [Tooltip("The length of the individual samples read from the audio source")]
        [Range(10, 500)] [SerializeField] public int sampleLengthInMs = 10;

        [Tooltip("The total audio data that should be buffered for lookback purposes on sound based activations.")]
        [SerializeField] public float micBufferLengthInSeconds = 1;

        [Tooltip("The maximum amount of concurrent requests that can occur")]
        [Range(1, 10)] [SerializeField] public int maxConcurrentRequests = 5;

        [Header("Custom Transcription")]
        [Tooltip(
            "If true, the audio recorded in the activation will be sent to Wit.ai for processing. If a custom transcription provider is set and this is false, only the transcription will be sent to Wit.ai for processing")]
        [SerializeField]
        public bool sendAudioToWit = true;

        [Tooltip("A custom provider that returns text to be used for nlu processing on activation instead of sending audio.")]
        [SerializeField] public CustomTranscriptionProvider customTranscriptionProvider;

        [Tooltip("If always record is set the mic will fill the mic data buffer as long as the component is enabled in the scene.")]
        public bool alwaysRecord;
    }
}