Merge pull request #58 from pastore99/54-fix-lighten-loading-of-the-p…

…atients-homepage

added javadoc for SpeechRecognition

src/main/java/model/service/exercise/SpeechRecognition.java

@@ -11,11 +11,15 @@
 import java.util.concurrent.Future;
 
 
-public class SpeechRecognition {
+public class SpeechRecognition implements SpeechRecognitionInterface{
     private static final String AZURE_PROPERTIES = "/azure.properties";
     private static String speechKey;
     private static String speechRegion;
 
+    /**
+     * Costruttore della classe SpeechRecognition.
+     * Carica le chiavi e la regione di Azure Speech-to-Text dal file di configurazione.
+     */
     public SpeechRecognition(){
         Properties azureProps = loadProps();
         speechRegion = azureProps.getProperty("azure.region");

src/main/java/model/service/exercise/SpeechRecognitionInterface.java

@@ -0,0 +1,28 @@
+package model.service.exercise;
+
+import java.io.*;
+import java.util.concurrent.ExecutionException;
+
+
+public interface SpeechRecognitionInterface {
+
+    /**
+     * Effettua il riconoscimento vocale utilizzando i servizi di Azure Speech-to-Text.
+     *
+     * @param audio InputStream rappresentante l'audio da analizzare.
+     * @return Una stringa contenente il testo riconosciuto, o null se non riconosciuto.
+     * @throws InterruptedException se il thread viene interrotto durante l'esecuzione.
+     * @throws ExecutionException   se si verifica un errore durante l'esecuzione del task.
+     * @throws IOException          se si verifica un errore di input/output.
+     */
+    public String azureSTT(InputStream audio) throws InterruptedException, ExecutionException, IOException;
+
+    /**
+     * Genera un file temporaneo a partire da un InputStream.
+     *
+     * @param inputAudio InputStream dell'audio.
+     * @return Il percorso del file temporaneo creato.
+     * @throws IOException se si verifica un errore di input/output.
+     */
+    public String generateFile(InputStream inputAudio) throws IOException;
+}