org.kurento.room.endpoint

Interface MediaShapingEndpoint

All Known Implementing Classes:

PublisherEndpoint

public interface MediaShapingEndpoint

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

Author:

Radu Tom Vlad

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	revert(org.kurento.client.MediaElement shaper) Removes the media element object found from the media chain structure.

Method Detail

apply

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

revert

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