aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/SpeechToText/ISpeechToTextProvider.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/SpeechToText/ISpeechToTextProvider.php')
-rw-r--r--lib/public/SpeechToText/ISpeechToTextProvider.php31
1 files changed, 31 insertions, 0 deletions
diff --git a/lib/public/SpeechToText/ISpeechToTextProvider.php b/lib/public/SpeechToText/ISpeechToTextProvider.php
new file mode 100644
index 00000000000..dce4a68ea0a
--- /dev/null
+++ b/lib/public/SpeechToText/ISpeechToTextProvider.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+
+namespace OCP\SpeechToText;
+
+use OCP\Files\File;
+use RuntimeException;
+
+/**
+ * @since 27.0.0
+ * @deprecated 30.0.0
+ */
+interface ISpeechToTextProvider {
+ /**
+ * @since 27.0.0
+ */
+ public function getName(): string;
+
+ /**
+ * @since 27.0.0
+ * @throws RuntimeException If the text could not be transcribed
+ */
+ public function transcribeFile(File $file): string;
+}