MSC3985: Break-out rooms

proposals/3985-break-out.md

@@ -0,0 +1,88 @@
+# MSC3985: Break-out rooms
+
+VoIP applications such as Zoom or MS Teams support break-out rooms - a mechanism
+for splitting users into multiple calls. This proposal suggests a mechanism for
+break-out rooms in Matrix which would not be limited to VoIP use-cases.
+
+## Proposal
+
+When a user wants to break-out the "parent" room's users into multiple "child"
+rooms, their client should first create those rooms and then send an
+`m.breakout` event:
+
+```json5
+{
+    "type": "m.breakout",
+    "state_key": "",
+    "content": {
+        "m.breakout": {
+            "!roomId1": {
+                "via": ["example.org", "other.example.org"],
+                "users": ["userId1", "userId2"]
+            },
+            "!roomId2": {
+                "via": ["example.org", "other.example.org"]
+            }
+        }
+    }
+}
+```
+
+This event contains a map of the "child" rooms along with their `via`s. The
+event may also include information about the users who are suggested to join a
+given "child" room.
+
+When the event is received by the other clients in the room, they should give
+their users the option to join the given rooms. If the user is suggested to join
+a specific room, the UI should reflect that.
+
+There should only ever be one set of break-out rooms with the `state_key` always
+being `""`.
+
+Break-out rooms can live on long after the break-out happens as regular
+standalone rooms. The `m.breakout` state event can be emptied, so that the
+"parent" no longer links to the "children".
+
+### "Child" rooms' `join_rule`s
+
+The "child" rooms may have `join_rules` of the `m.breakout` event's creator's or
+their client's choosing. A few common examples are:
+
+- The "child" room has a `join_rule` of `restricted` indicating that only the
+  members of the "parent" room can join.
+- The "child" room has `join_rule` if `invite` indicating that only the invited
+  users can join. In this case, the room information in the `m.breakout` event
+  should include the list of users who are suggested to join the given room.
+- The "child" room has a `join_rule` of `public` indicating anyone can join.
+  This would usually happen if the "parent" room was also public.
+
+### VoIP use-case
+
+If a user is participating in a call when the event is sent, they should either
+start a call or join an existing call in the "child" room, if there is one.
+
+### Security
+
+In public rooms, special precautions should be taken. In most cases, regular
+users shouldn't be allowed to send `m.breakout` events. But if they are, the
+client should warn the user, if the event is coming from an unknown user (one
+with whom we don't have a DM) who is not an admin/moderator either.
+
+## Potential issues
+
+None that I can think of.
+
+## Alternatives
+
+An alternative for the VoIP use-case would be having multiple calls in one room
+along with multiple threads for chat. While this works alright for some
+use-cases, it has its limitations.
+
+## Unstable prefix
+
+While this MSC is unstable, `org.matrix.msc3985.breakout` should be used instead
+of `m.breakout`.
+
+## Dependencies
+
+None that I can think of.