A C D E G H I J K L M N O P R S T U V

A

addIceCandidate(IceCandidate) - Method in class org.kurento.room.endpoint.IceWebRtcEndpoint

Add a new IceCandidate received gathered by the remote peer of this WebRtcEndpoint.

addIceCandidate(String, IceCandidate) - Method in class org.kurento.room.internal.Participant

addMediaElement(String, MediaElement) - Method in class org.kurento.room.RoomManager

Applies a media element (filter, recorder, etc.) to media that is currently streaming or that might get streamed sometime in the future.

addSubscriber(String) - Method in class org.kurento.room.internal.Participant

AdminException - Exception in org.kurento.room.exception

AdminException(String) - Constructor for exception org.kurento.room.exception.AdminException

apply(MediaElement) - Method in interface org.kurento.room.endpoint.MediaShapingEndpoint

Changes the media passing through a chain of media elements by applying the specified element/shaper.

apply(MediaElement) - Method in class org.kurento.room.endpoint.PublisherEndpoint

ASYNC_LATCH_TIMEOUT - Static variable in class org.kurento.room.internal.Room

C

cancelPublisher(Participant) - Method in class org.kurento.room.internal.Room

cancelReceivingMedia(String) - Method in class org.kurento.room.internal.Participant

close() - Method in class org.kurento.room.internal.Participant

close() - Method in class org.kurento.room.internal.Room

close() - Method in class org.kurento.room.RoomManager

Closes all resources.

closeRoom(String) - Method in class org.kurento.room.RoomManager

Closes an existing room by releasing all resources that were allocated for the room.

closeSession(ParticipantRequest) - Method in interface org.kurento.room.api.UserNotificationService

Notifies that any information associated with the provided request should be cleaned up (the participant has left).

connect(MediaElement) - Method in class org.kurento.room.endpoint.PublisherEndpoint

createEndpoint(CountDownLatch) - Method in class org.kurento.room.endpoint.IceWebRtcEndpoint

If this object doesn't have a WebRtcEndpoint, it is created in a thread-safe way using the internal MediaPipeline.

createPublishingEndpoint() - Method in class org.kurento.room.internal.Participant

createRoom(String) - Method in class org.kurento.room.RoomManager

Creates a room if it doesn’t already exist.

D

DefaultRoomEventHandler - Class in org.kurento.room.internal

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

DefaultRoomEventHandler(UserNotificationService) - Constructor for class org.kurento.room.internal.DefaultRoomEventHandler

deregisterPublisher() - Method in class org.kurento.room.internal.Room

E

endpoint - Variable in class org.kurento.room.endpoint.IceWebRtcEndpoint

equals(Object) - Method in class org.kurento.room.api.pojo.ParticipantRequest

equals(Object) - Method in class org.kurento.room.api.pojo.UserParticipant

equals(Object) - Method in class org.kurento.room.internal.Participant

evictParticipant(String) - Method in class org.kurento.room.RoomManager

Method that tries to remove a participant from her room.

G

gatherCandidates() - Method in class org.kurento.room.endpoint.IceWebRtcEndpoint

Instructs the internal WebRtcEndpoint to start gathering IceCandidates.

getActivePublishers() - Method in class org.kurento.room.internal.Room

getCode() - Method in exception org.kurento.room.exception.RoomException

getCodeValue() - Method in exception org.kurento.room.exception.RoomException

getConnectedSubscribedEndpoints() - Method in class org.kurento.room.internal.Participant

getEndpoint() - Method in class org.kurento.room.endpoint.IceWebRtcEndpoint

getEndpointName() - Method in class org.kurento.room.endpoint.IceWebRtcEndpoint

getId() - Method in class org.kurento.room.internal.Participant

getKurentoClient(String) - Method in interface org.kurento.room.api.KurentoClientProvider

Obtains a KurentoClient instance given the optional (nullable) peer identifier.

getMediaElements() - Method in class org.kurento.room.endpoint.PublisherEndpoint

getName() - Method in class org.kurento.room.internal.Participant

getName() - Method in class org.kurento.room.internal.Room

getOwner() - Method in class org.kurento.room.endpoint.IceWebRtcEndpoint

getParticipant(String) - Method in class org.kurento.room.internal.Room

getParticipantByName(String) - Method in class org.kurento.room.internal.Room

getParticipantId() - Method in class org.kurento.room.api.pojo.ParticipantRequest

