org.kurento.room.internal

Class DefaultRoomEventHandler

java.lang.Object

org.kurento.room.internal.DefaultRoomEventHandler

All Implemented Interfaces:

RoomEventHandler

public class DefaultRoomEventHandler
extends Object
implements RoomEventHandler

Default implementation that assumes that JSON-RPC messages specification was used for the client-server communications.

Author:

Radu Tom Vlad

Field Summary

Fields

Modifier and Type	Field and Description
static String	ICE_CANDIDATE_METHOD
static String	MEDIA_ERROR_METHOD
static String	ON_ICE_CANDIDATE_PARAM
static String	ON_ICE_EP_NAME_PARAM
static String	ON_ICE_SDP_M_LINE_INDEX_PARAM
static String	ON_ICE_SDP_MID_PARAM
static String	PARTICIPANT_JOINED_METHOD
static String	PARTICIPANT_LEFT_METHOD
static String	PARTICIPANT_PUBLISHED_METHOD
static String	PARTICIPANT_SEND_MESSAGE_METHOD
static String	PARTICIPANT_UNPUBLISHED_METHOD
static String	ROOM_CLOSED_METHOD

Constructor Summary

Constructors

Constructor and Description
DefaultRoomEventHandler(UserNotificationService notifService)

Method Summary

Methods

Modifier and Type	Method and Description
void	onParticipantJoined(ParticipantRequest request, String roomName, String newUserName, Set<UserParticipant> existingParticipants, RoomException error) Called as a result of RoomManager.joinRoom(String, String, ParticipantRequest).
void	onParticipantLeft(ParticipantRequest request, String roomName, String userName, Set<String> remainingParticipantIds, RoomException error) Called as a result of RoomManager#leaveRoom(String, String, ParticipantRequest) or RoomManager.evictParticipant(String) (admin action).
void	onParticipantMediaError(String participantId, String description) Called as a result of an error intercepted on a media element of a participant.
void	onPipelineError(String roomName, Set<String> participantIds, String description) Called as a result of an error intercepted on the media pipeline.
void	onPublishMedia(ParticipantRequest request, String publisherName, String sdpAnswer, Set<String> participantIds, RoomException error) Called as a result of RoomManager#publishMedia(String, ParticipantRequest, MediaElement...) .
void	onRecvIceCandidate(ParticipantRequest request, RoomException error) Called as a result of RoomManager.onIceCandidate(String, String, int, String, ParticipantRequest) .
void	onRoomClosed(String roomName, Set<String> participantIds) Called as a result of RoomManager.closeRoom(String) or RoomManager.evictParticipant(String) - server domain methods, not as a consequence of a room API request.
void	onRoomCreated(ParticipantRequest request, String roomName) Called as a result of RoomManager.joinRoom(String, String, ParticipantRequest) when the specified room doesn't exist and it's successfully created.
void	onSendIceCandidate(String participantId, String endpointName, org.kurento.client.IceCandidate candidate) Called when a new IceCandidate is gathered for the local WebRTC endpoint.
void	onSendMessage(ParticipantRequest request, String message, String userName, String roomName, Set<String> participantIds, RoomException error) Called as a result of RoomManager.sendMessage(String, String, String, ParticipantRequest) .
void	onSubscribe(ParticipantRequest request, String sdpAnswer, RoomException error) Called as a result of RoomManager.subscribe(String, String, ParticipantRequest).
void	onUnpublishMedia(ParticipantRequest request, String publisherName, Set<String> participantIds, RoomException error) Called as a result of RoomManager.unpublishMedia(ParticipantRequest).
void	onUnsubscribe(ParticipantRequest request, RoomException error) Called as a result of RoomManager.unsubscribe(String, ParticipantRequest).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARTICIPANT_LEFT_METHOD

public static final String PARTICIPANT_LEFT_METHOD

See Also:

Constant Field Values

PARTICIPANT_JOINED_METHOD

public static final String PARTICIPANT_JOINED_METHOD

See Also:

Constant Field Values

PARTICIPANT_PUBLISHED_METHOD

public static final String PARTICIPANT_PUBLISHED_METHOD

See Also:

Constant Field Values

PARTICIPANT_UNPUBLISHED_METHOD

public static final String PARTICIPANT_UNPUBLISHED_METHOD

See Also:

Constant Field Values

PARTICIPANT_SEND_MESSAGE_METHOD

public static final String PARTICIPANT_SEND_MESSAGE_METHOD

See Also:

Constant Field Values

ROOM_CLOSED_METHOD

public static final String ROOM_CLOSED_METHOD

See Also:

Constant Field Values

MEDIA_ERROR_METHOD

public static final String MEDIA_ERROR_METHOD

See Also:

Constant Field Values

ICE_CANDIDATE_METHOD

public static final String ICE_CANDIDATE_METHOD

See Also:

Constant Field Values

ON_ICE_EP_NAME_PARAM

public static final String ON_ICE_EP_NAME_PARAM

See Also:

Constant Field Values

ON_ICE_CANDIDATE_PARAM

public static final String ON_ICE_CANDIDATE_PARAM

See Also:

Constant Field Values

ON_ICE_SDP_MID_PARAM

public static final String ON_ICE_SDP_MID_PARAM

See Also:

Constant Field Values

ON_ICE_SDP_M_LINE_INDEX_PARAM

public static final String ON_ICE_SDP_M_LINE_INDEX_PARAM

See Also:

Constant Field Values

Constructor Detail

DefaultRoomEventHandler

public DefaultRoomEventHandler(UserNotificationService notifService)

Method Detail

onRoomCreated

public void onRoomCreated(ParticipantRequest request,
                 String roomName)

Description copied from interface: RoomEventHandler

Called as a result of RoomManager.joinRoom(String, String, ParticipantRequest) when the specified room doesn't exist and it's successfully created. Normally this event won't have to be notified to the user(s).

Specified by:

onRoomCreated in interface RoomEventHandler

Parameters:

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

roomName - the room's name

onRoomClosed

public void onRoomClosed(String roomName,
                Set<String> participantIds)

Description copied from interface: RoomEventHandler

Called as a result of RoomManager.closeRoom(String) or RoomManager.evictParticipant(String) - server domain methods, not as a consequence of a room API 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.

Specified by:

onRoomClosed in interface RoomEventHandler

Parameters:

roomName - the room that's just been closed

participantIds - identifiers of the participants in the room

onParticipantJoined

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

Description copied from interface: RoomEventHandler

Called as a result of RoomManager.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.

Specified by:

onParticipantJoined in interface RoomEventHandler

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 that represent 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

public void onParticipantLeft(ParticipantRequest request,
                     String roomName,
                     String userName,
                     Set<String> remainingParticipantIds,
                     RoomException error)

Description copied from interface: RoomEventHandler

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

Specified by:

onParticipantLeft in interface RoomEventHandler

Parameters:

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

roomName - the room's name

userName - the departing user's name

remainingParticipantIds - identifiers of the 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.

onPublishMedia

public void onPublishMedia(ParticipantRequest request,
                  String publisherName,
                  String sdpAnswer,
                  Set<String> participantIds,
                  RoomException error)

Description copied from interface: RoomEventHandler

Called as a result of RoomManager#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.

Specified by:

onPublishMedia in interface RoomEventHandler

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

participantIds - identifiers of 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

public void onUnpublishMedia(ParticipantRequest request,
                    String publisherName,
                    Set<String> participantIds,
                    RoomException error)

Description copied from interface: RoomEventHandler

Called as a result of RoomManager.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.

Specified by:

onUnpublishMedia in interface RoomEventHandler

Parameters:

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

publisherName - the user name

participantIds - identifiers of 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

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

Description copied from interface: RoomEventHandler

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

Specified by:

onSubscribe in interface RoomEventHandler

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

public void onUnsubscribe(ParticipantRequest request,
                 RoomException error)

Description copied from interface: RoomEventHandler

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

Specified by:

onUnsubscribe in interface RoomEventHandler

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

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

Description copied from interface: RoomEventHandler

Called as a result of RoomManager.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.

Specified by:

onSendMessage in interface RoomEventHandler

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

participantIds - identifiers of 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

public void onRecvIceCandidate(ParticipantRequest request,
                      RoomException error)

Description copied from interface: RoomEventHandler

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

Specified by:

onRecvIceCandidate in interface RoomEventHandler

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.

onSendIceCandidate

public void onSendIceCandidate(String participantId,
                      String endpointName,
                      org.kurento.client.IceCandidate candidate)

Description copied from interface: RoomEventHandler

Called when a new IceCandidate is gathered for the local WebRTC endpoint. The user should receive a notification with all the provided information so that the candidate is added to the remote WebRTC peer.

Specified by:

onSendIceCandidate in interface RoomEventHandler

Parameters:

participantId - identifier of the participant

endpointName - String the identifier of the local WebRTC endpoint (created in the server)

candidate - the gathered IceCandidate

onPipelineError

public void onPipelineError(String roomName,
                   Set<String> participantIds,
                   String description)

Description copied from interface: RoomEventHandler

Called as a result of an error intercepted on the media pipeline. The affected participants should be notified.

Specified by:

onPipelineError in interface RoomEventHandler

Parameters:

roomName - the room where the error occurred

participantIds - the participants identifiers

description - description of the error

onParticipantMediaError

public void onParticipantMediaError(String participantId,
                           String description)

Description copied from interface: RoomEventHandler

Called as a result of an error intercepted on a media element of a participant. The participant should be notified.

Specified by:

onParticipantMediaError in interface RoomEventHandler

Parameters:

participantId - identifier of the participant

description - description of the error