Captions interface
Struttura dei dati per l'oggetto Captions
- Extends
Proprietà ereditate
| active |
Indica la lingua parlata attiva corrente nella chiamata in formato BCP 47 |
| is |
Indica se le didascalie sono attive nella chiamata corrente |
| kind | Indica il tipo Captions per l'oggetto didascalie attivo |
| supported |
Elenco delle lingue parlate supportate da usare con il servizio didascalia in formato BCP 47 |
Metodi
| off("Captions |
Funzione Unsubscribe per uno degli eventi CaptionsPropertyChangedEventType |
| off("Captions |
Funzione Unsubscribe per uno degli eventi CaptionsPropertyChangedEventType |
| off("Spoken |
Funzione Unsubscribe per uno degli eventi SpokenLanguageChangedEventType |
| on("Captions |
Funzione Subscribe per uno degli eventi CaptionsPropertyChangedEventType |
| on("Captions |
Funzione Subscribe per l'evento CaptionsReceivedEventType |
| on("Spoken |
Funzione Subscribe per uno degli eventi SpokenLanguageChangedEventType |
Metodi ereditati
| set |
Aggiorna la lingua della trascrizione/sottotitoli in corso |
| start |
Avvia l'elaborazione delle didascalie in questa chiamata con il gestore fornito per questo client |
| stop |
Arresta il recupero dei dati delle didascalie nella chiamata per l'utente che ha avviato stopCaptions |
Dettagli proprietà ereditate
activeSpokenLanguage
Indica la lingua parlata attiva corrente nella chiamata in formato BCP 47
activeSpokenLanguage: stringValore della proprietà
string
ereditato daCaptionsCommon.activeSpokenLanguage
isCaptionsFeatureActive
Indica se le didascalie sono attive nella chiamata corrente
isCaptionsFeatureActive: booleanValore della proprietà
boolean
Ereditato daCaptionsCommon.isCaptionsFeatureActive
kind
Indica il tipo Captions per l'oggetto didascalie attivo
kind: CaptionsKindValore della proprietà
ereditato daCaptionsCommon.kind
supportedSpokenLanguages
Elenco delle lingue parlate supportate da usare con il servizio didascalia in formato BCP 47
supportedSpokenLanguages: string[]Valore della proprietà
string[]
Ereditato daCaptionsCommon.supportedSpokenLanguages
Dettagli metodo
off("CaptionsActiveChanged", PropertyChangedEvent)
Funzione Unsubscribe per uno degli eventi CaptionsPropertyChangedEventType
function off(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)Parametri
- event
-
"CaptionsActiveChanged"
nome evento
- listener
- PropertyChangedEvent
callback fn usato per sottoscrivere questo evento
off("CaptionsReceived", CaptionsHandler)
Funzione Unsubscribe per uno degli eventi CaptionsPropertyChangedEventType
function off(event: "CaptionsReceived", listener: CaptionsHandler)Parametri
- event
-
"CaptionsReceived"
nome evento
- listener
- CaptionsHandler
callback fn usato per sottoscrivere questo evento
off("SpokenLanguageChanged", PropertyChangedEvent)
Funzione Unsubscribe per uno degli eventi SpokenLanguageChangedEventType
function off(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)Parametri
- event
-
"SpokenLanguageChanged"
nome evento
- listener
- PropertyChangedEvent
callback fn usato per sottoscrivere questo evento
on("CaptionsActiveChanged", PropertyChangedEvent)
Funzione Subscribe per uno degli eventi CaptionsPropertyChangedEventType
function on(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)Parametri
- event
-
"CaptionsActiveChanged"
nome evento
- listener
- PropertyChangedEvent
callback fn usato per sottoscrivere questo evento
on("CaptionsReceived", CaptionsHandler)
Funzione Subscribe per l'evento CaptionsReceivedEventType
function on(event: "CaptionsReceived", listener: CaptionsHandler)Parametri
- event
-
"CaptionsReceived"
nome evento
- listener
- CaptionsHandler
callback fn usato per sottoscrivere questo evento
on("SpokenLanguageChanged", PropertyChangedEvent)
Funzione Subscribe per uno degli eventi SpokenLanguageChangedEventType
function on(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)Parametri
- event
-
"SpokenLanguageChanged"
nome evento
- listener
- PropertyChangedEvent
callback fn usato per sottoscrivere questo evento
Dettagli dei metodi ereditati
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.
Ereditato daCaptionsCommon.setSpokenLanguage
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.
ereditato daCaptionsCommon.startCaptions
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.
Ereditato daCaptionsCommon.stopCaptions