CaptionsCommon interface

Pakket:

@azure/communication-calling

Gegevensstructuur voor captionsCommon-object

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

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

Eigenschapdetails

activeSpokenLanguage

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

activeSpokenLanguage: string

Waarde van eigenschap

string

isCaptionsFeatureActive

Geeft aan of bijschriften actief zijn in de huidige aanroep

isCaptionsFeatureActive: boolean

Waarde van eigenschap

boolean

kind

Geeft het type bijschriften voor het object actieve bijschriften aan

kind: CaptionsKind

Waarde van eigenschap

CaptionsKind

supportedSpokenLanguages

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

supportedSpokenLanguages: string[]

Waarde van eigenschap

string[]

Methodedetails

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.

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.

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.