Captions interface

Pakket:

@azure/communication-calling

Gegevensstructuur voor ondertitelingsobject

Uitbreiding

CaptionsCommon

Overgenomen eigenschappen

activeSpokenLanguage	Geeft de huidige actieve gesproken taal in de aanroep in BCP 47-indeling aan
isCaptionsFeatureActive	Geeft aan of bijschriften actief zijn in de huidige aanroep
kind	Geeft het type bijschriften voor het object actieve bijschriften aan
supportedSpokenLanguages	Lijst met ondersteunde gesproken talen die moeten worden gebruikt met de ondertitelingsservice in BCP 47-indeling

Methoden

off("CaptionsActiveChanged", PropertyChangedEvent)	Afmeldingsfunctie voor een van de captionsPropertyChangedEventType-gebeurtenissen
off("CaptionsReceived", CaptionsHandler)	Afmeldingsfunctie voor een van de captionsPropertyChangedEventType-gebeurtenissen
off("SpokenLanguageChanged", PropertyChangedEvent)	De functie Afmelden voor een van de spokenLanguageChangedEventType-gebeurtenissen
on("CaptionsActiveChanged", PropertyChangedEvent)	De functie Subscribe voor een van de gebeurtenissen CaptionsPropertyChangedEventType
on("CaptionsReceived", CaptionsHandler)	De functie Subscribe voor de gebeurtenis CaptionsReceivedEventType
on("SpokenLanguageChanged", PropertyChangedEvent)	De functie Abonneren voor een van de gebeurtenissen SpokenLanguageChangedEventType

Overgenomen methoden

setSpokenLanguage(string)	De taal van de lopende transcriptie/bijschriften bijwerken
startCaptions(StartCaptionsOptions)	Hiermee start u de verwerking van bijschriften in deze aanroep met de opgegeven handler voor deze client
stopCaptions()	Stopt het ophalen van bijschriftgegevens in de aanroep voor de gebruiker die stopCaptions heeft gestart

Details van overgenomen eigenschap

activeSpokenLanguage

Geeft de huidige actieve gesproken taal in de aanroep in BCP 47-indeling aan

activeSpokenLanguage: string

Waarde van eigenschap

string

overgenomen vanCaptionsCommon.activeSpokenLanguage-

isCaptionsFeatureActive

Geeft aan of bijschriften actief zijn in de huidige aanroep

isCaptionsFeatureActive: boolean

Waarde van eigenschap

boolean

overgenomen vanCaptionsCommon.isCaptionsFeatureActive

kind

Geeft het type bijschriften voor het object actieve bijschriften aan

kind: CaptionsKind

Waarde van eigenschap

CaptionsKind

overgenomen vanCaptionsCommon.kind

supportedSpokenLanguages

Lijst met ondersteunde gesproken talen die moeten worden gebruikt met de ondertitelingsservice in BCP 47-indeling

supportedSpokenLanguages: string[]

Waarde van eigenschap

string[]

overgenomen vanCaptionsCommon.supportedSpokenLanguages

Methodedetails

off("CaptionsActiveChanged", PropertyChangedEvent)

Afmeldingsfunctie voor een van de captionsPropertyChangedEventType-gebeurtenissen

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

Parameters

event

"CaptionsActiveChanged"

gebeurtenisnaam

listener

PropertyChangedEvent

callback fn die is gebruikt om u te abonneren op deze gebeurtenis

off("CaptionsReceived", CaptionsHandler)

Afmeldingsfunctie voor een van de captionsPropertyChangedEventType-gebeurtenissen

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

Parameters

event

"CaptionsReceived"

gebeurtenisnaam

listener

CaptionsHandler

callback fn die is gebruikt om u te abonneren op deze gebeurtenis

off("SpokenLanguageChanged", PropertyChangedEvent)

De functie Afmelden voor een van de spokenLanguageChangedEventType-gebeurtenissen

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

Parameters

event

"SpokenLanguageChanged"

gebeurtenisnaam

listener

PropertyChangedEvent

callback fn die is gebruikt om u te abonneren op deze gebeurtenis

on("CaptionsActiveChanged", PropertyChangedEvent)

De functie Subscribe voor een van de gebeurtenissen CaptionsPropertyChangedEventType

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

Parameters

event

"CaptionsActiveChanged"

gebeurtenisnaam

listener

PropertyChangedEvent

callback fn die is gebruikt om u te abonneren op deze gebeurtenis

on("CaptionsReceived", CaptionsHandler)

De functie Subscribe voor de gebeurtenis CaptionsReceivedEventType

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

Parameters

event

"CaptionsReceived"

gebeurtenisnaam

listener

CaptionsHandler

callback fn die is gebruikt om u te abonneren op deze gebeurtenis

on("SpokenLanguageChanged", PropertyChangedEvent)

De functie Abonneren voor een van de gebeurtenissen SpokenLanguageChangedEventType

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

Parameters

event

"SpokenLanguageChanged"

gebeurtenisnaam

listener

PropertyChangedEvent

callback fn die is gebruikt om u te abonneren op deze gebeurtenis

Details overgenomen methode

setSpokenLanguage(string)

De taal van de lopende transcriptie/bijschriften bijwerken

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

Parameters

language

string

De taal voor het ondertitelen van spraak als. Moet de BCP 47-indeling hebben (bijvoorbeeld "en-us")

Retouren

Promise<void>

Een promise die de voltooiing van de bewerking Taal instellen aangeeft. De voltooiing van deze belofte geeft NIET aan dat de taal is gewijzigd. Er wordt een 'SpokenLanguageChanged'-gebeurtenis verzonden wanneer de taal daadwerkelijk is gewijzigd.

overgenomen vanCaptionsCommon.setSpokenLanguage-

startCaptions(StartCaptionsOptions)

Hiermee start u de verwerking van bijschriften in deze aanroep met de opgegeven handler voor deze client

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

Parameters

startCaptionsOptions

StartCaptionsOptions

Aanvullende opties voor het starten van bijschriften.

Retouren

Promise<void>

Een promise die de voltooiing van het intialisatieproces voor de bewerking Bijschrift starten aangeeft. De voltooiing van deze belofte geeft niet aan dat de bijschriften zijn gestart. Er wordt een 'CaptionsActiveChanged'-gebeurtenis verzonden wanneer bijschriften daadwerkelijk zijn gestart.

overgenomen vanCaptionsCommon.startCaptions-

stopCaptions()

Stopt het ophalen van bijschriftgegevens in de aanroep voor de gebruiker die stopCaptions heeft gestart

function stopCaptions(): Promise<void>

Retouren

Promise<void>

Een belofte die de voltooiing van de stopbijschriftbewerking aangeeft. De voltooiing van deze belofte geeft niet aan dat de ondertitelingsbot de aanroep heeft verlaten. De deelnemer zal zich afmelden voor het ontvangen van bijschriftgegevens wanneer deze is gestopt.

overgenomen vanCaptionsCommon.stopCaptions-