feat(stt): add ability to cancel a scheduled transcription

Signed-off-by: Julien Veyssier <julien-nc@posteo.net>

1 files changed, 11 insertions, 0 deletions

diff --git a/lib/public/SpeechToText/ISpeechToTextManager.php b/lib/public/SpeechToText/ISpeechToTextManager.php
index 96973cfca08..f281d52f0dd 100644
--- a/lib/public/SpeechToText/ISpeechToTextManager.php
+++ b/lib/public/SpeechToText/ISpeechToTextManager.php
@@ -62,6 +62,17 @@ interface ISpeechToTextManager {
 	public function scheduleFileTranscription(File $file, ?string $userId, string $appId): void;
 
 	/**
+	 * Will cancel a scheduled transcription process
+	 *
+	 * @param File $file The media file involved in the transcription
+	 * @param ?string $userId The user that triggered this request
+	 * @param string $appId The app that triggered this request
+	 * @throws InvalidArgumentException If the file could not be found or is not of a supported type
+	 * @since 29.0.0
+	 */
+	public function cancelScheduledFileTranscription(File $file, ?string $userId, string $appId): void;
+
+	/**
 	 * @param File $file The media file to transcribe
 	 * @returns string The transcription of the passed media file
 	 * @throws PreConditionNotMetException If no provider was registered but this method was still called