CaptionsCommon interface

Paket:

@azure/communication-calling

Datastruktur för CaptionsCommon-objekt

Egenskaper

activeSpokenLanguage	Anger aktuellt aktivt talat språk i anropet i BCP 47-format
isCaptionsFeatureActive	Anger om undertexter är aktiva i det aktuella anropet
kind	Anger textningstypen för objektet med aktiva bildtexter
supportedSpokenLanguages	Lista över talade språk som stöds att använda med undertexttjänsten i BCP 47-format

Metoder

setSpokenLanguage(string)	Uppdaterar språket för den pågående transkriptionen/bildtexterna
startCaptions(StartCaptionsOptions)	Startar bearbetningen av undertexter i det här anropet med den angivna hanteraren för den här klienten
stopCaptions()	Stoppar hämtningen av undertextdata i anropet för den användare som initierade stopCaptions

Egenskapsinformation

activeSpokenLanguage

Anger aktuellt aktivt talat språk i anropet i BCP 47-format

activeSpokenLanguage: string

Egenskapsvärde

string

isCaptionsFeatureActive

Anger om undertexter är aktiva i det aktuella anropet

isCaptionsFeatureActive: boolean

Egenskapsvärde

boolean

kind

Anger textningstypen för objektet med aktiva bildtexter

kind: CaptionsKind

Egenskapsvärde

CaptionsKind

supportedSpokenLanguages

Lista över talade språk som stöds att använda med undertexttjänsten i BCP 47-format

supportedSpokenLanguages: string[]

Egenskapsvärde

string[]

Metodinformation

setSpokenLanguage(string)

Uppdaterar språket för den pågående transkriptionen/bildtexterna

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

Parametrar

language

string

Språket som textningstal som. Måste vara BCP 47-format (t.ex. "en-us")

Returer

Promise<void>

Ett löfte som representerar slutförandet av åtgärden Ange språk. Slutförandet av det här löftet anger INTE att språket har ändrats. En "SpokenLanguageChanged"-händelse genereras när språket faktiskt har ändrats.

startCaptions(StartCaptionsOptions)

Startar bearbetningen av undertexter i det här anropet med den angivna hanteraren för den här klienten

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

Parametrar

startCaptionsOptions

StartCaptionsOptions

Ytterligare alternativ för att starta undertexter.

Returer

Promise<void>

Ett löfte som representerar slutförandet av intialiseringsprocessen för starttextåtgärden Slutförandet av det här löftet anger INTE att bildtexterna har startats. En "CaptionsActiveChanged"-händelse genereras när undertexter faktiskt har startats.

stopCaptions()

Stoppar hämtningen av undertextdata i anropet för den användare som initierade stopCaptions

function stopCaptions(): Promise<void>

Returer

Promise<void>

Ett löfte som representerar slutförandet av åtgärden Stoppa bildtext Slutförandet av det här löftet indikerar INTE att roboten för undertexter har lämnat anropet. Deltagaren avregistrerar sig från att ta emot undertextdata när den har stoppats.