Skip to content

Commit 66c088a

Browse files
v-regandownerv-regandowner
authored
Merge pull request #286564 from vac0224/vc-spotlight-2024-09-13
Standardize content -Spotlight
2 parents 7c50eda + 2b68cf8 commit 66c088a

File tree

5 files changed

+179
-148
lines changed

5 files changed

+179
-148
lines changed

‎articles/communication-services/how-tos/calling-sdk/includes/spotlight/spotlight-android.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -5,46 +5,30 @@ ms.topic: include
55
ms.date: 06/20/2023
66
ms.author: cnwankwo
77
---
8-
[!INCLUDE [Install SDK](../install-sdk/install-sdk-android.md)]
9-
10-
Communication Services or Microsoft 365 users can call the spotlight APIs based on role type and conversation type
11-
12-
**In a one to one call or group call scenario, the following APIs are supported for both Communication Services and Microsoft 365 users**
138

14-
|APIs| Organizer | Presenter | Attendee |
15-
|----------------------------------------------|--------|--------|--------|
16-
| startSpotlight | ✔️ | ✔️ | ✔️ |
17-
| stopSpotlight | ✔️ | ✔️ | ✔️ |
18-
| stopAllSpotlight | ✔️ | ✔️ | ✔️ |
19-
| getSpotlightedParticipants | ✔️ | ✔️ | ✔️ |
20-
| maxSupported | ✔️ | ✔️ | ✔️ |
21-
22-
**For meeting scenario the following APIs are supported for both Communication Services and Microsoft 365 users**
9+
[!INCLUDE [Install SDK](../install-sdk/install-sdk-android.md)]
2310

24-
|APIs| Organizer | Presenter | Attendee |
25-
|----------------------------------------------|--------|--------|--------|
26-
| startSpotlight | ✔️ | ✔️ | |
27-
| stopSpotlight | ✔️ | ✔️ | ✔️ |
28-
| stopAllSpotlight | ✔️ | ✔️ | |
29-
| getSpotlightedParticipants | ✔️ | ✔️ | ✔️ |
30-
| maxSupported | ✔️ | ✔️ | ✔️ |
11+
## Implement spotlight
3112

32-
Spotlight is an extended feature of the core `Call` API. You first need to import calling Features from the Calling SDK:
13+
Spotlight is an extended feature of the core `Call` API. You first need to import calling features from the Calling SDK.
3314

3415
```java
3516
import com.azure.android.communication.calling.SpotlightFeature;
3617
```
3718

38-
Then you can get the feature API object from the call instance:
19+
Then you can get the feature API object from the call instance.
3920

4021
```java
4122
SpotlightCallFeature spotlightCallFeature;
4223
spotlightCallFeature = call.feature(Features.SPOTLIGHT);
4324
```
44-
### Start spotlight for participants:
45-
Any participant in the call or meeting can be pinned. Only Microsoft 365 users who have an organizer, co-organizer or presenter role can start spotlight for other participants. This action is idempotent, trying to start spotlight on a pinned participant does nothing
4625

47-
To use this feature, a list of participants identifiers is required
26+
### Start spotlight for participants
27+
28+
Any participant in the call or meeting can be pinned. Only Microsoft 365 users who have an organizer, co-organizer, or presenter role can start spotlight for other participants. This action is idempotent, trying to start spotlight on a pinned participant does nothing
29+
30+
You need a list of participant identifiers to use this feature.
31+
4832
```java
4933
List<CommunicationIdentifier> spotlightIdentifiers = new ArrayList<>();
5034
CommunicationUserIdentifier acsUser = new CommunicationUserIdentifier(<USER_ID>);
@@ -53,17 +37,21 @@ spotlightIdentifiers.add(new CommunicationUserIdentifier("<USER_ID>"));
5337
spotlightIdentifiers.add(new MicrosoftTeamsUserIdentifier("<USER_ID>"));
5438
spotlightCallFeature.StartSpotlight(spotlightIdentifiers);
5539
```
56-
The following API can also be used to start the spotlight of participants
40+
41+
You can also use the following code to start a participant spotlight.
42+
5743
```java
5844
CommunicationUserIdentifier acsUser = new CommunicationUserIdentifier(<USER_ID>);
5945
MicrosoftTeamsUserIdentifier teamsUser = new MicrosoftTeamsUserIdentifier(<USER_ID>);
6046
spotlightCallFeature.StartSpotlight(acsUser, teamsUser);
6147
```
6248

6349
### Remove spotlight from participants
64-
Any pinned participant in the call or meeting can be unpinned. Only Microsoft 365 users who have an organizer, co-organizer or presenter role can unpin other participants. This action is idempotent, trying to stop spotlight on an unpinned participant does nothing
6550

