Package org.opencastproject.speechtotext.impl.engine

Class WhisperEngine

java.lang.Object

org.opencastproject.speechtotext.impl.engine.WhisperEngine

All Implemented Interfaces:

SpeechToTextEngine

public class WhisperEngine
extends Object
implements SpeechToTextEngine

Whisper implementation of the Speech-to-text engine interface.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencastproject.speechtotext.api.SpeechToTextEngine

SpeechToTextEngine.Result

Field Summary

Fields

Modifier and Type	Field	Description
static final String	WHISPER_EXECUTABLE_DEFAULT_PATH	Default path to Whisper.
static final String	WHISPER_MODEL_DEFAULT	Default whisper model

Constructor Summary

Constructors

Constructor	Description
WhisperEngine()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)
SpeechToTextEngine.Result	generateSubtitlesFile(File mediaFile, File workingDirectory, String language, Boolean translate)	Generates the subtitles file.
String	getEngineName()	Returns the name of the implemented engine.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

WHISPER_EXECUTABLE_DEFAULT_PATH

public static final String WHISPER_EXECUTABLE_DEFAULT_PATH

Default path to Whisper.

See Also:

• Constant Field Values

WHISPER_MODEL_DEFAULT

public static final String WHISPER_MODEL_DEFAULT

Default whisper model

See Also:

• Constant Field Values

Constructor Details

WhisperEngine

public WhisperEngine()

Method Details

getEngineName

public String getEngineName()

Description copied from interface: SpeechToTextEngine

Returns the name of the implemented engine.

Specified by:

getEngineName in interface SpeechToTextEngine

Returns:

The name of the implemented engine.

activate

public void activate(org.osgi.service.component.ComponentContext cc)

generateSubtitlesFile

public SpeechToTextEngine.Result generateSubtitlesFile(File mediaFile,
 File workingDirectory,
 String language,
 Boolean translate)
                                                throws SpeechToTextEngineException

Generates the subtitles file.

Specified by:

generateSubtitlesFile in interface SpeechToTextEngine

Parameters:

mediaFile - The media package containing the audio track.

workingDirectory - A unique working directory to safely operate in.

language - The language of the audio track.

translate - If the subtitles should be translated into english

Returns:

Result containing the language code and the subtitles file path.

Throws:

SpeechToTextEngineException - Thrown when an error occurs at the process.

See Also:

• SpeechToTextEngine.generateSubtitlesFile(File, File, String, Boolean)