Freigeben über

CaptionsCommon interface

  • Referenz
Paket:
@azure/communication-calling

Datenstruktur für CaptionsCommon-Objekt

Eigenschaften

activeSpokenLanguage

Gibt die aktuelle aktive gesprochene Sprache im Anruf im BCP 47-Format an.
isCaptionsFeatureActive

Gibt an, ob Untertitel im aktuellen Aufruf aktiv sind.
kind

Gibt den Captions-Typ für das aktive Captions-Objekt an.
supportedSpokenLanguages

Liste der unterstützten Sprachen, die mit dem Untertitel-Dienst im BCP 47-Format verwendet werden sollen

Methoden

setSpokenLanguage(string)

Updates der Sprache der laufenden Transkription/Untertitel
startCaptions(StartCaptionsOptions)

Startet die Verarbeitung von Untertiteln in diesem Aufruf mit dem bereitgestellten Handler für diesen Client.
stopCaptions()

Beendet den Abruf von Untertiteldaten im Aufruf für den Benutzer, der stopCaptions initiiert hat.

Details zur Eigenschaft

activeSpokenLanguage

Gibt die aktuelle aktive gesprochene Sprache im Anruf im BCP 47-Format an.

activeSpokenLanguage: string

Eigenschaftswert

string

isCaptionsFeatureActive

Gibt an, ob Untertitel im aktuellen Aufruf aktiv sind.

isCaptionsFeatureActive: boolean

Eigenschaftswert

boolean

kind

Gibt den Captions-Typ für das aktive Captions-Objekt an.

kind: CaptionsKind

Eigenschaftswert

CaptionsKind

supportedSpokenLanguages

Liste der unterstützten Sprachen, die mit dem Untertitel-Dienst im BCP 47-Format verwendet werden sollen

supportedSpokenLanguages: string[]

Eigenschaftswert

string[]

Details zur Methode

setSpokenLanguage(string)

Updates der Sprache der laufenden Transkription/Untertitel

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

Parameter

language

string

Die Sprache, in der Sprache Untertitel werden soll. Muss das BCP 47-Format aufweisen (z. B. "en-us")

Gibt zurück

Promise<void>

Eine Zusage, die den Abschluss des Vorgangs Sprache festlegen darstellt. Die Erfüllung dieser Zusage bedeutet NICHT, dass sich die Sprache geändert hat. Ein "SpokenLanguageChanged"-Ereignis wird ausgegeben, wenn die Sprache tatsächlich erfolgreich geändert wurde.

startCaptions(StartCaptionsOptions)

Startet die Verarbeitung von Untertiteln in diesem Aufruf mit dem bereitgestellten Handler für diesen Client.

function startCaptions(startCaptionsOptions?: StartCaptionsOptions): Promise<void>

Parameter

startCaptionsOptions
StartCaptionsOptions

Zusätzliche Optionen zum Starten von Untertiteln.

Gibt zurück

Promise<void>

Eine Zusage, die den Abschluss des Intialisierungsprozesses für den Start caption-Vorgang darstellt. Die Vervollständigung dieser Zusage gibt NICHT an, dass die Untertitel gestartet wurden. Ein "CaptionsActiveChanged"-Ereignis wird ausgegeben, wenn Untertitel tatsächlich erfolgreich gestartet wurden.

stopCaptions()

Beendet den Abruf von Untertiteldaten im Aufruf für den Benutzer, der stopCaptions initiiert hat.

function stopCaptions(): Promise<void>

Gibt zurück

Promise<void>

Eine Zusage, die den Abschluss des Vorgangs Beschriftung beenden darstellt. Die Vervollständigung dieser Zusage bedeutet NICHT, dass der Untertitelbot den Aufruf verlassen hat. Der Teilnehmer wird den Empfang von Untertiteldaten abbestellen, sobald er erfolgreich beendet wurde.