CaptionsCommon interface
Datová struktura pro objekt CaptionsCommon
Vlastnosti
active |
Označuje aktuální aktivní mluvený jazyk ve formátu BCP 47. |
is |
Označuje, jestli jsou titulky aktivní v aktuálním volání. |
kind | Označuje typ Titulky pro aktivní objekt titulků. |
supported |
Seznam podporovaných mluvených jazyků pro použití se službou titulků ve formátu BCP 47 |
Metody
set |
Aktualizuje jazyk probíhajícího přepisu nebo titulků. |
start |
Spustí zpracování titulků v tomto volání pomocí poskytnuté obslužné rutiny pro tohoto klienta. |
stop |
Zastaví načítání dat titulků ve volání uživatele, který inicioval zarážku. |
Podrobnosti vlastnosti
activeSpokenLanguage
Označuje aktuální aktivní mluvený jazyk ve formátu BCP 47.
activeSpokenLanguage: string
Hodnota vlastnosti
string
isCaptionsFeatureActive
Označuje, jestli jsou titulky aktivní v aktuálním volání.
isCaptionsFeatureActive: boolean
Hodnota vlastnosti
boolean
kind
supportedSpokenLanguages
Seznam podporovaných mluvených jazyků pro použití se službou titulků ve formátu BCP 47
supportedSpokenLanguages: string[]
Hodnota vlastnosti
string[]
Podrobnosti metody
setSpokenLanguage(string)
Aktualizuje jazyk probíhajícího přepisu nebo titulků.
function setSpokenLanguage(language: string): Promise<void>
Parametry
- language
-
string
Jazyk pro titulky řeči jako. Musí být formát BCP 47 (např. "en-us")
Návraty
Promise<void>
Příslib představující dokončení operace Set Language. Dokončení tohoto příslibu neznamená, že se jazyk změnil. Událost "SpokenLanguageChanged" se vygeneruje, když se jazyk skutečně úspěšně změnil.
startCaptions(StartCaptionsOptions)
Spustí zpracování titulků v tomto volání pomocí poskytnuté obslužné rutiny pro tohoto klienta.
function startCaptions(startCaptionsOptions?: StartCaptionsOptions): Promise<void>
Parametry
- startCaptionsOptions
- StartCaptionsOptions
Další možnosti pro spouštění titulků
Návraty
Promise<void>
Příslib představující dokončení procesu inicializace pro operaci Počáteční titulek Dokončení tohoto příslibu neznamená, že titulky byly spuštěny. Událost CaptionsActiveChanged se vygeneruje, když se titulky skutečně úspěšně spustily.
stopCaptions()
Zastaví načítání dat titulků ve volání uživatele, který inicioval zarážku.
function stopCaptions(): Promise<void>
Návraty
Promise<void>
Příslib představující dokončení operace Zastavit titulek Dokončení tohoto příslibu neznamená, že robot titulků opustil volání. Účastník se odhlásí od příjmu dat titulků po úspěšném zastavení.