org.kurento.client

Interface MediaObject

All Superinterfaces:

KurentoObject

All Known Subinterfaces:

AlphaBlending, BaseRtpEndpoint, Composite, Dispatcher, DispatcherOneToMany, Endpoint, FaceOverlayFilter, Filter, GStreamerFilter, HttpEndpoint, HttpPostEndpoint, Hub, HubPort, ImageOverlayFilter, MediaElement, MediaPipeline, Mixer, OpenCVFilter, PassThrough, PlayerEndpoint, RecorderEndpoint, RtpEndpoint, SdpEndpoint, ServerManager, SessionEndpoint, UriEndpoint, WebRtcEndpoint, ZBarFilter

public interface MediaObject
extends KurentoObject

Base for all objects that can be created in the media server.

Method Summary

Methods

Modifier and Type	Method and Description
ListenerSubscription	addErrorListener(EventListener<ErrorEvent> listener) Add a EventListener for event ErrorEvent.
void	addErrorListener(EventListener<ErrorEvent> listener, Continuation<ListenerSubscription> cont) Add a EventListener for event ErrorEvent.
void	addTag(String key, String value) Request a SessionSpec offer.
void	addTag(String key, String value, Continuation<Void> cont) Asynchronous version of addTag: Continuation.onSuccess(F) is called when the action is done.
void	addTag(Transaction tx, String key, String value) Request a SessionSpec offer.
List<MediaObject>	getChilds()
void	getChilds(Continuation<List<MediaObject>> cont)
TFuture<List<MediaObject>>	getChilds(Transaction tx)
int	getCreationTime()
void	getCreationTime(Continuation<Integer> cont)
TFuture<Integer>	getCreationTime(Transaction tx)
String	getId()
void	getId(Continuation<String> cont)
TFuture<String>	getId(Transaction tx)
MediaPipeline	getMediaPipeline()
void	getMediaPipeline(Continuation<MediaPipeline> cont)
TFuture<MediaPipeline>	getMediaPipeline(Transaction tx)
String	getName()
void	getName(Continuation<String> cont)
TFuture<String>	getName(Transaction tx)
MediaObject	getParent()
void	getParent(Continuation<MediaObject> cont)
TFuture<MediaObject>	getParent(Transaction tx)
boolean	getSendTagsInEvents()
void	getSendTagsInEvents(Continuation<Boolean> cont)
TFuture<Boolean>	getSendTagsInEvents(Transaction tx)
String	getTag(String key) Returns the value associated to the given key.
void	getTag(String key, Continuation<String> cont) Asynchronous version of getTag: Continuation.onSuccess(F) is called when the action is done.
TFuture<String>	getTag(Transaction tx, String key) Returns the value associated to the given key.
List<Tag>	getTags() Returns all the MediaObject tags.
void	getTags(Continuation<List<Tag>> cont) Asynchronous version of getTags: Continuation.onSuccess(F) is called when the action is done.
TFuture<List<Tag>>	getTags(Transaction tx) Returns all the MediaObject tags.
void	removeErrorListener(ListenerSubscription listenerSubscription) Remove a ListenerSubscription for event ErrorEvent.
void	removeErrorListener(ListenerSubscription listenerSubscription, Continuation<Void> cont) Remove a ListenerSubscription for event ErrorEvent.
void	removeTag(String key) Remove the tag (key and value) associated to a tag
void	removeTag(String key, Continuation<Void> cont) Asynchronous version of removeTag: Continuation.onSuccess(F) is called when the action is done.
void	removeTag(Transaction tx, String key) Remove the tag (key and value) associated to a tag
void	setName(String name)
void	setName(String name, Continuation<Void> cont)
void	setName(String name, Transaction tx)
void	setSendTagsInEvents(boolean sendTagsInEvents)
void	setSendTagsInEvents(boolean sendTagsInEvents, Continuation<Void> cont)
void	setSendTagsInEvents(boolean sendTagsInEvents, Transaction tx)

Methods inherited from interface org.kurento.client.KurentoObject

isCommited, release, release, release, waitCommited, whenCommited, whenCommited

Method Detail

getMediaPipeline

MediaPipeline getMediaPipeline()

getMediaPipeline

void getMediaPipeline(Continuation<MediaPipeline> cont)

getMediaPipeline

TFuture<MediaPipeline> getMediaPipeline(Transaction tx)

getParent

MediaObject getParent()

getParent

void getParent(Continuation<MediaObject> cont)

getParent

TFuture<MediaObject> getParent(Transaction tx)

getId

String getId()

Specified by:

getId in interface KurentoObject

