TeamsCaptions interface
Datastruktur för TeamsCaptions-objekt
- Extends
Egenskaper
active |
Anger aktuellt aktivt textningsspråk i ISO 639-1-format |
supported |
Lista över undertextspråk som stöds att använda med undertexttjänsten i ISO 639-1-format |
Ärvda egenskaper
active |
Anger aktuellt aktivt talat språk i anropet i BCP 47-format |
is |
Anger om undertexter är aktiva i det aktuella anropet |
kind | Anger textningstypen för objektet med aktiva bildtexter |
supported |
Lista över talade språk som stöds att använda med undertexttjänsten i BCP 47-format |
Metoder
off("Caption |
Avsluta prenumerationsfunktionen för någon av captionLanguageChangedEventType-händelserna |
off("Captions |
Avsluta prenumerationsfunktionen för någon av captionsPropertyChangedEventType-händelserna |
off("Captions |
Avsluta prenumerationsfunktionen för någon av captionsPropertyChangedEventType-händelserna |
off("Spoken |
Avsluta prenumerationsfunktionen för någon av SpokenLanguageChangedEventType-händelserna |
on("Caption |
Funktionen Prenumerera för någon av CaptionLanguageChangedEventType-händelser |
on("Captions |
Funktionen Prenumerera för någon av captionsPropertyChangedEventType-händelser |
on("Captions |
Funktionen Prenumerera för händelsen CaptionsReceivedEventType |
on("Spoken |
Prenumerationsfunktionen för någon av SpokenLanguageChangedEventType-händelserna |
set |
Uppdaterar språket för den pågående transkriptionen/bildtexterna |
Ärvda metoder
set |
Uppdaterar språket för den pågående transkriptionen/bildtexterna |
start |
Startar bearbetningen av undertexter i det här anropet med den angivna hanteraren för den här klienten |
stop |
Stoppar hämtningen av undertextdata i anropet för den användare som initierade stopCaptions |
Egenskapsinformation
activeCaptionLanguage
Anger aktuellt aktivt textningsspråk i ISO 639-1-format
activeCaptionLanguage: string
Egenskapsvärde
string
supportedCaptionLanguages
Lista över undertextspråk som stöds att använda med undertexttjänsten i ISO 639-1-format
supportedCaptionLanguages: string[]
Egenskapsvärde
string[]
Information om ärvda egenskaper
activeSpokenLanguage
Anger aktuellt aktivt talat språk i anropet i BCP 47-format
activeSpokenLanguage: string
Egenskapsvärde
string
ärvd frånCaptionsCommon.activeSpokenLanguage
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
ärvd frånCaptionsCommon.kind
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
off("CaptionLanguageChanged", PropertyChangedEvent)
Avsluta prenumerationsfunktionen för någon av captionLanguageChangedEventType-händelserna
function off(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)
Parametrar
- event
-
"CaptionLanguageChanged"
händelsenamn
- listener
- PropertyChangedEvent
callback fn som användes för att prenumerera på den här händelsen
off("CaptionsActiveChanged", PropertyChangedEvent)
Avsluta prenumerationsfunktionen för någon av captionsPropertyChangedEventType-händelserna
function off(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)
Parametrar
- event
-
"CaptionsActiveChanged"
händelsenamn
- listener
- PropertyChangedEvent
callback fn som användes för att prenumerera på den här händelsen
off("CaptionsReceived", TeamsCaptionsHandler)
Avsluta prenumerationsfunktionen för någon av captionsPropertyChangedEventType-händelserna
function off(event: "CaptionsReceived", listener: TeamsCaptionsHandler)
Parametrar
- event
-
"CaptionsReceived"
händelsenamn
- listener
- TeamsCaptionsHandler
callback fn som användes för att prenumerera på den här händelsen
off("SpokenLanguageChanged", PropertyChangedEvent)
Avsluta prenumerationsfunktionen för någon av SpokenLanguageChangedEventType-händelserna
function off(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)
Parametrar
- event
-
"SpokenLanguageChanged"
händelsenamn
- listener
- PropertyChangedEvent
callback fn som användes för att prenumerera på den här händelsen
on("CaptionLanguageChanged", PropertyChangedEvent)
Funktionen Prenumerera för någon av CaptionLanguageChangedEventType-händelser
function on(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)
Parametrar
- event
-
"CaptionLanguageChanged"
händelsenamn
- listener
- PropertyChangedEvent
callback fn som användes för att prenumerera på den här händelsen
on("CaptionsActiveChanged", PropertyChangedEvent)
Funktionen Prenumerera för någon av captionsPropertyChangedEventType-händelser
function on(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)
Parametrar
- event
-
"CaptionsActiveChanged"
händelsenamn
- listener
- PropertyChangedEvent
callback fn som användes för att prenumerera på den här händelsen
on("CaptionsReceived", TeamsCaptionsHandler)
Funktionen Prenumerera för händelsen CaptionsReceivedEventType
function on(event: "CaptionsReceived", listener: TeamsCaptionsHandler)
Parametrar
- event
-
"CaptionsReceived"
händelsenamn
- listener
- TeamsCaptionsHandler
callback fn som användes för att prenumerera på den här händelsen
on("SpokenLanguageChanged", PropertyChangedEvent)
Prenumerationsfunktionen för någon av SpokenLanguageChangedEventType-händelserna
function on(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)
Parametrar
- event
-
"SpokenLanguageChanged"
händelsenamn
- listener
- PropertyChangedEvent
callback fn som användes för att prenumerera på den här händelsen
setCaptionLanguage(string)
Uppdaterar språket för den pågående transkriptionen/bildtexterna
function setCaptionLanguage(language: string): Promise<void>
Parametrar
- language
-
string
Språket som textningstal som. Måste vara ISO 639-1-format (t.ex. "en")
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 "CaptionLanguageChanged"-händelse genereras när språket faktiskt har ändrats.
Ärvd 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.
ärvd frånCaptionsCommon.setSpokenLanguage
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.
ärvd frånCaptionsCommon.startCaptions
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.
ärvd frånCaptionsCommon.stopCaptions