Captions interface
Struktura danych dla obiektu Captions
- Rozszerzenie
Właściwości dziedziczone
| active |
Wskazuje bieżący aktywny język mówiony w wywołaniu w formacie BCP 47 |
| is |
Wskazuje, czy podpisy są aktywne w bieżącym wywołaniu |
| kind | Wskazuje typ podpisów dla obiektu aktywnych podpisów |
| supported |
Lista obsługiwanych języków mówionych do użycia z usługą podpisów w formacie BCP 47 |
Metody
| off("Captions |
Funkcja Anuluj subskrypcję dla dowolnego zdarzenia CaptionsPropertyChangedEventType |
| off("Captions |
Funkcja Anuluj subskrypcję dla dowolnego zdarzenia CaptionsPropertyChangedEventType |
| off("Spoken |
Anuluj subskrypcję funkcji dla dowolnego zdarzenia SpokenLanguageChangedEventType |
| on("Captions |
Funkcja subskrybuj dowolne zdarzenia CaptionsPropertyChangedEventType |
| on("Captions |
Funkcja Subskrybuj zdarzenie CaptionsReceivedEventType |
| on("Spoken |
Funkcja subskrybuj dla dowolnego zdarzenia SpokenLanguageChangedEventType |
Metody dziedziczone
| set |
Aktualizuje język trwającej transkrypcji/transkrypcji |
| start |
Uruchamia przetwarzanie podpisów w tym wywołaniu z podaną procedurą obsługi dla tego klienta |
| stop |
Zatrzymuje pobieranie danych transkrypcji w wywołaniu dla użytkownika, który zainicjował stopCaptions |
Szczegóły właściwości dziedziczonej
activeSpokenLanguage
Wskazuje bieżący aktywny język mówiony w wywołaniu w formacie BCP 47
activeSpokenLanguage: stringWartość właściwości
string
dziedziczone zCaptionsCommon.activeSpokenLanguage
isCaptionsFeatureActive
Wskazuje, czy podpisy są aktywne w bieżącym wywołaniu
isCaptionsFeatureActive: booleanWartość właściwości
boolean
dziedziczone zCaptionsCommon.isCaptionsFeatureActive
kind
Wskazuje typ podpisów dla obiektu aktywnych podpisów
kind: CaptionsKindWartość właściwości
dziedziczone zCaptionsCommon.kind
supportedSpokenLanguages
Lista obsługiwanych języków mówionych do użycia z usługą podpisów w formacie BCP 47
supportedSpokenLanguages: string[]Wartość właściwości
string[]
dziedziczone zCaptionsCommon.supportedSpokenLanguages
Szczegóły metody
off("CaptionsActiveChanged", PropertyChangedEvent)
Funkcja Anuluj subskrypcję dla dowolnego zdarzenia CaptionsPropertyChangedEventType
function off(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)Parametry
- event
-
"CaptionsActiveChanged"
nazwa zdarzenia
- listener
- PropertyChangedEvent
fn wywołania zwrotnego użytego do subskrybowania tego zdarzenia
off("CaptionsReceived", CaptionsHandler)
Funkcja Anuluj subskrypcję dla dowolnego zdarzenia CaptionsPropertyChangedEventType
function off(event: "CaptionsReceived", listener: CaptionsHandler)Parametry
- event
-
"CaptionsReceived"
nazwa zdarzenia
- listener
- CaptionsHandler
fn wywołania zwrotnego użytego do subskrybowania tego zdarzenia
off("SpokenLanguageChanged", PropertyChangedEvent)
Anuluj subskrypcję funkcji dla dowolnego zdarzenia SpokenLanguageChangedEventType
function off(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)Parametry
- event
-
"SpokenLanguageChanged"
nazwa zdarzenia
- listener
- PropertyChangedEvent
fn wywołania zwrotnego użytego do subskrybowania tego zdarzenia
on("CaptionsActiveChanged", PropertyChangedEvent)
Funkcja subskrybuj dowolne zdarzenia CaptionsPropertyChangedEventType
function on(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)Parametry
- event
-
"CaptionsActiveChanged"
nazwa zdarzenia
- listener
- PropertyChangedEvent
fn wywołania zwrotnego użytego do subskrybowania tego zdarzenia
on("CaptionsReceived", CaptionsHandler)
Funkcja Subskrybuj zdarzenie CaptionsReceivedEventType
function on(event: "CaptionsReceived", listener: CaptionsHandler)Parametry
- event
-
"CaptionsReceived"
nazwa zdarzenia
- listener
- CaptionsHandler
fn wywołania zwrotnego użytego do subskrybowania tego zdarzenia
on("SpokenLanguageChanged", PropertyChangedEvent)
Funkcja subskrybuj dla dowolnego zdarzenia SpokenLanguageChangedEventType
function on(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)Parametry
- event
-
"SpokenLanguageChanged"
nazwa zdarzenia
- listener
- PropertyChangedEvent
fn wywołania zwrotnego użytego do subskrybowania tego zdarzenia
Szczegóły metody dziedziczonej
setSpokenLanguage(string)
Aktualizuje język trwającej transkrypcji/transkrypcji
function setSpokenLanguage(language: string): Promise<void>Parametry
- language
-
string
Język do transkrymowania mowy jako. Musi mieć format BCP 47 (np. "en-us")
Zwraca
Promise<void>
Obietnica reprezentująca ukończenie operacji Ustaw język. Ukończenie tej obietnicy nie wskazuje, że język uległ zmianie. Zdarzenie "SpokenLanguageChanged" będzie emitowane, gdy język rzeczywiście został pomyślnie zmieniony.
dziedziczone zCaptionsCommon.setSpokenLanguage
startCaptions(StartCaptionsOptions)
Uruchamia przetwarzanie podpisów w tym wywołaniu z podaną procedurą obsługi dla tego klienta
function startCaptions(startCaptionsOptions?: StartCaptionsOptions): Promise<void>Parametry
- startCaptionsOptions
- StartCaptionsOptions
Dodatkowe opcje uruchamiania podpisów.
Zwraca
Promise<void>
Obietnica reprezentująca ukończenie procesu inicjowania dla operacji Podpis początkowy Ukończenie tej obietnicy nie wskazuje, że napisy zostały uruchomione. Zdarzenie "CaptionsActiveChanged" będzie emitowane po pomyślnym uruchomieniu podpisów.
dziedziczone zCaptionsCommon.startCaptions
stopCaptions()
Zatrzymuje pobieranie danych transkrypcji w wywołaniu dla użytkownika, który zainicjował stopCaptions
function stopCaptions(): Promise<void>Zwraca
Promise<void>
Obietnica reprezentująca ukończenie operacji Stop Caption Ukończenie tej obietnicy nie wskazuje, że bot podpisów opuścił wywołanie. Uczestnik anuluje subskrypcję otrzymania danych z podpisów po pomyślnym zatrzymaniu.
dziedziczone zCaptionsCommon.stopCaptions