TeamsCaptions interface

Paquet:

@azure/communication-calling

Structure de données pour l’objet TeamsCaptions

Extends

CaptionsCommon

Propriétés

activeCaptionLanguage	Indique la langue de légende active actuelle au format ISO 639-1
supportedCaptionLanguages	Liste des langues de légende prises en charge à utiliser avec le service de légende au format ISO 639-1

Propriétés héritées

activeSpokenLanguage	Indique la langue parlée active actuelle dans l’appel au format BCP 47
isCaptionsFeatureActive	Indique si les légendes sont actives dans l’appel actuel
kind	Indique le type Captions de l’objet légendes actifs
supportedSpokenLanguages	Liste des langues parlées prises en charge à utiliser avec le service de légende au format BCP 47

Méthodes

off("CaptionLanguageChanged", PropertyChangedEvent)	Fonction De désabonnement pour l’un des événements CaptionLanguageChangedEventType
off("CaptionsActiveChanged", PropertyChangedEvent)	Fonction De désabonnement pour l’un des événements CaptionsPropertyChangedEventType
off("CaptionsReceived", TeamsCaptionsHandler)	Fonction De désabonnement pour l’un des événements CaptionsPropertyChangedEventType
off("SpokenLanguageChanged", PropertyChangedEvent)	Fonction De désabonnement pour l’un des événements SpokenLanguageChangedEventType
on("CaptionLanguageChanged", PropertyChangedEvent)	Fonction Subscribe pour l’un des événements CaptionLanguageChangedEventType
on("CaptionsActiveChanged", PropertyChangedEvent)	Fonction Subscribe pour l’un des événements CaptionsPropertyChangedEventType
on("CaptionsReceived", TeamsCaptionsHandler)	Fonction Subscribe pour l’événement CaptionsReceivedEventType
on("SpokenLanguageChanged", PropertyChangedEvent)	Fonction Subscribe pour l’un des événements SpokenLanguageChangedEventType
setCaptionLanguage(string)	Met à jour la langue de la transcription / légendes en cours

Méthodes héritées

setSpokenLanguage(string)	Met à jour la langue de la transcription / légendes en cours
startCaptions(StartCaptionsOptions)	Démarre le traitement des légendes dans cet appel avec le gestionnaire fourni pour ce client
stopCaptions()	Arrête la récupération des données de légendes dans l’appel pour l’utilisateur qui a lancé stopCaptions

Détails de la propriété

activeCaptionLanguage

Indique la langue de légende active actuelle au format ISO 639-1

activeCaptionLanguage: string

Valeur de propriété

string

supportedCaptionLanguages

Liste des langues de légende prises en charge à utiliser avec le service de légende au format ISO 639-1

supportedCaptionLanguages: string[]

Valeur de propriété

string[]

Détails de la propriété héritée

activeSpokenLanguage

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

activeSpokenLanguage: string

Valeur de propriété

string

héritée deCaptionsCommon.activeSpokenLanguage

isCaptionsFeatureActive

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

isCaptionsFeatureActive: boolean

Valeur de propriété

boolean

héritée deCaptionsCommon.isCaptionsFeatureActive

kind

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

kind: CaptionsKind

Valeur de propriété

CaptionsKind

héritée deCaptionsCommon.kind

supportedSpokenLanguages

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é

string[]

héritée deCaptionsCommon.supportedSpokenLanguages

Détails de la méthode

off("CaptionLanguageChanged", PropertyChangedEvent)

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

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

Paramètres

event

"CaptionLanguageChanged"

nom de l’événement

listener

PropertyChangedEvent

rappel fn utilisé pour s’abonner à cet événement

off("CaptionsActiveChanged", PropertyChangedEvent)

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

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

Paramètres

event

"CaptionsActiveChanged"

nom de l’événement

listener

PropertyChangedEvent

rappel fn utilisé pour s’abonner à cet événement

off("CaptionsReceived", TeamsCaptionsHandler)

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

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

Paramètres

event

"CaptionsReceived"

nom de l’événement

listener

TeamsCaptionsHandler

rappel fn utilisé pour s’abonner à cet événement

off("SpokenLanguageChanged", PropertyChangedEvent)

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

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

Paramètres

event

"SpokenLanguageChanged"

nom de l’événement

listener

PropertyChangedEvent

rappel fn utilisé pour s’abonner à cet événement

on("CaptionLanguageChanged", PropertyChangedEvent)

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

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

Paramètres

event

"CaptionLanguageChanged"

nom de l’événement

listener

PropertyChangedEvent

rappel fn utilisé pour s’abonner à cet événement

on("CaptionsActiveChanged", PropertyChangedEvent)

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

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

Paramètres

event

"CaptionsActiveChanged"

nom de l’événement

listener

PropertyChangedEvent

rappel fn utilisé pour s’abonner à cet événement

on("CaptionsReceived", TeamsCaptionsHandler)

Fonction Subscribe pour l’événement CaptionsReceivedEventType

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

Paramètres

event

"CaptionsReceived"

nom de l’événement

listener

TeamsCaptionsHandler

rappel fn utilisé pour s’abonner à cet événement

on("SpokenLanguageChanged", PropertyChangedEvent)

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

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

Paramètres

event

"SpokenLanguageChanged"

nom de l’événement

listener

PropertyChangedEvent

rappel fn utilisé pour s’abonner à cet événement

setCaptionLanguage(string)

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

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

Paramètres

language

string

Langue de légende de la parole en tant que. Doit être au format ISO 639-1 (par exemple, « en »)

Retours

Promise<void>

Une 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 « CaptionLanguageChanged » est émis lorsque la langue a réellement changé.

Détails de la méthode héritée

setSpokenLanguage(string)

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

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

Paramètres

language

string

Langue de légende de la parole en tant que. Doit être au format BCP 47 (par exemple, «en-us»)

Retours

Promise<void>

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

startCaptions(StartCaptionsOptions)

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

startCaptionsOptions

StartCaptionsOptions

Options supplémentaires pour démarrer les sous-titres.

Retours

Promise<void>

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

stopCaptions()

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

Promise<void>

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