getParticipantId() - Method in class org.kurento.room.api.pojo.UserParticipant

getParticipantIds() - Method in class org.kurento.room.internal.Room

getParticipants() - Method in class org.kurento.room.internal.Room

getParticipants(String) - Method in class org.kurento.room.RoomManager

Returns all the participants inside a room.

getPeerPublishers(String) - Method in class org.kurento.room.RoomManager

Returns the peer’s publishers (participants from which the peer is receiving media).

getPeerSubscribers(String) - Method in class org.kurento.room.RoomManager

Returns the peer’s subscribers (participants towards the peer is streaming media).

getPipeline() - Method in class org.kurento.room.endpoint.IceWebRtcEndpoint

getPipeline() - Method in class org.kurento.room.internal.Participant

getPipeline() - Method in class org.kurento.room.internal.Room

getPipeline(String) - Method in class org.kurento.room.RoomManager

Returns the media pipeline used by the participant.

getPublisher() - Method in class org.kurento.room.internal.Participant

getPublishers(String) - Method in class org.kurento.room.RoomManager

Returns all the publishers (participants streaming their media) inside a room.

getRequestId() - Method in class org.kurento.room.api.pojo.ParticipantRequest

getRoom() - Method in class org.kurento.room.internal.Participant

getRooms() - Method in class org.kurento.room.RoomManager

Returns all currently active (opened) rooms.

getSubscribers(String) - Method in class org.kurento.room.RoomManager

Returns all the subscribers (participants subscribed to a least one stream of another user) inside a room.

getUserName() - Method in class org.kurento.room.api.pojo.UserParticipant

getValue() - Method in enum org.kurento.room.exception.RoomException.Code

H

hashCode() - Method in class org.kurento.room.api.pojo.ParticipantRequest

hashCode() - Method in class org.kurento.room.api.pojo.UserParticipant

hashCode() - Method in class org.kurento.room.internal.Participant

I

ICE_CANDIDATE_METHOD - Static variable in class org.kurento.room.internal.DefaultRoomEventHandler

IceWebRtcEndpoint - Class in org.kurento.room.endpoint

WebRtcEndpoint wrapper that supports buffering of IceCandidates until the WebRtcEndpoint is created.

IceWebRtcEndpoint(Participant, String, MediaPipeline, Logger) - Constructor for class org.kurento.room.endpoint.IceWebRtcEndpoint

Constructor to set the owner, the endpoint's name and the media pipeline.

internalEndpointInitialization(CountDownLatch) - Method in class org.kurento.room.endpoint.IceWebRtcEndpoint

Create the endpoint and any other additional elements (if needed).

internalEndpointInitialization(CountDownLatch) - Method in class org.kurento.room.endpoint.PublisherEndpoint

isClosed() - Method in class org.kurento.room.internal.Participant

isClosed() - Method in class org.kurento.room.internal.Room

isConnectedToPublisher() - Method in class org.kurento.room.endpoint.SubscriberEndpoint

isStreaming() - Method in class org.kurento.room.api.pojo.UserParticipant

isStreaming() - Method in class org.kurento.room.internal.Participant

isSubscribed() - Method in class org.kurento.room.internal.Participant

J

join(String, String) - Method in class org.kurento.room.internal.Room

joinRoom(String, String, ParticipantRequest) - Method in class org.kurento.room.RoomManager

Represents a client’s request to join a room.

K

KurentoClientProvider - Interface in org.kurento.room.api

This service interface was designed so that the room manager could obtain a KurentoClient instance at any time, without requiring knowledge about the placement of the media server instances.

L

leave(String) - Method in class org.kurento.room.internal.Room

leaveRoom(ParticipantRequest) - Method in class org.kurento.room.RoomManager

Represents a client’s notification that she’s leaving the room.

M

MEDIA_ERROR_METHOD - Static variable in class org.kurento.room.internal.DefaultRoomEventHandler

MediaShapingEndpoint - Interface in org.kurento.room.endpoint

Media-related operations that a media endpoint will implement in order to allow modifications on its media stream.

N

newPublisher(Participant) - Method in class org.kurento.room.internal.Room

O

ON_ICE_CANDIDATE_PARAM - Static variable in class org.kurento.room.internal.DefaultRoomEventHandler

ON_ICE_EP_NAME_PARAM - Static variable in class org.kurento.room.internal.DefaultRoomEventHandler

