Captions interface
Datenstruktur für Captions-Objekt
- Extends
Geerbte Eigenschaften
| active |
Gibt die aktuelle aktive gesprochene Sprache im Anruf im BCP 47-Format an. |
| is |
Gibt an, ob Beschriftungen im aktuellen Aufruf aktiv sind. |
| kind | Gibt den Beschriftungstyp für das aktive Captions-Objekt an. |
| supported |
Liste der unterstützten gesprochenen Sprachen, die mit dem Untertiteldienst im BCP 47-Format verwendet werden sollen |
Methoden
| off("Captions |
Unsubscribe-Funktion für eines der CaptionsPropertyChangedEventType-Ereignisse |
| off("Captions |
Unsubscribe-Funktion für eines der CaptionsPropertyChangedEventType-Ereignisse |
| off("Spoken |
Unsubscribe-Funktion für eines der SpokenLanguageChangedEventType-Ereignisse |
| on("Captions |
Subscribe function for any of the CaptionsPropertyChangedEventType events |
| on("Captions |
Subscribe-Funktion für das CaptionsReceivedEventType-Ereignis |
| on("Spoken |
Subscribe function for any of the SpokenLanguageChangedEventType events |
Geerbte Methoden
| set |
Aktualisiert die Sprache der fortlaufenden Transkription / Untertitel |
| start |
Startet die Verarbeitung von Beschriftungen in diesem Aufruf mit dem bereitgestellten Handler für diesen Client. |
| stop |
Beendet den Abruf von Beschriftungsdaten im Anruf für den Benutzer, der stopCaptions initiiert hat. |
Geerbte Eigenschaftsdetails
activeSpokenLanguage
Gibt die aktuelle aktive gesprochene Sprache im Anruf im BCP 47-Format an.
activeSpokenLanguage: stringEigenschaftswert
string
geerbt vonCaptionsCommon.activeSpokenLanguage
isCaptionsFeatureActive
Gibt an, ob Beschriftungen im aktuellen Aufruf aktiv sind.
isCaptionsFeatureActive: booleanEigenschaftswert
boolean
Geerbt vonCaptionsCommon.isCaptionsFeatureActive
kind
Gibt den Beschriftungstyp für das aktive Captions-Objekt an.
kind: CaptionsKindEigenschaftswert
supportedSpokenLanguages
Liste der unterstützten gesprochenen Sprachen, die mit dem Untertiteldienst im BCP 47-Format verwendet werden sollen
supportedSpokenLanguages: string[]Eigenschaftswert
string[]
Geerbt vonCaptionsCommon.supportedSpokenLanguages
Details zur Methode
off("CaptionsActiveChanged", PropertyChangedEvent)
Unsubscribe-Funktion für eines der CaptionsPropertyChangedEventType-Ereignisse
function off(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)Parameter
- event
-
"CaptionsActiveChanged"
Ereignisname
- listener
- PropertyChangedEvent
callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde
off("CaptionsReceived", CaptionsHandler)
Unsubscribe-Funktion für eines der CaptionsPropertyChangedEventType-Ereignisse
function off(event: "CaptionsReceived", listener: CaptionsHandler)Parameter
- event
-
"CaptionsReceived"
Ereignisname
- listener
- CaptionsHandler
callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde
off("SpokenLanguageChanged", PropertyChangedEvent)
Unsubscribe-Funktion für eines der SpokenLanguageChangedEventType-Ereignisse
function off(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)Parameter
- event
-
"SpokenLanguageChanged"
Ereignisname
- listener
- PropertyChangedEvent
callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde
on("CaptionsActiveChanged", PropertyChangedEvent)
Subscribe function for any of the CaptionsPropertyChangedEventType events
function on(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)Parameter
- event
-
"CaptionsActiveChanged"
Ereignisname
- listener
- PropertyChangedEvent
callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde
on("CaptionsReceived", CaptionsHandler)
Subscribe-Funktion für das CaptionsReceivedEventType-Ereignis
function on(event: "CaptionsReceived", listener: CaptionsHandler)Parameter
- event
-
"CaptionsReceived"
Ereignisname
- listener
- CaptionsHandler
callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde
on("SpokenLanguageChanged", PropertyChangedEvent)
Subscribe function for any of the SpokenLanguageChangedEventType events
function on(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)Parameter
- event
-
"SpokenLanguageChanged"
Ereignisname
- listener
- PropertyChangedEvent
callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde
Details zur geerbten 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.
geerbt vonCaptionsCommon.setSpokenLanguage
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.
geerbt vonCaptionsCommon.startCaptions
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.
Geerbt vonCaptionsCommon.stopCaptions