Partager via

Captions interface

  • Référence
Paquet:
@azure/communication-calling

Notes

Ce API est en version bêta et est fourni en tant qu’aperçu pour les développeurs et il peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Structure de données pour l’objet Captions

Extends
CaptionsCommon

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 captions actif
supportedSpokenLanguages

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

Méthodes

off("CaptionsActiveChanged", PropertyChangedEvent)

Fonction Unsubscribe pour l’un des événements CaptionsPropertyChangedEventType
off("CaptionsReceived", CaptionsHandler)

Fonction Unsubscribe pour l’un des événements CaptionsPropertyChangedEventType
off("SpokenLanguageChanged", PropertyChangedEvent)

Fonction Unsubscribe pour l’un des événements SpokenLanguageChangedEventType
on("CaptionsActiveChanged", PropertyChangedEvent)

Fonction Subscribe pour l’un des événements CaptionsPropertyChangedEventType
on("CaptionsReceived", CaptionsHandler)

Fonction Subscribe pour l’événement CaptionsReceivedEventType
on("SpokenLanguageChanged", PropertyChangedEvent)

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

Méthodes héritées

setSpokenLanguage(string)

Mises à jour la langue de la transcription /légendes en cours
startCaptions(StartCaptionsOptions)

Démarre le traitement des sous-titres 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 de l’utilisateur qui a lancé stopCaptions

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é deCaptionsCommon.activeSpokenLanguage

isCaptionsFeatureActive

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

isCaptionsFeatureActive: boolean

Valeur de propriété

boolean

Hérité deCaptionsCommon.isCaptionsFeatureActive

kind

Indique le type Captions de l’objet captions actif

kind: CaptionsKind

Valeur de propriété

CaptionsKind

Hérité deCaptionsCommon.kind

supportedSpokenLanguages

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

supportedSpokenLanguages: string[]

Valeur de propriété

string[]

Hérité deCaptionsCommon.supportedSpokenLanguages

Détails de la méthode

off("CaptionsActiveChanged", PropertyChangedEvent)

Fonction Unsubscribe 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", CaptionsHandler)

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

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

Paramètres

event

"CaptionsReceived"

nom de l’événement

listener
CaptionsHandler

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

off("SpokenLanguageChanged", PropertyChangedEvent)

Fonction Unsubscribe 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("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", CaptionsHandler)

Fonction Subscribe pour l’événement CaptionsReceivedEventType

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

Paramètres

event

"CaptionsReceived"

nom de l’événement

listener
CaptionsHandler

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

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

setSpokenLanguage(string)

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

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

Paramètres

language

string

Langue à légende 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. La réalisation de cette promesse n’indique PAS que la langue a changé. Un événement « SpokenLanguageChanged » est émis lorsque la langue a effectivement été modifiée.

Hérité deCaptionsCommon.setSpokenLanguage

startCaptions(StartCaptionsOptions)

Démarre le traitement des sous-titres dans cet appel avec le gestionnaire fourni pour ce client

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

Paramètres

startCaptionsOptions
StartCaptionsOptions

Options supplémentaires pour le démarrage des sous-titres.

Retours

Promise<void>

Une promesse représentant l’achèvement du processus d’intialisation pour l’opération Démarrer la légende 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 démarré avec succès.

Hérité deCaptionsCommon.startCaptions

stopCaptions()

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

function stopCaptions(): Promise<void>

Retours

Promise<void>

Promesse représentant la fin de l’opération Arrêter la légende L’achèvement de cette promesse n’indique PAS que le bot de sous-titres a quitté l’appel. Le participant se désabonnera de la réception des données de sous-titres lors de l’arrêt réussi.

Hérité deCaptionsCommon.stopCaptions