ON_ICE_SDP_M_LINE_INDEX_PARAM - Static variable in class org.kurento.room.internal.DefaultRoomEventHandler

ON_ICE_SDP_MID_PARAM - Static variable in class org.kurento.room.internal.DefaultRoomEventHandler

onIceCandidate(String, String, int, String, ParticipantRequest) - Method in class org.kurento.room.RoomManager

Request that carries info about an ICE candidate gathered on the client side.

onParticipantJoined(ParticipantRequest, String, String, Set<UserParticipant>, RoomException) - Method in interface org.kurento.room.api.RoomEventHandler

Called as a result of RoomManager.joinRoom(String, String, ParticipantRequest).

onParticipantJoined(ParticipantRequest, String, String, Set<UserParticipant>, RoomException) - Method in class org.kurento.room.internal.DefaultRoomEventHandler

onParticipantLeft(ParticipantRequest, String, String, Set<String>, RoomException) - Method in interface org.kurento.room.api.RoomEventHandler

Called as a result of RoomManager#leaveRoom(String, String, ParticipantRequest) or RoomManager.evictParticipant(String) (admin action).

onParticipantLeft(ParticipantRequest, String, String, Set<String>, RoomException) - Method in class org.kurento.room.internal.DefaultRoomEventHandler

onParticipantMediaError(String, String) - Method in interface org.kurento.room.api.RoomEventHandler

Called as a result of an error intercepted on a media element of a participant.

onParticipantMediaError(String, String) - Method in class org.kurento.room.internal.DefaultRoomEventHandler

onPipelineError(String, Set<String>, String) - Method in interface org.kurento.room.api.RoomEventHandler

Called as a result of an error intercepted on the media pipeline.

onPipelineError(String, Set<String>, String) - Method in class org.kurento.room.internal.DefaultRoomEventHandler

onPublishMedia(ParticipantRequest, String, String, Set<String>, RoomException) - Method in interface org.kurento.room.api.RoomEventHandler

Called as a result of RoomManager#publishMedia(String, ParticipantRequest, MediaElement...) .

onPublishMedia(ParticipantRequest, String, String, Set<String>, RoomException) - Method in class org.kurento.room.internal.DefaultRoomEventHandler

onRecvIceCandidate(ParticipantRequest, RoomException) - Method in interface org.kurento.room.api.RoomEventHandler

Called as a result of RoomManager.onIceCandidate(String, String, int, String, ParticipantRequest) .

onRecvIceCandidate(ParticipantRequest, RoomException) - Method in class org.kurento.room.internal.DefaultRoomEventHandler

onRoomClosed(String, Set<String>) - Method in interface org.kurento.room.api.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.

onRoomClosed(String, Set<String>) - Method in class org.kurento.room.internal.DefaultRoomEventHandler

onRoomCreated(ParticipantRequest, String) - Method in interface org.kurento.room.api.RoomEventHandler

Called as a result of RoomManager.joinRoom(String, String, ParticipantRequest) when the specified room doesn't exist and it's successfully created.

onRoomCreated(ParticipantRequest, String) - Method in class org.kurento.room.internal.DefaultRoomEventHandler

onSendIceCandidate(String, String, IceCandidate) - Method in interface org.kurento.room.api.RoomEventHandler

Called when a new IceCandidate is gathered for the local WebRTC endpoint.

onSendIceCandidate(String, String, IceCandidate) - Method in class org.kurento.room.internal.DefaultRoomEventHandler

onSendMessage(ParticipantRequest, String, String, String, Set<String>, RoomException) - Method in interface org.kurento.room.api.RoomEventHandler

Called as a result of RoomManager.sendMessage(String, String, String, ParticipantRequest) .

onSendMessage(ParticipantRequest, String, String, String, Set<String>, RoomException) - Method in class org.kurento.room.internal.DefaultRoomEventHandler

onSubscribe(ParticipantRequest, String, RoomException) - Method in interface org.kurento.room.api.RoomEventHandler

Called as a result of RoomManager.subscribe(String, String, ParticipantRequest).

onSubscribe(ParticipantRequest, String, RoomException) - Method in class org.kurento.room.internal.DefaultRoomEventHandler

onUnpublishMedia(ParticipantRequest, String, Set<String>, RoomException) - Method in interface org.kurento.room.api.RoomEventHandler

Called as a result of RoomManager.unpublishMedia(ParticipantRequest).

