org.kurento.room.endpoint

Class MediaEndpoint

java.lang.Object

org.kurento.room.endpoint.MediaEndpoint

Direct Known Subclasses:

PublisherEndpoint, SubscriberEndpoint

public abstract class MediaEndpoint
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

Constructor Summary

Constructors

Constructor and Description
MediaEndpoint(boolean web, 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.SdpEndpoint	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() If supported, it instructs the internal endpoint to start gathering IceCandidates.
protected String	generateOffer() Orders the internal endpoint (RtpEndpoint or WebRtcEndpoint) to generate the offer String that can be used to initiate a connection.
org.kurento.client.SdpEndpoint	getEndpoint()
String	getEndpointName()
MutedMediaType	getMuteType()
Participant	getOwner()
org.kurento.client.MediaPipeline	getPipeline()
protected org.kurento.client.RtpEndpoint	getRtpEndpoint()
protected org.kurento.client.WebRtcEndpoint	getWebEndpoint()
protected void	internalEndpointInitialization(CountDownLatch endpointLatch) Creates the endpoint (RTP or WebRTC) and any other additional elements (if needed).
boolean	isWeb()
abstract void	mute(MutedMediaType muteType) Mute the media stream.
protected String	processAnswer(String answer) Orders the internal endpoint (RtpEndpoint or WebRtcEndpoint) to process the answer String.
protected String	processOffer(String offer) Orders the internal endpoint (RtpEndpoint or 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() 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.
protected void	resolveCurrentMuteType(MutedMediaType newMuteType)
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.
void	setMuteType(MutedMediaType muteType)
abstract void	unmute() Reconnect the muted media leg(s).
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

Constructor Detail

MediaEndpoint

public MediaEndpoint(boolean web,
             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

isWeb

public boolean isWeb()

getOwner

public Participant getOwner()

Returns:

the user session that created this endpoint

getEndpoint

public org.kurento.client.SdpEndpoint getEndpoint()

Returns:

the internal endpoint (RtpEndpoint or WebRtcEndpoint)

getWebEndpoint

protected org.kurento.client.WebRtcEndpoint getWebEndpoint()

getRtpEndpoint

protected org.kurento.client.RtpEndpoint getRtpEndpoint()

createEndpoint

public org.kurento.client.SdpEndpoint 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

unregisterErrorListeners

public void unregisterErrorListeners()

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

mute

public abstract void mute(MutedMediaType muteType)

Mute the media stream.

Parameters:

muteType - which type of leg to disconnect (audio, video or both)

unmute

public abstract void unmute()

Reconnect the muted media leg(s).

setMuteType

public void setMuteType(MutedMediaType muteType)

getMuteType

public MutedMediaType getMuteType()

resolveCurrentMuteType

protected void resolveCurrentMuteType(MutedMediaType newMuteType)

internalEndpointInitialization

protected void internalEndpointInitialization(CountDownLatch endpointLatch)

Creates the endpoint (RTP or WebRTC) and any other additional elements (if needed).

Parameters:

endpointLatch -

addIceCandidate

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

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

Parameters:

candidate - the remote candidate

Throws:

RoomException

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)
                       throws RoomException

Orders the internal endpoint (RtpEndpoint or WebRtcEndpoint) to process the offer String.

Parameters:

offer - String with the Sdp offer

Returns:

the Sdp answer

Throws:

RoomException

See Also:

SdpEndpoint.processOffer(String)

generateOffer

protected String generateOffer()
                        throws RoomException

Orders the internal endpoint (RtpEndpoint or WebRtcEndpoint) to generate the offer String that can be used to initiate a connection.

Returns:

the Sdp offer

Throws:

RoomException

See Also:

SdpEndpoint.generateOffer()

processAnswer

protected String processAnswer(String answer)
                        throws RoomException

Orders the internal endpoint (RtpEndpoint or WebRtcEndpoint) to process the answer String.

Parameters:

answer - String with the Sdp answer from remote

Returns:

the updated Sdp offer, based on the received answer

Throws:

RoomException

See Also:

SdpEndpoint.processAnswer(String)

registerOnIceCandidateEventListener

protected void registerOnIceCandidateEventListener()
                                            throws RoomException

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.

Throws:

RoomException - if thrown, unable to register the listener

See Also:

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

gatherCandidates

protected void gatherCandidates()
                         throws RoomException

If supported, it instructs the internal endpoint to start gathering IceCandidates.

Throws:

RoomException