CaptionsCallFeature interface

Package:

@azure/communication-calling

Feature for Captions

Extends

CallFeature

Properties

captions

Indicates which captions type is currently active

Inherited Properties

name	The feature name.

Methods

off("CaptionsKindChanged", PropertyChangedEvent)	Unsubscribe function for any of the CaptionsKindChangedEventType events
on("CaptionsKindChanged", PropertyChangedEvent)	Subscribe function for any of the CaptionsKindChangedEventType events

Inherited Methods

dispose()

Property Details

captions

Indicates which captions type is currently active

captions: CaptionsCommon

Property Value

CaptionsCommon

Inherited Property Details

name

The feature name.

name: string

Property Value

string

Inherited From CallFeature.name

Method Details

off("CaptionsKindChanged", PropertyChangedEvent)

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Unsubscribe function for any of the CaptionsKindChangedEventType events

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

Parameters

event

"CaptionsKindChanged"

event name

listener

PropertyChangedEvent

callback fn that was used to subscribe to this event

on("CaptionsKindChanged", PropertyChangedEvent)

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Subscribe function for any of the CaptionsKindChangedEventType events

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

Parameters

event

"CaptionsKindChanged"

event name

listener

PropertyChangedEvent

callback fn that was used to subscribe to this

Inherited Method Details

dispose()

function dispose()

Inherited From CallFeature.dispose