66-
To use this feature, a list of participants identifiers is required
51+
Any pinned participant in the call or meeting can be unpinned. Only Microsoft 365 users who have an organizer, co-organizer, or presenter role can unpin other participants. This action is idempotent, trying to stop spotlight on an unpinned participant does nothing.
52+
53+
You need a list of participants identifiers to use this feature.
54+
6755
```java
6856
List<CommunicationIdentifier> spotlightIdentifiers = new ArrayList<>();
6957
CommunicationUserIdentifier acsUser = new CommunicationUserIdentifier(<USER_ID>);
@@ -72,20 +60,29 @@ spotlightIdentifiers.add(new CommunicationUserIdentifier("<USER_ID>"));
7260
spotlightIdentifiers.add(new MicrosoftTeamsUserIdentifier("<USER_ID>"));
7361
spotlightCallFeature.StopSpotlight(spotlightIdentifiers);
7462
```
75-
The following API can also be used to remove the spotlight of participants
63+
64+
You can also use the following code to remove a participant spotlight.
65+
7666
```java
7767
CommunicationUserIdentifier acsUser = new CommunicationUserIdentifier(<USER_ID>);
7868
MicrosoftTeamsUserIdentifier teamsUser = new MicrosoftTeamsUserIdentifier(<USER_ID>);
7969
spotlightCallFeature.StopSpotlight(acsUser, teamsUser);
8070
```
71+
8172
### Remove all spotlights
82-
All pinned participants can be unpinned using this API. Only MicrosoftTeamsUserIdentifier users who have an organizer, co-organizer or presenter role can unpin all participants.
73+
74+
All pinned participants can be unpinned using this operation. Only `MicrosoftTeamsUserIdentifier` users who have an organizer, co-organizer, or presenter role can unpin all participants.
75+
8376
```java
8477
spotlightCallFeature.stopAllSpotlight();
8578
```
8679

8780
### Handle changed states
88-
The `Spotlight` API allows you to subscribe to `SpotlightChanged` events. A `SpotlightChanged` event comes from a `call` instance and contains information about newly spotlighted participants and participants whose spotlight were stopped
81+
82+
Spotlight mode enables you to subscribe to `SpotlightChanged` events. A `SpotlightChanged` event comes from a call instance and contains information about newly spotlighted participants and participants whose spotlight stopped. The returned array `SpotlightedParticipant` is sorted by the order the participants were spotlighted.
83+
84+
To get information about all participants with spotlight state changes on the current call, use the following code.
85+
8986
```java
9087
import com.azure.android.communication.calling.SpotlightedParticipant;
9188

@@ -106,8 +103,9 @@ void onSpotlightChanged(SpotlightChangedEvent args) {
106103
spotlightCallFeature.addOnSpotlightChangedListener(onSpotlightChanged);
107104
```
108105

109-
### Get all spotlighted participants:
110-
To get information about all participants that have spotlight state on current call, you can use the following API. The returned array is sorted by the order the participants were spotlighted.
106+
### Get all spotlighted participants
107+
108+
To get information about all participants that have spotlight state on current call, use the following operation. The returned array is sorted by the order the participants were spotlighted.
111109

112110
``` java
113111
List<SpotlightedParticipant> currentSpotlightedParticipants = spotlightCallFeature.getSpotlightedParticipants();
@@ -117,8 +115,10 @@ foreach (SpotlightedParticipant participant in currentSpotlightedParticipants)
117115
}
118116
```
119117

120-
### Get the maximum supported spotlight:
121-
The following API can be used to get the maximum number of participants that can be spotlighted using the Calling SDK
118+
### Get the maximum supported spotlight participants
119+
120+
Use the following operation to get the maximum number of participants that can be spotlighted using the Calling SDK.
121+
122122
``` java
123123
spotlightCallFeature.maxSupported();
124124
```

‎articles/communication-services/how-tos/calling-sdk/includes/spotlight/spotlight-ios.md

Lines changed: 25 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,9 @@ ms.author: cnwankwo
77
---
88
[!INCLUDE [Install SDK](../install-sdk/install-sdk-ios.md)]
99

10-
Communication Services or Microsoft 365 users can call the spotlight APIs based on role type and conversation type
10+
## Implement spotlight
1111

12-
**In a one to one call or group call scenario, the following APIs are supported for both Communication Services and Microsoft 365 users**
13-
14-
|APIs| Organizer | Presenter | Attendee |
15-
|----------------------------------------------|--------|--------|--------|
16-
| startSpotlight | ✔️ | ✔️ | ✔️ |
17-
| stopSpotlight | ✔️ | ✔️ | ✔️ |
18-
| stopAllSpotlight | ✔️ | ✔️ | ✔️ |
19-
| spotlightedParticipants | ✔️ | ✔️ | ✔️ |
20-
| maxSupported | ✔️ | ✔️ | ✔️ |
21-
22-
**For meeting scenario the following APIs are supported for both Communication Services and Microsoft 365 users**
23-
24-
|APIs| Organizer | Presenter | Attendee |
25-
|----------------------------------------------|--------|--------|--------|
26-
| startSpotlight | ✔️ | ✔️ | |
27-
| stopSpotlight | ✔️ | ✔️ | ✔️ |
28-
| stopAllSpotlight | ✔️ | ✔️ | |
29-
| spotlightedParticipants | ✔️ | ✔️ | ✔️ |
30-
| maxSupported | ✔️ | ✔️ | ✔️ |
31-
32-
Spotlight is an extended feature of the core `Call` API. You first need to import calling Features from the Calling SDK:
12+
Spotlight is an extended feature of the core `Call` API. You first need to import calling features from the Calling SDK.
3313

