From 1d17e28e36658152a385af4e423f6c596d8a2f10 Mon Sep 17 00:00:00 2001 From: Marcel Klehr Date: Wed, 19 Apr 2023 15:37:18 +0200 Subject: [PATCH] fix(SpeechToText): TranscriptionFailedEvent#getErrorMessage() is only for debugging Signed-off-by: Marcel Klehr --- developer_manual/digging_deeper/speech-to-text.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/developer_manual/digging_deeper/speech-to-text.rst b/developer_manual/digging_deeper/speech-to-text.rst index 4c90e1762..efaee83a7 100644 --- a/developer_manual/digging_deeper/speech-to-text.rst +++ b/developer_manual/digging_deeper/speech-to-text.rst @@ -23,7 +23,7 @@ Listening to the transcription events Since ``scheduleFileTranscription`` does not block, you will need to listen to the following events in your app to obtain the transcript or be notified of any failure. * ``OCP\SpeechToText\Events\TranscriptionSuccessfulEvent`` This event class offers the ``getTranscript()`` method which returns the transcript as a string - * ``OCP\SpeechToText\Events\TranscriptionFailedEvent`` This event class offers the ``getErrorMessage()`` method which returns the error message as a string + * ``OCP\SpeechToText\Events\TranscriptionFailedEvent`` This event class offers the ``getErrorMessage()`` method which returns the error message as a string (only in English and for debugging purposes, so don't show this to the user) Both classes provide the ``$appId`` and ``$userId`` params that you initially passed to ``scheduleFileTranscription`` via ``getAppId()`` and ``getUserId()`` as well as ``getFileId()`` and ``getFile()`` to access the media file that was transcribed.