{"id":4480,"date":"2021-11-23T20:54:24","date_gmt":"2021-11-23T12:54:24","guid":{"rendered":"https:\/\/www.enablex.io\/developer\/?page_id=4480"},"modified":"2025-04-11T15:33:35","modified_gmt":"2025-04-11T07:33:35","slug":"floor-access-control","status":"publish","type":"page","link":"https:\/\/doc.smartflomeet.ttns.in\/developer\/video-api\/client-api\/ios-toolkit\/floor-access-control\/","title":{"rendered":"Floor Access Control: iOS SDK &#8211; Video API"},"content":{"rendered":"\n<p>In Lecture Mode, only the Moderator can publish a stream in the Room and the participants can only subscribe to the Moderator&#8217;s stream. If a participant(s) wants to publish their Stream during the session, they need to request the Moderator for Floor Access. <\/p>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h4>Table of Contents<\/h4>\n\n\n\n<ul><li><a href=\"#request-floor-access\">Request Floor Access<\/a><\/li><li><a href=\"#cancel-floor-access\">Cancel Requested Floor Access<\/a><\/li><li><a href=\"#deny-floor-access\">Deny Floor Access <\/a><\/li><li><a href=\"#grant-floor-access\">Grant Floor Access<\/a><\/li><li><a href=\"#finish-floor-access\">Finish Floor Access<\/a><\/li><li><a href=\"#release-floor-access\">Release Floor Access<\/a><\/li><li><a href=\"#invite-floor\">Invite Participant to Floor<\/a><\/li><\/ul>\n\n\n\n<p>The Floor Access Controls are implemented using the following APIs:<\/p>\n\n\n\n<a name=\"request-floor-access\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3> Request Floor Access <\/h3>\n\n\n\n<p>The <code>EnxRoom.requestFloor()<\/code> method allows a Participant to request the Moderator for Floor Access.<\/p>\n\n\n\n<p><strong>Class<\/strong>: <code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method:<\/strong> <code>- (void)requestFloor;<\/code> &#8211; No parameter required.<\/p>\n\n\n\n<p><strong>Delegate Method<\/strong>:  <\/p>\n\n\n\n<p><code>- didFloorRequestReceived: <\/code> &#8211; Notification to the Moderator when a Participant&#8217;s access request is received.<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">[room requestFloor];\n -(void)didFloorRequestReceived:(NSArray )Data{     \n \n\/*Data is \n      [   {\n              \"clientId\": \"XXXX\", \/\/ Who requested\n              \"name\": \"iOS\" \n          },\n          \"&lt;null&gt;\"\n      ]\n      *\/\n  }<\/pre>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th>Code<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>5003<\/td><td>Unauthorized Access. When a user with a Moderator role invokes <code>requestFloor()<\/code>.<\/td><\/tr><tr><td>5041<\/td><td>Repeated <code>requestFloor()<\/code> call while the previous request is in process.<\/td><\/tr><tr><td>5042<\/td><td>Repeated <code>requestFloor()<\/code> call after the request has already been registered with the Moderator.<\/td><\/tr><tr><td>5067<\/td><td>Unable to process the request for a Room in group mode. Non-Contextual method call.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>Note:&nbsp;<\/strong>In case of error, &lt;null&gt; is received at the first Index, and Error Info at the second Index.<\/p>\n\n\n\n<a name=\"cancel-floor-access\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Cancel Requested Floor Access<\/h3>\n\n\n\n<p>The <code>Enxroom.cancelFloor()<\/code> method allows participants to cancel their request for Floor Access pending for Moderator&#8217;s approval.<\/p>\n\n\n\n<p><strong>Class<\/strong>:&nbsp;<code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method:<\/strong>&nbsp;<code>- (void)cancelFloor;<\/code>&nbsp;\u2013 No Parameter required.<\/p>\n\n\n\n<p><strong>Delegate Method<\/strong>:&nbsp;<\/p>\n\n\n\n<ul><li><code>- room:didCancelledFloorRequest:&nbsp;<\/code>Notification to the Moderator when the participant cancels the Floor Access Request.<\/li><li>&#8211;<code> room:didFloorCancelled<\/code>: Acknowledgment to the Participant when their Floor Access Request is canceled.<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">[room cancelFloor];\n\n\/\/Moderator receives cancellation request\n -(void)didCancelledFloorRequest:(NSArray )Data;     \n \n\/*Data is \n      [   {\n              \"clientId\": \"XXXX\", \/\/ Who requested\n              \"name\": \"iOS\" \n          },\n          \"&lt;null&gt;\"\n      ]\n      *\/\n  }\n\n\/\/ Participant receives acknowledgement\n -(void)didFloorCancelled:(NSArray )Data;     \n \n\/*Data is \n      [   {\n              \"clientId\": \"XXXX\", \/\/ Who requested\n              \"name\": \"iOS\" \n          },\n          \"&lt;null&gt;\"\n      ]\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>5003<\/td><td>Unauthorized Access. When a user with <code>moderator<\/code> role invokes <code>cancelFloor()<\/code>.<\/td><\/tr><tr><td>5041<\/td><td>Repeated <code>cancelFloor()<\/code> call while a previous request is in process.<\/td><\/tr><tr><td>5042<\/td><td>Repeated <code>cancelFloor()<\/code> call after the request has already been canceled.<\/td><\/tr><tr><td>5067<\/td><td>Unable to process the request for a Room in group mode. Non-Contextual method call.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>Note:&nbsp;<\/strong>In case of error, &lt;null&gt; is received at the first Index and Error Info at the second Index.<\/p>\n\n\n\n<a name=\"deny-floor-access\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Deny Floor Access<\/h3>\n\n\n\n<p>The <code>EnxRoom.denyFloor()<\/code> method allows the Moderator to deny a Participant&#8217;s request for Floor Access.<\/p>\n\n\n\n<p><strong>Class<\/strong>:&nbsp;<code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method:&nbsp;<\/strong><code>- (void)denyFloor:(NSString *)clientId;&nbsp;<\/code><\/p>\n\n\n\n<p><strong>Parameter:<\/strong><\/p>\n\n\n\n<p><code>clientId<\/code> &#8211; Client ID of the Participant requesting Floor Access.<\/p>\n\n\n\n<p><strong>Delegate Method<\/strong>:&nbsp;<\/p>\n\n\n\n<ul><li><code>- didDeniedFloorRequest:<\/code>&nbsp;\u2013 Notification to the Participant when the Floor Access has been denied.<\/li><li><code>- didProcessFloorRequested:&nbsp;<\/code>\u2013 Acknowledgment to the Moderator when the Floor Access has been denied.<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">[room denyFloor:@\u201dclientId\u201d];   \/\/ Moderator denies floor access\n \/\/ Participant is notified about denied floor access\n -(void)didDeniedFloorRequest:(NSArray  )Data{     \n     \n     \/* Data is \n     [   {\n             \"result\":4117,\n             \"msg\":\"Floor Request Denied\",\n             \"clientId\":\"XXX\" \n         },\n         \"&lt;null&gt;\"\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>5005<\/td><td>Unauthorized Access. When a user with <code>participant<\/code> role invokes <code>denyFloor()<\/code>.<\/td><\/tr><tr><td>5045<\/td><td>When an invalid Client ID is passed to <code>denyFloor().<\/code><\/td><\/tr><tr><td>5047<\/td><td>Repeated <code>denyFloor()<\/code> call while the previous request is in process.<\/td><\/tr><tr><td>5048<\/td><td><code>denyFloor()<\/code> called after granting Floor Access. Non-Contextual Method Call.<\/td><\/tr><tr><td>5067<\/td><td>Unable to process the request for a Room in group mode. Non-Contextual method call.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>Note:&nbsp;<\/strong>In case of error, &lt;null&gt; is received at the first Index and Error Info at the second Index.<br><\/p>\n\n\n\n<a name=\"grant-floor-access\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3> Grant Floor Access <\/h3>\n\n\n\n<p>The <code>EnxRoom.grantFloor()<\/code> method allows the Moderator to grant Floor Access to one or more Participants one by one. Note that at any given point in time, only one Participant can be granted floor access. To grant Floor Access to others, the Moderator must release Floor Access from the existing participant.<\/p>\n\n\n\n<p><strong>Class<\/strong>: <code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method: <\/strong><code>- (void)grantFloor:(NSString *)clientId;<\/code> <\/p>\n\n\n\n<p><strong>Delegate Method<\/strong>:  <\/p>\n\n\n\n<ul><li><code>- didGrantedFloorRequest:<\/code> &#8211; Notification to the Participant when Floor Access is received.<\/li><li><code>- didProcessFloorRequested:&nbsp;<\/code>\u2013 Acknowledgment to the Moderator when Participant is granted Floor Access.<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">[room grantFloor:@\u201dclientId\u201d];   \/\/ Moderator grants floor access\n \/\/ Participant receives floor access\n -(void) didGrantedFloorRequest:(NSArray *)Data{\n    \n     \/* Data is \n     [   {\n             \"result\":1708,\n             \"msg\":\"Floor Granted\",\n             \"clientId\":\"XXX\" \n         },\n         \"&lt;null&gt;\"\n     ] *\/\n }<\/pre>\n\n\n\n<p><strong>Error Codes &amp; 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>5004<\/td><td>Unauthorized Access. When a user with <code>participant<\/code> role invokes <code>grantFloor()<\/code>.<\/td><\/tr><tr><td>5045<\/td><td>When Invalid Client ID is passed to <code>grantFloor()<\/code>.<\/td><\/tr><tr><td>5043<\/td><td>Repeated <code>grantFloor()<\/code> call while the previous request is in process.<\/td><\/tr><tr><td>5044<\/td><td>Repeated <code>grantFloor()<\/code> call after successfully granting Floor Access.<\/td><\/tr><tr><td>5046<\/td><td><code>grantFloor()<\/code> to another Participant without releasing the Floor Access from the existing Participant.<\/td><\/tr><tr><td>5069<\/td><td>Unable to grant Floor Access when Floor Release is in process.<\/td><\/tr><tr><td>5067<\/td><td>Unable to process the request for a Room in group mode. Non-Contextual method call.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>Note:&nbsp;<\/strong>In case of error, &lt;null&gt; is received at the first Index and Error Info at the second Index.<\/p>\n\n\n\n<a name=\"finish-floor-access\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Finish Floor Access <\/h3>\n\n\n\n<p>The <code>EnxRoom.finishFloor() <\/code>allows the Participant to announce the completion of Floor Access and release Floor Access.<\/p>\n\n\n\n<p><strong>Class<\/strong>: <code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method: <\/strong> <code>- (void)finishFloor; <\/code>\u2013 No Parameter required. <\/p>\n\n\n\n<p><strong>Delegate Method<\/strong>:&nbsp;<\/p>\n\n\n\n<ul><li><code>- room:didFinishedFloorRequest:&nbsp;<\/code>Notification to the Moderator when the Participant finishes Floor Access.<\/li><li><code>\u2013&nbsp;room:didFloorFinished: <\/code>Acknowledgment to the Participant when Floor Access is finished.<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">[room finishFloor];\n\n\/\/Moderator receives finished floor access\n(void)didFinishedFloorRequest:(NSArray )Data;     \n \n\/*Data is \n      [   {\n              \"clientId\": \"XXXX\", \/\/ Who requested\n              \"name\": \"iOS\" \n          },\n          \"&lt;null&gt;\"\n      ]\n      *\/\n  }\n\n\/\/ Participant receives acknowledgement\n -(void)didFloorFinished:(NSArray )Data;     \n \n\/*Data is \n      [   {\n              \"clientId\": \"XXXX\", \/\/ Who requested\n              \"name\": \"iOS\" \n          },\n          \"&lt;null&gt;\"\n      ]\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>5003<\/td><td>Unauthorized Access. When a user with <code>moderator<\/code> role invokes <code>finishFloor()<\/code>.<\/td><\/tr><tr><td>5041<\/td><td>Repeated <code>finishFloor()<\/code> call while the previous request is in process.<\/td><\/tr><tr><td>5042<\/td><td>When participant retries <code>finishFloor()<\/code> after finishing the Floor Access.<\/td><\/tr><tr><td>5067<\/td><td>Unable to process the request for a Room in group mode. Non-Contextual method call.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>Note:&nbsp;<\/strong>In case of error, &lt;null&gt; is received at the first Index and Error Info at the second Index.<\/p>\n\n\n\n<a name=\"release-floor-access\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3> Release Floor Access <\/h3>\n\n\n\n<p>The <code>Enxroom.releaseFloor()<\/code> method allows the Moderator to terminate the Floor Access granted to a Participant. This unpublishes the participant&#8217;s streams and makes the Floor available for access again.<\/p>\n\n\n\n<p><strong>Class<\/strong>: <code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method: <\/strong> <code>-(void)releaseFloor:(NSString *)clientId; <\/code><\/p>\n\n\n\n<p><strong>Parameter:<\/strong><\/p>\n\n\n\n<p><code>clientId<\/code> &#8211; Client ID of the Participant whose Floor Access is being released.<\/p>\n\n\n\n<p><strong>Delegate Method<\/strong>:  <\/p>\n\n\n\n<ul><li><code>- didReleasedFloorRequest: <\/code> &#8211; Notification to the Participant when their Floor Access is revoked.<\/li><li> <code>- didProcessFloorRequested:&nbsp;<\/code>\u2013 Acknowledgment to the Moderator when the Floor Access is released.<\/li><\/ul>\n\n\n\n<pre class=\"wp-block-preformatted\">[room releaseFloor:@\u201dclientId\u201d];   \/\/ Moderator revokes floor access \n\n \/\/ Participant is notified moderator has revoked floor access \n -(void)didReleasedFloorRequest:(NSArray )Data{     \n\n    \/* Data is \n     [   {\n             \"result\":1712,\n             \"msg\":\"Floor Released\",\n             \"clientId\":\"XXXX\"    \n         },\n         \"&lt;null&gt;\"\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>5006<\/td><td>Unauthorized Access. When a user with <code>participant <\/code>role invokes <code>releaseFloor()<\/code><\/td><\/tr><tr><td>5045<\/td><td>Invalid Client ID passed to <code>releaseFloor()<\/code>.<\/td><\/tr><tr><td>5049<\/td><td>Repeated <code>releaseFloor()<\/code> call while the previous request is in process.<\/td><\/tr><tr><td>5050<\/td><td><code>releaseFloor()<\/code> called without granting Floor Access. Non-Contextual Method Call.<\/td><\/tr><tr><td>5067<\/td><td>Unable to process the request for a Room in group mode. Non-Contextual method call.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><strong>Note:&nbsp;<\/strong>In case of error, &lt;null&gt; is received at the first Index and Error Info at the second Index.<\/p>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Restore Moderator Session <\/h3>\n\n\n\n<p>If the Moderator gets disconnected during a session, the list of Floor Access Requests and participants currently with Floor Access can be retrieved via the <a rel=\"noreferrer noopener\" href=\"\/developer\/video-api\/client-api\/appendix\/#room-meta\" target=\"_blank\">Room-Meta-Data<\/a> when the Moderator gets reconnected.<\/p>\n\n\n\n<p><strong>Structured Data JSON<\/strong><\/p>\n\n\n\n<ul><li><code>room.roomMetaData[@\"raisedHands\"]<\/code><em>\u2013 <em>An Array of Client IDs requesting floor access<\/em><\/em>.<\/li><li><code>room.roomMetaData[@\"approvedHands\"<\/code>] \u2013 <em><em>An Array of Client IDs currently having floor access<\/em>.<\/em><\/li><\/ul>\n\n\n\n<a name=\"invite-floor\"><\/a>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2>Invite to Floor<\/h2>\n\n\n\n<p>In lecture mode, where only the Moderator can speak and control speakers in the Room through Floor Access Control methods, the Invite to Floor methods provide more options to the Moderator to organize a conference in lecture mode.<\/p>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Invite Participant to Floor<\/h3>\n\n\n\n<p>The <code>EnxRoom.inviteToFloor()<\/code> method allows the Moderator to invite any Participant in the ongoing conference to the Floor and talk. <\/p>\n\n\n\n<p><strong>Class:<\/strong> <code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method:<\/strong> <code>-(<strong>void<\/strong>)inviteToFloor:(NSString* <strong>_Nonnull<\/strong>)clientId&nbsp;<\/code><\/p>\n\n\n\n<p><strong>Parameter:<\/strong><\/p>\n\n\n\n<p><code>clientId<\/code> &#8211; String. The client ID of the invited Participant.<\/p>\n\n\n\n<p><strong>Delegate Methods:<\/strong><\/p>\n\n\n\n<ul><li><code>didACKInviteToFloorRequested<\/code> &#8211; Acknowledgment to the Moderator when an invitation to Floor is sent to the Participant.<\/li><\/ul>\n\n\n\n<p><strong>Response Body:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">{\n   msg = Success;&nbsp;\n&nbsp;  result = 0;\n}&nbsp;<\/pre>\n\n\n\n<ul><li><code>didInviteToFloorRequested<\/code> &#8211; Notification to all the Moderators in the Room when an invitation to Floor is sent to the Participant.<\/li><\/ul>\n\n\n\n<p><strong>Response Body:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">{\n    clientId = \"cae0afbc-fb94-4743-8c04-ae48e9d3eb52\";&nbsp;\n    id = inviteToFloor;&nbsp;\n    name = Jay;\n}&nbsp;<\/pre>\n\n\n\n<ul><li><code>didInvitedForFloorAccess<\/code> &#8211; Notification to the invited Participant when an invitation to Floor is received.<\/li><\/ul>\n\n\n\n<p><strong>Response Body:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">{ &nbsp;\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; clientId = \"9554a040-58bd-4f0b-a010-7f92c54b2918\";&nbsp;\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; id = inviteToFloor;&nbsp;\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; moderator = \"e2b48879-3754-49f2-bf86-08a73347e408\";&nbsp;\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; name = Jay;&nbsp;\n&nbsp;}&nbsp;<\/pre>\n\n\n\n<pre class=\"wp-block-preformatted\">\/\/ invitation sent to participant to come on floor and talk\n[EnxRoom inviteToFloor:\"ClientID\"]; \n\n\/\/Acknowledgment to the moderator who invited\n-(void)didACKInviteToFloorRequested:(NSArray *_Nullable)Data; \n\n\/\/Notification to all the moderators in the room\n-(void)didInviteToFloorRequested:(NSArray *_Nullable)Data; \n\n\/\/Notification to the invited participant\n-(void)didInvitedForFloorAccess:(NSArray *_Nullable)Data;  <\/pre>\n\n\n\n<p><strong>Error Codes &amp; Exceptions:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-table is-style-regular\"><table><thead><tr><th>Code<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>5086&nbsp;<\/td><td>Endpoint application is not connected to a Room.&nbsp;<\/td><\/tr><tr><td>5097<\/td><td><code>inviteToFloor<\/code>() is not applicable in a Chat-Only Room. Non-Contextual method call.<\/td><\/tr><tr><td>5006<\/td><td>A User with a participant role is not authorized to invoke <code>inviteToFloor<\/code>().<\/td><\/tr><tr><td>5045<\/td><td>Unable to invite a user with an invalid client ID.&nbsp;<\/td><\/tr><tr><td>5067<\/td><td>Unable to process the request for a Room in group mode. Non-Contextual method call.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<a name=\"cancel-floor-invite\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Cancel Invitation to Floor<\/h3>\n\n\n\n<p>The <code>EnxRoom.cancelFloorInvite()<\/code> method allows the Moderator to cancel a Floor Invitation sent to a Participant. <\/p>\n\n\n\n<p><strong>Class:<\/strong> <code>EnxRoom<\/code><\/p>\n\n\n\n<p><strong>Method:<\/strong> <code>-(<strong>void<\/strong>)cancelFloorInvite:(NSString* <strong>_Nonnull<\/strong>)clientId;&nbsp;<\/code><\/p>\n\n\n\n<p><strong>Parameter:<\/strong> <\/p>\n\n\n\n<p><code>clientId<\/code> &#8211; Client Id of the Participant whose invitation needs to be canceled.<\/p>\n\n\n\n<p><strong>Callback:<\/strong><\/p>\n\n\n\n<ul><li><code>didProcessFloorRequested<\/code> &#8211; Acknowledgment to the Moderator when Cancel Invitation request is sent to the Participant.<\/li><\/ul>\n\n\n\n<p><strong>Response Body:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">{ \n     msg = Success; \n     request =  { \n\n        id = processFloorRequest; \n \tparams =  { \n\n            action = cancelFloorInvite;\n            clientId = \"cae0afbc-fb94-4743-8c04-ae48e9d3eb52\"; \n       \t\t}; \n\t}; \n    \tresult = 0; \n} <\/pre>\n\n\n\n<ul><li><code>didCanceledFloorInvite<\/code> &#8211; Notification to the invited Participant and other Moderators in the Room when invitation is canceled by the Moderator. <\/li><\/ul>\n\n\n\n<p><strong>Response Body for the Participant:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">{ \n        clientId = \"a067fd70-1461-4ca4-befc-2b570c0db494\"; \n        id = cancelFloorInvite; \n        moderator = \"e2b48879-3754-49f2-bf86-08a73347e408\"; \n        name = JayiOS; \n} <\/pre>\n\n\n\n<p><strong>Response Body for other Moderators:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">{ \n        clientId = \"ade30ef1-595d-4364-b4f5-1d9420f24b0f\"; \n        id = cancelFloorInvite; \n        name = JayiOS; \n} <\/pre>\n\n\n\n<pre class=\"wp-block-preformatted\">\/\/ Cancel Floor invitation request sent by the Moderator\n [EnxRoom cancelFloorInvite:\"ClientID\"]; \n\n\/\/ Acknowledgment to the Moderator that Cancel Floor Invitation is initiated\n- (void)didProcessFloorRequested:(NSArray *_Nullable)Data; \n\n\/\/ Notification to the invited participant and other Moderators in the Room that invitation is canceled\n-(void)didCanceledFloorInvite:(NSArray *_Nullable)Data <\/pre>\n\n\n\n<p><strong>Error Codes &amp; Exceptions:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-table is-style-regular\"><table><thead><tr><th>Code<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>5086&nbsp;<\/td><td>Endpoint application is not connected to a Room.&nbsp;<\/td><\/tr><tr><td>5097<\/td><td><code>cancelFloorInvite<\/code>() not applicable in a Chat-Only Room. Non-Contextual method call.<\/td><\/tr><tr><td>5006<\/td><td>A User with a participant role is not authorized to invoke <code>cancelFloorInvite<\/code>(). <\/td><\/tr><tr><td>5045<\/td><td>Unable to cancel invitation for an invalid client ID.&nbsp;<\/td><\/tr><tr><td>5067<\/td><td>Unable to process the request for a Room in group mode. Non-Contextual method call.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<a name=\"accept-invite-floor-request\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Accept Invitation to Floor<\/h3>\n\n\n\n<p>The <code>EnxRoom.acceptInviteFloorRequest()<\/code> method allows the Participant to accept the invitation to the Floor and talk. <\/p>\n\n\n\n<p><strong>Class:<\/strong> EnxRoom<\/p>\n\n\n\n<p><strong>Method:<\/strong> <code>-(<strong>void<\/strong>)acceptInviteFloorRequest:(NSString* <strong>_Nonnull<\/strong>)clientId&nbsp;<\/code><\/p>\n\n\n\n<p><strong>Parameter:<\/strong><\/p>\n\n\n\n<p><code>clientId<\/code> &#8211; Client Id of the Participant who has received the invitation to the Floor.<\/p>\n\n\n\n<p><strong>Delegate Methods:<\/strong><\/p>\n\n\n\n<ul><li><code>didProcessFloorRequested<\/code> &#8211; Acknowledgment to the Participant when they accept the invitation to the Floor.<\/li><\/ul>\n\n\n\n<p><strong>Response Body:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">{ \n    msg = Success; \n    request =     { \n        id = processFloorRequest; \n        params =  { \n            action = acceptFloor; \n            clientId = \"18c9b8bb-142e-44a7-b30b-6701cd9e62d9\"; \n        }; \n    }; \n    result = 0;\n} <\/pre>\n\n\n\n<ul><li><code>didAcceptedFloorInvite<\/code> &#8211; Notification to all the Moderators in the Room including the one who sent the invitation when the Participant accepts invitation.<\/li><\/ul>\n\n\n\n<p><strong>Response Body:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">{ \n        clientId = \"8ed7241c-36d9-4224-b8f3-7d015718d09e\"; \n        id = floorAccepted; \n        msg = \"Floor accepted\"; \n        result = 1738; \n}<\/pre>\n\n\n\n<pre class=\"wp-block-preformatted\">\/\/Participant accepts the invitation to Floor\n[EnxRoom.acceptInviteFloorRequest:\"ClientID\"]; \n\n\/\/ Acknowledgment to the Participant when they accept the invitation to the Floor\n- (void)didProcessFloorRequested:(NSArray *_Nullable)Data; \n\n\/\/ Notification to all the Moderators in the Room including the one who sent the invitation\n-(void)didAcceptedFloorInvite:(NSArray *_Nullable)Data; <\/pre>\n\n\n\n<p><strong>Error Codes &amp; Exceptions:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-table is-style-regular\"><table><thead><tr><th>Code<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>5086&nbsp;<\/td><td>Endpoint application is not connected to a Room.&nbsp;<\/td><\/tr><tr><td>5097<\/td><td><code><code>acceptInviteFloorRequest<\/code><\/code>() not applicable in a Chat-Only Room. Non-Contextual method call.<\/td><\/tr><tr><td>5006<\/td><td>A User with a Moderator role is not authorized to invoke <code><code>acceptInviteFloorRequest<\/code><\/code>(). <\/td><\/tr><tr><td>5045<\/td><td>Unable to accept the invitation for an invalid client ID.&nbsp;<\/td><\/tr><tr><td>5067<\/td><td>Unable to process the request for a Room in group mode. Non-Contextual method call.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<a name=\"reject-invite-floor\"><\/a>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3>Reject Invitation to Floor<\/h3>\n\n\n\n<p id=\"block-76bf2659-b082-4c09-8a85-3cf7da1384a3\">The <code>EnxRoom.rejectInviteFloor()<\/code> method allows the invited Participant to reject the invitation to the Floor.<\/p>\n\n\n\n<p id=\"block-1bfa9b0f-b806-4507-b2d2-80add1043101\"><strong>Class:<\/strong> <code>EnxRoom<\/code><\/p>\n\n\n\n<p id=\"block-800ad48f-08f2-467c-b2e1-d2759a1a1215\"><strong>Method:<\/strong> <code>-(<strong>void<\/strong>)rejectInviteFloor:(NSString* <strong>_Nonnull<\/strong>)clientId;&nbsp;<\/code><\/p>\n\n\n\n<p id=\"block-288ceff7-d108-434a-9dd1-00d4554a7e5a\"><strong>Parameter:<\/strong><\/p>\n\n\n\n<p id=\"block-0f327582-561d-4ef3-86da-60be5984393b\"><code>clientId<\/code> &#8211; Client Id of the Participant who has received the invitation to the Floor.<\/p>\n\n\n\n<p id=\"block-4e4d2f65-d92e-4939-b481-86ae22e0c78e\"><strong>Delegate Methods:<\/strong><\/p>\n\n\n\n<ul id=\"block-01e6a63a-dcd5-4363-85b9-c2a095f03684\"><li><code>didProcessFloorRequested<\/code> &#8211; Acknowledgment to the Participant when they reject the invitation to Floor.<\/li><\/ul>\n\n\n\n<p id=\"block-02d7b5f8-7de5-4451-84cf-97d0b1854397\"><strong>Response Body:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">{ \n    msg = Success; \n    request =     { \n        id = processFloorRequest; \n        params =  { \n            action = rejectFloor; \n            clientId = \"87184b36-26b3-4450-b908-6d9de6a457c5\"; \n        }; \n    }; \n    result = 0; \n} <\/pre>\n\n\n\n<ul><li><code>didRejectedInviteFloor<\/code> &#8211; Notification to all the Moderators including the one who sent the invitation when the Participant rejects the invitation.<\/li><\/ul>\n\n\n\n<p><strong>Response Body:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">{ \n        clientId = \"57ab3a52-2d85-4a22-a4b4-d58b90ea84ec\"; \n        id = floorRejected; \n        msg = \"Floor Denied\"; \n        result = 1709; \n} <\/pre>\n\n\n\n<pre class=\"wp-block-preformatted\">\/\/ Participant rejects invitation to Floor\n[EnxRoom rejectInviteFloor:\"ClientID\"];\n\n\/\/ Acknowledgment to the Participant wen they reject invitation to the Floor\n-(void)didProcessFloorRequested:(NSArray *_Nullable)Data;  \n\n\/\/ Notification to the Moderators when Participant rejects invitation to the Floor\n-(void)didRejectedInviteFloor:(NSArray *_Nullable)Data; <\/pre>\n\n\n\n<p><strong>Error Codes &amp; Exceptions:<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-table is-style-regular\"><table><thead><tr><th>Code<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>5086&nbsp;<\/td><td>Endpoint application is not connected to a Room.&nbsp;<\/td><\/tr><tr><td>5097<\/td><td><code><code><code>rejectInviteFloor<\/code><\/code><\/code>() not applicable in a Chat-Only Room. Non-Contextual method call.<\/td><\/tr><tr><td>5006<\/td><td>A User with a Moderator role is not authorized to invoke <code><code><code>rejectInviteFloor<\/code><\/code><\/code>(). <\/td><\/tr><tr><td>5045<\/td><td>Unable to reject the invitation for an invalid client ID.&nbsp;<\/td><\/tr><tr><td>5067<\/td><td>Unable to process the request for a Room in group mode. Non-Contextual method call.<\/td><\/tr><\/tbody><\/table><\/figure>\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=\"..\/break-out-room\/\">Break-Out Room<\/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=\"..\/live-media-statistics\/\">Get Live Media Statistics<\/a> \u2192<\/p>\n<\/div>\n<\/div>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"<p>In Lecture Mode, only the Moderator can publish a stream in the Room and the participants can only subscribe to the Moderator&#8217;s stream. If a participant(s) wants to publish their Stream during the session, they need to request the Moderator for Floor Access. Table of Contents Request Floor Access Cancel Requested Floor Access Deny Floor Access Grant Floor Access Finish Floor Access Release Floor Access Invite Participant to Floor The&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":"In Lecture Mode, only the Moderator can publish a stream in the Room and the participants can only subscribe to the Moderator&#8217;s stream. If a participant(s) wants to publish their Stream during the session, they need to request the Moderator for Floor Access. Table of Contents Request Floor Access Cancel Requested Floor Access Deny Floor&hellip;","_links":{"self":[{"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/4480"}],"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=4480"}],"version-history":[{"count":0,"href":"https:\/\/doc.smartflomeet.ttns.in\/developer\/wp-json\/wp\/v2\/pages\/4480\/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=4480"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}