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 Beschriftungen im aktuellen Aufruf aktiv sind.
kind

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

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

Methoden

setSpokenLanguage(string)

Aktualisiert die Sprache der fortlaufenden Transkription / Untertitel
startCaptions(StartCaptionsOptions)

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

Beendet den Abruf von Beschriftungsdaten im Anruf 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 Beschriftungen im aktuellen Aufruf aktiv sind.

isCaptionsFeatureActive: boolean

Eigenschaftswert

boolean

kind

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

kind: CaptionsKind

Eigenschaftswert

CaptionsKind

supportedSpokenLanguages

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

supportedSpokenLanguages: string[]

Eigenschaftswert

string[]

Details zur Methode

setSpokenLanguage(string)

Aktualisiert die Sprache der fortlaufenden Transkription / Untertitel

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

Parameter

language

string

Die Sprache zum Beschriften der Sprache als. Muss BCP 47-Format sein (z. B. "en-us")

Gibt zurück

Promise<void>

Eine Zusage, die den Abschluss des Vorgangs "Sprache festlegen" darstellt. Der Abschluss dieser Zusage gibt NICHT an, 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 Beschriftungen 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 Beschriftungen.

Gibt zurück

Promise<void>

Eine Zusage, die den Abschluss des Intialisierungsprozesses für den Vorgang "Beschriftung starten" darstellt. Der Abschluss dieser Zusage gibt NICHT an, dass die Beschriftungen gestartet wurden. Ein "CaptionsActiveChanged"-Ereignis wird ausgegeben, wenn Beschriftungen tatsächlich erfolgreich gestartet wurden.

stopCaptions()

Beendet den Abruf von Beschriftungsdaten im Anruf 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. Der Abschluss dieser Zusage gibt NICHT an, dass der Untertitel-Bot den Anruf verlassen hat. Der Teilnehmer melde sich vom Empfang von Untertiteldaten ab, sobald er erfolgreich beendet wurde.