Sdílet prostřednictvím

CaptionsCommon interface

  • Reference
Balíček:
@azure/communication-calling

Struktura dat pro objekt CaptionsCommon

Vlastnosti

activeSpokenLanguage

Označuje aktuální aktivní mluvený jazyk ve volání ve formátu BCP 47.
isCaptionsFeatureActive

Označuje, jestli jsou v aktuálním volání aktivní titulky.
kind

Označuje typ Titulky pro aktivní objekt titulků.
supportedSpokenLanguages

Seznam podporovaných mluvených jazyků pro použití se službou popis ve formátu BCP 47

Metody

setSpokenLanguage(string)

Aktualizace jazyk probíhajícího přepisu / titulků
startCaptions(StartCaptionsOptions)

Zahájí zpracování titulků v tomto volání pomocí poskytnuté obslužné rutiny pro tohoto klienta.
stopCaptions()

Zastaví načítání dat titulků ve volání uživatele, který inicioval stopCaptions.

Podrobnosti vlastnosti

activeSpokenLanguage

Označuje aktuální aktivní mluvený jazyk ve volání ve formátu BCP 47.

activeSpokenLanguage: string

Hodnota vlastnosti

string

isCaptionsFeatureActive

Označuje, jestli jsou v aktuálním volání aktivní titulky.

isCaptionsFeatureActive: boolean

Hodnota vlastnosti

boolean

kind

Označuje typ Titulky pro aktivní objekt titulků.

kind: CaptionsKind

Hodnota vlastnosti

CaptionsKind

supportedSpokenLanguages

Seznam podporovaných mluvených jazyků pro použití se službou popis ve formátu BCP 47

supportedSpokenLanguages: string[]

Hodnota vlastnosti

string[]

Podrobnosti metody

setSpokenLanguage(string)

Aktualizace jazyk probíhajícího přepisu / titulků

function setSpokenLanguage(language: string): Promise<void>

Parametry

language

string

Jazyk, který chcete popis řeč jako. Musí mít formát BCP 47 (např. "en-us").

Návraty

Promise<void>

Příslib představující dokončení operace Nastavit jazyk. Dokončení tohoto slibu neznamená, že se jazyk změnil. Událost "SpokenLanguageChanged" se vygeneruje, když se jazyk skutečně úspěšně změnil.

startCaptions(StartCaptionsOptions)

Zahájí 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 spuštění titulků

Návraty

Promise<void>

Příslib představující dokončení procesu inicializace pro operaci Spustit titulek Dokončení tohoto příslibu NEZNAMENÁ, že titulky byly zahájeny. 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 stopCaptions.

function stopCaptions(): Promise<void>

Návraty

Promise<void>

Příslib představující dokončení operace Zastavit titulky Dokončení tohoto příslibu NEZNAMENÁ, že robot titulků opustil volání. Účastník se po úspěšném zastavení odběru dat titulků odhlásí.