TeamsCaptions interface
Datenstruktur für das TeamsCaptions-Objekt
- Extends
Eigenschaften
| active |
Gibt die aktuelle aktive Untertitel Sprache im ISO 639-1-Format an. |
| supported |
Liste der unterstützten Untertitel Sprachen, die mit dem Untertitel-Dienst im ISO 639-1-Format verwendet werden sollen |
Geerbte Eigenschaften
| active |
Gibt die aktuelle aktive gesprochene Sprache im Anruf im BCP 47-Format an. |
| is |
Gibt an, ob Untertitel im aktuellen Aufruf aktiv sind. |
| kind | Gibt den Captions-Typ für das aktive Captions-Objekt an. |
| supported |
Liste der unterstützten Sprachen, die mit dem Untertitel-Dienst im BCP 47-Format verwendet werden sollen |
Methoden
| off("Caption |
Unsubscribe-Funktion für eines der CaptionLanguageChangedEventType-Ereignisse |
| 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("Caption |
Subscribe-Funktion für eines der CaptionLanguageChangedEventType-Ereignisse |
| on("Captions |
Subscribe-Funktion für eines der CaptionsPropertyChangedEventType-Ereignisse |
| on("Captions |
Subscribe-Funktion für das CaptionsReceivedEventType-Ereignis |
| on("Spoken |
Subscribe-Funktion für eines der SpokenLanguageChangedEventType-Ereignisse |
| set |
Updates der Sprache der laufenden Transkription/Untertitel |
Geerbte Methoden
| set |
Updates der Sprache der laufenden Transkription/Untertitel |
| start |
Startet die Verarbeitung von Untertiteln in diesem Aufruf mit dem bereitgestellten Handler für diesen Client. |
| stop |
Beendet den Abruf von Untertiteldaten im Aufruf für den Benutzer, der stopCaptions initiiert hat. |
Details zur Eigenschaft
activeCaptionLanguage
Gibt die aktuelle aktive Untertitel Sprache im ISO 639-1-Format an.
activeCaptionLanguage: stringEigenschaftswert
string
supportedCaptionLanguages
Liste der unterstützten Untertitel Sprachen, die mit dem Untertitel-Dienst im ISO 639-1-Format verwendet werden sollen
supportedCaptionLanguages: string[]Eigenschaftswert
string[]
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 Untertitel im aktuellen Aufruf aktiv sind.
isCaptionsFeatureActive: booleanEigenschaftswert
boolean
Geerbt vonCaptionsCommon.isCaptionsFeatureActive
kind
Gibt den Captions-Typ für das aktive Captions-Objekt an.
kind: CaptionsKindEigenschaftswert
Geerbt vonCaptionsCommon.kind
supportedSpokenLanguages
Liste der unterstützten Sprachen, die mit dem Untertitel-Dienst im BCP 47-Format verwendet werden sollen
supportedSpokenLanguages: string[]Eigenschaftswert
string[]
Geerbt vonCaptionsCommon.supportedSpokenLanguages
Details zur Methode
off("CaptionLanguageChanged", PropertyChangedEvent)
Unsubscribe-Funktion für eines der CaptionLanguageChangedEventType-Ereignisse
function off(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)Parameter
- event
-
"CaptionLanguageChanged"
Ereignisname
- listener
- PropertyChangedEvent
Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde
off("CaptionsActiveChanged", PropertyChangedEvent)
Unsubscribe-Funktion für eines der CaptionsPropertyChangedEventType-Ereignisse
function off(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)Parameter
- event
-
"CaptionsActiveChanged"
Ereignisname
- listener
- PropertyChangedEvent
Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde
off("CaptionsReceived", TeamsCaptionsHandler)
Unsubscribe-Funktion für eines der CaptionsPropertyChangedEventType-Ereignisse
function off(event: "CaptionsReceived", listener: TeamsCaptionsHandler)Parameter
- event
-
"CaptionsReceived"
Ereignisname
- listener
- TeamsCaptionsHandler
Rückruf 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
Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde
on("CaptionLanguageChanged", PropertyChangedEvent)
Subscribe-Funktion für eines der CaptionLanguageChangedEventType-Ereignisse
function on(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)Parameter
- event
-
"CaptionLanguageChanged"
Ereignisname
- listener
- PropertyChangedEvent
Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde
on("CaptionsActiveChanged", PropertyChangedEvent)
Subscribe-Funktion für eines der CaptionsPropertyChangedEventType-Ereignisse
function on(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)Parameter
- event
-
"CaptionsActiveChanged"
Ereignisname
- listener
- PropertyChangedEvent
Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde
on("CaptionsReceived", TeamsCaptionsHandler)
Subscribe-Funktion für das CaptionsReceivedEventType-Ereignis
function on(event: "CaptionsReceived", listener: TeamsCaptionsHandler)Parameter
- event
-
"CaptionsReceived"
Ereignisname
- listener
- TeamsCaptionsHandler
Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde
on("SpokenLanguageChanged", PropertyChangedEvent)
Subscribe-Funktion für eines der SpokenLanguageChangedEventType-Ereignisse
function on(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)Parameter
- event
-
"SpokenLanguageChanged"
Ereignisname
- listener
- PropertyChangedEvent
Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde
setCaptionLanguage(string)
Updates der Sprache der laufenden Transkription/Untertitel
function setCaptionLanguage(language: string): Promise<void>Parameter
- language
-
string
Die Sprache, in der Sprache Untertitel werden soll. Muss das FORMAT ISO 639-1 aufweisen (z. B. "en")
Gibt zurück
Promise<void>
Eine Zusage, die den Abschluss des Vorgangs Sprache festlegen darstellt. Die Vervollständigung dieser Zusage weist NICHT darauf hin, dass sich die Sprache geändert hat. Ein "CaptionLanguageChanged"-Ereignis wird ausgegeben, wenn die Sprache tatsächlich erfolgreich geändert wurde.
Details zur geerbten 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.
Geerbt vonCaptionsCommon.setSpokenLanguage
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.
Geerbt vonCaptionsCommon.startCaptions
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.
Geerbt vonCaptionsCommon.stopCaptions