onUnpublishMedia(ParticipantRequest, String, Set<String>, RoomException) - Method in class org.kurento.room.internal.DefaultRoomEventHandler

onUnsubscribe(ParticipantRequest, RoomException) - Method in interface org.kurento.room.api.RoomEventHandler

Called as a result of RoomManager.unsubscribe(String, ParticipantRequest).

onUnsubscribe(ParticipantRequest, RoomException) - Method in class org.kurento.room.internal.DefaultRoomEventHandler

org.kurento.room - package org.kurento.room

org.kurento.room.api - package org.kurento.room.api

org.kurento.room.api.pojo - package org.kurento.room.api.pojo

org.kurento.room.endpoint - package org.kurento.room.endpoint

org.kurento.room.exception - package org.kurento.room.exception

org.kurento.room.internal - package org.kurento.room.internal

P

Participant - Class in org.kurento.room.internal

Participant(String, String, Room, MediaPipeline) - Constructor for class org.kurento.room.internal.Participant

PARTICIPANT_JOINED_METHOD - Static variable in class org.kurento.room.internal.DefaultRoomEventHandler

PARTICIPANT_LEFT_METHOD - Static variable in class org.kurento.room.internal.DefaultRoomEventHandler

PARTICIPANT_PUBLISHED_METHOD - Static variable in class org.kurento.room.internal.DefaultRoomEventHandler

PARTICIPANT_SEND_MESSAGE_METHOD - Static variable in class org.kurento.room.internal.DefaultRoomEventHandler

PARTICIPANT_UNPUBLISHED_METHOD - Static variable in class org.kurento.room.internal.DefaultRoomEventHandler

ParticipantRequest - Class in org.kurento.room.api.pojo

ParticipantRequest(String, String) - Constructor for class org.kurento.room.api.pojo.ParticipantRequest

processOffer(String) - Method in class org.kurento.room.endpoint.IceWebRtcEndpoint

Orders the internal WebRtcEndpoint to process the offer String.

publish(String, boolean) - Method in class org.kurento.room.endpoint.PublisherEndpoint

Initializes this WebRtcEndpoint for publishing media.

PublisherEndpoint - Class in org.kurento.room.endpoint

Publisher aspect of the TrickleIceEndpoint.

PublisherEndpoint(Participant, String, MediaPipeline) - Constructor for class org.kurento.room.endpoint.PublisherEndpoint

publishMedia(ParticipantRequest, String, boolean, MediaElement...) - Method in class org.kurento.room.RoomManager

Represents a client’s request to start streaming her local media to anyone inside the room.

publishToRoom(String, boolean) - Method in class org.kurento.room.internal.Participant

R

receiveMediaFrom(Participant, String) - Method in class org.kurento.room.internal.Participant

registerElemErrListener(MediaElement) - Method in class org.kurento.room.endpoint.IceWebRtcEndpoint

Registers a listener for when the MediaElement triggers an ErrorEvent.

registerOnIceCandidateEventListener() - Method in class org.kurento.room.endpoint.IceWebRtcEndpoint

Registers a listener for when the WebRtcEndpoint gathers a new IceCandidate and sends it to the remote User Agent as a notification using the messaging capabilities of the Participant.

registerPublisher() - Method in class org.kurento.room.internal.Room

removeMediaElement(String, MediaElement) - Method in class org.kurento.room.RoomManager

Disconnects and removes media element (filter, recorder, etc.) from a media stream.

revert(MediaElement) - Method in interface org.kurento.room.endpoint.MediaShapingEndpoint

Removes the media element object found from the media chain structure.

revert(MediaElement) - Method in class org.kurento.room.endpoint.PublisherEndpoint

Room - Class in org.kurento.room.internal

Room(String, KurentoClient, RoomEventHandler) - Constructor for class org.kurento.room.internal.Room

ROOM_CLOSED_METHOD - Static variable in class org.kurento.room.internal.DefaultRoomEventHandler

RoomEventHandler - Interface in org.kurento.room.api

Through this interface, the room API passes the execution result of client primitives to the application and from there to the clients.

RoomException - Exception in org.kurento.room.exception

RoomException(RoomException.Code, String) - Constructor for exception org.kurento.room.exception.RoomException

RoomException.Code - Enum in org.kurento.room.exception

RoomManager - Class in org.kurento.room

The Kurento room manager represents an SDK for any developer that wants to implement the Room server-side application.

