TeamsCaptions interface

Gibt die aktuelle aktive Beschriftungssprache im ISO 639-1-Format an.

activeCaptionLanguage: string

Eigenschaftswert

Liste der unterstützten Beschriftungssprachen, die im ISO 639-1-Format mit dem Untertiteldienst verwendet werden sollen

supportedCaptionLanguages: string[]

Eigenschaftswert

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

activeSpokenLanguage: string

Eigenschaftswert

geerbt vonCaptionsCommon.activeSpokenLanguage

Gibt an, ob Beschriftungen im aktuellen Aufruf aktiv sind.

isCaptionsFeatureActive: boolean

Eigenschaftswert

Geerbt vonCaptionsCommon.isCaptionsFeatureActive

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

kind: CaptionsKind

Eigenschaftswert

vonCaptionsCommon.kind geerbt

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

supportedSpokenLanguages: string[]

Eigenschaftswert

Geerbt vonCaptionsCommon.supportedSpokenLanguages

Unsubscribe-Funktion für eines der CaptionLanguageChangedEventType-Ereignisse

function off(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)

Parameter

Unsubscribe-Funktion für eines der CaptionsPropertyChangedEventType-Ereignisse

function off(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)

Parameter

Unsubscribe-Funktion für eines der CaptionsPropertyChangedEventType-Ereignisse

function off(event: "CaptionsReceived", listener: TeamsCaptionsHandler)

Parameter

Unsubscribe-Funktion für eines der SpokenLanguageChangedEventType-Ereignisse

function off(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)

Parameter

Subscribe-Funktion für eines der CaptionLanguageChangedEventType-Ereignisse

function on(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)

Parameter

Subscribe function for any of the CaptionsPropertyChangedEventType events

function on(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)

Parameter

Subscribe-Funktion für das CaptionsReceivedEventType-Ereignis

function on(event: "CaptionsReceived", listener: TeamsCaptionsHandler)

Parameter

Subscribe function for any of the SpokenLanguageChangedEventType events

function on(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)

Parameter

Aktualisiert die Sprache der fortlaufenden Transkription / Untertitel

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

Parameter

Gibt zurück

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 "CaptionLanguageChanged"-Ereignis wird ausgegeben, wenn die Sprache tatsächlich erfolgreich geändert wurde.

Aktualisiert die Sprache der fortlaufenden Transkription / Untertitel

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

Parameter

Gibt zurück

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

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

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

Parameter

Gibt zurück

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

Beendet den Abruf von Beschriftungsdaten im Anruf für den Benutzer, der stopCaptions initiiert hat.

function stopCaptions(): Promise<void>

Gibt zurück

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