{"id":4421,"date":"2021-11-22T15:45:10","date_gmt":"2021-11-22T07:45:10","guid":{"rendered":"https:\/\/www.enablex.io\/developer\/?page_id=4421"},"modified":"2025-04-10T20:45:17","modified_gmt":"2025-04-10T12:45:17","slug":"room-information","status":"publish","type":"page","link":"https:\/\/doc.smartflomeet.ttns.in\/developer\/video-api\/client-api\/ios-toolkit\/room-information\/","title":{"rendered":"Know Room Information: iOS SDK &#8211; Video API"},"content":{"rendered":"\n<p><\/p>\n\n\n\n<p>The EnxRoom Class provides the following methods to access various <a href=\"\/developer\/video-api\/client-api\/web-toolkit\/enxroom\/\">room-related information.<\/a><\/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-room-meta\">Get Room Meta Data<\/a><\/li><li><a href=\"#get-connected-user-id\">Get connected Client Id<\/a><\/li><li><a href=\"#get-connected-user-name\">Get Name of the connected User<\/a><\/li><li><a href=\"#get-connected-user-role\">Get Role of the connected User<\/a><\/li><li><a href=\"#whoami\">Get Information of the connected User<\/a><\/li><li><a href=\"#get-connected-user-list\">Get list of the connected Users<\/a><\/li><\/ul>\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>The <code>roomID<\/code> property provides the ID of the Room you are connected to. The Room ID is assigned to each Room during <a href=\"\/developer\/video-api\/server-api\/rooms-route\/#create-room\" target=\"_blank\" rel=\"noreferrer noopener\">Room Creation.<\/a><\/p>\n\n\n\n<p><strong>Class<\/strong>: <code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Property<\/strong>: <code>roomId <\/code><\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">NSString* roomID= room.roomId; <\/pre>\n\n\n\n<a name=\"get-room-meta\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Get Room Meta Information<\/h3>\n\n\n\n<p>The <code>roomMetadata<\/code> property provides the Meta Information of the Room to which you are connected. The <a href=\"..\/..\/appendix\/#room-meta\">Room Meta information<\/a> JSON payload contains the complete Room definition along with many run-time parameters with their current values and room-stats of connected users and streams. All the endpoints receive this information through <code>- room:didConnect: <\/code>delegate method after getting connected to the Room. Some of the run-time parameters are updated internally by the SDK on various events.<\/p>\n\n\n\n<p><strong>Class<\/strong>: <code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>property<\/strong>: <code>roomMetadata<\/code><\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">NSDictionary* roomMeta = room.roomMetadata;<\/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 Client ID of the connected User<\/h3>\n\n\n\n<p>The <code>clientId<\/code> property provides the Client ID of the connected endpoint. The Client ID is unique for each user connected to the Room for the session.<\/p>\n\n\n\n<p><strong>Class<\/strong>: <code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method<\/strong>: <code>clientId<\/code>  <\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">NSString* ClientId = room.clientId; <\/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 Name of the connected User<\/h3>\n\n\n\n<p>The <code>clientName<\/code> property provides the name of the user connected through the Client endpoint.<\/p>\n\n\n\n<p><strong>Class<\/strong>: <code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method<\/strong>: <code>clientName<\/code><\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">NSString* ClientName = room.clientName; <\/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 Role of the connected User<\/h3>\n\n\n\n<p>The <code>userRole<\/code> property provides the role of the user connected to the Room for the session, either <em>Moderator<\/em> or <em>Participant<\/em>.<\/p>\n\n\n\n<p><strong>Class<\/strong>: <code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method<\/strong>: <code>userRole<\/code><\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">NSString* role = room.userRole;<\/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 Information of the connected User<\/h3>\n\n\n\n<p>The <code>EnxRoom.whoami()<\/code> method provides the complete <a href=\"\/developer\/video-api\/client-api\/appendix\/#user-meta\" target=\"_blank\" rel=\"noreferrer noopener\">User Meta Information<\/a> of the connected user.<\/p>\n\n\n\n<p><strong>Class<\/strong>: <code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method<\/strong>: <code>- (NSDictionary)Whoami;<\/code><\/p>\n\n\n\n<p><strong>Returns<\/strong>: <a href=\"\/developer\/video-api\/client-api\/appendix\/#user-meta\" target=\"_blank\" rel=\"noreferrer noopener\">User Meta Information JSON object<\/a>.<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">NSDictionary* myinfo = [room Whoami]; <\/pre>\n\n\n\n<p><\/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 list of connected Users<\/h3>\n\n\n\n<p>The <code>userList<\/code> property provides a list of users connected to the Room.<\/p>\n\n\n\n<p><strong>Class<\/strong>: <code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Property<\/strong>: NSArray <code>userList<\/code> <\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">(NSArray)Users = room.getUserList()\n\n\/\/ Return JSON 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<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=\"..\/stream-information\/\">Know Your Stream<\/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=\"..\/chat\/\">Send Message<\/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>The EnxRoom Class provides the following methods to access various room-related information. Table of Contents Get Room ID Get Room Meta Data Get connected Client Id Get Name of the connected User Get Role of the connected User Get Information of the connected User Get list of the connected Users Get Room ID The roomID property provides the ID of the Room you are connected to. The Room ID is&hellip; <\/p>\n","protected":false},"author":1,"featured_media":0,"parent":3732,"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":"The EnxRoom Class provides the following methods to access various room-related information. Table of Contents Get Room ID Get Room Meta Data Get connected Client Id Get Name of the connected User Get Role of the connected User Get Information of the connected User Get list of the connected Users Get Room ID The roomID&hellip;","_links":{"self":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/4421"}],"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=4421"}],"version-history":[{"count":0,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/4421\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/3732"}],"wp:attachment":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/media?parent=4421"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}