Dela via

Captions interface

  • Referens
Paket:
@azure/communication-calling

Anteckning

Denna API är i betaversion och tillhandahålls som en förhandsversion för utvecklare och kan komma att ändras utifrån den feedback vi får. Använd inte detta API i en produktionsmiljö.

Datastruktur för undertextobjekt

Extends
CaptionsCommon

Ärvda egenskaper

activeSpokenLanguage

Anger det aktuella aktiva talade språket i anropet i BCP 47-format
isCaptionsFeatureActive

Anger om undertexter är aktiva i det aktuella anropet
kind

Anger typen Undertexter för det aktiva undertextobjektet
supportedSpokenLanguages

Lista över talade språk som stöds för användning med bildtext-tjänsten i BCP 47-format

Metoder

off("CaptionsActiveChanged", PropertyChangedEvent)

Funktionen Avbryt prenumeration för någon av captionsPropertyChangedEventType-händelserna
off("CaptionsReceived", CaptionsHandler)

Funktionen Avbryt prenumeration för någon av captionsPropertyChangedEventType-händelserna
off("SpokenLanguageChanged", PropertyChangedEvent)

Avbryt prenumerationsfunktionen för någon av SpokenLanguageChangedEventType-händelserna
on("CaptionsActiveChanged", PropertyChangedEvent)

Funktionen Subscribe för någon av captionsPropertyChangedEventType-händelserna
on("CaptionsReceived", CaptionsHandler)

Funktionen Subscribe för händelsen CaptionsReceivedEventType
on("SpokenLanguageChanged", PropertyChangedEvent)

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

Ärvda metoder

setSpokenLanguage(string)

Uppdateringar språket i den pågående transkriptionen/beskrivningarna
startCaptions(StartCaptionsOptions)

Påbörjar 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

Information om ärvda egenskaper

activeSpokenLanguage

Anger det aktuella aktiva talade språket 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

Ärvd frånCaptionsCommon.isCaptionsFeatureActive

kind

Anger typen Undertexter för det aktiva undertextobjektet

kind: CaptionsKind

Egenskapsvärde

CaptionsKind

Ärvd frånCaptionsCommon.kind

supportedSpokenLanguages

Lista över talade språk som stöds för användning med bildtext-tjänsten i BCP 47-format

supportedSpokenLanguages: string[]

Egenskapsvärde

string[]

Ärvd frånCaptionsCommon.supportedSpokenLanguages

Metodinformation

off("CaptionsActiveChanged", PropertyChangedEvent)

Funktionen Avbryt prenumeration 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", CaptionsHandler)

Funktionen Avbryt prenumeration för någon av captionsPropertyChangedEventType-händelserna

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

Parametrar

event

"CaptionsReceived"

händelsenamn

listener
CaptionsHandler

callback fn som användes för att prenumerera på den här händelsen

off("SpokenLanguageChanged", PropertyChangedEvent)

Avbryt 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("CaptionsActiveChanged", PropertyChangedEvent)

Funktionen Subscribe för någon av captionsPropertyChangedEventType-händelserna

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", CaptionsHandler)

Funktionen Subscribe för händelsen CaptionsReceivedEventType

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

Parametrar

event

"CaptionsReceived"

händelsenamn

listener
CaptionsHandler

callback fn som användes för att prenumerera på den här händelsen

on("SpokenLanguageChanged", PropertyChangedEvent)

Funktionen Subscribe 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

Ärvd metodinformation

setSpokenLanguage(string)

Uppdateringar språket i den pågående transkriptionen/beskrivningarna

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

Parametrar

language

string

Språket som ska bildtext tal 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 indikerar INTE att språket har ändrats. En "SpokenLanguageChanged"-händelse genereras när språket faktiskt har ändrats.

Ärvd frånCaptionsCommon.setSpokenLanguage

startCaptions(StartCaptionsOptions)

Påbörjar 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 åtgärden Starttext Slutförandet av det här löftet indikerar INTE att undertexterna 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 stopptextåtgärden Slutförandet av det här löftet indikerar INTE att roboten för undertexter har lämnat anropet. Deltagaren avbryter prenumerationen från att ta emot undertextdata när den har stoppats.

Ärvd frånCaptionsCommon.stopCaptions