org.kurento.room

Class NotificationRoomManager

java.lang.Object

org.kurento.room.NotificationRoomManager

public class NotificationRoomManager
extends Object

The Kurento room manager represents an SDK for any developer that wants to implement the Room server-side application. They can build their application on top of the manager's Java API and implement their desired business logic without having to consider room or media-specific details.

It will trigger events which when handled, should notify the client side with the execution result of the requested actions (for client-originated requests).

Author:

Radu Tom Vlad

Constructor Summary

Constructors

Constructor and Description
NotificationRoomManager(NotificationRoomHandler notificationRoomHandler, KurentoClientProvider kcProvider) Provides an instance of the room manager by setting an event handler.
NotificationRoomManager(UserNotificationService notificationService, KurentoClientProvider kcProvider) Provides an instance of the room manager by setting an user notification service that will be used by the default event handler to send responses and notifications back to the clients.

Method Summary

Modifier and Type	Method and Description
void	addMediaElement(String participantId, org.kurento.client.MediaElement element)
void	addMediaElement(String participantId, org.kurento.client.MediaElement element, org.kurento.client.MediaType type)
void	close()
void	closeRoom(String roomName)
void	createRoom(KurentoClientSessionInfo kcSessionInfo)
void	evictParticipant(String participantId) Application-originated request to remove a participant from the room.
String	generatePublishOffer(String participantId)
Set<UserParticipant>	getParticipants(String roomName)
Set<UserParticipant>	getPeerPublishers(String participantId)
Set<UserParticipant>	getPeerSubscribers(String participantId)
org.kurento.client.MediaPipeline	getPipeline(String participantId)
Set<UserParticipant>	getPublishers(String roomName)
RoomManager	getRoomManager()
Set<String>	getRooms()
Set<UserParticipant>	getSubscribers(String roomName)
void	joinRoom(String userName, String roomName, boolean dataChannels, boolean webParticipant, ParticipantRequest request) Calls RoomManager#joinRoom(String, String, boolean, KurentoClientSessionInfo, String) with a DefaultKurentoClientSessionInfo bean as implementation of the KurentoClientSessionInfo.
void	leaveRoom(ParticipantRequest request)
void	mutePublishedMedia(MutedMediaType muteType, String participantId)
void	muteSubscribedMedia(String remoteName, MutedMediaType muteType, String participantId)
void	onIceCandidate(String endpointName, String candidate, int sdpMLineIndex, String sdpMid, ParticipantRequest request)
void	publishMedia(ParticipantRequest request, boolean isOffer, String sdp, org.kurento.client.MediaElement loopbackAlternativeSrc, org.kurento.client.MediaType loopbackConnectionType, boolean doLoopback, org.kurento.client.MediaElement... mediaElements)
void	publishMedia(ParticipantRequest request, String sdpOffer, boolean doLoopback, org.kurento.client.MediaElement... mediaElements)
void	removeMediaElement(String participantId, org.kurento.client.MediaElement element)
void	sendMessage(String message, String userName, String roomName, ParticipantRequest request) Used by clients to send written messages to all other participants in the room. Side effects: The room event handler should acknowledge the client's request by sending an empty message.
void	subscribe(String remoteName, String sdpOffer, ParticipantRequest request)
void	unmutePublishedMedia(String participantId)
void	unmuteSubscribedMedia(String remoteName, String participantId)
void	unpublishMedia(ParticipantRequest request)
void	unsubscribe(String remoteName, ParticipantRequest request)

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationRoomManager

public NotificationRoomManager(UserNotificationService notificationService,
                               KurentoClientProvider kcProvider)

Provides an instance of the room manager by setting an user notification service that will be used by the default event handler to send responses and notifications back to the clients.

Parameters:

notificationService - encapsulates the communication layer, used to instantiate DefaultNotificationRoomHandler

kcProvider - enables the manager to obtain Kurento Client instances

NotificationRoomManager

public NotificationRoomManager(NotificationRoomHandler notificationRoomHandler,
                               KurentoClientProvider kcProvider)

Provides an instance of the room manager by setting an event handler.

Parameters:

notificationRoomHandler - the room event handler implementation

kcProvider - enables the manager to obtain Kurento Client instances

Method Detail

joinRoom

public void joinRoom(String userName,
                     String roomName,
                     boolean dataChannels,
                     boolean webParticipant,
                     ParticipantRequest request)

Calls RoomManager#joinRoom(String, String, boolean, KurentoClientSessionInfo, String) with a DefaultKurentoClientSessionInfo bean as implementation of the KurentoClientSessionInfo.

Parameters:

b -

request - instance of ParticipantRequest POJO containing the participant's id and a request id (optional identifier of the request at the communications level, included when responding back to the client)

See Also:

RoomManager.joinRoom(String, String, boolean, boolean, KurentoClientSessionInfo, String)

leaveRoom

public void leaveRoom(ParticipantRequest request)

Parameters:

request - instance of ParticipantRequest POJO

See Also:

RoomManager.leaveRoom(String)

publishMedia

public void publishMedia(ParticipantRequest request,
                         boolean isOffer,
                         String sdp,
                         org.kurento.client.MediaElement loopbackAlternativeSrc,
                         org.kurento.client.MediaType loopbackConnectionType,
                         boolean doLoopback,
                         org.kurento.client.MediaElement... mediaElements)

Parameters:

request - instance of ParticipantRequest POJO

See Also:

RoomManager.publishMedia(String, boolean, String, MediaElement, MediaType, boolean, MediaElement...)

publishMedia

public void publishMedia(ParticipantRequest request,
                         String sdpOffer,
                         boolean doLoopback,
                         org.kurento.client.MediaElement... mediaElements)

Parameters:

request - instance of ParticipantRequest POJO

See Also:

RoomManager.publishMedia(String, String, boolean, MediaElement...)

unpublishMedia

public void unpublishMedia(ParticipantRequest request)

Parameters:

request - instance of ParticipantRequest POJO

See Also:

RoomManager.unpublishMedia(String)

subscribe

public void subscribe(String remoteName,
                      String sdpOffer,
                      ParticipantRequest request)

Parameters:

request - instance of ParticipantRequest POJO

See Also:

RoomManager.subscribe(String, String, String)

unsubscribe

public void unsubscribe(String remoteName,
                        ParticipantRequest request)

Parameters:

request - instance of ParticipantRequest POJO

See Also:

RoomManager.unsubscribe(String, String)

onIceCandidate

public void onIceCandidate(String endpointName,
                           String candidate,
                           int sdpMLineIndex,
                           String sdpMid,
                           ParticipantRequest request)

See Also:

RoomManager.onIceCandidate(String, String, int, String, String)

sendMessage

public void sendMessage(String message,
                        String userName,
                        String roomName,
                        ParticipantRequest request)

Used by clients to send written messages to all other participants in the room.
Side effects: The room event handler should acknowledge the client's request by sending an empty message. Should also send notifications to the all participants in the room with the message and its sender.

Parameters:

message - message contents

userName - name or identifier of the user in the room

roomName - room's name

request - instance of ParticipantRequest POJO

close

@PreDestroy
public void close()

See Also:

RoomManager.close()

getRooms

public Set<String> getRooms()

See Also:

RoomManager.getRooms()

getParticipants

public Set<UserParticipant> getParticipants(String roomName)
                                     throws RoomException

Throws:

RoomException

See Also:

RoomManager.getParticipants(String)

getPublishers

public Set<UserParticipant> getPublishers(String roomName)
                                   throws RoomException

Throws:

RoomException

See Also:

RoomManager.getPublishers(String)

getSubscribers

public Set<UserParticipant> getSubscribers(String roomName)
                                    throws RoomException

Throws:

RoomException

See Also:

RoomManager.getSubscribers(String)

getPeerPublishers

public Set<UserParticipant> getPeerPublishers(String participantId)
                                       throws RoomException

Throws:

RoomException

See Also:

RoomManager.getPeerPublishers(String)

getPeerSubscribers

public Set<UserParticipant> getPeerSubscribers(String participantId)
                                        throws RoomException

Throws:

RoomException

See Also:

RoomManager.getPeerSubscribers(String)

createRoom

public void createRoom(KurentoClientSessionInfo kcSessionInfo)
                throws RoomException

Throws:

RoomException

See Also:

RoomManager.createRoom(KurentoClientSessionInfo)

getPipeline

public org.kurento.client.MediaPipeline getPipeline(String participantId)
                                             throws RoomException

Throws:

RoomException

See Also:

RoomManager.getPipeline(String)

evictParticipant

public void evictParticipant(String participantId)
                      throws RoomException

Application-originated request to remove a participant from the room.
Side effects: The room event handler should notify the user that she has been evicted. Should also send notifications to all other participants about the one that's just been evicted.

Throws:

RoomException

See Also:

RoomManager.leaveRoom(String)

closeRoom

public void closeRoom(String roomName)
               throws RoomException

Throws:

RoomException

See Also:

RoomManager.closeRoom(String)

generatePublishOffer

public String generatePublishOffer(String participantId)
                            throws RoomException

Throws:

RoomException

See Also:

RoomManager.generatePublishOffer(String)

addMediaElement

public void addMediaElement(String participantId,
                            org.kurento.client.MediaElement element)
                     throws RoomException

Throws:

RoomException

See Also:

RoomManager.addMediaElement(String, MediaElement)

addMediaElement

public void addMediaElement(String participantId,
                            org.kurento.client.MediaElement element,
                            org.kurento.client.MediaType type)
                     throws RoomException

Throws:

RoomException

See Also:

RoomManager.addMediaElement(String, MediaElement, MediaType)

removeMediaElement

public void removeMediaElement(String participantId,
                               org.kurento.client.MediaElement element)
                        throws RoomException

Throws:

RoomException

See Also:

RoomManager.removeMediaElement(String, MediaElement)

mutePublishedMedia

public void mutePublishedMedia(MutedMediaType muteType,
                               String participantId)
                        throws RoomException

Throws:

RoomException

See Also:

RoomManager.mutePublishedMedia(MutedMediaType, String)

unmutePublishedMedia

public void unmutePublishedMedia(String participantId)
                          throws RoomException

Throws:

RoomException

See Also:

RoomManager.unmutePublishedMedia(String)

muteSubscribedMedia

public void muteSubscribedMedia(String remoteName,
                                MutedMediaType muteType,
                                String participantId)
                         throws RoomException

Throws:

RoomException

See Also:

RoomManager.muteSubscribedMedia(String, MutedMediaType, String)

unmuteSubscribedMedia

public void unmuteSubscribedMedia(String remoteName,
                                  String participantId)
                           throws RoomException

Throws:

RoomException

See Also:

RoomManager.unmuteSubscribedMedia(String, String)

getRoomManager

public RoomManager getRoomManager()