ACSSpotlightCallFeature Class
Declaration
@interface ACSSpotlightCallFeature : ACSCallFeature;
Description
Call Feature for managing spotlight states in a call.
Methods
cancelAllSpotlights
Send request to stop spotlight for all spotlighted participants
-(void)cancelAllSpotlightsWithCompletionHandler:(void (^)(NSError *error))completionHandler;
Parameters
completionHandler
- A block to be invoked asynchronously after the operation has finished.
Returns
void
spotlight
Start spotlight for participants.
-(void)spotlight:(NSArray<id<CommunicationIdentifier>>* _Nonnull)identifiers
withCompletionHandler:(void (^ _Nonnull)(NSError * _Nullable error))completionHandler;
Parameters
identifiers
- Participants to start spotlight on.completionHandler
- A block to be invoked asynchronously after the operation has finished.
cancelSpotLights
Cancel spotlight for spotlighted participants.
-(void)cancelSpotlights:(NSArray<id<CommunicationIdentifier>>* _Nonnull)identifiers
withCompletionHandler:(void (^ _Nonnull)(NSError * _Nullable error))completionHandler;
Parameters
identifiers
- Participants cancel spotlight.completionHandler
- A block to be invoked asynchronously after the operation has finished.
Properties
delegate
An object you provide to receive events from this ACSSpotlightCallFeature instance.
@property(nonatomic, assign) id<ACSSpotlightCallFeatureDelegate> delegate;
maxSpotlightedParticipants
Send request to return the maximum number of participants that can be spotlighted
@property (readonly) int maxSpotlightedParticipants;
spotlightedParticipants
Send request to get a list of all spotlighted participants
@property (copy, nonnull, readonly) NSArray<ACSSpotlightedParticipant *> * spotlightedParticipants;