PPTLiveCallFeature interface

Package:

@azure/communication-calling

PPTLive feature.

Extends

CallFeature

Properties

activePresenterId	Current presenter's identifier
isActive	Indicates if pptlive is active in current call
target	The target html element in which the ppt live is rendering on. Use this property and attach it to any UI html element. Example: document.getElement('someDiv').appendChild(target);

Inherited Properties

name	The feature name.

Methods

off("isActiveChanged", PropertyChangedEvent)	Unsubscribe function for isActiveChanged event
on("isActiveChanged", PropertyChangedEvent)	Subscribe function for isActiveChanged event

Inherited Methods

dispose()

Property Details

activePresenterId

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.

Current presenter's identifier

activePresenterId?: CommunicationIdentifier

Property Value

CommunicationIdentifier

isActive

Indicates if pptlive is active in current call

isActive: boolean

Property Value

boolean

target

The target html element in which the ppt live is rendering on. Use this property and attach it to any UI html element. Example: document.getElement('someDiv').appendChild(target);

target: HTMLElement

Property Value

HTMLElement

Inherited Property Details

name

The feature name.

name: string

Property Value

string

Inherited From CallFeature.name

Method Details

off("isActiveChanged", PropertyChangedEvent)

Unsubscribe function for isActiveChanged event

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

Parameters

event

"isActiveChanged"

event name - isActiveChanged

listener

PropertyChangedEvent

callback fn that was used to subscribe to this event

on("isActiveChanged", PropertyChangedEvent)

Subscribe function for isActiveChanged event

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

Parameters

event

"isActiveChanged"

event name - isActiveChanged

listener

PropertyChangedEvent

callback fn that was used to subscribe to this event

Inherited Method Details

dispose()

function dispose()

Inherited From CallFeature.dispose