{"id":4735,"date":"2021-12-06T18:02:42","date_gmt":"2021-12-06T10:02:42","guid":{"rendered":"https:\/\/www.enablex.io\/developer\/?page_id=4735"},"modified":"2025-02-21T19:21:35","modified_gmt":"2025-02-21T11:21:35","slug":"room-information","status":"publish","type":"page","link":"https:\/\/doc.smartflomeet.ttns.in\/developer\/video-api\/client-api\/flutter-toolkit\/room-information\/","title":{"rendered":"Room Information: Flutter SDK &#8211; Video API"},"content":{"rendered":"\n<p>Video API provides different methods to access Room Information.<\/p>\n\n\n\n<h4>Table of Contents<\/h4>\n\n\n\n<ul><li><a href=\"#get-room-id\">Get Room ID<\/a><\/li><li><a href=\"#get-connected-user-id\">Get connected User Id or Client Id<\/a><\/li><li><a href=\"#get-connected-user-name\">Get connected User Name<\/a><\/li><li><a href=\"#get-connected-user-role\">Get connected User Role<\/a><\/li><li><a href=\"#whoami\">Get connected User Information<\/a><\/li><li><a href=\"#get-connected-user-list\">Get list of connected Users<\/a><\/li><li><a href=\"#get-remote-streams\">Get list of Remote Streams<\/a><\/li><li><a href=\"#know-room-at\">If the Room has Active Talker<\/a><\/li><\/ul>\n\n\n\n<p><\/p>\n\n\n\n<a name=\"get-room-id\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Get  Room ID<\/h3>\n\n\n\n<p>Every Room is assigned with a Unique Room ID while creating the Room. The Room  ID of the room to which you are connected may be known by using <code>getRoomId()<\/code> method.<\/p>\n\n\n\n<p><strong>Method<\/strong>: <code>static Future&lt;String&gt; getRoomId() <\/code>&#8211; No parameter needed<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">String room_id = EnxRtc.getRoomId();<\/pre>\n\n\n\n<a name=\"get-connected-user-id\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Get connected User ID or Client ID<\/h3>\n\n\n\n<p>Each connected user to the Room is assigned with a Unique Client ID for the session. To know the Client ID of the connected user from the enc-point, use <code>getClientId()<\/code> method. <\/p>\n\n\n\n<p><strong>Method<\/strong>: <code>static Future&lt;String&gt; getClientId()<\/code> &#8211; No parameter needed<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">String ClientId = EnxRtc.getClientId(); <\/pre>\n\n\n\n<a name=\"get-connected-user-name\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Get connected User Name<\/h3>\n\n\n\n<p>To know the name of connected user from the end-point, use <code>getClientName()<\/code> method. <\/p>\n\n\n\n<p><strong>Method<\/strong>: <code>static Future&lt;String&gt; getClientName()<\/code> &#8211; No parameter needed<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">String ClientName = EnxRtc.getClientName(); <\/pre>\n\n\n\n<a name=\"get-connected-user-role\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Get connected User Role<\/h3>\n\n\n\n<p>A User connected to a Room with either role of <em>moderator <\/em>or <em>participant<\/em>. Use <code>getRole()<\/code> to know role of the user <\/p>\n\n\n\n<p><strong>Method<\/strong>: <code>static Future&lt;String&gt; getRole()<\/code> &#8211; No parameter needed<\/p>\n\n\n\n<p><strong>Returns<\/strong>: Enumerated Values: moderator, participant<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">String role = EnxRtc.getRole();<\/pre>\n\n\n\n<a name=\"whoami\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Get connected User Information at an End-Point<\/h3>\n\n\n\n<p>To get connected user information at an End-Point, use <code>whoami()<\/code> method. It returns complete user-meta for the connected user in a JSON Object.<\/p>\n\n\n\n<p><strong>Method<\/strong>: <code>static Future&lt;Map&lt;String, dynamic&gt;&gt; whoAmI()<\/code> &#8211; No parameter needed<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">JSONObject myinfo = EnxRtc.whoami(); <\/pre>\n\n\n\n<p><strong>Note<\/strong>: <a href=\"..\/..\/appendix\/#user-meta\">Refer JSON Object structure for User Meta<\/a> &#8211; i.e. for <em>myinfo <\/em>in above example.<\/p>\n\n\n\n<a name=\"get-connected-user-list\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Get connected User List<\/h3>\n\n\n\n<p>To get a list of connected users to the Room to which the end-point is also connected to, use <code>getUserList()<\/code> method. It returns a JSON with list of connected user&#8217;s information.<\/p>\n\n\n\n<p><strong>Method<\/strong>: <code>static Future&lt;List&lt;dynamic&gt;&gt; getUserList()<\/code> &#8211; No parameter needed<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">List users= EnxRtc.getUserList();\n\n\/\/ Return List Users\n\/*\n[\n      {\n          \"clientId\": \"\",             \/\/ Unique Client ID assigned by the Portal\n          \"name\": \"\",                 \/\/ User's name\n          \"user_ref\": \"\",             \/\/ User's Reference\n          \"role\": \"participant\",      \/\/ Enum: moderator, participant\n          \"permissions\": {            \/\/ In-Session Permission of User\n          \"publish\": Boolean,         \/\/ Whether user can pubish local stream\n          \"subscribe\": Boolean,       \/\/ Whether user can subscribe remote streams\n          \"record\": Boolean,          \/\/ Whether user can initiate recording\n          \"stats\": Boolean,           \/\/ Whether user can view stream status\n          \"controlhandlers\": Boolean  \n          }\n      }\n  ] \n*\/<\/pre>\n\n\n\n<a name=\"get-remote-streams\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Get list of Remote Streams<\/h3>\n\n\n\n<p>To get all the Remote Streams available in the Room, use <code>getRemoteStreams() <\/code>method. <\/p>\n\n\n\n<p><strong>Method<\/strong>: <code>public  Map &lt; String, EnxStream &gt; getRemoteStreams() <\/code>&#8211; No parameter needed<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">Map &lt;String, EnxStream&gt; remoteStreams = room.getRemoteStreams();<\/pre>\n\n\n\n<a name=\"know-room-at\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Know if Room has Active Talker<\/h3>\n\n\n\n<p>To check if the Room has Active Talker use <code>isRoomActiveTalker()<\/code> method.<\/p>\n\n\n\n<p>Method:<code> static Future&lt;bool&gt; isRoomActiveTalker()<\/code><\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">await EnxRtc.isRoomActiveTalker();<\/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=\"..\/active-talkers\/\"><\/a><a href=\"..\/active-talkers\/\">Handle Active Talkers<\/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=\"..\/advance-stream-options\/\">Advance Stream Options<\/a> \u2192<a href=\"\/developer\/how-to-use\/\"><\/a><\/p>\n<\/div>\n<\/div>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Video API provides different methods to access Room Information. Table of Contents Get Room ID Get connected User Id or Client Id Get connected User Name Get connected User Role Get connected User Information Get list of connected Users Get list of Remote Streams If the Room has Active Talker Get Room ID Every Room is assigned with a Unique Room ID while creating the Room. The Room ID of&hellip; <\/p>\n","protected":false},"author":1,"featured_media":0,"parent":3755,"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":"Video API provides different methods to access Room Information. Table of Contents Get Room ID Get connected User Id or Client Id Get connected User Name Get connected User Role Get connected User Information Get list of connected Users Get list of Remote Streams If the Room has Active Talker Get Room ID Every Room&hellip;","_links":{"self":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/4735"}],"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=4735"}],"version-history":[{"count":0,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/4735\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/3755"}],"wp:attachment":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/media?parent=4735"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}