Captions interface

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

activeSpokenLanguage: string

Egenskapsvärde

ärvd frånCaptionsCommon.activeSpokenLanguage

Anger om undertexter är aktiva i det aktuella anropet

isCaptionsFeatureActive: boolean

Egenskapsvärde

ärvd frånCaptionsCommon.isCaptionsFeatureActive

Anger textningstypen för objektet med aktiva bildtexter

kind: CaptionsKind

Egenskapsvärde

ärvd frånCaptionsCommon.kind

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

supportedSpokenLanguages: string[]

Egenskapsvärde

ärvd frånCaptionsCommon.supportedSpokenLanguages

Avsluta prenumerationsfunktionen för någon av captionsPropertyChangedEventType-händelserna

function off(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)

Parametrar

Avsluta prenumerationsfunktionen för någon av captionsPropertyChangedEventType-händelserna

function off(event: "CaptionsReceived", listener: CaptionsHandler)

Parametrar

Avsluta prenumerationsfunktionen för någon av SpokenLanguageChangedEventType-händelserna

function off(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)

Parametrar

Funktionen Prenumerera för någon av captionsPropertyChangedEventType-händelser

function on(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)

Parametrar

Funktionen Prenumerera för händelsen CaptionsReceivedEventType

function on(event: "CaptionsReceived", listener: CaptionsHandler)

Parametrar

Prenumerationsfunktionen för någon av SpokenLanguageChangedEventType-händelserna

function on(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)

Parametrar

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

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

Parametrar

Returer

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.

ärvd frånCaptionsCommon.setSpokenLanguage

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

Returer

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.

ärvd frånCaptionsCommon.startCaptions

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

function stopCaptions(): Promise<void>

Returer

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.

ärvd frånCaptionsCommon.stopCaptions