ambiser
/
openvidu
mirror of https://github.com/OpenVidu/openvidu.git
8
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

openvidu-browser: subscribeToSpeechToText param documentation

pull/748/head
pabloFuente 2022-10-21 12:40:05 +02:00
parent 9a5cf628d0
commit c865b70c40
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
openvidu-browser/src/OpenVidu/Session.ts
View File

@ -648,6 +648,9 @@ export class Session extends EventDispatcher {
* Subscribe to the Speech-To-Text events for this [[Stream]]. The Session object will emit [[SpeechToTextEvent]] for the Stream * Subscribe to the Speech-To-Text events for this [[Stream]]. The Session object will emit [[SpeechToTextEvent]] for the Stream
* when speech is detected in its audio track. * when speech is detected in its audio track.
* *
* @param stream - The Stream for which you want to start receiving [[SpeechToTextEvent]].
* @þaram lang - The language of the Stream's audio track. It must be a valid [BCP-47](https://tools.ietf.org/html/bcp47) language tag like "en-US" or "es-ES".
*
* @returns A Promise (to which you can optionally subscribe to) that is resolved if the speech-to-text subscription * @returns A Promise (to which you can optionally subscribe to) that is resolved if the speech-to-text subscription
* was successful and rejected with an Error object if not. * was successful and rejected with an Error object if not.
*/ */