Sdílet prostřednictvím

TeamsCaptions interface

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

Struktura dat pro objekt TeamsCaptions

Extends
CaptionsCommon

Vlastnosti

activeCaptionLanguage

Označuje aktuální aktivní jazyk popis ve formátu ISO 639-1.
supportedCaptionLanguages

Seznam podporovaných popis jazyků pro použití se službou popis ve formátu ISO 639-1

Zděděné 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

off("CaptionLanguageChanged", PropertyChangedEvent)

Funkce Odhlášení odběru pro všechny události CaptionLanguageChangedEventType
off("CaptionsActiveChanged", PropertyChangedEvent)

Funkce Odhlášení odběru pro všechny události CaptionsPropertyChangedEventType
off("CaptionsReceived", TeamsCaptionsHandler)

Funkce Odhlášení odběru pro všechny události CaptionsPropertyChangedEventType
off("SpokenLanguageChanged", PropertyChangedEvent)

Funkce Odhlášení odběru pro všechny události SpokenLanguageChangedEventType
on("CaptionLanguageChanged", PropertyChangedEvent)

Funkce Subscribe pro všechny události CaptionLanguageChangedEventType
on("CaptionsActiveChanged", PropertyChangedEvent)

Funkce Subscribe pro všechny události CaptionsPropertyChangedEventType
on("CaptionsReceived", TeamsCaptionsHandler)

Přihlásit se k odběru události CaptionsReceivedEventType
on("SpokenLanguageChanged", PropertyChangedEvent)

Přihlásit se k odběru libovolné události SpokenLanguageChangedEventType
setCaptionLanguage(string)

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

Zděděné 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

activeCaptionLanguage

Označuje aktuální aktivní jazyk popis ve formátu ISO 639-1.

activeCaptionLanguage: string

Hodnota vlastnosti

string

supportedCaptionLanguages

Seznam podporovaných popis jazyků pro použití se službou popis ve formátu ISO 639-1

supportedCaptionLanguages: string[]

Hodnota vlastnosti

string[]

Podrobnosti zděděných vlastností

activeSpokenLanguage

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

activeSpokenLanguage: string

Hodnota vlastnosti

string

Zděděno ztitulkůCommon.activeSpokenLanguage

isCaptionsFeatureActive

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

isCaptionsFeatureActive: boolean

Hodnota vlastnosti

boolean

Zděděno ztitulkůCommon.isCaptionsFeatureActive

kind

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

kind: CaptionsKind

Hodnota vlastnosti

CaptionsKind

Zděděno ztitulkůCommon.kind

supportedSpokenLanguages

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

supportedSpokenLanguages: string[]

Hodnota vlastnosti

string[]

Zděděno ztitulkůCommon.supportedSpokenLanguages

Podrobnosti metody

off("CaptionLanguageChanged", PropertyChangedEvent)

Funkce Odhlášení odběru pro všechny události CaptionLanguageChangedEventType

function off(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)

Parametry

event

"CaptionLanguageChanged"

název události

listener
PropertyChangedEvent

zpětné volání fn použité k přihlášení k odběru této události

off("CaptionsActiveChanged", PropertyChangedEvent)

Funkce Odhlášení odběru pro všechny události CaptionsPropertyChangedEventType

function off(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)

Parametry

event

"CaptionsActiveChanged"

název události

listener
PropertyChangedEvent

zpětné volání fn použité k přihlášení k odběru této události

off("CaptionsReceived", TeamsCaptionsHandler)

Funkce Odhlášení odběru pro všechny události CaptionsPropertyChangedEventType

function off(event: "CaptionsReceived", listener: TeamsCaptionsHandler)

Parametry

event

"CaptionsReceived"

název události

listener
TeamsCaptionsHandler

zpětné volání fn použité k přihlášení k odběru této události

off("SpokenLanguageChanged", PropertyChangedEvent)

Funkce Odhlášení odběru pro všechny události SpokenLanguageChangedEventType

function off(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)

Parametry

event

"SpokenLanguageChanged"

název události

listener
PropertyChangedEvent

zpětné volání fn použité k přihlášení k odběru této události

on("CaptionLanguageChanged", PropertyChangedEvent)

Funkce Subscribe pro všechny události CaptionLanguageChangedEventType

function on(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)

Parametry

event

"CaptionLanguageChanged"

název události

listener
PropertyChangedEvent

zpětné volání fn použité k přihlášení k odběru této události

on("CaptionsActiveChanged", PropertyChangedEvent)

Funkce Subscribe pro všechny události CaptionsPropertyChangedEventType

function on(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)

Parametry

event

"CaptionsActiveChanged"

název události

listener
PropertyChangedEvent

zpětné volání fn použité k přihlášení k odběru této události

on("CaptionsReceived", TeamsCaptionsHandler)

Přihlásit se k odběru události CaptionsReceivedEventType

function on(event: "CaptionsReceived", listener: TeamsCaptionsHandler)

Parametry

event

"CaptionsReceived"

název události

listener
TeamsCaptionsHandler

zpětné volání fn použité k přihlášení k odběru této události

on("SpokenLanguageChanged", PropertyChangedEvent)

Přihlásit se k odběru libovolné události SpokenLanguageChangedEventType

function on(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)

Parametry

event

"SpokenLanguageChanged"

název události

listener
PropertyChangedEvent

zpětné volání fn použité k přihlášení k odběru této události

setCaptionLanguage(string)

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

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

Parametry

language

string

Jazyk, který chcete popis řeč jako. Musí mít formát ISO 639-1 (např. "en").

Návraty

Promise<void>

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

Podrobnosti zděděných metod

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.

Zděděno ztitulkůCommon.setSpokenLanguage

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.

Zděděno ztitulkůCommon.startCaptions

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í.

Zděděno ztitulkůCommon.stopCaptions