mutterkey
KDE-first push-to-talk transcription tool for KDE Plasma
Loading...
Searching...
No Matches
TranscriptionEngine Class Referenceabstract

Immutable engine configuration that creates backend sessions. More...

#include <transcriptionengine.h>

Public Member Functions

 TranscriptionEngine (const TranscriptionEngine &)=delete
 
TranscriptionEngineoperator= (const TranscriptionEngine &)=delete
 
 TranscriptionEngine (TranscriptionEngine &&)=delete
 
TranscriptionEngineoperator= (TranscriptionEngine &&)=delete
 
virtual BackendCapabilities capabilities () const =0
 Returns the runtime capabilities for sessions created by this engine.
 
virtual RuntimeDiagnostics diagnostics () const =0
 Returns runtime inspection data for this engine instance.
 
virtual std::shared_ptr< const TranscriptionModelHandleloadModel (RuntimeError *error=nullptr) const =0
 Loads an immutable validated model handle for this engine.
 
virtual std::unique_ptr< TranscriptionSessioncreateSession (std::shared_ptr< const TranscriptionModelHandle > model) const =0
 Creates a new isolated transcription session from a loaded model.
 

Detailed Description

Immutable engine configuration that creates backend sessions.

The engine boundary keeps future backend selection and model-loading policy out of the app/service orchestration layers.

Definition at line 111 of file transcriptionengine.h.

Member Function Documentation

◆ capabilities()

virtual BackendCapabilities TranscriptionEngine::capabilities ( ) const
pure virtual

Returns the runtime capabilities for sessions created by this engine.

Returns
App-owned capability snapshot suitable for diagnostics.

◆ createSession()

virtual std::unique_ptr< TranscriptionSession > TranscriptionEngine::createSession ( std::shared_ptr< const TranscriptionModelHandle model) const
pure virtual

Creates a new isolated transcription session from a loaded model.

Parameters
modelShared immutable model handle created by this engine.
Returns
Newly constructed session that owns only mutable backend state.

◆ diagnostics()

virtual RuntimeDiagnostics TranscriptionEngine::diagnostics ( ) const
pure virtual

Returns runtime inspection data for this engine instance.

Returns
App-owned runtime diagnostics separate from static capabilities.

◆ loadModel()

virtual std::shared_ptr< const TranscriptionModelHandle > TranscriptionEngine::loadModel ( RuntimeError error = nullptr) const
pure virtual

Loads an immutable validated model handle for this engine.

Parameters
errorOptional destination for a structured failure reason.
Returns
Shared loaded-model handle suitable for multiple sessions.

The documentation for this class was generated from the following file: