org.kurento.room.api

Interface NotificationRoomHandler

All Superinterfaces:

RoomHandler

All Known Implementing Classes:

DefaultNotificationRoomHandler

public interface NotificationRoomHandler
extends RoomHandler

Through this interface, the room API passes the execution result of client-originated requests to the application and from there to the clients. It's the application's duty to respect this contract.

Extends RoomHandler interface so that the clients are also notified of spontaneous media events.

Author:

Radu Tom Vlad

See Also:

RoomHandler

Method Summary

Modifier and Type	Method and Description
void	onParticipantEvicted(UserParticipant participant) Called as a result of NotificationRoomManager.evictParticipant(String) - application-originated method, not as a consequence of a client request.
void	onParticipantJoined(ParticipantRequest request, String roomName, String newUserName, Set<UserParticipant> existingParticipants, RoomException error) Called as a result of NotificationRoomManager#joinRoom(String, String, ParticipantRequest) .
void	onParticipantLeft(ParticipantRequest request, String userName, Set<UserParticipant> remainingParticipants, RoomException error) Called as a result of NotificationRoomManager#leaveRoom(String, String, ParticipantRequest) .
void	onParticipantLeft(String userName, Set<UserParticipant> remainingParticipants) Called as a result of NotificationRoomManager.evictParticipant(String) (application-originated action).
void	onPublishMedia(ParticipantRequest request, String publisherName, String sdpAnswer, Set<UserParticipant> participants, RoomException error) Called as a result of NotificationRoomManager#publishMedia(String, ParticipantRequest, MediaElement...) .
void	onRecvIceCandidate(ParticipantRequest request, RoomException error) Called as a result of NotificationRoomManager.onIceCandidate(String, String, int, String, ParticipantRequest) .
void	onRoomClosed(String roomName, Set<UserParticipant> participants) Called as a result of NotificationRoomManager.closeRoom(String) - application-originated method, not as a consequence of a client request.
void	onSendMessage(ParticipantRequest request, String message, String userName, String roomName, Set<UserParticipant> participants, RoomException error) Called as a result of NotificationRoomManager.sendMessage(String, String, String, ParticipantRequest) .
void	onSubscribe(ParticipantRequest request, String sdpAnswer, RoomException error) Called as a result of NotificationRoomManager.subscribe(String, String, ParticipantRequest) .
void	onUnpublishMedia(ParticipantRequest request, String publisherName, Set<UserParticipant> participants, RoomException error) Called as a result of NotificationRoomManager.unpublishMedia(ParticipantRequest).
void	onUnsubscribe(ParticipantRequest request, RoomException error) Called as a result of NotificationRoomManager.unsubscribe(String, ParticipantRequest).

Methods inherited from interface org.kurento.room.api.RoomHandler

onIceCandidate, onMediaElementError, onPipelineError

Method Detail

onParticipantJoined

void onParticipantJoined(ParticipantRequest request,
                         String roomName,
                         String newUserName,
                         Set<UserParticipant> existingParticipants,
                         RoomException error)

Called as a result of NotificationRoomManager#joinRoom(String, String, ParticipantRequest) . The new participant should be responded with all the available information: the existing peers and, for any publishers, their stream names. The current peers should receive a notification of the join event.

Parameters:

request - instance of ParticipantRequest POJO to identify the user and the request

roomName - the room's name

newUserName - the new user

existingParticipants - instances of UserParticipant POJO representing the already existing peers

error - instance of RoomException POJO, includes a code and error message. If not null, then the join was unsuccessful and the user should be responded accordingly.

onParticipantLeft

void onParticipantLeft(ParticipantRequest request,
                       String userName,
                       Set<UserParticipant> remainingParticipants,
                       RoomException error)

Called as a result of NotificationRoomManager#leaveRoom(String, String, ParticipantRequest) . The user should receive an acknowledgement if the operation completed successfully, and the remaining peers should be notified of this event.

Parameters:

request - instance of ParticipantRequest POJO to identify the user and the request

userName - the departing user's name

remainingParticipants - instances of UserParticipant representing the remaining participants in the room

error - instance of RoomException POJO, includes a code and error message. If not null, then the operation was unsuccessful and the user should be responded accordingly.

onParticipantLeft

void onParticipantLeft(String userName,
                       Set<UserParticipant> remainingParticipants)

Called as a result of NotificationRoomManager.evictParticipant(String) (application-originated action). The remaining peers should be notified of this event.

Parameters:

request - instance of ParticipantRequest POJO to identify the user and the request

