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
Copy file name to clipboardExpand all lines: articles/communication-services/how-tos/calling-sdk/breakoutrooms.md
+5-5Lines changed: 5 additions & 5 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: Tutorial - Integrate Microsoft Teams breakout rooms
3
3
titleSuffix: An Azure Communication Services tutorial
4
-
description: Use Azure Communication Services SDKs to access BreakoutRooms
4
+
description: Use Azure Communication Services SDKs to access BreakoutRooms.
5
5
author: sravanthivelidandla
6
6
ms.author: insravan
7
7
ms.service: azure-communication-services
@@ -21,14 +21,14 @@ In this article, you learn how to implement Microsoft Teams breakout rooms with
21
21
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
22
22
- A deployed Communication Services resource. [Create a Communication Services resource](../../quickstarts/create-communication-resource.md).
23
23
- A user access token to enable the calling client. For more information, see [Create and manage access tokens](../../quickstarts/identity/access-tokens.md).
24
-
- Teams meeting organizer needs to have assigned Teams meeting policy that enables breakout rooms.[Teams meeting policy](/powershell/module/teams/set-csteamsmeetingpolicy?view=teams-ps&preserve-view=true)
24
+
- Teams meeting organizer needs to assign Teams meeting policy that enables breakout rooms.[Teams meeting policy](/powershell/module/teams/set-csteamsmeetingpolicy?view=teams-ps&preserve-view=true)
25
25
- Optional: Complete the quickstart to [add voice calling to your application](../../quickstarts/voice-video-calling/getting-started-with-calling.md)
26
26
27
-
Only Microsoft 365 Users with Organizer, Co-Organizer or Breakout Room manager roles can manage the breakout rooms.
27
+
Only Microsoft 365 Users with Organizer, Co-Organizer, or Breakout Room manager roles can manage the breakout rooms.
28
28
29
29
## Support
30
30
The following tables define support of breakout rooms in Azure Communication Services.
31
-
### Identities & call types
31
+
### Identities and call types
32
32
The following tables show support of breakout rooms for specific call type and identity.
33
33
34
34
|Identities | Teams meeting | Room | 1:1 call | Group call | 1:1 Teams interop call | Group Teams interop call |
@@ -63,7 +63,7 @@ The following tables show support of breakout rooms feature in individual Azure
Event **breakoutRoomsUpdated** provides instance of one of the following classes as an input parameter. You can use property `type` to distinguish between individual event types.
33
33
34
34
1. Class `BreakoutRoomsEvent`: This event is triggered when a user with a role organizer, co-organizer, or breakout room manager creates or updates the breakout rooms. Microsoft 365 users with role organizer, co-organizer or breakout room manager can receive this type of event. Developers can use the breakout rooms in property `data` to render details about all breakout rooms. This class has property `type` equal to `"breakoutRooms"`.
35
35
```js
36
-
exportinterfaceBreakoutRoomsEvent {
37
-
/**
38
-
* Breakout room event type
39
-
*/
40
-
type: "breakoutRooms",
41
-
/**
42
-
* list of Breakout rooms
43
-
*/
44
-
data: BreakoutRoom[] | undefined;
45
-
}
36
+
exportinterfaceBreakoutRoomsEvent {
37
+
/**
38
+
* Breakout room event type
39
+
*/
40
+
type: "breakoutRooms",
41
+
/**
42
+
* list of Breakout rooms
43
+
*/
44
+
data: BreakoutRoom[] | undefined;
45
+
}
46
46
```
47
47
48
48
2. Class `BreakoutRoomsSettingsEvent`: This event is triggered when a user with a role organizer, co-organizer, or breakout room manager updates the breakout room's settings. Developers can use this information to render the time when breakout room ends or decide whether to render button to join main room. This class has property `type` equal to `"breakoutRoomSettings"`.
49
49
```js
50
-
exportinterfaceBreakoutRoomSettingsEvent {
51
-
/**
52
-
* Breakout room event type
53
-
*/
54
-
type: "breakoutRoomSettings",
55
-
/**
56
-
* Breakout Room setting details
57
-
*/
58
-
data: BreakoutRoomSettings | undefined;
59
-
}
50
+
exportinterfaceBreakoutRoomSettingsEvent {
51
+
/**
52
+
* Breakout room event type
53
+
*/
54
+
type: "breakoutRoomSettings",
55
+
/**
56
+
* Breakout Room setting details
57
+
*/
58
+
data: BreakoutRoomSettings | undefined;
59
+
}
60
60
```
61
61
62
62
3. Class `AssignedBreakoutRoomsEvent`: This event is triggered when user is assigned to a breakout room, or assigned breakout room is updated. Users can join the breakout room when property `state` is set to `open`, leave the breakout room when property `state` is set to `closed` or render details of the breakout room. This class has property `type` equal to `"assignedBreakoutRoom"`.
63
63
```js
64
-
exportinterfaceAssignedBreakoutRoomEvent {
65
-
/**
66
-
* Breakout room event type
67
-
*/
68
-
type: "assignedBreakoutRoom";
69
-
/**
70
-
* Assigned breakout room details
71
-
*/
72
-
data: BreakoutRoom | undefined;
73
-
}
64
+
exportinterfaceAssignedBreakoutRoomEvent {
65
+
/**
66
+
* Breakout room event type
67
+
*/
68
+
type: "assignedBreakoutRoom";
69
+
/**
70
+
* Assigned breakout room details
71
+
*/
72
+
data: BreakoutRoom | undefined;
73
+
}
74
74
```
75
75
76
76
77
77
4. Class `JoinBreakoutRoomsEvent` : This event is triggered when the participant is joining breakout room call. This can happen when user is automatically moved to breakout room (i.e., if `assignedBreakoutRoom` has property `state` set to `open` and `autoMoveParticipantToBreakoutRoom` is set to `true`) or when user explicitly joins breakout room (i.e., calls method `join` on the instance `assignedBreakoutRoom` when `autoMoveParticipantToBreakoutRoom` is set to `false`). Property `data` contains the breakout room `call` instance, that developers can use to control breakout room call. This class has property `type` equal to `"join"`.
78
78
```js
79
-
exportinterfaceJoinBreakoutRoomEvent {
80
-
/**
81
-
* Breakout room event type
82
-
*/
83
-
type: "join";
84
-
/**
85
-
* Breakoutroom call object
86
-
*/
87
-
data: Call | TeamsCall;
88
-
}
79
+
exportinterfaceJoinBreakoutRoomEvent {
80
+
/**
81
+
* Breakout room event type
82
+
*/
83
+
type: "join";
84
+
/**
85
+
* Breakoutroom call object
86
+
*/
87
+
data: Call | TeamsCall;
88
+
}
89
89
```
90
90
The following code shows you valuable information received in the breakout room events:
91
91
```js
92
-
constbreakoutRoomsUpdatedListener= (event) => {
93
-
switch(event.type) {
94
-
case"breakoutRooms":
95
-
constbreakoutRooms=event.data;
96
-
console.log(`Breakout rooms are created or updated. There are ${breakoutRooms.length} breakout rooms in total.`);
97
-
breakoutRooms.forEach((room)=>{
98
-
console.log(`- ${room.displayName}`);
99
-
});
100
-
break;
101
-
case"assignedBreakoutRooms":
102
-
constassignedRoom=event.data;
103
-
console.log(`You are assigned to breakout room named: ${assignedRoom.displayName}`);
0 commit comments