org.kurento.room.endpoint

Class IceWebRtcEndpoint

java.lang.Object

org.kurento.room.endpoint.IceWebRtcEndpoint

Direct Known Subclasses:

PublisherEndpoint, SubscriberEndpoint

public abstract class IceWebRtcEndpoint
extends Object

WebRtcEndpoint wrapper that supports buffering of IceCandidates until the WebRtcEndpoint is created. Connections to other peers are opened using the corresponding method of the internal endpoint.

Author:

Radu Tom Vlad

Field Summary

Fields

Modifier and Type	Field and Description
protected org.kurento.client.WebRtcEndpoint	endpoint

Constructor Summary

Constructors

Constructor and Description
IceWebRtcEndpoint(Participant owner, String endpointName, org.kurento.client.MediaPipeline pipeline, org.slf4j.Logger log) Constructor to set the owner, the endpoint's name and the media pipeline.

Method Summary

Methods

Modifier and Type	Method and Description
void	addIceCandidate(org.kurento.client.IceCandidate candidate) Add a new IceCandidate received gathered by the remote peer of this WebRtcEndpoint.
org.kurento.client.WebRtcEndpoint	createEndpoint(CountDownLatch endpointLatch) If this object doesn't have a WebRtcEndpoint, it is created in a thread-safe way using the internal MediaPipeline.
protected void	gatherCandidates() Instructs the internal WebRtcEndpoint to start gathering IceCandidates.
org.kurento.client.WebRtcEndpoint	getEndpoint()
String	getEndpointName()
Participant	getOwner()
org.kurento.client.MediaPipeline	getPipeline()
protected void	internalEndpointInitialization(CountDownLatch endpointLatch) Create the endpoint and any other additional elements (if needed).
protected String	processOffer(String offer) Orders the internal WebRtcEndpoint to process the offer String.
protected org.kurento.client.ListenerSubscription	registerElemErrListener(org.kurento.client.MediaElement element) Registers a listener for when the MediaElement triggers an ErrorEvent.
protected void	registerOnIceCandidateEventListener() 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.
void	setEndpointName(String endpointName) Sets the endpoint's name (as indicated by the browser).
void	setMediaPipeline(org.kurento.client.MediaPipeline pipeline) Sets the MediaPipeline used to create the internal WebRtcEndpoint.
protected void	unregisterElementErrListener(org.kurento.client.MediaElement element, org.kurento.client.ListenerSubscription subscription) Unregisters the error listener from the media element using the provided subscription.
void	unregisterErrorListeners() Unregisters all error listeners created for media elements owned by this instance.

Methods inherited from class java.lang.Object

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

Field Detail

endpoint

protected org.kurento.client.WebRtcEndpoint endpoint

Constructor Detail

IceWebRtcEndpoint

public IceWebRtcEndpoint(Participant owner,
                 String endpointName,
                 org.kurento.client.MediaPipeline pipeline,
                 org.slf4j.Logger log)

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

Parameters:

owner -

endpointName -

pipeline -

Method Detail

getOwner

public Participant getOwner()

Returns:

the user session that created this endpoint

getEndpoint

public org.kurento.client.WebRtcEndpoint getEndpoint()

Returns:

the internal WebRtcEndpoint

createEndpoint

public org.kurento.client.WebRtcEndpoint createEndpoint(CountDownLatch endpointLatch)

If this object doesn't have a WebRtcEndpoint, it is created in a thread-safe way using the internal MediaPipeline. Otherwise no actions are taken. It also registers an error listener for the endpoint and for any additional media elements.

Parameters:

endpointLatch - latch whose countdown is performed when the asynchronous call to build the WebRtcEndpoint returns

Returns:

the existing endpoint, if any

getPipeline

public org.kurento.client.MediaPipeline getPipeline()

Returns:

the pipeline

setMediaPipeline

public void setMediaPipeline(org.kurento.client.MediaPipeline pipeline)

Sets the MediaPipeline used to create the internal WebRtcEndpoint.

Parameters:

pipeline - the MediaPipeline

getEndpointName

public String getEndpointName()

Returns:

name of this endpoint (as indicated by the browser)

setEndpointName

public void setEndpointName(String endpointName)

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

Parameters:

endpointName - the name

addIceCandidate

public void addIceCandidate(org.kurento.client.IceCandidate candidate)

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

Parameters:

candidate - the remote candidate

unregisterErrorListeners

public void unregisterErrorListeners()

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

internalEndpointInitialization

protected void internalEndpointInitialization(CountDownLatch endpointLatch)

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

Parameters:

endpointLatch -

registerOnIceCandidateEventListener

protected void registerOnIceCandidateEventListener()
                                            throws RoomException

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.

Throws:

RoomException - if thrown, unable to register the listener

See Also:

WebRtcEndpoint.addOnIceCandidateListener(org.kurento.client.EventListener), Participant.sendIceCandidate(String, IceCandidate)

registerElemErrListener

protected org.kurento.client.ListenerSubscription registerElemErrListener(org.kurento.client.MediaElement element)

Registers a listener for when the MediaElement triggers an ErrorEvent. Notifies the owner with the error.

Parameters:

element - the MediaElement

Returns:

ListenerSubscription that can be used to deregister the listener

unregisterElementErrListener

protected void unregisterElementErrListener(org.kurento.client.MediaElement element,
                                org.kurento.client.ListenerSubscription subscription)

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

Parameters:

element - the MediaElement

subscription - the associated ListenerSubscription

processOffer

protected String processOffer(String offer)

Orders the internal WebRtcEndpoint to process the offer String.

Parameters:

offer - String with the Sdp offer

Returns:

the Sdp answer

See Also:

SdpEndpoint.processOffer(String)

gatherCandidates

protected void gatherCandidates()

Instructs the internal WebRtcEndpoint to start gathering IceCandidates.