docs: update transcription docs (#481)

* docs: update transcription docs * update transcriptionChunkReceived payload format
jitsi · Dec 15, 2023 · 26d78b3 · 26d78b3
1 parent da9e154
commit 26d78b3
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/docs/dev-guide/iframe-commands.md b/docs/dev-guide/iframe-commands.md
@@ -436,7 +436,9 @@ Enables or disables the subtitles.
 
 ```javascript
 api.executeCommand('setSubtitles',
-    enabled: boolean
+    enabled: boolean,
+    displaySubtitles: boolean = true,
+    language: string | null = 'en'
 );
 ```
 

diff --git a/docs/dev-guide/iframe-events.md b/docs/dev-guide/iframe-events.md
@@ -760,11 +760,18 @@ The listener receives an object with the following structure:
 
 ```javascript
 {
+    // Transcription language
+    language: string,
+
     // ID for this chunk.
     messageID: string,
 
-    // Name of the participant.
-    participantName: string,
+    // participant info
+    participant: {
+        avatarUrl: string,
+        id: string
+        name: string,
+    },
 
     // If the transcription is final, the text will be here.
     final: string,