getId

void getId(Continuation<String> cont)

getId

TFuture<String> getId(Transaction tx)

getChilds

List<MediaObject> getChilds()

getChilds

void getChilds(Continuation<List<MediaObject>> cont)

getChilds

TFuture<List<MediaObject>> getChilds(Transaction tx)

getName

String getName()

getName

void getName(Continuation<String> cont)

getName

TFuture<String> getName(Transaction tx)

setName

void setName(String name)

setName

void setName(String name,
           Continuation<Void> cont)

setName

void setName(String name,
           Transaction tx)

getSendTagsInEvents

boolean getSendTagsInEvents()

getSendTagsInEvents

void getSendTagsInEvents(Continuation<Boolean> cont)

getSendTagsInEvents

TFuture<Boolean> getSendTagsInEvents(Transaction tx)

setSendTagsInEvents

void setSendTagsInEvents(boolean sendTagsInEvents)

setSendTagsInEvents

void setSendTagsInEvents(boolean sendTagsInEvents,
                       Continuation<Void> cont)

setSendTagsInEvents

void setSendTagsInEvents(boolean sendTagsInEvents,
                       Transaction tx)

getCreationTime

int getCreationTime()

getCreationTime

void getCreationTime(Continuation<Integer> cont)

getCreationTime

TFuture<Integer> getCreationTime(Transaction tx)

addTag

void addTag(String key,
          String value)

Request a SessionSpec offer. This can be used to initiate a connection.

Parameters:

key - Key of the tag

value - Value of the tag

addTag

void addTag(String key,
          String value,
          Continuation<Void> cont)

Asynchronous version of addTag: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.

Parameters:

key - Key of the tag

value - Value of the tag

See Also:

addTag(java.lang.String, java.lang.String)

addTag

void addTag(Transaction tx,
          String key,
          String value)

Request a SessionSpec offer. This can be used to initiate a connection.

Parameters:

key - Key of the tag

value - Value of the tag

removeTag

void removeTag(String key)

Remove the tag (key and value) associated to a tag

Parameters:

key - Key of the tag to remove

removeTag

void removeTag(String key,
             Continuation<Void> cont)

Asynchronous version of removeTag: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.

Parameters:

key - Key of the tag to remove

See Also:

removeTag(java.lang.String)

removeTag

void removeTag(Transaction tx,
             String key)

Remove the tag (key and value) associated to a tag

Parameters:

key - Key of the tag to remove

getTag

String getTag(String key)

Returns the value associated to the given key.

Parameters:

key - Tag key.

Returns:

The value associated to the given key. *

getTag

void getTag(String key,
          Continuation<String> cont)

Asynchronous version of getTag: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.

Parameters:

key - Tag key.

See Also:

getTag(java.lang.String)

getTag

TFuture<String> getTag(Transaction tx,
                     String key)

Returns the value associated to the given key.

Parameters:

key - Tag key.

Returns:

The value associated to the given key. *

getTags

List<Tag> getTags()

Returns all the MediaObject tags.

Returns:

An array containing all pairs key-value associated to the MediaObject. *

getTags

void getTags(Continuation<List<Tag>> cont)

Asynchronous version of getTags: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.

See Also:

getTags()

getTags

TFuture<List<Tag>> getTags(Transaction tx)

Returns all the MediaObject tags.

Returns:

An array containing all pairs key-value associated to the MediaObject. *

addErrorListener

ListenerSubscription addErrorListener(EventListener<ErrorEvent> listener)

Add a EventListener for event ErrorEvent. Synchronous call.

Parameters:

listener - Listener to be called on ErrorEvent

Returns:

ListenerSubscription for the given Listener

addErrorListener

void addErrorListener(EventListener<ErrorEvent> listener,
                    Continuation<ListenerSubscription> cont)

Add a EventListener for event ErrorEvent. Asynchronous call. Calls Continuation<ListenerSubscription> when it has been added.

Parameters:

listener - Listener to be called on ErrorEvent

cont - Continuation to be called when the listener is registered

removeErrorListener

void removeErrorListener(ListenerSubscription listenerSubscription)

Remove a ListenerSubscription for event ErrorEvent. Synchronous call.

Parameters:

listenerSubscription - Listener subscription to be removed

removeErrorListener

void removeErrorListener(ListenerSubscription listenerSubscription,
                       Continuation<Void> cont)

Remove a ListenerSubscription for event ErrorEvent. Asynchronous call. Calls Continuation<Void> when it has been removed.

Parameters:

listenerSubscription - Listener subscription to be removed

cont - Continuation to be called when the listener is removed