3414
```swift
3515
import AzureCommunicationCalling
@@ -43,10 +23,11 @@ Then you can get the feature API object from the call instance:
4323
spotlightFeature = self.call!.feature(Features.spotlight)
4424
```
4525

46-
### Start spotlight for participants:
47-
Any participant in the call or meeting can be pinned. Only Microsoft 365 users who have an organizer, co-organizer or presenter role can start spotlight for other participants. This action is idempotent, trying to start spotlight on a pinned participant does nothing
26+
### Start spotlight for participants
4827

49-
To use this feature, a list of participants identifiers is required
28+
Any participant in the call or meeting can be pinned. Only Microsoft 365 users who have an organizer, co-organizer, or presenter role can start spotlight for other participants. This action is idempotent, trying to start spotlight on a pinned participant does nothing
29+
30+
You need a list of participant identifiers to use this feature.
5031

5132
```swift
5233
var identifiers : [CommunicationIdentifier] = []
@@ -60,9 +41,11 @@ spotlightFeature.startSpotlight(participants: identifiers, completionHandler: {
6041
```
6142

6243
### Remove spotlight from participants
63-
Any pinned participant in the call or meeting can be unpinned. Only Microsoft 365 users who have an organizer, co-organizer or presenter role can unpin other participants. This action is idempotent, trying to stop spotlight on an unpinned participant does nothing
6444

65-
To use this feature, a list of participants identifiers is required
45+
Any pinned participant in the call or meeting can be unpinned. Only Microsoft 365 users who have an organizer, co-organizer, or presenter role can unpin other participants. This action is idempotent, trying to stop spotlight on an unpinned participant does nothing.
46+
47+
You need a list of participants identifiers to use this feature.
48+
6649
```swift
6750
var identifiers : [CommunicationIdentifier] = []
6851
identifiers.append(CommunicationUserIdentifier("<USER_ID>"))
@@ -75,7 +58,9 @@ spotlightFeature.stopSpotlight(participants: identifiers, completionHandler: { (
7558
```
7659

7760
### Remove all spotlights
78-
All pinned participants can be unpinned using this API. Only MicrosoftTeamsUserIdentifier users who have an organizer, co-organizer or presenter role can unpin all participants.
61+
62+
All pinned participants can be unpinned using this operation. Only `MicrosoftTeamsUserIdentifier` users who have an organizer, co-organizer, or presenter role can unpin all participants.
63+
7964
```swift
8065
spotlightFeature.stopAllSpotlight(completionHandler: { (error) in
8166
if let error = error {
@@ -85,7 +70,11 @@ spotlightFeature.stopAllSpotlight(completionHandler: { (error) in
8570
```
8671

8772
### Handle changed states
88-
The `Spotlight` API allows you to subscribe to `SpotlightChanged` events. A `SpotlightChanged` event comes from a `call` instance and contains information about newly spotlighted participants and participants whose spotlight were stopped
73+
74+
Spotlight mode enables you to subscribe to `SpotlightChanged` events. A `SpotlightChanged` event comes from a call instance and contains information about newly spotlighted participants and participants whose spotlight stopped. The returned array `SpotlightedParticipant` is sorted by the order the participants were spotlighted.
75+
76+
To get information about all participants with spotlight state changes on the current call, use the following code.
77+
8978
```swift
9079
// event : { added: SpotlightedParticipant[]; removed: SpotlightedParticipant[] }
9180
// SpotlightedParticipant = { identifier: CommunicationIdentifier }
@@ -107,17 +96,20 @@ public class SpotlightDelegate: SpotlightCallFeatureDelegate {
10796
}
10897
```
10998

110-
### Get all spotlighted participants:
111-
To get information about all participants that have spotlight state on current call, you can use the following API. The returned array is sorted by the order the participants were spotlighted.
99+
### Get all spotlighted participants
100+
101+
To get information about all participants that have spotlight state on the current call, use the following operation. The returned array is sorted by the order the participants were spotlighted.
112102

113103
``` swift
114104
spotlightCallFeature.spotlightedParticipants.forEach { participant in
115105
print("Spotlight active for participant: " + Utilities.toMri(participant.identifier))
116106
}
117107
```
118108

119-
### Get the maximum supported spotlight:
120-
The following API can be used to get the maximum number of participants that can be spotlighted using the Calling SDK
109+
### Get the maximum supported spotlight participants
110+
111+
Use the following operation to get the maximum number of participants that can be spotlighted using the Calling SDK.
112+
121113
``` swift
122114
spotlightCallFeature.maxSupported();
123115
```

0 commit comments

Comments
 (0)