Skip to content

Commit 650dddf

Browse files
Merge pull request #286501 from vac0224/vc-together-mode-2024-09-14
Standardize content -Together Mode
2 parents 7f8e6b0 + 3d1e1a7 commit 650dddf

File tree

2 files changed

+35
-28
lines changed

2 files changed

+35
-28
lines changed

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

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,22 @@ ms.author: cnwankwo
88

99
[!INCLUDE [Install SDK](../install-sdk/install-sdk-web.md)]
1010

11-
11+
## Implement Together Mode
1212

1313
Together Mode is an extended feature of the core `Call` API. You first need to import calling Features from the Calling SDK:
1414

1515
```js
1616
import { Features} from "@azure/communication-calling";
1717
```
1818

19-
Then you can get the feature API object from the call instance:
19+
Then you can get the Together Mode API object from the call instance:
2020

2121
```js
2222
const togetherModeFeature = call.feature(Features.TogetherMode);
2323
```
2424

2525
### Receive events when Together Mode stream starts or updates
26+
2627
You can subscribe to the event `togetherModeStreamsUpdated` to receive notifications when Together Mode starts or updates. The event contains information about rendering the added video stream.
2728

2829
```js
@@ -35,29 +36,33 @@ togetherModeFeature.on('togetherModeStreamsUpdated', (event) => {
3536
```
3637

3738
### Get Together Mode stream
39+
3840
You can access Together Mode streams through the property `togetherModeStream`.
3941

4042
```js
4143
const togetherModeStreams = togetherModeFeature.togetherModeStream;
4244
```
4345

44-
| Together Mode Stream Properties | Description|
45-
|----------------------------------------------|--------|
46-
|`id` | Unique number used to identify the stream. |
47-
|`mediaStreamType` | Returns the Together Mode stream type. The value of `mediaStreamType` is always `video`. |
48-
|`isReceiving` | Returns a Boolean value indicating if video packets are received. |
49-
|`size` | Returns the Together Mode `StreamSize` with information about the width and height of the stream in pixels. |
46+
| Together Mode Stream Properties | Description |
47+
| --- | --- |
48+
| `id` | Unique number used to identify the stream. |
49+
| `mediaStreamType` | Returns the Together Mode stream type. The value of `mediaStreamType` is always `video`. |
50+
| `isReceiving` | Returns a Boolean value indicating if video packets are received. |
51+
| `size` | Returns the Together Mode `StreamSize` with information about the width and height of the stream in pixels. |
5052

5153
### Start Together Mode for all participants
52-
Microsoft 365 users with role organizer, co-organizer, or presenter can start Together Mode for everyone in the meeting. When Together Mode starts, all subscribers to the `togetherModeStreamsUpdated` event receive notification that enables participants to render together mode.
54+
55+
Microsoft 365 users with role organizer, co-organizer, or presenter can start Together Mode for everyone in the meeting. When Together Mode starts, all subscribers to the `togetherModeStreamsUpdated` event receive notification that enables participants to render Together Mode.
5356

5457
```js
5558
togetherModeFeature.start();
5659
```
5760
### End Together Mode
58-
Together Mode will automatically terminate for all participants if no video stream is detected from any participant for a duration of one minute. There's no API to end Together Mode.
61+
62+
Together Mode automatically terminates for all participants if no video stream is detected from any participant for a duration of one minute. There's no API to end Together Mode.
5963

6064
### Get coordinates of participants in Together Mode
65+
6166
The property `togetherModeSeatingMap` provides coordinates for individual participants in the stream. Developers can use these coordinates to overlay participant info such as display name or visual features like spotlight, hand raised, and reactions on the stream.
6267

6368
```js
@@ -74,6 +79,7 @@ const seatingMap = togetherModeFeature.togetherModeSeatingMap;
7479
```
7580

7681
### Manage scene size
82+
7783
The `sceneSize` property specifies the dimensions (width and height) of the HTML container that houses the `togetherMode` video stream. The seating positions of participants are calculated based on the dimensions of the scene size. If scene size isn't provided, the calculation defaults to a width of 1,280 pixels and a height of 720 pixels.
7884

