Package com.azure.android.communication.calling

Class SpotlightCallFeature

Object

CallFeature

SpotlightCallFeature

public final class SpotlightCallFeature
extends CallFeature

Call Feature for managing spotlight states in a call.

Method Summary

Modifier and Type	Method	Description
void	addOnSpotlightChangedListener(SpotlightChangedListener listener)	Adds the specified listener to receive OnSpotlightChanged events.
CompletableFuture<Void>	cancelAllSpotlights()	Send request to stop spotlight for all spotlighted participants
CompletableFuture<Void>	cancelSpotlights(CommunicationIdentifier... identifiers)	Cancel spotlight for participants
CompletableFuture<Void>	cancelSpotlights(Iterable<CommunicationIdentifier> identifiers)	Cancel spotlight for participants
int	getMaxSpotlightedParticipants()	Send request to return the maximum number of participants that can be spotlighted
List<SpotlightedParticipant>	getSpotlightedParticipants()	Send request to get a list of all spotlighted participants
void	removeOnSpotlightChangedListener(SpotlightChangedListener listener)	Removes the specified listener to receive OnSpotlightChanged events.
CompletableFuture<Void>	spotlight(CommunicationIdentifier... identifiers)	Starts spotlight for participants
CompletableFuture<Void>	spotlight(Iterable<CommunicationIdentifier> identifiers)	Starts spotlight for participants

Methods inherited from class CallFeature

finalize, getName

Methods inherited from class Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getMaxSpotlightedParticipants

public int getMaxSpotlightedParticipants()

Send request to return the maximum number of participants that can be spotlighted

getSpotlightedParticipants

public List<SpotlightedParticipant> getSpotlightedParticipants()

Send request to get a list of all spotlighted participants

addOnSpotlightChangedListener

public void addOnSpotlightChangedListener(SpotlightChangedListener listener)

Adds the specified listener to receive OnSpotlightChanged events. Spotlight event occurs when any user starts or stops spotlight.

removeOnSpotlightChangedListener

public void removeOnSpotlightChangedListener(SpotlightChangedListener listener)

Removes the specified listener to receive OnSpotlightChanged events. Spotlight event occurs when any user starts or stops spotlight.

cancelAllSpotlights

public CompletableFuture<Void> cancelAllSpotlights()

Send request to stop spotlight for all spotlighted participants

spotlight

public CompletableFuture<Void> spotlight(Iterable<CommunicationIdentifier> identifiers)

Starts spotlight for participants

Parameters:

identifiers - List of participants id that needs to be spotlighted.

spotlight

public CompletableFuture<Void> spotlight(CommunicationIdentifier... identifiers)

Starts spotlight for participants

Parameters:

identifiers - variable number of participants id that needs to be spotlighted.

cancelSpotlights

public CompletableFuture<Void> cancelSpotlights(Iterable<CommunicationIdentifier> identifiers)

Cancel spotlight for participants

Parameters:

identifiers - List of participants id that should have spotlight state removed

cancelSpotlights

public CompletableFuture<Void> cancelSpotlights(CommunicationIdentifier... identifiers)

Cancel spotlight for participants

Parameters:

identifiers - variable number of participants id that should have spotlight state removed