Captions interface

Indique la langue parlée active actuelle dans l’appel au format BCP 47

activeSpokenLanguage: string

Valeur de propriété

héritée deCaptionsCommon.activeSpokenLanguage

Indique si les légendes sont actives dans l’appel actuel

isCaptionsFeatureActive: boolean

Valeur de propriété

héritée deCaptionsCommon.isCaptionsFeatureActive

Indique le type Captions de l’objet légendes actifs

kind: CaptionsKind

Valeur de propriété

héritée deCaptionsCommon.kind

Liste des langues parlées prises en charge à utiliser avec le service de légende au format BCP 47

supportedSpokenLanguages: string[]

Valeur de propriété

héritée deCaptionsCommon.supportedSpokenLanguages

Fonction De désabonnement pour l’un des événements CaptionsPropertyChangedEventType

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

Paramètres

Fonction De désabonnement pour l’un des événements CaptionsPropertyChangedEventType

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

Paramètres

Fonction De désabonnement pour l’un des événements SpokenLanguageChangedEventType

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

Paramètres

Fonction Subscribe pour l’un des événements CaptionsPropertyChangedEventType

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

Paramètres

Fonction Subscribe pour l’événement CaptionsReceivedEventType

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

Paramètres

Fonction Subscribe pour l’un des événements SpokenLanguageChangedEventType

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

Paramètres

Met à jour la langue de la transcription / légendes en cours

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

Paramètres

Retours

Promesse représentant l’achèvement de l’opération Définir la langue. L’achèvement de cette promesse n’indique PAS que la langue a changé. Un événement « SpokenLanguageChanged » est émis lorsque la langue a réellement changé.

héritée deCaptionsCommon.setSpokenLanguage

Démarre le traitement des légendes dans cet appel avec le gestionnaire fourni pour ce client

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

Paramètres

Retours

Promesse représentant l’achèvement du processus d’intialisation pour l’opération de légende de début L’achèvement de cette promesse n’indique pas que les légendes ont démarré. Un événement « CaptionsActiveChanged » est émis lorsque les légendes ont réellement démarré.

héritée deCaptionsCommon.startCaptions

Arrête la récupération des données de légendes dans l’appel pour l’utilisateur qui a lancé stopCaptions

function stopCaptions(): Promise<void>

Retours

Une promesse représentant l’achèvement de l’opération Stop Caption L’achèvement de cette promesse n’indique PAS que le bot de légendes a quitté l’appel. Le participant se désabonne de la réception des données de sous-titres lors de l’arrêt réussi.

héritée deCaptionsCommon.stopCaptions