SpotlightCallFeature interface

Package:

@azure/communication-calling

Spotlight call feature.

Extends

CallFeature

Properties

maxParticipantsToSpotlight

Returns the maximum number of participants that can be Spotlighted

Inherited Properties

name	The feature name.

Methods

getSpotlightedParticipants()
off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)	Subscribe function for SpotlightUpdated event
on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)	Subscribe function for SpotlightUpdated event
startSpotlight(CommunicationIdentifier[])
stopAllSpotlight()	Stops Spotlighting for all participants.
stopSpotlight(CommunicationIdentifier[])

Inherited Methods

dispose()

Property Details

maxParticipantsToSpotlight

Returns the maximum number of participants that can be Spotlighted

maxParticipantsToSpotlight: number

Property Value

number

Inherited Property Details

name

The feature name.

name: string

Property Value

string

Inherited From CallFeature.name

Method Details

getSpotlightedParticipants()

function getSpotlightedParticipants(): SpotlightedParticipant[]

Returns

SpotlightedParticipant[]

Returns list of all participants currently Spotlighted

off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Subscribe function for SpotlightUpdated event

function off(event: "spotlightChanged", listener: CollectionUpdatedEvent<SpotlightedParticipant>)

Parameters

event

"spotlightChanged"

event name

listener

CollectionUpdatedEvent<SpotlightedParticipant>

callback function that was used to subscribe to this event

on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Subscribe function for SpotlightUpdated event

function on(event: "spotlightChanged", listener: CollectionUpdatedEvent<SpotlightedParticipant>)

Parameters

event

"spotlightChanged"

event name

listener

CollectionUpdatedEvent<SpotlightedParticipant>

callback function that was used to subscribe to this event

startSpotlight(CommunicationIdentifier[])

function startSpotlight(participants?: CommunicationIdentifier[]): Promise<void>

Parameters

participants

CommunicationIdentifier[]

starts Spotlight for local and remote participants when participants array is not passed, action is performed on local participant

Returns

Promise<void>

A Promise representing the completion of startParticipantSpotlight operation. A 'SpotlightUpdated' event will be emitted when startParticipantSpotlight have successfully started.

stopAllSpotlight()

Stops Spotlighting for all participants.

function stopAllSpotlight(): Promise<void>

Returns

Promise<void>

A Promise representing the completion of the stopAllSpotlight operation. A 'SpotlightUpdated' event will be emitted when stopAllSpotlight have successfully stopped.

stopSpotlight(CommunicationIdentifier[])

function stopSpotlight(participants?: CommunicationIdentifier[]): Promise<void>

Parameters

participants

CommunicationIdentifier[]

stops Spotlight for local and remote participants when participants array is not passed, action is performed on local participant

Returns

Promise<void>

A Promise representing the completion of stopParticipantSpotlight operation. A 'SpotlightUpdated' event will be emitted when stopParticipantSpotlight have successfully stopped.

Inherited Method Details

dispose()

function dispose()

Inherited From CallFeature.dispose