aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/SpeechToText
diff options
context:
space:
mode:
authorJoas Schilling <coding@schilljs.com>2023-04-19 12:42:23 +0200
committerJoas Schilling <coding@schilljs.com>2023-04-19 12:42:23 +0200
commitdb9901a02e59479e44d32368d3cde377153b35fd (patch)
treebca153e2329dceef1530ead0ad6ce0b311bb9b92 /lib/public/SpeechToText
parentfbcd275acb1e77fc493767859418ca39972d227e (diff)
downloadnextcloud-server-db9901a02e59479e44d32368d3cde377153b35fd.tar.gz
nextcloud-server-db9901a02e59479e44d32368d3cde377153b35fd.zip
Fix(docs): Fix parameter type in doc block
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'lib/public/SpeechToText')
-rw-r--r--lib/public/SpeechToText/ISpeechToTextManager.php6
1 files changed, 3 insertions, 3 deletions
diff --git a/lib/public/SpeechToText/ISpeechToTextManager.php b/lib/public/SpeechToText/ISpeechToTextManager.php
index 167017ead60..eff00ec0fa1 100644
--- a/lib/public/SpeechToText/ISpeechToTextManager.php
+++ b/lib/public/SpeechToText/ISpeechToTextManager.php
@@ -47,21 +47,21 @@ interface ISpeechToTextManager {
* belonging to your transcription request.
*
* @param File $file The media file to transcribe
- * @param string $userId The user that triggered this request (only for convenience, will be available on the TranscriptEvents)
+ * @param ?string $userId The user that triggered this request (only for convenience, will be available on the TranscriptEvents)
* @param string $appId The app that triggered this request (only for convenience, will be available on the TranscriptEvents)
- * @since 27.0.0
* @throws PreConditionNotMetException If no provider was registered but this method was still called
* @throws InvalidArgumentException If the file could not be found or is not of a supported type
+ * @since 27.0.0
*/
public function scheduleFileTranscription(File $file, ?string $userId, string $appId): void;
/**
- * @since 27.0.0
* @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
* @throws InvalidArgumentException If the file could not be found or is not of a supported type
* @throws RuntimeException If the transcription failed for other reasons
+ * @since 27.0.0
*/
public function transcribeFile(File $file): string;
}