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

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

Méthodes

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é

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 actifs

kind: CaptionsKind

Valeur de propriété

CaptionsKind

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

Détails de la méthode

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

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

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.