Udostępnij za pośrednictwem

CaptionsCommon interface

  • Odwołanie
Pakiet:
@azure/communication-calling

Struktura danych dla obiektu CaptionsCommon

Właściwości

activeSpokenLanguage

Wskazuje bieżący aktywny język mówiony w wywołaniu w formacie BCP 47
isCaptionsFeatureActive

Wskazuje, czy podpisy są aktywne w bieżącym wywołaniu
kind

Wskazuje typ podpisów dla obiektu aktywnych podpisów
supportedSpokenLanguages

Lista obsługiwanych języków mówionych do użycia z usługą podpisów w formacie BCP 47

Metody

setSpokenLanguage(string)

Aktualizuje język trwającej transkrypcji/transkrypcji
startCaptions(StartCaptionsOptions)

Uruchamia przetwarzanie podpisów w tym wywołaniu z podaną procedurą obsługi dla tego klienta
stopCaptions()

Zatrzymuje pobieranie danych transkrypcji w wywołaniu dla użytkownika, który zainicjował stopCaptions

Szczegóły właściwości

activeSpokenLanguage

Wskazuje bieżący aktywny język mówiony w wywołaniu w formacie BCP 47

activeSpokenLanguage: string

Wartość właściwości

string

isCaptionsFeatureActive

Wskazuje, czy podpisy są aktywne w bieżącym wywołaniu

isCaptionsFeatureActive: boolean

Wartość właściwości

boolean

kind

Wskazuje typ podpisów dla obiektu aktywnych podpisów

kind: CaptionsKind

Wartość właściwości

CaptionsKind

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[]

Szczegóły metody

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.

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.

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.