org.kurento.room.endpoint

Class PublisherEndpoint

java.lang.Object

org.kurento.room.endpoint.MediaEndpoint

org.kurento.room.endpoint.PublisherEndpoint

public class PublisherEndpoint
extends MediaEndpoint

Publisher aspect of the MediaEndpoint.

Author:

Radu Tom Vlad

Constructor Summary

Constructors

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

Method Summary

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.
String	apply(org.kurento.client.MediaElement shaper, org.kurento.client.MediaType type) Same as apply(MediaElement), can specify the media type that will be streamed through the shaper element.
void	connect(org.kurento.client.MediaElement sink)
void	connect(org.kurento.client.MediaElement sink, org.kurento.client.MediaType type)
void	disconnectFrom(org.kurento.client.MediaElement sink)
void	disconnectFrom(org.kurento.client.MediaElement sink, org.kurento.client.MediaType type)
Collection<org.kurento.client.MediaElement>	getMediaElements()
protected void	internalEndpointInitialization(CountDownLatch endpointLatch) Creates the endpoint (RTP or WebRTC) and any other additional elements (if needed).
void	mute(MutedMediaType muteType) Mute the media stream.
String	preparePublishConnection()
String	publish(SdpType sdpType, String sdpString, boolean doLoopback, org.kurento.client.MediaElement loopbackAlternativeSrc, org.kurento.client.MediaType loopbackConnectionType) Initializes this media endpoint for publishing media and processes the SDP offer or answer.
void	revert(org.kurento.client.MediaElement shaper) Removes the media element object found from the media chain structure.
void	unmute() Reconnect the muted media leg(s).
void	unregisterErrorListeners() Unregisters all error listeners created for media elements owned by this instance.

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

addIceCandidate, createEndpoint, gatherCandidates, generateOffer, getEndpoint, getEndpointName, getMuteType, getOwner, getPipeline, getRtpEndpoint, getWebEndpoint, isWeb, processAnswer, processOffer, registerElemErrListener, registerOnIceCandidateEventListener, resolveCurrentMuteType, setEndpointName, setMediaPipeline, setMuteType, unregisterElementErrListener

Methods inherited from class java.lang.Object

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

Constructor Detail

PublisherEndpoint

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

Method Detail

internalEndpointInitialization

protected void internalEndpointInitialization(CountDownLatch endpointLatch)

Description copied from class: MediaEndpoint

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

Overrides:

internalEndpointInitialization in class MediaEndpoint

unregisterErrorListeners

public void unregisterErrorListeners()

Description copied from class: MediaEndpoint

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

Overrides:

unregisterErrorListeners in class MediaEndpoint

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(SdpType sdpType,
                      String sdpString,
                      boolean doLoopback,
                      org.kurento.client.MediaElement loopbackAlternativeSrc,
                      org.kurento.client.MediaType loopbackConnectionType)

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

Parameters:

sdpType - indicates the type of the sdpString (offer or answer)

sdpString - offer or answer from the remote peer

doLoopback - loopback flag

loopbackAlternativeSrc - alternative loopback source

loopbackConnectionType - how to connect the loopback source

Returns:

the SDP response (the answer if processing an offer SDP, otherwise is the updated offer generated previously by this endpoint)

preparePublishConnection

public String preparePublishConnection()

connect

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

connect

public void connect(org.kurento.client.MediaElement sink,
                    org.kurento.client.MediaType type)

disconnectFrom

public void disconnectFrom(org.kurento.client.MediaElement sink)

disconnectFrom

public void disconnectFrom(org.kurento.client.MediaElement sink,
                           org.kurento.client.MediaType type)

apply

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

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.

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

apply

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

Same as apply(MediaElement), can specify the media type that will be streamed through the shaper element.

Parameters:

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

type - indicates which type of media will be connected to the shaper (MediaType), if null then the connection is mixed

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

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.

Parameters:

shaper - MediaElement that will be removed from the chain

Throws:

RoomException - if thrown, the media element was not removed

mute

public void mute(MutedMediaType muteType)

Description copied from class: MediaEndpoint

Mute the media stream.

Specified by:

mute in class MediaEndpoint

Parameters:

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

unmute

public void unmute()

Description copied from class: MediaEndpoint

Reconnect the muted media leg(s).

Specified by:

unmute in class MediaEndpoint