LocalRecordingCallFeature interface

Package:

@azure/communication-calling

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.

Feature for call recording.

Extends

CallFeature

Properties

isRecordingActive	Indicates if recording is active in current call
recordings	Gets current recordings

Inherited Properties

name	The feature name.

Methods

off("isLocalRecordingActiveChanged", PropertyChangedEvent)	Unsubscribe function for isLocalRecordingActiveChanged event
off("localRecordingsUpdated", CollectionUpdatedEvent<LocalRecordingInfo>)	Unsubscribe function for localRecordingsUpdated event
on("isLocalRecordingActiveChanged", PropertyChangedEvent)	Subscribe function for isLocalRecordingActiveChanged event
on("localRecordingsUpdated", CollectionUpdatedEvent<LocalRecordingInfo>)	Subscribe function for localRecordingsUpdated event

Inherited Methods

dispose()

Property Details

isRecordingActive

Indicates if recording is active in current call

isRecordingActive: boolean

Property Value

boolean

recordings

Gets current recordings

recordings: LocalRecordingInfo[]

Property Value

LocalRecordingInfo[]

Inherited Property Details

name

The feature name.

name: string

Property Value

string

Inherited From BaseFeature.name

Method Details

off("isLocalRecordingActiveChanged", PropertyChangedEvent)

Unsubscribe function for isLocalRecordingActiveChanged event

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

Parameters

event

"isLocalRecordingActiveChanged"

event name

listener

PropertyChangedEvent

callback fn that was used to subscribe to this event

off("localRecordingsUpdated", CollectionUpdatedEvent<LocalRecordingInfo>)

Unsubscribe function for localRecordingsUpdated event

function off(event: "localRecordingsUpdated", listener: CollectionUpdatedEvent<LocalRecordingInfo>)

Parameters

event

"localRecordingsUpdated"

event name

listener

CollectionUpdatedEvent<LocalRecordingInfo>

callback fn that was used to subscribe to this event

on("isLocalRecordingActiveChanged", PropertyChangedEvent)

Subscribe function for isLocalRecordingActiveChanged event

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

Parameters

event

"isLocalRecordingActiveChanged"

event name

listener

PropertyChangedEvent

callback fn that was used to subscribe to this event

on("localRecordingsUpdated", CollectionUpdatedEvent<LocalRecordingInfo>)

Subscribe function for localRecordingsUpdated event

function on(event: "localRecordingsUpdated", listener: CollectionUpdatedEvent<LocalRecordingInfo>)

Parameters

event

"localRecordingsUpdated"

event name

listener

CollectionUpdatedEvent<LocalRecordingInfo>

callback fn that was used to subscribe to this event

Inherited Method Details

dispose()

function dispose()

Inherited From Disposable.dispose