| Package | Description |
|---|---|
| org.kurento.room | |
| org.kurento.room.api | |
| org.kurento.room.endpoint | |
| org.kurento.room.internal |
| Modifier and Type | Method and Description |
|---|---|
void |
RoomManager.addMediaElement(String participantId,
org.kurento.client.MediaElement element)
Applies a media element (filter, recorder, mixer, etc.) to media that is
currently streaming or that might get streamed sometime in the future.
|
void |
NotificationRoomManager.addMediaElement(String participantId,
org.kurento.client.MediaElement element) |
void |
RoomManager.addMediaElement(String participantId,
org.kurento.client.MediaElement element,
org.kurento.client.MediaType type)
Applies a media element (filter, recorder, mixer, etc.) to media that is
currently streaming or that might get streamed sometime in the future.
|
void |
NotificationRoomManager.addMediaElement(String participantId,
org.kurento.client.MediaElement element,
org.kurento.client.MediaType type) |
Set<UserParticipant> |
RoomManager.closeRoom(String roomName)
Closes an existing room by releasing all resources that were allocated
for the room.
|
void |
NotificationRoomManager.closeRoom(String roomName) |
void |
RoomManager.createRoom(KurentoClientSessionInfo kcSessionInfo)
Creates a room if it doesn't already exist.
|
void |
NotificationRoomManager.createRoom(KurentoClientSessionInfo kcSessionInfo) |
void |
NotificationRoomManager.evictParticipant(String participantId)
Application-originated request to remove a participant from the room.
|
String |
RoomManager.generatePublishOffer(String participantId)
Represents a client's request to initiate the media connection from the
server-side (generate the SDP offer and send it back to the client) and
must be followed by processing the SDP answer from the client in order to
establish the streaming.
|
String |
NotificationRoomManager.generatePublishOffer(String participantId) |
UserParticipant |
RoomManager.getParticipantInfo(String participantId)
Searches for the participant using her identifier and returns the
corresponding
UserParticipant POJO. |
String |
RoomManager.getParticipantName(String participantId)
Finds the participant's username.
|
Set<UserParticipant> |
RoomManager.getParticipants(String roomName)
Returns all the participants inside a room.
|
Set<UserParticipant> |
NotificationRoomManager.getParticipants(String roomName) |
Set<UserParticipant> |
RoomManager.getPeerPublishers(String participantId)
Returns the peer's publishers (participants from which the peer is
receiving media).
|
Set<UserParticipant> |
NotificationRoomManager.getPeerPublishers(String participantId) |
Set<UserParticipant> |
RoomManager.getPeerSubscribers(String participantId)
Returns the peer's subscribers (participants towards the peer is
streaming media).
|
Set<UserParticipant> |
NotificationRoomManager.getPeerSubscribers(String participantId) |
org.kurento.client.MediaPipeline |
RoomManager.getPipeline(String participantId)
Returns the media pipeline used by the participant.
|
org.kurento.client.MediaPipeline |
NotificationRoomManager.getPipeline(String participantId) |
Set<UserParticipant> |
RoomManager.getPublishers(String roomName)
Returns all the publishers (participants streaming their media) inside a
room.
|
Set<UserParticipant> |
NotificationRoomManager.getPublishers(String roomName) |
String |
RoomManager.getRoomName(String participantId)
Finds the room's name of a given participant.
|
Set<UserParticipant> |
RoomManager.getSubscribers(String roomName)
Returns all the subscribers (participants subscribed to a least one
stream of another user) inside a room.
|
Set<UserParticipant> |
NotificationRoomManager.getSubscribers(String roomName) |
boolean |
RoomManager.isPublisherStreaming(String participantId)
Checks if a participant is currently streaming media.
|
Set<UserParticipant> |
RoomManager.joinRoom(String userName,
String roomName,
boolean webParticipant,
KurentoClientSessionInfo kcSessionInfo,
String participantId)
Represents a client's request to join a room.
|
Set<UserParticipant> |
RoomManager.leaveRoom(String participantId)
Represents a client's notification that she's leaving the room.
|
void |
RoomManager.mutePublishedMedia(MutedMediaType muteType,
String participantId)
Mutes the streamed media of this publisher in a selective manner.
|
void |
NotificationRoomManager.mutePublishedMedia(MutedMediaType muteType,
String participantId) |
void |
RoomManager.muteSubscribedMedia(String remoteName,
MutedMediaType muteType,
String participantId)
Mutes the incoming media stream from the remote publisher in a selective
manner.
|
void |
NotificationRoomManager.muteSubscribedMedia(String remoteName,
MutedMediaType muteType,
String participantId) |
void |
RoomManager.onIceCandidate(String endpointName,
String candidate,
int sdpMLineIndex,
String sdpMid,
String participantId)
Request that carries info about an ICE candidate gathered on the client
side.
|
String |
RoomManager.publishMedia(String participantId,
boolean isOffer,
String sdp,
boolean doLoopback,
org.kurento.client.MediaElement... mediaElements)
Same as
RoomManager.publishMedia(String, boolean, String, MediaElement, MediaType, boolean, MediaElement...)
, using as loopback the published stream and no specific type of loopback
connection. |
String |
RoomManager.publishMedia(String participantId,
boolean isOffer,
String sdp,
org.kurento.client.MediaElement loopbackAlternativeSrc,
org.kurento.client.MediaType loopbackConnectionType,
boolean doLoopback,
org.kurento.client.MediaElement... mediaElements)
Represents a client's request to start streaming her local media to
anyone inside the room.
|
String |
RoomManager.publishMedia(String participantId,
String sdp,
boolean doLoopback,
org.kurento.client.MediaElement... mediaElements)
Same as
RoomManager.publishMedia(String, boolean, String, MediaElement, MediaType, boolean, MediaElement...)
where the sdp String is an offer generated by the remote peer, the
published stream will be used for loopback (if required) and no specific
type of loopback connection. |
void |
RoomManager.removeMediaElement(String participantId,
org.kurento.client.MediaElement element)
Disconnects and removes media element (filter, recorder, etc.) from a
media stream.
|
void |
NotificationRoomManager.removeMediaElement(String participantId,
org.kurento.client.MediaElement element) |
String |
RoomManager.subscribe(String remoteName,
String sdpOffer,
String participantId)
Represents a client's request to receive media from room participants
that published their media.
|
void |
RoomManager.unmutePublishedMedia(String participantId)
Reverts the effects of the mute operation.
|
void |
NotificationRoomManager.unmutePublishedMedia(String participantId) |
void |
RoomManager.unmuteSubscribedMedia(String remoteName,
String participantId)
Reverts any previous mute operation.
|
void |
NotificationRoomManager.unmuteSubscribedMedia(String remoteName,
String participantId) |
void |
RoomManager.unpublishMedia(String participantId)
Represents a client's request to stop publishing her media stream.
|
void |
RoomManager.unsubscribe(String remoteName,
String participantId)
Represents a client's request to stop receiving media from the remote
peer.
|
| Modifier and Type | Method and Description |
|---|---|
void |
NotificationRoomHandler.onParticipantJoined(ParticipantRequest request,
String roomName,
String newUserName,
Set<UserParticipant> existingParticipants,
RoomException error)
Called as a result of
NotificationRoomManager#joinRoom(String, String, ParticipantRequest)
. |
void |
NotificationRoomHandler.onParticipantLeft(ParticipantRequest request,
String userName,
Set<UserParticipant> remainingParticipants,
RoomException error)
Called as a result of
NotificationRoomManager#leaveRoom(String, String, ParticipantRequest)
. |
void |
NotificationRoomHandler.onPublishMedia(ParticipantRequest request,
String publisherName,
String sdpAnswer,
Set<UserParticipant> participants,
RoomException error)
Called as a result of
NotificationRoomManager#publishMedia(String, ParticipantRequest, MediaElement...)
. |
void |
NotificationRoomHandler.onRecvIceCandidate(ParticipantRequest request,
RoomException error)
Called as a result of
NotificationRoomManager.onIceCandidate(String, String, int, String, ParticipantRequest)
. |
void |
NotificationRoomHandler.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 |
NotificationRoomHandler.onSubscribe(ParticipantRequest request,
String sdpAnswer,
RoomException error)
Called as a result of
NotificationRoomManager.subscribe(String, String, ParticipantRequest)
. |
void |
NotificationRoomHandler.onUnpublishMedia(ParticipantRequest request,
String publisherName,
Set<UserParticipant> participants,
RoomException error)
Called as a result of
NotificationRoomManager.unpublishMedia(ParticipantRequest). |
void |
NotificationRoomHandler.onUnsubscribe(ParticipantRequest request,
RoomException error)
Called as a result of
NotificationRoomManager.unsubscribe(String, ParticipantRequest). |
void |
UserNotificationService.sendErrorResponse(ParticipantRequest participantRequest,
Object data,
RoomException error)
Responds back to the remote peer with the details of why the invoked
method failed to be processed correctly.
|
| Modifier and Type | Method and Description |
|---|---|
org.kurento.client.KurentoClient |
KurentoClientProvider.getKurentoClient(KurentoClientSessionInfo sessionInfo)
Obtains a
KurentoClient instance given the custom session bean. |
| Modifier and Type | Method and Description |
|---|---|
void |
MediaEndpoint.addIceCandidate(org.kurento.client.IceCandidate candidate)
Add a new
IceCandidate received gathered by the remote peer of
this WebRtcEndpoint. |
String |
PublisherEndpoint.apply(org.kurento.client.MediaElement shaper)
Changes the media passing through a chain of media elements by applying
the specified element/shaper.
|
String |
PublisherEndpoint.apply(org.kurento.client.MediaElement shaper,
org.kurento.client.MediaType type)
Same as
PublisherEndpoint.apply(MediaElement), can specify the
media type that will be streamed through the shaper element. |
protected void |
MediaEndpoint.gatherCandidates()
If supported, it instructs the internal endpoint to start gathering
IceCandidates. |
protected String |
MediaEndpoint.generateOffer()
Orders the internal endpoint (
RtpEndpoint or
WebRtcEndpoint) to generate the offer String that can be used to
initiate a connection. |
protected String |
MediaEndpoint.processAnswer(String answer)
Orders the internal endpoint (
RtpEndpoint or
WebRtcEndpoint) to process the answer String. |
protected String |
MediaEndpoint.processOffer(String offer)
Orders the internal endpoint (
RtpEndpoint or
WebRtcEndpoint) to process the offer String. |
protected void |
MediaEndpoint.registerOnIceCandidateEventListener()
If supported, it registers a listener for when a new
IceCandidate
is gathered by the internal endpoint (WebRtcEndpoint) and sends
it to the remote User Agent as a notification using the messaging
capabilities of the Participant. |
void |
PublisherEndpoint.revert(org.kurento.client.MediaElement shaper)
Removes the media element object found from the media chain structure.
|
| Modifier and Type | Method and Description |
|---|---|
void |
DefaultNotificationRoomHandler.onParticipantJoined(ParticipantRequest request,
String roomName,
String newUserName,
Set<UserParticipant> existingParticipants,
RoomException error) |
void |
DefaultNotificationRoomHandler.onParticipantLeft(ParticipantRequest request,
String userName,
Set<UserParticipant> remainingParticipants,
RoomException error) |
void |
DefaultNotificationRoomHandler.onPublishMedia(ParticipantRequest request,
String publisherName,
String sdpAnswer,
Set<UserParticipant> participants,
RoomException error) |
void |
DefaultNotificationRoomHandler.onRecvIceCandidate(ParticipantRequest request,
RoomException error) |
void |
DefaultNotificationRoomHandler.onSendMessage(ParticipantRequest request,
String message,
String userName,
String roomName,
Set<UserParticipant> participants,
RoomException error) |
void |
DefaultNotificationRoomHandler.onSubscribe(ParticipantRequest request,
String sdpAnswer,
RoomException error) |
void |
DefaultNotificationRoomHandler.onUnpublishMedia(ParticipantRequest request,
String publisherName,
Set<UserParticipant> participants,
RoomException error) |
void |
DefaultNotificationRoomHandler.onUnsubscribe(ParticipantRequest request,
RoomException error) |
| Modifier and Type | Method and Description |
|---|---|
void |
Room.join(String participantId,
String userName,
boolean webParticipant) |
void |
Room.leave(String participantId) |
Copyright © 2015 Kurento. All rights reserved.