7985
```js
@@ -88,9 +94,9 @@ console.log(`Current scene has the following size: ${JSON.stringify(togetherMode
8894

8995
### Receive events when scene or seatings updates
9096
> [!NOTE]
91-
> Only Microsoft 365 users with role organizer, co-organizer and presenter can change scene or assignment of participants in Together Mode. These changes can only be made from the Teams Client.
97+
> Only Microsoft 365 users with role organizer, co-organizer, or presenter can change scene or assignment of participants in Together Mode. These changes can only be made from the Teams Client.
9298
93-
If there's a scene change or seating, the `togetherModeSceneUpdated` or `togetherModeSeatingUpdated` events are raised respectively, providing an updated calculation of the participants’ seating positions.
99+
If there's a scene change or seating change, the `togetherModeSceneUpdated` or `togetherModeSeatingUpdated` events are raised respectively, providing an updated calculation of the participant seating positions.
94100

95101
```js
96102
const seatUpdate = (participantSeatingMap) => {
@@ -104,8 +110,8 @@ togetherModeFeature.on('togetherModeSeatingUpdated', seatUpdate);
104110
```
105111

106112
## Troubleshooting
107-
|code| Subcode | Result Category | Reason | Resolution |
113+
| Code | Subcode | Result Category | Reason | Resolution |
108114
|----------------------------------------------|--------|--------|---------|----------|
109-
|403 | 46303 | ExpectedError | The participant’s role doesn’t have the necessary permissions to call the `togetherMode` start API. | Only Microsoft 365 users with role organizer, co-organizer and presenter can start Together Mode. You can check the role of a user via 'role' property on instance of `Call` class. |
110-
|403 | 46304 | ExpectedError | Together Mode started in an unsupported calling scenario. | Ensure Together Mode is started only in group call or meeting scenarios. |
111-
|403 | 46306 | ExpectedError | Together Mode `start` API called by an Azure Communication Services user. | Only Microsoft 365 users with role organizer, co-organizer and presenter can start together mode. |
115+
| 403 | 46303 | ExpectedError | The participant’s role doesn’t have the necessary permissions to call the `togetherMode` start API. | Only Microsoft 365 users with role organizer, co-organizer, or presenter can start Together Mode. You can check the role of a user via `role` property on instance of `Call` class. |
116+
| 403 | 46304 | ExpectedError | Together Mode started in an unsupported calling scenario. | Ensure Together Mode is started only in group call or meeting scenarios. |
117+
| 403 | 46306 | ExpectedError | Together Mode `start` API called by an Azure Communication Services user. | Only Microsoft 365 users with role organizer, co-organizer, or presenter can start Together Mode. |

articles/communication-services/how-tos/calling-sdk/together-mode.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Together Mode
33
titleSuffix: An Azure Communication Services how-to guide
4-
description: Make your Microsoft Teams virtual meetings feel more personal with Teams together mode.
4+
description: Make your Microsoft Teams virtual meetings feel more personal with Teams Together Mode.
55
author: cnwankwo
66
ms.author: cnwankwo
77
ms.service: azure-communication-services
@@ -11,9 +11,9 @@ ms.date: 07/17/2024
1111
ms.custom: template-how-to
1212
---
1313

14-
1514
# Together Mode
16-
In this article, you learn how to implement Microsoft Teams Together Mode with Azure Communication Services Calling SDKs. This feature enhances virtual meetings and calls, making them feel more personal. By creating a unified view that places everyone in a shared background, participants can connect seamlessly and collaborate effectively.
15+
16+
This article describes how to implement Microsoft Teams Together Mode with Azure Communication Services Calling SDKs. Together Mode enhances virtual meetings and calls, making them feel more personal. By creating a unified view that places everyone in a shared background, participants can connect seamlessly and collaborate effectively.
1717

1818
[!INCLUDE [Public Preview Disclaimer](../../includes/public-preview-include-document.md)]
1919

@@ -30,18 +30,19 @@ The following tables define support for Together Mode in Azure Communication Ser
3030
### Identities and call types
3131
The following table shows support for call and identity types.
3232

33-
|Identities | Teams meeting | Room | 1:1 call | Group call | 1:1 Teams interop call | Group Teams interop call |
34-
|--------------------------------------|---------------|------|----------|------------|------------------------|--------------------------|
33+
|Identities | Teams meeting | Room | 1:1 call | Group call | 1:1 Teams interop call | Group Teams interop call |
34+
| --- | --- | --- | --- | --- | --- | --- |
3535
|Communication Services user | ✔️ | | | ✔️ | | ✔️ |
3636
|Microsoft 365 user | ✔️ | | | ✔️ | | ✔️ |
3737

3838
### Operations
39+
3940
The following table shows support for individual APIs in Calling SDK to individual identity types.
4041

41-
|Operations | Communication Services user | Microsoft 365 user |
42-
|-----------------------------|------------------------------|-------------------|
43-
| Start together mode stream | | ✔️ [1] |
44-
| Get together mode stream | ✔️ | ✔️ |
42+
|Operations | Communication Services user | Microsoft 365 user |
43+
| --- | --- | --- |
44+
| Start Together Mode stream | | ✔️ [1] |
45+
| Get Together Mode stream | ✔️ | ✔️ |
4546
| Get scene size | ✔️ | ✔️ |
4647
| Get seating map | ✔️ | ✔️ |
4748
| Change scene | | |
@@ -50,13 +51,13 @@ The following table shows support for individual APIs in Calling SDK to individu
5051
[1] Start Together Mode can only be called by a Microsoft 365 user with the role of organizer, co-organizer, or presenter.
5152

5253
### SDKs
54+
5355
The following table shows support for Together Mode feature in individual Azure Communication Services SDKs.
5456

5557
| Platforms | Web | Web UI | iOS | iOS UI | Android | Android UI | Windows |
56-
|---------------|-----|--------|--------|--------|----------|--------|---------|
57-
|Is Supported | ✔️ | | | | | | |
58+
| --- | --- | --- | --- | --- | --- | --- | --- |
59+
| Is Supported | ✔️ | | | | | | |
5860

59-
## Together Mode
6061

6162
[!INCLUDE [Together Mode Client-side JavaScript](./includes/together-mode/together-mode-web.md)]
6263

0 commit comments

Comments
 (0)