Floor Access Control

In Lecture Mode, only the moderator can publish a stream in a room, and the participants can only subscribe to the moderator's stream. If a participant wants to publish a stream during the session, the participant must request the moderator for floor access to do this.

The Android SDK provides the following methods for managing floor access:

• requestFloor(): To request the moderator for floor access.
• cancelFloor(): To cancel the request for floor access.
• denyFloor(): To deny a participant's request for floor access.
• grantFloor(): To grant floor access to one or more participants in sequence.
• finishFloor(): To announce the completion of floor access and its availability for subsequent requests.
• releaseFloor(): To terminate floor access granted to a participant.
• inviteToFloor(): To invite a participant of an ongoing conference to the floor.
• cancelFloorInvite(): To cancel a floor invitation.
• acceptInviteFloorRequest(): To accept invitation to a floor and talk.
• rejectInviteFloor(): To reject invitation to a floor.

Request Floor Access

The EnxRoom.requestFloor() method allows a participant to request the moderator for floor access.

Class: EnxRoom

Method: public void requestFloor()

Observer: public void setChairControlObserver( EnxChairControlObserver-Object )

Callbacks

Sample Code

// Initiate Chair Control Observer to receive Callbacks
room.setChairControlObserver(this);
 
room.requestFloor(); // To request floor access

public void onFloorRequested(JSONObject jsonobject){
 // Your Request is received by Moderator
}

public void onFloorRequestReceived(JSONObject jsonobject){
 // Moderator receives floor access request
 // JSON has requesting participant information
}

Error Codes and Exceptions

Cancel a Requested Floor Access

The Enxroom.cancelFloor() method allows participants to cancel their request for pending floor access for moderator's approval.

Class: Enxroom

Method: public void cancelFloor()

Callbacks

Sample Code

room.cancelFloor();

// Moderator receives cancellation request 
public void onCancelledFloorRequest(JSONObject jsonObject) {
	// Handle JSONObject
}

// Participant is acknowedged that floor request is cancelled
public void onFloorCancelled(JSONObject jsonObject) {
	// Handle JSONObject
}

Error Codes and Exceptions

Deny Floor Access

The EnxRoom.denyFloor() method allows moderators to deny a Participant's request for floor access.

Class: EnxRoom

Method: public void denyFloor(String clientID)

Parameter: clientID: String. Client ID of the participant requesting for floor access.

Observer: public void setChairControlObserver( EnxChairControlObserver-Object )

Callbacks

Sample Code

// Initiate Chair Control Observer to receive Callbacks
room.setChairControlObserver(this); 

room.denyFloor(clientId); // To deny floor access to a clientId

public void onProcessFloorRequested(JSONObject jsonobject){
 // You denied floor access to a Participant
}

public void onDeniedFloorRequest(JSONObject jsonobject){
 // Participant is notified that he is denied Floor Access
}

Error Codes and Exceptions

Grant Floor Access

The EnxRoom.grantFloor() method allows the moderator to grant floor access to one or more participants individually. Note that at any given time, only one participant can be granted floor access. To grant floor access to other participants, the moderator must release floor access from the existing participant.

Class: EnxRoom

Method: public void grantFloor(String clientID)

Observer: public void setChairControlObserver( EnxChairControlObserver-Object )

Callbacks

Sample Code

// Initiate Chair Control Observer to receive Callbacks
room.setChairControlObserver(this); 

room.grantFloor(clientId); // To grant floor access to a clientId

public void onProcessFloorRequested(JSONObject jsonobject){
 // You granted floor access to a Participant
}

public void onGrantedFloor(JSONObject jsonobject){
 // Participant is notified that he is granted Floor Access
 room.publish(localStream); // Publish now
}

Error Codes and Exceptions

Complete a Granted Floor Access

The EnxRoom.finishFloor() allows participants to announce the completion and release of floor access.

Class: EnxRoom

Method: public void finishFloor()

Callbacks

Sample Code

room.finishFloor();

// Moderator received Floor Finish notification 
public void onFinishedFloorRequest(JSONObject jsonObject) {
	// Handle JSONObject
}

// Participants is acknowledged that floor access is finished
public void onFloorFinished(JSONObject jsonObject) {
	// Handle JSONObject
}

Error Codes and Exceptions

Note: In case of an error, <null> is received at the first index and error info at the second index.

Release Floor Access

The Enxroom.releaseFloor() method allows moderators to terminate the floor access granted to a participant. It unpublishes the participant's streams and makes the floor available for access.

Class: Enxroom

Method: public void releaseFloor(String clientId)

Parameter: clientID: String. Client ID of the participant whose floor access will be released.

Observer: public void setChairControlObserver( EnxChairControlObserver-Object )

Callbacks

Sample Code

// Initiate Chair Control Observer to receive Callbacks
room.setChairControlObserver(this); 

room.releaseFloor(clientId); // To release floor access of the Participant

public void onProcessFloorRequested(JSONObject jsonobject){
 // You got floor access released from the Participant
}

public void onReleasedFloorRequest(JSONObject jsonobject){
 // Participant is notified that floor access is revoked
}

Error Codes and Exceptions

Note: The Object EnxRoom.setChairControlObserver() is called only once for any or all of the above methods to receive callbacks.

Restore a Moderator's Session

If a moderator is disconnected during a session, the list of floor access requests and participants currently with floor access can be retrieved through the room metadata when the moderator is reconnected.

Structured Data JSON

• room.getRoomMetaData().getJSONArray("raisedHands"): An array of Client IDs requesting floor access.
• room.getRoomMetaData().getJSONArray("approvedHands"): An array of Client IDs currently having floor access.

