Condividi tramite

CaptionsCommon interface

  • Riferimento
Pacchetto:
@azure/communication-calling

Struttura dei dati per l'oggetto CaptionsCommon

Proprietà

activeSpokenLanguage

Indica la lingua parlata attiva corrente nella chiamata in formato BCP 47
isCaptionsFeatureActive

Indica se le didascalie sono attive nella chiamata corrente
kind

Indica il tipo Captions per l'oggetto didascalie attivo
supportedSpokenLanguages

Elenco delle lingue parlate supportate da usare con il servizio didascalia in formato BCP 47

Metodi

setSpokenLanguage(string)

Aggiorna la lingua della trascrizione/sottotitoli in corso
startCaptions(StartCaptionsOptions)

Avvia l'elaborazione delle didascalie in questa chiamata con il gestore fornito per questo client
stopCaptions()

Arresta il recupero dei dati delle didascalie nella chiamata per l'utente che ha avviato stopCaptions

Dettagli proprietà

activeSpokenLanguage

Indica la lingua parlata attiva corrente nella chiamata in formato BCP 47

activeSpokenLanguage: string

Valore della proprietà

string

isCaptionsFeatureActive

Indica se le didascalie sono attive nella chiamata corrente

isCaptionsFeatureActive: boolean

Valore della proprietà

boolean

kind

Indica il tipo Captions per l'oggetto didascalie attivo

kind: CaptionsKind

Valore della proprietà

CaptionsKind

supportedSpokenLanguages

Elenco delle lingue parlate supportate da usare con il servizio didascalia in formato BCP 47

supportedSpokenLanguages: string[]

Valore della proprietà

string[]

Dettagli metodo

setSpokenLanguage(string)

Aggiorna la lingua della trascrizione/sottotitoli in corso

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

Parametri

language

string

Lingua in cui eseguire la didascalia vocale. Deve essere formato BCP 47 (ad esempio "en-us")

Restituisce

Promise<void>

Promessa che rappresenta il completamento dell'operazione Imposta lingua. Il completamento di questa promessa non indica che la lingua è cambiata. Un evento 'SpokenLanguageChanged' verrà generato quando la lingua è stata effettivamente modificata.

startCaptions(StartCaptionsOptions)

Avvia l'elaborazione delle didascalie in questa chiamata con il gestore fornito per questo client

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

Parametri

startCaptionsOptions
StartCaptionsOptions

Opzioni aggiuntive per l'avvio delle didascalie.

Restituisce

Promise<void>

Promessa che rappresenta il completamento del processo di inizializzazione per l'operazione Start Caption Il completamento di questa promessa non indica che le didascalie sono state avviate. Un evento 'CaptionsActiveChanged' verrà generato quando le didascalie sono state effettivamente avviate correttamente.

stopCaptions()

Arresta il recupero dei dati delle didascalie nella chiamata per l'utente che ha avviato stopCaptions

function stopCaptions(): Promise<void>

Restituisce

Promise<void>

Promessa che rappresenta il completamento dell'operazione Stop Caption Il completamento di questa promessa non indica che il bot didascalie ha lasciato la chiamata. Il partecipante annulla la ricezione dei dati delle didascalie al termine dell'arresto.