You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
### Receive events when Together Mode stream starts or updates
26
+
26
27
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.
|`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. |
50
52
51
53
### 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.
53
56
54
57
```js
55
58
togetherModeFeature.start();
56
59
```
57
60
### 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.
59
63
60
64
### Get coordinates of participants in Together Mode
65
+
61
66
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.
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.
78
84
79
85
```js
@@ -88,9 +94,9 @@ console.log(`Current scene has the following size: ${JSON.stringify(togetherMode
88
94
89
95
### Receive events when scene or seatings updates
90
96
> [!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.
92
98
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.
|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. |
Copy file name to clipboardExpand all lines: articles/communication-services/how-tos/calling-sdk/together-mode.md
+13-12Lines changed: 13 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Together Mode
3
3
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.
5
5
author: cnwankwo
6
6
ms.author: cnwankwo
7
7
ms.service: azure-communication-services
@@ -11,9 +11,9 @@ ms.date: 07/17/2024
11
11
ms.custom: template-how-to
12
12
---
13
13
14
-
15
14
# 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.
0 commit comments