|
2 | 2 | title: Spotlight states
|
3 | 3 | titleSuffix: An Azure Communication Services how-to guide
|
4 | 4 | description: Use Azure Communication Services SDKs to send spotlight state.
|
5 |
| -author: cnwankwo |
6 |
| -ms.author: cnwankwo |
| 5 | +author: sloanster |
| 6 | +ms.author: micahvivion |
7 | 7 | ms.service: azure-communication-services
|
8 | 8 | ms.subservice: teams-interop
|
9 | 9 | ms.topic: how-to
|
10 |
| -ms.date: 03/01/2023 |
| 10 | +ms.date: 10/15/2024 |
11 | 11 | ms.custom: template-how-to
|
12 | 12 | zone_pivot_groups: acs-plat-web-ios-android-windows
|
13 | 13 | ---
|
14 | 14 |
|
15 | 15 | # Spotlight states
|
16 | 16 |
|
17 |
| -This article describes how to implement Microsoft Teams spotlight capability with Azure Communication Services Calling SDKs. This capability enables users in the call or meeting to pin and unpin videos for everyone. The maximum limit of pinned videos is seven. |
18 |
| - |
19 |
| -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. |
| 17 | +This article describes how to implement spotlight capability with Azure Communication Services Calling SDKs. This capability enables users in the call or meeting to signal to other participants that selected user should be **in the spotlight**. This feature enables users to tag other users in the call and notify all the participants that someone is spotlighted and other clients need to change the User Interface layout for that user. |
20 | 18 |
|
21 | 19 | ## Overview
|
22 | 20 |
|
23 |
| -Spotlighting a video is like pinning it for everyone in the meeting. The organizer, co-organizer, or presenter can choose up to seven people's video feeds (including their own) to highlight for everyone else. |
| 21 | +Spotlight serves as a signaling feature instead of a media capability. Once someone is spotlighted applications can determine how to manage or adjust the spotlighted participant User Interface, typically by highlighting them, placing them at the center of the UI layout, and enlarging their video renderer size while keeping other participants' videos smaller. The maximum limit of spotlighted participants in a call is seven, meaning in a single call a total number of distinct users that are spotlighted is 7. |
24 | 22 |
|
25 |
| -The two different ways to spotlight are your own video and someone else's video (up to seven people). |
| 23 | +Spotlighting a participant is possible in both ACS calls and in Teams meetings. In Teams meetings the organizer, coorganizer, or presenter can choose up to seven user's (including themselves) to be in the spotlight. Do remember in a Teams meeting scenario, when a call is set to Large gallery or Together mode participants can't change the UI layout. |
26 | 24 |
|
27 |
| -When a user spotlights or pins someone in the meeting, this increases the height or width of the participant grid depending on the orientation. |
| 25 | +To enable higher resolution for a spotlighted user's video, the application must ensure that their video renderer is larger than those of other users displayed on the screen. This allows the ACS SDK to request and subscribe to a higher resolution stream, which matches the renderer's size, provided hardware and network conditions permit. If not optimal, the SDK adjusts the resolution for smooth playback. Resolution can also be controlled using via [Video Constraints](../../concepts/voice-video-calling/video-constraints.md), overriding the default ACS SDK behavior. |
28 | 26 |
|
29 |
| -Remind participants that they can't spotlight a video if their view is set to Large gallery or Together mode. |
30 | 27 |
|
31 | 28 | ## Prerequisites
|
32 | 29 |
|
@@ -101,7 +98,7 @@ The following table shows support for spotlight feature in individual Azure Comm
|
101 | 98 | | --- | --- | --- | --- | --- |
|
102 | 99 | | 400 | 45900 | ExpectedError | All provided participant IDs are already spotlighted. | Only participants who aren't currently spotlighted can be spotlighted. |
|
103 | 100 | | 400 | 45902 | ExpectedError | The maximum number of participants are already spotlighted. | Only seven participants can be in the spotlight state at any given time. |
|
104 |
| -| 403 | 45903 | ExpectedError | Only participants with the roles of organizer, co-organizer, or presenter can initiate a spotlight. | Ensure the participant calling the `startSpotlight` operation has the role of organizer, co-organizer, or presenter. | |
| 101 | +| 403 | 45903 | ExpectedError | Only participants with the roles of organizer, coorganizer, or presenter can initiate a spotlight. | Ensure the participant calling the `startSpotlight` operation has the role of organizer, coorganizer, or presenter. | |
105 | 102 |
|
106 | 103 | ## Next steps
|
107 | 104 |
|
|
0 commit comments