Invite to Floor

In the Lecture mode, where only a moderator can speak and control speakers in the room through Floor Access Control methods, the Invite Floor methods provide more options to the moderator to organize a conference in this mode.

Invite Participants to a Floor

The EnxRoom.inviteToFloor() method allows moderators to invite any participants in the ongoing conference to the floor and talk.

Class: EnxRoom

Method: public void inviteToFloor(String clientId)

Parameters: clientID: String. The client ID of the invited participant.

Callbacks

Sample Code

Sample Response 1

{
   msg = Success; 
   result = 0;
}

Sample Response 2

{
    clientId = "cae0afbc-fb94-4743-8c04-ae48e9d3eb52"; 
    id = inviteToFloor; 
    name = Jay;
}

Sample Response 3

{  
        clientId = "9554a040-58bd-4f0b-a010-7f92c54b2918"; 
        id = inviteToFloor; 
        moderator = "e2b48879-3754-49f2-bf86-08a73347e408"; 
        name = Jay; 
 }

// invitation sent to participant to come on floor and talk
EnxRoom.inviteToFloor(clientId); 

//Acknowledgment to the moderator who invited
@Override 
public void onACKInviteToFloorRequested(JSONObject jsonObject) 

//Notification to all the moderators in the room
@Override
public void onInviteToFloorRequested(JSONObject jsonObject)

//Notification to the invited participant
@Override 
public void onInvitedForFloorAccess(JSONObject jsonObject)

Error Codes and Exceptions

Cancel Floor Invitation

The EnxRoom.cancelFloorInvite() method allows moderators to cancel a floor invitation sent to a participant.

Class: EnxRoom

Method: public void cancelFloorInvite(String clientId)

Parameter: clientID: String. Client Id of the participant whose invitation needs to be canceled.

Callbacks

Sample Code

** Sample Response**

{ 
    msg = Success; 
    request =  { 
        id = processFloorRequest; 
 	params =  { 
            action = cancelFloorInvite;
            clientId = "cae0afbc-fb94-4743-8c04-ae48e9d3eb52"; 
       		}; 
	}; 
  	result = 0; 
}

Sample Response for a Participant

{ 
        clientId = "a067fd70-1461-4ca4-befc-2b570c0db494"; 
        id = cancelFloorInvite; 
        moderator = "e2b48879-3754-49f2-bf86-08a73347e408"; 
        name = JayiOS; 
}

Sample Response for Other Moderators

{ 
        clientId = "ade30ef1-595d-4364-b4f5-1d9420f24b0f"; 
        id = cancelFloorInvite; 
        name = JayiOS; 
}

// Cancel Floor invitation request sent by the Moderator
EnxRoom.cancelFloorInvite(clientId); 

// Acknowledgment to the Moderator that Cancel Floor Invitation is initiated
@Override 
public void onProcessFloorRequested(JSONObject jsonObject) 

// Notification to the invited participant and other Moderators in the Room that invitation is canceled
@Override 
public void onCanceledFloorInvite(JSONObject jsonObject)

Error Codes and Exceptions

Accept Floor Invitation

The EnxRoom.acceptInviteFloorRequest() method allows participants to accept the invitation to the floor and talk.

Class: EnxRoom

Method: public void acceptInviteFloorRequest(String clientId)

Parameter: clientID: String. Client Id of the participant who has received the invitation to the floor.

Callbacks

Sample Code

Sample Response 1

{ 
    msg = Success; 
    request =     { 
        id = processFloorRequest; 
        params =  { 
            action = acceptFloor; 
            clientId = "18c9b8bb-142e-44a7-b30b-6701cd9e62d9"; 
        }; 
    }; 
    result = 0;
}

Sample Response 2

{ 
        clientId = "8ed7241c-36d9-4224-b8f3-7d015718d09e"; 
        id = floorAccepted; 
        msg = "Floor accepted"; 
        result = 1738; 
}

// Participant accepts the invitation to Floor
EnxRoom.acceptInviteFloorRequest(clientId);

// Acknowledgment to the Participant when they accept the invitation to the Floor
@Override 
public void onProcessFloorRequested(JSONObject jsonObject) 

// Notification to all the Moderators in the Room including the one who sent the invitation
@Override 
public void onAcceptedFloorInvite(JSONObject jsonObject)

Error Codes and Exception

Reject Floor Invitation

The EnxRoom.rejectInviteFloor() method allows invited participants to reject the floor invitation.

Class: EnxRoom

Method: public void rejectInviteFloor(String clientId)

Parameter: clientID: String. Client Id of the participant who has received the invitation to the floor.

Callbacks

Sample Code

Sample Response 1

{ 
    msg = Success; 
    request =     { 
        id = processFloorRequest; 
        params =  { 
            action = rejectFloor; 
            clientId = "87184b36-26b3-4450-b908-6d9de6a457c5"; 
        }; 
    }; 
    result = 0; 
}

Sample Response 2

{ 
        clientId = "57ab3a52-2d85-4a22-a4b4-d58b90ea84ec"; 
        id = floorRejected; 
        msg = "Floor Denied"; 
        result = 1709; 
}

// Participant rejects invitation to Floor
EnxRoom.rejectInviteFloor(clientId);

// Acknowledgment to the Participant wen they reject invitation to the Floor
@Override 
public void onProcessFloorRequested(JSONObject jsonObject) 

// Notification to the Moderators when Participant rejects invitation to the Floor
@Override 
public void onRejectedInviteFloor(JSONObject jsonObject)

Error Codes and Exceptions