TeamsCaptionsInfo interface

  • Reference
Package:
@azure/communication-calling

Data structure received for each CaptionsReceivedEventType event

Properties

captionLanguage

The language that the captions are presented in. Corresponds to the captionLanguage specified in setCaptionLanguage
captionText

The caption text
resultType

The state in which this caption data can be classified
speaker

The information of the call participant who spoke the captioned text
spokenLanguage

The language that the spoken words were interpretted as. Corresponds to the language specified in startCaptions / setSpokenLanguage
spokenText

The original spoken caption text prior to translating to caption language
timestamp

Timestamp of when the captioned words were initially spoken

Property Details

captionLanguage

The language that the captions are presented in. Corresponds to the captionLanguage specified in setCaptionLanguage

captionLanguage: string

Property Value

string

captionText

The caption text

captionText: string

Property Value

string

resultType

The state in which this caption data can be classified

resultType: CaptionsResultType

Property Value

CaptionsResultType

speaker

The information of the call participant who spoke the captioned text

speaker: CallerInfo

Property Value

CallerInfo

spokenLanguage

The language that the spoken words were interpretted as. Corresponds to the language specified in startCaptions / setSpokenLanguage

spokenLanguage: string

Property Value

string

spokenText

The original spoken caption text prior to translating to caption language

spokenText: string

Property Value

string

timestamp

Timestamp of when the captioned words were initially spoken

timestamp: Date

Property Value

Date