EnableX brings in Live Transcription of Video Sessions. All end-points requesting live transcription, start receiving Speech to Text contents of all actively talking users in the Video room through a notification event. This is helpful in circumstances where participants have limited language proficiency or they have difficulty in hearing because of a noisy background.
Table of Contents
- Overview
- Service Subscription
- Live Transcription Settings in Room
- Methods & Notifications
- Language Codes
Overview
Using Live Transcription feature all active talkers’ speech in a video room can be converted to text content and the content may be sent out to each user subscribing to receive it. Transcription process starts when first user requests for it till the last user opts out of it. So, the text content generated through a single transcription process gets broadcasted to each user requested it.
Service Subscription
Live Transcription is a subscription based service. Connect to Sales/Account Manager for subscription.
Live Transcription Settings in Room
If subscription is enabled, all Video Rooms will be Live-Transcription enabled automatically. However, you can disable it for some room and qualify it further to meet your requirement using room level “settings”.
live.transcription.language
: String. Required. Language Code. The Primary language of communication. Language Codes are given later in the document.live_transcription.auto_transcribe
: Boolean, true or false. Default false. Set it to true, the transcription process starts automatically as session starts and all text contents gets saved in a file. This file is made available post session through API.live_transcription.enable
: Boolean, true or false. Default true. Set to false if transcription is not needed in a Room. If subscribed, live transcription is enabled in each room by default.
Example: Room Definition JSON Payload to live transcription settings.
{
"name": "HLS Trial",
"owner_ref": "XOXO",
"settings": {
"description": "HLS Trial",
"mode": "group",
"scheduled": false,
"adhoc": false,
"duration": 30,
"moderators": "1",
"participants": "2",
"audiences": 6,
"auto_recording": false,
"quality": "SD",
"live_transcription": {
"language": "english_us",
"auto_transcribe": true,
"enable": true
}
}
}
Note: If Live Transcription is not subscribed, room definition with related settings is not permitted.
Methods & Notifications
Apart from auto start settings of Live Transcription, it can be started or stopped using SDK method calls.
When SDK method is called to start Live Transcription, it initiates it and subscribes for the feed to receive. If the transcription process is already started in the room, it simply subscribes it. So, any new user subsequently executes command to start, only gets subscribes to it.
On the other hand, when stop command is executes, the user unsubscribes the feed and he doesn’t receive transcribed content thereafter. When the last subscribed user stops subscription, transcription process stops in the room.
Note that if transcription is automatically started at room-level to save, the process doesn’t stop when last user stops. It only gets stopped at the end of the session.
Method and Notification explanation for each SDK are individually documented. Refer to related SDK:
Language Codes
Following Language Codes may be used while defining room for live transcription, and also with startLiveTranscription() method of different SDKs:
Sl. | Language | Language Code |
---|---|---|
1 | Afrikaans (South Africa) | afrikaans_sa |
2 | Amharic (Ethiopia) | amharic_et |
3 | Arabic (United Arab Emirates) | arabic_uae |
4 | Arabic (Bahrain) | arabic_bah |
5 | Arabic (Algeria) | arabic_alg |
6 | Arabic (Egypt) | arabic_egy |
7 | Arabic (Israel) | arabic_isr |
8 | Arabic (Iraq) | arabic_ira |
9 | Arabic (Jordan) | arabic_jor |
10 | Arabic (Kuwait) | arabic_kuw |
11 | Arabic (Lebanon) | arabic_leb |
12 | Arabic (Libya) | arabic_lib |
13 | Arabic (Morocco) | arabic_mor |
14 | Arabic (Oman) | arabic_oma |
15 | Arabic (Palestinian Territories) | arabic_pal |
16 | Arabic (Qatar) | arabic_qat |
17 | Arabic (Saudi Arabia) | arabic_sa |
18 | Arabic (Syria) | arabic_sy |
19 | Arabic (Tunisia) | arabic_tun |
20 | Arabic (Yemen) | arabic_yem |
21 | Azerbaijani (Azerbaijan) | azerbaijan |
22 | Bulgarian (Bulgaria) | bulgarian |
23 | Bengali (India) | bengali |
24 | Bosnian (Bosnia) | bosnian |
25 | Catalan (Spain) | catalan_esp |
26 | Czech (Czech) | czech |
27 | Welsh (United Kingdom) | welsh_uk |
28 | Danish (Denmark) | danish_da |
29 | German (Austria) | german_aus |
30 | German (Switzerland) | german_swi |
31 | German (Germany) | german_ger |
32 | Greek (Greece) | greek |
33 | English (Australia) | english_aus |
34 | English (Canada) | english_ca |
35 | English (United Kingdom) | english_uk |
36 | English (Ghana) | english_gh |
37 | English (Hongkong) | english_hg |
38 | English (Ireland) | english_ire |
39 | English (India) | english_ind |
40 | English (Kenya) | english_ken |
41 | English (Nigeria) | english_nig |
42 | English (New Zealand) | english_nz |
43 | English (Philippines) | english_phi |
44 | English (Singapore) | english_sing |
45 | English (Tanzania) | english_tanz |
46 | English (United States) | english_us |
47 | English (South Africa) | english_sa |
48 | Spanish (Argentina) | spanish_ar |
49 | Spanish (Bolivia) | spanish_bol |
50 | Spanish (Chile) | spanish_chi |
51 | Spanish (Colombia) | spanish_col |
52 | Spanish (Costa Rica) | spanish_cost |
53 | Spanish (Cuba) | spanish_cub |
54 | Spanish (Dominican Republic) | spanish_dom |
55 | Spanish (Ecuador) | spanish_ecu |
56 | Spanish (Spain) | spanish_sp |
57 | Spanish (Equatorial Guinea) | spanish_gq |
58 | Spanish (Guatemala) | spanish_gua |
59 | Spanish (Honduras) | spanish_hon |
60 | Spanish (Mexico) | spanish_mex |
61 | Spanish (Nicaragua) | spanish_nic |
62 | Spanish (Panama) | spanish_pan |
63 | Spanish (Peru) | spanish_per |
64 | Spanish (Puerto Rico) | spanish_pue |
65 | Spanish (Paraguay) | spanish_par |
66 | Spanish (El Salvador) | spanish_el |
67 | Spanish (United States) | spanish_us |
68 | Spanish (Uruguay) | spanish_uru |
69 | Spanish (Venezuela) | spanish_ven |
70 | Estonian (Estonia) | estonian |
71 | Basque | basque |
72 | Persian (Iran) | persian |
73 | Finnish (Finland) | finnish |
74 | Filipino (Philippines) | filipino |
75 | French (Belgium) | french_bel |
76 | French (Canada) | french_can |
77 | French (Switzerland) | french_swi |
78 | French (France) | french_fra |
79 | Irish (Ireland) | irish |
80 | Galician | galician |
81 | Gujarati (India) | gujarati_in |
82 | Hindi (India) | hindi_in |
83 | Croatian (Croatia) | croation |
84 | Hungarian (Hungary) | hungarian |
85 | Armenian (Armenia) | armenian |
86 | Indonesian (Indonesia) | indonesian |
87 | Icelandic (Iceland) | icelandic |
88 | talian (Switzerland) | italy_swi |
89 | Italian (Italy) | italy |
90 | Japanese (Japan) | japanese |
91 | Javanese (Indonesia) | javanese |
92 | Georgian (Georgia) | georgian |
93 | Kazakh (Kazakhstan) | kazakh |
94 | Khmer (Cambodia) | khmer |
95 | Kannada (India) | kannada |
96 | Korean (Korea) | korean |
97 | Lao (Laos) | laos |
98 | Lithuanian (Lithuania) | lithuanian |
99 | Latvian (Latvia) | latvian |
100 | Macedonian (Republic of North Macedonia) | macedonian |
101 | Malayalam (India) | malayalam |
102 | Mongolian (Mongolia) | mongolian |
103 | Marathi (India) | marathi |
104 | Malay (Malaysia) | malay |
105 | Maltese (Malta) | maltese |
106 | Burmese (Myanmar) | burmese |
107 | Norwegian (Bokmal, Norway) | norwegian |
108 | Nepali (Nepal) | nepali |
109 | Dutch (Belgium) | dutch_bel |
110 | Dutch (Netherlands) | dutch_neth |
111 | Polish (Poland) | polish |
112 | Pashto (Afghanistan) | pashto |
113 | Portuguese (Portugal) | portuguese |
114 | Romanian (Romania) | romanian |
115 | Russian (Russia) | russian |
116 | Sinhala (Sri Lanka | sinhala |
117 | Slovak (Slovakia) | slovak |
118 | Slovenian (Slovenia) | slovenian |
119 | Somali (Somalia) | somalix |
120 | Albanian (Albania) | albanian |
121 | Serbian (Serbia) | serbian |
122 | Sundanese (Indonesia) | sundanese |
123 | Swedish (Sweden) | swedish |
124 | Swahili (Kenya) | swahili_ken |
125 | Swahili (Tanzania) | swahili_tan |
126 | Tamil (India) | tamil_ind |
127 | Telugu (India) | telugu |
128 | Thai (Thailand) | thai |
129 | Turkish (Turkey) | turkish |
130 | Ukrainian (Ukraine) | ukrainian |
131 | Uzbek (Uzbekistan) | uzbek |
132 | Vietnamese (Vietnam) | vietnamese |
133 | Chinese (Wu, Simplified) | chinese_wu |
134 | Chinese (Cantonese, Simplified) | chinese_cant |
135 | Chinese (Mandarin, Simplified) | chinese_mand |
136 | Chinese (Taiwanese Mandarin) | chinese_tai |
137 | Zulu (South Africa) | zulu |