org.kurento.room.endpoint

Class PublisherEndpoint

java.lang.Object

org.kurento.room.endpoint.IceWebRtcEndpoint

org.kurento.room.endpoint.PublisherEndpoint

All Implemented Interfaces:

MediaShapingEndpoint

public class PublisherEndpoint
extends IceWebRtcEndpoint
implements MediaShapingEndpoint

Publisher aspect of the TrickleIceEndpoint.

Author:

Radu Tom Vlad

Field Summary

Fields inherited from class org.kurento.room.endpoint.IceWebRtcEndpoint

endpoint

Constructor Summary

Constructors

Constructor and Description
PublisherEndpoint(Participant owner, String endpointName, org.kurento.client.MediaPipeline pipeline)

Method Summary

Methods

Modifier and Type	Method and Description
String	apply(org.kurento.client.MediaElement shaper) Changes the media passing through a chain of media elements by applying the specified element/shaper.
void	connect(org.kurento.client.MediaElement other)
Collection<org.kurento.client.MediaElement>	getMediaElements()
protected void	internalEndpointInitialization(CountDownLatch endpointLatch) Create the endpoint and any other additional elements (if needed).
String	publish(String sdpOffer, boolean doLoopback) Initializes this WebRtcEndpoint for publishing media.
void	revert(org.kurento.client.MediaElement shaper) Removes the media element object found from the media chain structure.
void	unregisterErrorListeners() Unregisters all error listeners created for media elements owned by this instance.

Methods inherited from class org.kurento.room.endpoint.IceWebRtcEndpoint

addIceCandidate, createEndpoint, gatherCandidates, getEndpoint, getEndpointName, getOwner, getPipeline, processOffer, registerElemErrListener, registerOnIceCandidateEventListener, setEndpointName, setMediaPipeline, unregisterElementErrListener

Methods inherited from class java.lang.Object

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

Constructor Detail

PublisherEndpoint

public PublisherEndpoint(Participant owner,
                 String endpointName,
                 org.kurento.client.MediaPipeline pipeline)

Method Detail

internalEndpointInitialization

protected void internalEndpointInitialization(CountDownLatch endpointLatch)

Description copied from class: IceWebRtcEndpoint

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

Overrides:

internalEndpointInitialization in class IceWebRtcEndpoint

unregisterErrorListeners

public void unregisterErrorListeners()

Description copied from class: IceWebRtcEndpoint

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

Overrides:

unregisterErrorListeners in class IceWebRtcEndpoint

getMediaElements

public Collection<org.kurento.client.MediaElement> getMediaElements()

Returns:

all media elements created for this publisher, except for the main element (WebRtcEndpoint)

publish

public String publish(String sdpOffer,
             boolean doLoopback)

Initializes this WebRtcEndpoint for publishing media. Registers an event listener for the ICE candidates, instructs the endpoint to start gathering the candidates and processes the SDP offer. If required, it connects to itself (after applying the intermediate media elements and the PassThrough) to allow loopback of the media stream.

Parameters:

sdpOffer - offer from the remote peer

doLoopback - loopback flag

Returns:

the SDP answer

connect

public void connect(org.kurento.client.MediaElement other)

apply

public String apply(org.kurento.client.MediaElement shaper)
             throws RoomException

Description copied from interface: MediaShapingEndpoint

Changes the media passing through a chain of media elements by applying the specified element/shaper. The element is plugged into the stream only if the chain has been initialized (a.k.a. media streaming has started), otherwise it is left ready for when the connections between elements will materialize and the streaming begins.

Specified by:

apply in interface MediaShapingEndpoint

Parameters:

shaper - MediaElement that will be linked to the end of the chain (e.g. a filter)

Returns:

the element's id

Throws:

RoomException - if thrown, the media element was not added

revert

public void revert(org.kurento.client.MediaElement shaper)
            throws RoomException

Description copied from interface: MediaShapingEndpoint

Removes the media element object found from the media chain structure. The object is released. If the chain is connected, both adjacent remaining elements will be interconnected.

Specified by:

revert in interface MediaShapingEndpoint

Parameters:

shaper - MediaElement that will be removed from the chain

Throws:

RoomException - if thrown, the media element was not removed