Partager via

CaptionsCommon interface

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

Structure de données pour l’objet CaptionsCommon

Propriétés

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

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

Méthodes

setSpokenLanguage(string)

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

Démarre le traitement des sous-titres de 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é

activeSpokenLanguage

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

activeSpokenLanguage: string

Valeur de propriété

string

isCaptionsFeatureActive

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

isCaptionsFeatureActive: boolean

Valeur de propriété

boolean

kind

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

kind: CaptionsKind

Valeur de propriété

CaptionsKind

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[]

Détails de la méthode

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. L’achèvement 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.

startCaptions(StartCaptionsOptions)

Démarre le traitement des sous-titres de 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 Démarrer la légende L’achèvement de cette promesse n’indique PAS que les sous-titres ont démarré. Un événement « CaptionsActiveChanged » sera émis lorsque les sous-titres auront démarré avec succès.

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 l’achèvement de l’opération Arrêter la légende L’achèvement de cette promesse n’indique PAS que le bot de légendes a quitté l’appel. Le participant se désinscrit de la réception des données de sous-titres une fois l’arrêt réussi.