SpotlightCallFeature Class

Package:
com.azure.android.communication.calling
  • java.lang.Object
    • CallFeature
      • com.azure.android.communication.calling.SpotlightCallFeature

public class SpotlightCallFeature extends CallFeature

Call Feature for managing spotlight states in a call.

Method Summary

Modifier and Type Method and Description
void addOnSpotlightChangedListener(SpotlightChangedListener listener)

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

CompletableFuture<Void> cancelAllSpotlights()

Send request to stop spotlight for all spotlighted participants

CompletableFuture<Void> cancelSpotlights(com.azure.android.communication.common.CommunicationIdentifier... identifiers)

Cancel spotlight for participants

CompletableFuture<Void> cancelSpotlights(Iterable<com.azure.android.communication.common.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. Spotlight event occurs when any user starts or stops spotlight.

CompletableFuture<Void> spotlight(com.azure.android.communication.common.CommunicationIdentifier... identifiers)

Starts spotlight for participants

CompletableFuture<Void> spotlight(Iterable<com.azure.android.communication.common.CommunicationIdentifier> identifiers)

Starts spotlight for participants

Inherited Members

CallFeature.finalize() CallFeature.getName()

Method Details

addOnSpotlightChangedListener

public void addOnSpotlightChangedListener(SpotlightChangedListener listener)

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

Parameters:

listener

cancelAllSpotlights

public CompletableFuture<Void> cancelAllSpotlights()

Send request to stop spotlight for all spotlighted participants

cancelSpotlights

public CompletableFuture<Void> cancelSpotlights(com.azure.android.communication.common.CommunicationIdentifier... identifiers)

Cancel spotlight for participants

Parameters:

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

cancelSpotlights

public CompletableFuture<Void> cancelSpotlights(Iterable<com.azure.android.communication.common.CommunicationIdentifier> identifiers)

Cancel spotlight for participants

Parameters:

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

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

removeOnSpotlightChangedListener

public void removeOnSpotlightChangedListener(SpotlightChangedListener listener)

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

Parameters:

listener

spotlight

public CompletableFuture<Void> spotlight(com.azure.android.communication.common.CommunicationIdentifier... identifiers)

Starts spotlight for participants

Parameters:

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

spotlight

public CompletableFuture<Void> spotlight(Iterable<com.azure.android.communication.common.CommunicationIdentifier> identifiers)

Starts spotlight for participants

Parameters:

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

Applies to