{"id":4016,"date":"2021-11-02T16:54:10","date_gmt":"2021-11-02T08:54:10","guid":{"rendered":"https:\/\/www.enablex.io\/developer\/?page_id=4016"},"modified":"2025-02-24T18:51:27","modified_gmt":"2025-02-24T10:51:27","slug":"break-out-room","status":"publish","type":"page","link":"https:\/\/doc.smartflomeet.ttns.in\/developer\/video-api\/client-api\/web-toolkit\/break-out-room\/","title":{"rendered":"Break-Out Room: Web SDK \u2013 Video API"},"content":{"rendered":"\n<p>Break-Out Rooms allow users to participate in a discussion outside of the main Video Room i.e. the Parent Room.<\/p>\n\n\n\n<h4>Table of Contents<\/h4>\n\n\n\n<ul><li><a href=\"#create-breakout-room\">Create Break-Out Room<\/a><\/li><li><a href=\"#invite-breakout-room\">Invite Users to join a Break-Out Room<\/a><\/li><li><a href=\"#create-breakout-room-invite\">Create Break-Out Room &amp; Auto-Invite Users to join<\/a><\/li><li><a href=\"#join-breakout-room\">Join Break-Out Room<\/a><\/li><li><a href=\"#reject-break-out-room\">Reject Break-Out Room Invitation<\/a><\/li><li><a href=\"#pause-resume-parent-room\">Pause\/Resume Parent Room<\/a><\/li><li><a href=\"#mute-unmute-parent-room\">Mute\/Unmute Parent Room<\/a><\/li><li><a href=\"#disconnect-breakout-room\">Disconnect from Break-Out Room<\/a><\/li><li><a rel=\"noreferrer noopener\" href=\"#clearall-breakout-rooms\" target=\"_blank\">Clear All Break-Out Rooms<\/a><\/li><li><a rel=\"noreferrer noopener\" href=\"#destroyall-breakout-rooms\" target=\"_blank\">Handle All Destroyed Break-Out Rooms<\/a><\/li><\/ul>\n\n\n\n<p>The process of breaking-out takes place in the following manner:<\/p>\n\n\n\n<ul><li>A creator or owner of the Break-Out Room invites one or more users from the Parent Room to the Break-Out Room.<\/li><li>The invited users get notified about the request and need to accept the request to join the Break-Out room.<\/li><li>Users moving out of the Parent Room are treated as \u201cpaused\u201d users in the Parent Room until they return.<\/li><\/ul>\n\n\n\n<p>The implementation of Break-Out Room must be carried out with the following considerations:<\/p>\n\n\n\n<ul><li>Break-Out Room is available in Group Mode room only, not in Lecture Mode.<\/li><li>Break-Out room can be created by a user from the Parent Room only. A user cannot create another Break-Out Room while being within a Break-Out Room.<\/li><li>A Break-Out Room can be created with a limit to the maximum allowed participants in it. In any case, the maximum allowed participants in the Break-Out Room must be less than the maximum Active Talkers in the Parent Room.<\/li><li>Break-Out room currently supports only Audio Call with Screen Share and Canvas Streaming support.<\/li><li>Maximum 10 Break-Out Rooms are allowed for a Parent Room.<\/li><\/ul>\n\n\n\n<a name=\"create-breakout-room\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Create Break-Out Room<\/h3>\n\n\n\n<p>The&nbsp;<code>EnxRoom.createBreakOutRoom()<\/code>&nbsp;method is used to create a Break-Out Room.<\/p>\n\n\n\n<p><strong>Method:&nbsp;<\/strong><code>EnxRoom.createBreakoutRoom(RoomDefinition, Callback);<\/code><\/p>\n\n\n\n<p><strong>Parameters<\/strong>:<\/p>\n\n\n\n<ul><li><code>RoomDefinition<\/code>&nbsp;\u2013 Required. JSON Object with Room definition parameters defined as following keys:<ul><li><code>participants<\/code>&nbsp;\u2013 Numeric. Required. Total number of Participants in the Break-Out Room. Range: Min: 2. Max: max_active_talkers of Parent Room \u2013 1<\/li><li><code>audio<\/code>&nbsp;\u2013 Boolean. Required. Set to true to enable Audio Communication in Break-Out Room.<\/li><li><code>video<\/code>&nbsp;\u2013 Boolean. Required. Set to true to enable Video Communication in Break-Out Room. (This is currently not supported).<\/li><li><code>canvas<\/code>&nbsp;\u2013 Boolean. Required. Set to true to enable Canvas Streaming in Break-Out Room.<\/li><li><code>share<\/code>&nbsp;\u2013 Boolean. Required. Set to true to enable Screen Share in Break-Out Room.<\/li><li><code>max_rooms&nbsp;<\/code>\u2013 Numeric. Required. The total number of Break-Out rooms to be created.<\/li><\/ul><\/li><li><code>Callback<\/code>&nbsp;\u2013 To get result of Create Break-Out Room as JSON Array<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">RoomDefinition = {\n\t\"participants\": 2, \n\t\"audio\": <strong>true<\/strong>,\n\t\"video\": <strong>false<\/strong>, \n\t\"canvas\": <strong>false<\/strong>, \n\t\"share\": <strong>false<\/strong>, \n\t\"max_rooms\": 1\n};\n\nroom.createBreakoutRoom(RoomDefinition, function(data) {\n\t\/\/ data is JSON with created Break-Out Room Information, e.g.\n\t\/*\t\t\n\t{\tmsg: {\u200b\u200b\n\t\t\trooms: [ \n\t\t\t\txxx, xxx\n\t\t\t]\n\t\t},\n\t\tresult: 0\n\t}\n\t*\/\n});<\/pre>\n\n\n\n<p><strong>Error Codes \/ Exception<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th>Code<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>1724<\/td><td>Participant Count not found.<\/td><\/tr><tr><td>1725<\/td><td>Participant Count is more than Parent Room Size.<\/td><\/tr><tr><td>1726<\/td><td>Permissible limit to create Break-Out Room has exceeded<\/td><\/tr><tr><td>1729<\/td><td>Failed to generate Token.<\/td><\/tr><tr><td>1731<\/td><td>Failed to create Break-Out Room.<\/td><\/tr><tr><td>1734<\/td><td>Required parameter missing. Participant count is mandatory<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<a name=\"invite-breakout-room\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Invite Users to join a Break-Out Room<\/h3>\n\n\n\n<p>The&nbsp;<code>EnxRoom.inviteToBreakOutRoom()<\/code>&nbsp;method allows the Creator\/Owner of a Break-Out Room to invite one or more users from the Parent Room to join the Break-Out Room.<\/p>\n\n\n\n<p>This method must be invoked from the Parent Room and NOT from the Break-Out Room.<\/p>\n\n\n\n<p><strong>Class:<\/strong>&nbsp;<code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method:&nbsp;<\/strong><code>EnxRoom.inviteToBreakoutRoom(invitee, Callback)<\/code><\/p>\n\n\n\n<p><strong>Parameters<\/strong>:<\/p>\n\n\n\n<ul><li><code>invitee<\/code>&nbsp;\u2013 JSON Object with invitation details.<ul><li><code>clients<\/code>&nbsp;\u2013 Array of Client IDs of users to be invited.<\/li><li><code>room_id<\/code>&nbsp;\u2013 String. Room ID of the Break-Out Room to which the users are being invited.<\/li><li><code>force_join<\/code>&nbsp;\u2013 Boolean. If set to true, the invited participant will be forced to join the Break-Out Room. Availability: Web SDK 2.0.1+.<\/li><\/ul><\/li><li>Callback \u2013 To get result of invitation process.<\/li><\/ul>\n\n\n\n<p><strong>Event Listeners<\/strong><\/p>\n\n\n\n<ul><li><code>join-breakout-room<\/code>&nbsp;\u2013 Notification sent to the invited users when they are invited to join a Break-Out Room.<\/li><li><code>breakout-room-joining<\/code>&nbsp;\u2013 Notification sent to the invited Participant that he has to join the breakout room.<\/li><li><code>breakout-room-connected<\/code>&nbsp;\u2013 Notification sent to the invited Participant when he gets connected to the Break-Out Room.<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">invitee = {\n\t\"clients\" : \"[clientId1, clientId2]\", \n\t\"room_id\" : \"RoomID\",\n        \"force_join\" : <strong>true<\/strong>\n};\n\nroom.inviteToBreakoutRoom(invitee, <strong>function<\/strong>(resp) {\n\t\/\/ resp is the result of invitation process, e.g.\n\t\/*\t\t\n\t{\t\"msg\": \"Success\",\n\t\t\"result\": 0,\n\t}\n\t*\/\n});\n \n\/\/ Users get invite to join Break-Out Room. When \"force_join: false\" is used or omitted\nroom.addEventListener(\"join-breakout-room\", <strong>function<\/strong> (event) {\n\t\/\/ event carries the invitation details, e.g.\n\t\/*\t\t\n\t{\ttype: 'join-breakout-room', \n\t\tmessage: {\n\t\t\troom_id: \"String\",\n\t\t\trequestor: \"String\"\n\t\t}\n\t}\n\t*\/\n\n\t\/\/ User may join room now. This is optional.  \n\t\/\/ User may be presented with UI to either Join or Reject\n\t\/\/ In case, he needs to join, Read JoinBreakOutRoom() later in the document\n\tJoinee = {\n\t\t\"role\" : \"participant\", \n\t\t\"room_id\" : \"RoomID\"\n\t};\n\n\tStreamInfo = {\n\t\t\"audio\": <strong>true<\/strong>, \n\t\t\"video\" : <strong>false<\/strong>,\n\t\t\"canvas\" : <strong>false<\/strong>,\n\t\t\"screen\" : <strong>false<\/strong>\n\t};\n\t\n\troom.joinBreakOutRoom(Joinee, StreamInfo, <strong>function<\/strong>(resp) {\n\t\t\/\/ Status \n\t});\n});\n\n\/\/ Users get notification to join directly when invited with  \"force_join: true\".\nroom.addEventListener(\"breakout-room-joining\", <strong>function<\/strong> (event) {\n\t\/\/ event carries the invitation details, e.g.\n\t\/*\t\t\n\t{\ttype: 'breakout-room-joining', \n\t\tmessage: {\n\t\t\troom_id: \"String\",\n\t\t\trequestor: \"String\"\n\t\t}\n\t}\n\t*\/\n\n}\n\n\/\/ Users get notification when connected with Break-Out Room with invited with \"force_join: true\".\nroom.addEventListener(\"breakout-room-connected\", <strong>function<\/strong> (event) {\n\t\/\/ event carries the room meta \n\t\/\/ Ref: https:\/\/www.smartflomeet.ttns.in\/developer\/video-api\/client-api\/appendix\/#room-meta\n\n}\n<\/pre>\n\n\n\n<a name=\"create-breakout-room-invite\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Create Break-Out Room &amp; Auto-Invite Users<\/h3>\n\n\n\n<p>The&nbsp;<code>EnxRoom.createAndInviteBreakoutRoom()<\/code>&nbsp;is used to support certain use-cases where auto-assignment of users into different Break-Out Rooms is required. This method creates a Break-Out Room with given specifications and invites users to join a Break-Out Room randomly depending on the Room\u2019s capacity.<\/p>\n\n\n\n<p><strong>Class:<\/strong>&nbsp;<code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method:&nbsp;<\/strong><code>EnxRoom.createAndInviteBreakoutRoom(RoomDefinition, Callback)<\/code><\/p>\n\n\n\n<p><strong>Parameters<\/strong>:<\/p>\n\n\n\n<ul><li><code>RoomDefinition<\/code>&nbsp;\u2013 JSON object with Room definition parameters as explained in&nbsp;<a href=\"#create-breakout-room\" target=\"_blank\" rel=\"noreferrer noopener\">Create Breakout Room<\/a>.<\/li><li><code>Callback<\/code>&nbsp;\u2013 To get result of Create Break-Out Room as JSON Array<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">RoomDefinition = {\n\t\"participants\": 2, \n\t\"audio\": <strong>true<\/strong>,\n\t\"video\": <strong>false<\/strong>, \n\t\"canvas\": <strong>false<\/strong>, \n\t\"share\": <strong>false<\/strong>, \n\t\"max_rooms\": 1\n};\n\nroom.createAndInviteBreakoutRoom(RoomDefinition, function(data) {\n\t\/\/ data is JSON with created Break-Out Room Information, e.g.\n\t\/*\t\t\n\t{\tmsg: {\u200b\u200b\n\t\t\trooms: [ \n\t\t\t\txxx, xxx\n\t\t\t]\n\t\t},\n\t\tresult: 0\n\t}\n\t*\/\n});<\/pre>\n\n\n\n<a name=\"join-breakout-room\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Join a Break-Out Room<\/h3>\n\n\n\n<p>The&nbsp;<code>EnxRoom.joinBreakOutRoom()<\/code>&nbsp;method allows users to join a Break-Out room on being invited by the creator. A user can join a Break-Out Room from the Parent Room only and can join only one Break-Out Room at a time, thus allowing the user to join another Break-Out Room only after rejoining the Parent Room first.<\/p>\n\n\n\n<p><strong>Method:&nbsp;<\/strong><code>EnxRoom.joinBreakOutRoom<\/code>(<code>Joinee, streamInfo, Callback);<\/code><\/p>\n\n\n\n<p><strong>Parameters<\/strong>:<\/p>\n\n\n\n<ul><li><code>Joinee<\/code>&nbsp;\u2013 JSON Object with details required to join the Break-Out Room.<ul><li><code>role<\/code>&nbsp;\u2013 String. Required. Enumerated Values: participant, moderator.<\/li><li><code>room_id<\/code>&nbsp;\u2013 String. Required. Room-ID of the Break-Out Room being joined.<\/li><\/ul><\/li><li><code>streamInfo<\/code>&nbsp;\u2013 JSON Object with Stream information while joining the Break-Out Room.<ul><li><code>audio&nbsp;<\/code>\u2013 Boolean. Set to&nbsp;<em>true<\/em>&nbsp;to join with Audio.<\/li><li><code>video&nbsp;<\/code>\u2013 Boolean. Set to&nbsp;<em>true<\/em>&nbsp;to join with Video. This is currently not supported.<\/li><li><code>screen&nbsp;<\/code>\u2013 Boolean. Set to&nbsp;<em>true<\/em>&nbsp;for screen sharing capability.<\/li><li><code>canvas&nbsp;<\/code>\u2013 Boolen. Set to&nbsp;<em>true<\/em>&nbsp;for canvas streaming capability.<\/li><\/ul><\/li><li><code>Callback&nbsp;<\/code>\u2013 To know result of the join Room call.<\/li><\/ul>\n\n\n\n<p><strong>Event Listeners<\/strong><\/p>\n\n\n\n<ul><li><code>breakout-room-error<\/code>&nbsp;\u2013 Notification to the Joiner on failure to join the Break-Out Room.<\/li><li><code>breakout-room-connected<\/code>&nbsp;\u2013 Acknowledgment to the Joiner when Break-Out Room joined successfully.<\/li><li><code>user-joined-breakout-room<\/code>&nbsp;\u2013 Notification to everyone in the Break-Out Room when a new user joins the Room.<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">Joinee = {\n\t\"role\" : \"participant\", \n\t\"room_id\" : \"RoomID\"\n};\n\nStreamInfo = {\n\t\"audio\": <strong>true<\/strong>, \n\t\"video\" : <strong>false<\/strong>,\n\t\"canvas\" : <strong>false<\/strong>,\n\t\"screen\" : <strong>false<\/strong>\n};\n\nroom.joinBreakOutRoom(Joinee, StreamInfo, <strong>function<\/strong>(resp) {\n\t\/\/ Status \n});\n\n\/\/ User gets connected to Break-Out Room \nroom.addEventListener(\"breakout-room-connected\", <strong>function<\/strong> (roomMeta) {\n\t\/\/ roomMetadata contains meta information of the Room \n});\n\n\/\/ User fails to connect  to Break-Out Room \nroom.addEventListener(\"breakout-room-error\", <strong>function<\/strong> (result) {\n\t\/\/ result contains reasons of failed connection, e.g.\n\t\/*\n\t{\t\"result\": 1729,\n\t\t\"msg\": \"Failed to generate Token\"\n\t}\n\t*\/\n});\n\n\/\/ Others are notified about the new joinee in Break-Out Room \nroom.addEventListener(\"user-joined-breakout-room\", <strong>function<\/strong> (result) {\n\t\/\/ result contains new joinee user's information \n\t\/*\n\t{\t\"clientId\": \"String\",\n\t\t\"room\": \"String\";\n\t}\n\t*\/\n});\n<\/pre>\n\n\n\n<a name=\"reject-break-out-room\"><\/a>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Reject Break-Out Room Invitation<\/h3>\n\n\n\n<p>The <code>EnxRoom.rejectBreakOutRoomInvite()<\/code> allows the invited user to reject the invitation to join a Break-Out Room. <\/p>\n\n\n\n<p><strong>Class:<\/strong> <code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method:<\/strong> <code>EnxRoom.rejectBreakOutRoomInvite(roomId, callback);&nbsp;<\/code><\/p>\n\n\n\n<p><strong>Parameter:<\/strong><\/p>\n\n\n\n<ul><li><code>roomId<\/code> &#8211; The Break-Out Room identifier to which the user is invited.<\/li><li><code>callback<\/code> &#8211; To know the result of the reject Break-out Room invite.<\/li><\/ul>\n\n\n\n<p><strong><strong>Event Listeners<\/strong><\/strong>:<\/p>\n\n\n\n<ul><li><code>breakout-invite-rejected<\/code> &#8211; Notification to the moderator when a user rejects an invitation to a Break-Out Room.<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">\/\/ User rejects break-out room invitation.\nEnxRoom.rejectBreakOutRoomInvitation(roomId, function(resp) {\n\t\/\/ Status \n}); \n\n\/\/ The moderator is notified when a user rejects an invitation to a Break-Out Room\nroom.addEventListener(\"breakout-invite-rejected\", function (result) {\n\t\n});<\/pre>\n\n\n\n<a name=\"pause-resume-parent-room\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Pause\/Resume Parent Room<\/h3>\n\n\n\n<p>The&nbsp;<code>EnxRoom.pause()<\/code>&nbsp;method allows the user to pause the Parent Room after joining the Break-Out Room.<\/p>\n\n\n\n<p>The&nbsp;<code>EnxRoom.resume()<\/code>&nbsp;method is used to resume the Parent Room if it was paused while joining the Break-Out Room.<\/p>\n\n\n\n<p><strong>Method:&nbsp;<\/strong><\/p>\n\n\n\n<ul><li><code>EnxRom.pauseRoom(Callback)<\/code><\/li><li><code>EnxRom.resumeRoom(Callback)<\/code><\/li><\/ul>\n\n\n\n<p><strong>Parameters:<\/strong><\/p>\n\n\n\n<ul><li><code>Callback&nbsp;<\/code>\u2013 To know status of the pause\/resume API call.<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">room.pauseRoom(<strong>function<\/strong>(resp) {\n\t\/\/ resp carries status\n\t\/*\n\t{\t\"msg\": \"Room paused\",\n\t\t\"result\": 0\n\t}\n\t*\/\n}\n\nroom.resumeRoom(<strong>function<\/strong>(resp) {\n\t\/\/ resp carries status\n\t\/*\n\t{\t\"msg\": \"Room resumed\",\n\t\t\"result\": 0\n\t}\n\t*\/\n}\n<\/pre>\n\n\n\n<p><strong>Error Codes \/ Exceptions<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th>Code<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>1138<\/td><td>Internal Server Error.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<a name=\"mute-unmute-parent-room\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Mute\/Unmute Parent Room<\/h3>\n\n\n\n<p>The&nbsp;<code>EnxRoom.muteRoom()<\/code>&nbsp;method allows the user to mute Audio and\/or Video of the Parent Room after joining the Break-Out Room.<\/p>\n\n\n\n<p>The&nbsp;<code>EnxRoom.unmuteRoom()<\/code>&nbsp;is used to unmute Audio and\/or Video of the Parent Room after disconnecting from Break-Out Room and resuming the Parent Room.<\/p>\n\n\n\n<p><strong>Class:<\/strong>&nbsp;<code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Methods:&nbsp;<\/strong><\/p>\n\n\n\n<ul><li><code>EnxRoom.muteRoom(muteInfo, Callback)<\/code><\/li><li><code>EnxRoom.unMuteRoom(unmuteInfo, Callback)<\/code><\/li><\/ul>\n\n\n\n<p><strong>Parameters<\/strong>:<\/p>\n\n\n\n<ul><li><code>mutetInfo<\/code>&nbsp;\u2013 JSON object with options to mute Audio and Video separately.<ul><li><code>audio<\/code>&nbsp;\u2013&nbsp;<code>Boolean<\/code>. Set&nbsp;<em>true<\/em>&nbsp;mute Audio.<\/li><li><code>video<\/code>&nbsp;\u2013&nbsp;<code>Boolean<\/code>. Set&nbsp;<em>true&nbsp;<\/em>to mute Video.<\/li><\/ul><\/li><li><code>unmuteInfo<\/code>&nbsp;\u2013 JSON Object with options to unmute Audio and Video separately.<ul><li><code>audio&nbsp;<\/code>\u2013&nbsp;<code>Boolean<\/code>. Set&nbsp;<em>true<\/em>&nbsp;<code>un<\/code>mute Audio.<\/li><li><code>video&nbsp;<\/code>\u2013&nbsp;<code>Boolean<\/code>. Set&nbsp;<em>true<\/em>&nbsp;to unmute Video.<\/li><\/ul><\/li><li>Callback \u2013 To know status of the API call.<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">MuteInfo = {\n\t\"audio\" : <strong>true<\/strong>, \n\t\"video\" : <strong>true<\/strong>\n};\n\nUnmuteInfo = {\n\t\"audio\" : <strong>true<\/strong>, \n\t\"video\" : <strong>true<\/strong>\n};\n\nroom.muteRoom(MuteInfo, <strong>function<\/strong>(resp) {\n\t\/\/ resp carries status\n\t\/*\n\t{\t\"msg\": \"Room muted\",\n\t\t\"result\": 0\n\t}\n\t*\/\n}\n\nroom.unMuteRoom(<strong>function<\/strong>(resp) {\n\t\/\/ resp carries status\n\t\/*\n\t{\t\"msg\": \"Room unmuted\",\n\t\t\"result\": 0\n\t}\n\t*\/\n}\n<\/pre>\n\n\n\n<a name=\"disconnect-breakout-room\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Disconnect from Break-Out Room<\/h3>\n\n\n\n<p>The&nbsp;<code>EnxRoom.disconnect()<\/code>&nbsp;method allows the user to disconnect from the Break-Out Room.<\/p>\n\n\n\n<p><strong>Class:<\/strong>&nbsp;<code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method:<\/strong>&nbsp;<code>EnxRoom.disconnect()<\/code>&nbsp;\u2013 No Parameter required.<\/p>\n\n\n\n<p><strong>Event Listeners:<\/strong><\/p>\n\n\n\n<ul><li><code>breakout-room-disconnected<\/code>&nbsp;\u2013 Acknowledgment to the user when successfully disconnected from the Break-Out Room.<\/li><li><code>user-disconnected-breakout-room<\/code>&nbsp;\u2013 Notification to everyone in the Break-Out Room when a user gets disconnected from the Room.<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">breakout_room.disconnect();\n\n\/\/ User is notified that he is disconnected from Break-Out Room\nroom.addEventListener(\"breakout-room-disconnected\", <strong>function<\/strong> (event) {\n\t \n});\n\n\/\/ Others are notified about the user disconnected from Break-Out Room\nroom.addEventListener(\"user-disconnected-breakout-room\", <strong>function<\/strong> (event) {\n\t \n});<\/pre>\n\n\n\n<a name=\"clearall-breakout-rooms\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Clear All Break-Out Rooms<\/h3>\n\n\n\n<p>Availability: Web SDK 2.0.1+<\/p>\n\n\n\n<p>The&nbsp;<code>EnxRoom.clearAllBreakOutSession()<\/code>&nbsp;method allows the participant to clear all Break-Out Rooms. The Participant gets disconnected from all breakout instances and resumes with the Parent Room.<\/p>\n\n\n\n<p><strong>Class:&nbsp;<\/strong><code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method:&nbsp;<\/strong><code>EnxRoom.clearAllBreakOutSession()<\/code>&nbsp;\u2013 No Parameter required.<\/p>\n\n\n\n<p><strong>Event Listeners:<\/strong><\/p>\n\n\n\n<ul><li><code>breakout-user-disconnected<\/code>&nbsp;\u2013 Notification to the Moderator\/Owner of the Break-Out Room with information of the disconnected participant.<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">room.addEventListener(\"breakout-user-disconnected\", <strong>function<\/strong> (event) {\n\t\/* event is JSON with information of disconnected participant\t\t\n\t{\ttype: 'breakout-user-disconnected', \n\t\tmessage: {\n\t\t\troom_id: \"String\",\n\t\t\tclient_id: \"String\"\n\t\t}\n\t}\n\t*\/\n});<\/pre>\n\n\n\n<a name=\"destroyall-breakout-rooms\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Handle All Destroyed Break-Out Rooms<\/h3>\n\n\n\n<p>Availability: Web SDK 2.0.1+<\/p>\n\n\n\n<p>The&nbsp;<code>EnxRoom.destroyAllBreakOutSession()<\/code>&nbsp;method allows the moderator to destroy all the Breakout Room sessions. When all the Breakout Room sessions get destroyed, the Parent Room is automatically resumed and unmuted.<\/p>\n\n\n\n<p><strong>Class:<\/strong>&nbsp;<code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method<\/strong>:&nbsp;<code>EnxRoom.destroyAllBreakOutSession()<\/code>&nbsp;\u2013 No Parameter required<\/p>\n\n\n\n<p><strong>Event Listeners:<\/strong><\/p>\n\n\n\n<ul><li><code>breakout-room-destroyed<\/code>&nbsp;\u2013 Notification to the owner when the Breakout Room gets destroyed.<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">room.destroyAllBreakOutSession(); \n\nroom.addEventListener(\"breakout-room-destroyed\", <strong>function<\/strong> (event) {\n\t \n});<\/pre>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<hr class=\"wp-block-separator is-style-wide\"\/>\n\n\n\n<div class=\"wp-block-columns\">\n<div class=\"wp-block-column\">\n<p> \u2190  <a href=\"..\/room-mode-switch\/\">Room Mode Switch<\/a><\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column\">\n<p class=\"has-text-align-center\"> <a href=\"..\/\">Index<\/a> <\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column\">\n<p class=\"has-text-align-right\"><a href=\"..\/floor-access-control\/\">Lecture Mode<\/a> \u2192 <\/p>\n<\/div>\n<\/div>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Break-Out Rooms allow users to participate in a discussion outside of the main Video Room i.e. the Parent Room. Table of Contents Create Break-Out Room Invite Users to join a Break-Out Room Create Break-Out Room &amp; Auto-Invite Users to join Join Break-Out Room Reject Break-Out Room Invitation Pause\/Resume Parent Room Mute\/Unmute Parent Room Disconnect from Break-Out Room Clear All Break-Out Rooms Handle All Destroyed Break-Out Rooms The process of breaking-out&hellip; <\/p>\n","protected":false},"author":1,"featured_media":0,"parent":3724,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"ub_ctt_via":""},"featured_image_src":null,"uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false,"featured":false,"featured-large":false},"uagb_author_info":{"display_name":"vcxdevwpadmin","author_link":"https:\/\/doc.smartflomeet.ttns.in\/developer\/author\/vcxdevwpadmin\/"},"uagb_comment_info":0,"uagb_excerpt":"Break-Out Rooms allow users to participate in a discussion outside of the main Video Room i.e. the Parent Room. Table of Contents Create Break-Out Room Invite Users to join a Break-Out Room Create Break-Out Room &amp; Auto-Invite Users to join Join Break-Out Room Reject Break-Out Room Invitation Pause\/Resume Parent Room Mute\/Unmute Parent Room Disconnect from&hellip;","_links":{"self":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/4016"}],"collection":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/comments?post=4016"}],"version-history":[{"count":0,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/4016\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/3724"}],"wp:attachment":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/media?parent=4016"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}