RoomManager(UserNotificationService, KurentoClientProvider) - Constructor for class org.kurento.room.RoomManager

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.

RoomManager(RoomEventHandler, KurentoClientProvider) - Constructor for class org.kurento.room.RoomManager

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

S

sendErrorResponse(ParticipantRequest, Object, RoomException) - Method in interface org.kurento.room.api.UserNotificationService

Responds back to the remote peer with the details of why the invoked method failed to be processed correctly.

sendIceCandidate(String, IceCandidate) - Method in class org.kurento.room.internal.Participant

sendIceCandidate(String, String, IceCandidate) - Method in class org.kurento.room.internal.Room

sendMediaError(ErrorEvent) - Method in class org.kurento.room.internal.Participant

sendMediaError(String, String) - Method in class org.kurento.room.internal.Room

sendMessage(String, String, String, ParticipantRequest) - Method in class org.kurento.room.RoomManager

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.

sendNotification(String, String, Object) - Method in interface org.kurento.room.api.UserNotificationService

Sends a notification to a remote peer.

sendResponse(ParticipantRequest, Object) - Method in interface org.kurento.room.api.UserNotificationService

Responds back to the remote peer with the result of the invoked method.

setConnectedToPublisher(boolean) - Method in class org.kurento.room.endpoint.SubscriberEndpoint

setEndpointName(String) - Method in class org.kurento.room.endpoint.IceWebRtcEndpoint

Sets the endpoint's name (as indicated by the browser).

setMediaPipeline(MediaPipeline) - Method in class org.kurento.room.endpoint.IceWebRtcEndpoint

Sets the MediaPipeline used to create the internal WebRtcEndpoint.

setParticipantId(String) - Method in class org.kurento.room.api.pojo.ParticipantRequest

setParticipantId(String) - Method in class org.kurento.room.api.pojo.UserParticipant

setRequestId(String) - Method in class org.kurento.room.api.pojo.ParticipantRequest

setStreaming(boolean) - Method in class org.kurento.room.api.pojo.UserParticipant

setUserName(String) - Method in class org.kurento.room.api.pojo.UserParticipant

subscribe(String, PublisherEndpoint) - Method in class org.kurento.room.endpoint.SubscriberEndpoint

subscribe(String, String, ParticipantRequest) - Method in class org.kurento.room.RoomManager

Represents a client’s request to receive media from room participants that published their media.

SubscriberEndpoint - Class in org.kurento.room.endpoint

Subscriber aspect of the TrickleIceEndpoint.

SubscriberEndpoint(Participant, String, MediaPipeline) - Constructor for class org.kurento.room.endpoint.SubscriberEndpoint

T

toString() - Method in class org.kurento.room.api.pojo.ParticipantRequest

toString() - Method in class org.kurento.room.api.pojo.UserParticipant

toString() - Method in exception org.kurento.room.exception.RoomException

toString() - Method in class org.kurento.room.internal.Participant

U

unpublishMedia() - Method in class org.kurento.room.internal.Participant

unpublishMedia(ParticipantRequest) - Method in class org.kurento.room.RoomManager

Represents a client’s request to stop publishing her media stream.

unregisterElementErrListener(MediaElement, ListenerSubscription) - Method in class org.kurento.room.endpoint.IceWebRtcEndpoint

Unregisters the error listener from the media element using the provided subscription.

unregisterErrorListeners() - Method in class org.kurento.room.endpoint.IceWebRtcEndpoint

Unregisters all error listeners created for media elements owned by this instance.

unregisterErrorListeners() - Method in class org.kurento.room.endpoint.PublisherEndpoint

unsubscribe(String, ParticipantRequest) - Method in class org.kurento.room.RoomManager

Represents a client’s request to stop receiving media from the remote peer.

UserNotificationService - Interface in org.kurento.room.api

This specification was designed so that the room manager could send notifications or responses back to the remote peers whilst remaining isolated from the transport or communications layers.

UserParticipant - Class in org.kurento.room.api.pojo

UserParticipant(String, String, boolean) - Constructor for class org.kurento.room.api.pojo.UserParticipant

UserParticipant(String, String) - Constructor for class org.kurento.room.api.pojo.UserParticipant

V

valueOf(String) - Static method in enum org.kurento.room.exception.RoomException.Code

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.kurento.room.exception.RoomException.Code

Returns an array containing the constants of this enum type, in the order they are declared.

A C D E G H I J K L M N O P R S T U V