Fix(docs): Fix parameter type in doc block

Signed-off-by: Joas Schilling <coding@schilljs.com>
This commit is contained in:
Joas Schilling 2023-04-19 12:42:23 +02:00
parent fbcd275acb
commit db9901a02e
No known key found for this signature in database
GPG key ID: 74434EFE0D2E2205

View file

@ -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;
}