Skip to content

Commit 3239e07

Browse files
Merge pull request #284153 from cn0151/cnwankwo/spotlight_troubleshooting_table
Error table
2 parents 936e890 + ee9d51a commit 3239e07

File tree

2 files changed

+43
-25
lines changed

2 files changed

+43
-25
lines changed

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

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,6 @@ ms.author: cnwankwo
77
---
88
[!INCLUDE [Install SDK](../install-sdk/install-sdk-web.md)]
99

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**
13-
14-
|APIs| Organizer | Presenter | Attendee |
15-
|----------------------------------------------|--------|--------|--------|
16-
| startSpotlight | ✔️ | ✔️ | ✔️ |
17-
| stopSpotlight | ✔️ | ✔️ | ✔️ |
18-
| stopAllSpotlight | ✔️ | ✔️ | ✔️ |
19-
| getSpotlightedParticipants | ✔️ | ✔️ | ✔️ |
20-
21-
**For meeting scenario the following APIs are supported for both Communication Services and Microsoft 365 users**
22-
23-
|APIs| Organizer | Presenter | Attendee |
24-
|----------------------------------------------|--------|--------|--------|
25-
| startSpotlight | ✔️ | ✔️ | |
26-
| stopSpotlight | ✔️ | ✔️ | ✔️ |
27-
| stopAllSpotlight | ✔️ | ✔️ | |
28-
| getSpotlightedParticipants | ✔️ | ✔️ | ✔️ |
29-
3010
Spotlight is an extended feature of the core `Call` API. You first need to import calling Features from the Calling SDK:
3111

3212
```js
@@ -46,7 +26,7 @@ spotLightFeature.startSpotlight();
4626
```
4727

4828
### Spotlight specific participants
49-
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+
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
5030
```js
5131
// Specify list of participants to be spotlighted
5232
CommunicationUserIdentifier acsUser = new CommunicationUserIdentifier(<USER_ID>);
@@ -63,7 +43,7 @@ spotLightFeature.stopSpotlight();
6343

6444

6545
### Remove spotlight from participants
66-
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+
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
6747
```js
6848
// Specify list of participants to be spotlighted
6949
CommunicationUserIdentifier acsUser = new CommunicationUserIdentifier(<USER_ID>);
@@ -72,7 +52,7 @@ spotLightFeature.stopSpotlight([acsUser, teamsUser]);
7252
```
7353

7454
### Remove all spotlights
75-
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.
55+
All pinned participants can be unpinned using this API. Only Microsoft 365 users who have an organizer, co-organizer, or presenter role can unpin all participants.
7656
```js
7757
spotLightFeature.stopAllSpotLight();
7858
```
@@ -108,4 +88,11 @@ let spotlightedParticipants = spotLightFeature.getSpotlightedParticipants();
10888
The following API can be used to get the maximum number of participants that can be spotlighted using the Calling SDK
10989
```js
11090
spotLightFeature.maxParticipantsToSpotlight;
111-
```
91+
```
92+
93+
## Troubleshooting
94+
|code| Subcode | Result Category | Reason | Resolution |
95+
|----------------------------------------------|--------|--------|---------|----------|
96+
|400 | 45900 | ExpectedError | All provided participant IDs are already spotlighted | Only participants who aren't currently spotlighted can be spotlighted |
97+
|400 | 45902 | ExpectedError | The maximum number of participants that can be spotlighted has been reached | Only seven participants can be in the spotlight state at any given time |
98+
|403 | 45903 | ExpectedError | Only participants with the roles of organizer, co-organizer, or presenter can initiate a spotlight | Ensure the participant calling the `startSpotlight` API has assigned role of organizer, co-organizer or presenter |

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

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ zone_pivot_groups: acs-plat-web-ios-android-windows
1313
---
1414

1515
# Spotlight states
16-
In this article, you learn how to implement Microsoft Teams spotlight capability with Azure Communication Services Calling SDKs. This capability allows users in the call or meeting to pin and unpin videos for everyone.
16+
In this article, you learn how to implement Microsoft Teams spotlight capability with Azure Communication Services Calling SDKs. This capability allows users in the call or meeting to pin and unpin videos for everyone. The maximum limit of pinned videos is seven.
17+
1718
Since the video stream resolution of a participant is increased when spotlighted, it should be noted that the settings done on [Video Constraints](../../concepts/voice-video-calling/video-constraints.md) also apply to spotlight.
1819

1920
## Prerequisites
@@ -24,6 +25,36 @@ Since the video stream resolution of a participant is increased when spotlighted
2425
- Optional: Complete the quickstart to [add voice calling to your application](../../quickstarts/voice-video-calling/getting-started-with-calling.md)
2526

2627

28+
## Support
29+
The following tables define support for Spotlight in Azure Communication Services.
30+
31+
### Identities & call types
32+
The following table shows support for call and identity types.
33+
34+
|Identities | Teams meeting | Room | 1:1 call | Group call | 1:1 Teams interop call | Group Teams interop call |
35+
|--------------------------------------|---------------|------|----------|------------|------------------------|--------------------------|
36+
|Communication Services user | ✔️ | ✔️ | | ✔️ | | ✔️ |
37+
|Microsoft 365 user | ✔️ | ✔️ | | ✔️ | | ✔️ |
38+
39+
### Operations
40+
The following table shows support for individual APIs in Calling SDK to individual identity types.
41+
42+
|Operations | Communication Services user | Microsoft 365 user |
43+
|-----------------------------|------------------------------|-------------------|
44+
| startSpotlight | ✔️ [1] | ✔️ [1] |
45+
| stopSpotlight | ✔️ | ✔️ |
46+
| stopAllSpotlight | ✔️ [1] | ✔️ [1] |
47+
| getSpotlightedParticipants | ✔️ | ✔️ |
48+
49+
[1] In Teams meeting scenarios, these APIs are only available to users with role organizer, co-organizer, or presenter.
50+
51+
### SDKs
52+
The following table shows support for Spotlight feature in individual Azure Communication Services SDKs.
53+
54+
| Platforms | Web | Web UI | iOS | iOS UI | Android | Android UI | Windows |
55+
|---------------|-----|--------|--------|--------|----------|--------|---------|
56+
|Is Supported | ✔️ | ✔️ | ✔️ | | ✔️ | | ✔️ |
57+
2758
::: zone pivot="platform-web"
2859
[!INCLUDE [Spotlight Client-side JavaScript](./includes/spotlight/spotlight-web.md)]
2960
::: zone-end

0 commit comments

Comments
 (0)