userName - the departing user's name

remainingParticipants - instances of UserParticipant representing the remaining participants in the room

onPublishMedia

void onPublishMedia(ParticipantRequest request,
                    String publisherName,
                    String sdpAnswer,
                    Set<UserParticipant> participants,
                    RoomException error)

Called as a result of NotificationRoomManager#publishMedia(String, ParticipantRequest, MediaElement...) . The user should receive the generated SPD answer from the local WebRTC endpoint, and the other peers should be notified of this event.

Parameters:

request - instance of ParticipantRequest POJO to identify the user and the request

publisherName - the user name

sdpAnswer - String with generated SPD answer from the local WebRTC endpoint

participants - instances of UserParticipant for ALL the participants in the room (includes the publisher)

error - instance of RoomException POJO, includes a code and error message. If not null, then the operation was unsuccessful and the user should be responded accordingly.

onUnpublishMedia

void onUnpublishMedia(ParticipantRequest request,
                      String publisherName,
                      Set<UserParticipant> participants,
                      RoomException error)

Called as a result of NotificationRoomManager.unpublishMedia(ParticipantRequest). The user should receive an acknowledgement if the operation completed successfully, and all other peers in the room should be notified of this event.

Parameters:

request - instance of ParticipantRequest POJO to identify the user and the request

publisherName - the user name

participants - instances of UserParticipant for ALL the participants in the room (includes the publisher)

error - instance of RoomException POJO, includes a code and error message. If not null, then the operation was unsuccessful and the user should be responded accordingly.

onSubscribe

void onSubscribe(ParticipantRequest request,
                 String sdpAnswer,
                 RoomException error)

Called as a result of NotificationRoomManager.subscribe(String, String, ParticipantRequest) . The user should be responded with generated SPD answer from the local WebRTC endpoint.

Parameters:

request - instance of ParticipantRequest POJO to identify the user and the request

sdpAnswer - String with generated SPD answer from the local WebRTC endpoint

error - instance of RoomException POJO, includes a code and error message. If not null, then the operation was unsuccessful and the user should be responded accordingly.

onUnsubscribe

void onUnsubscribe(ParticipantRequest request,
                   RoomException error)

Called as a result of NotificationRoomManager.unsubscribe(String, ParticipantRequest). The user should receive an acknowledgement if the operation completed successfully (no error).

Parameters:

request - instance of ParticipantRequest POJO to identify the user and the request

error - instance of RoomException POJO, includes a code and error message. If not null, then the operation was unsuccessful and the user should be responded accordingly.

onSendMessage

void onSendMessage(ParticipantRequest request,
                   String message,
                   String userName,
                   String roomName,
                   Set<UserParticipant> participants,
                   RoomException error)

Called as a result of NotificationRoomManager.sendMessage(String, String, String, ParticipantRequest) . The user should receive an acknowledgement if the operation completed successfully, and all the peers in the room should be notified with the message contents and its origin.

Parameters:

request - instance of ParticipantRequest POJO to identify the user and the request

message - String with the message body

userName - name of the peer that sent it

roomName - the current room name

participants - instances of UserParticipant for ALL the participants in the room (includes the sender)

error - instance of RoomException POJO, includes a code and error message. If not null, then the operation was unsuccessful and the user should be responded accordingly.

onRecvIceCandidate

void onRecvIceCandidate(ParticipantRequest request,
                        RoomException error)

Called as a result of NotificationRoomManager.onIceCandidate(String, String, int, String, ParticipantRequest) . The user should receive an acknowledgement if the operation completed successfully (no error).

Parameters:

request - instance of ParticipantRequest POJO to identify the user and the request

error - instance of RoomException POJO, includes a code and error message. If not null, then the operation was unsuccessful and the user should be responded accordingly.

onRoomClosed

void onRoomClosed(String roomName,
                  Set<UserParticipant> participants)

Called as a result of NotificationRoomManager.closeRoom(String) - application-originated method, not as a consequence of a client request. All resources on the server, associated with the room, have been released. The existing participants in the room should be notified of this event so that the client-side application acts accordingly.

Parameters:

roomName - the room that's just been closed

participants - instances of UserParticipant POJO representing the peers of the closed room

onParticipantEvicted

void onParticipantEvicted(UserParticipant participant)

Called as a result of NotificationRoomManager.evictParticipant(String) - application-originated method, not as a consequence of a client request. The participant should be notified so that the client-side application would terminate gracefully.

Parameters:

participant - instance of UserParticipant POJO representing the evicted peer