org.kurento.module.pointerdetector

Interface PointerDetectorFilter

All Superinterfaces:

org.kurento.client.Filter, org.kurento.client.KurentoObject, org.kurento.client.MediaElement, org.kurento.client.MediaObject

public interface PointerDetectorFilter
extends org.kurento.client.Filter

This type of Filter detects UI pointers in a video feed.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PointerDetectorFilter.Builder

Method Summary

Methods

Modifier and Type	Method and Description
void	addWindow(PointerDetectorWindowMediaParam window) Adds a new detection window for the filter to detect pointers entering or exiting the window
void	addWindow(PointerDetectorWindowMediaParam window, org.kurento.client.Continuation<Void> cont) Asynchronous version of addWindow: Continuation.onSuccess(F) is called when the action is done.
void	addWindow(org.kurento.client.Transaction tx, PointerDetectorWindowMediaParam window) Adds a new detection window for the filter to detect pointers entering or exiting the window
org.kurento.client.ListenerSubscription	addWindowInListener(org.kurento.client.EventListener<WindowInEvent> listener) Add a EventListener for event WindowInEvent.
void	addWindowInListener(org.kurento.client.EventListener<WindowInEvent> listener, org.kurento.client.Continuation<org.kurento.client.ListenerSubscription> cont) Add a EventListener for event WindowInEvent.
org.kurento.client.ListenerSubscription	addWindowOutListener(org.kurento.client.EventListener<WindowOutEvent> listener) Add a EventListener for event WindowOutEvent.
void	addWindowOutListener(org.kurento.client.EventListener<WindowOutEvent> listener, org.kurento.client.Continuation<org.kurento.client.ListenerSubscription> cont) Add a EventListener for event WindowOutEvent.
void	clearWindows() Removes all pointer detector windows
void	clearWindows(org.kurento.client.Continuation<Void> cont) Asynchronous version of clearWindows: Continuation.onSuccess(F) is called when the action is done.
void	clearWindows(org.kurento.client.Transaction tx) Removes all pointer detector windows
void	removeWindow(String windowId) Removes a window from the list to be monitored
void	removeWindow(String windowId, org.kurento.client.Continuation<Void> cont) Asynchronous version of removeWindow: Continuation.onSuccess(F) is called when the action is done.
void	removeWindow(org.kurento.client.Transaction tx, String windowId) Removes a window from the list to be monitored
void	removeWindowInListener(org.kurento.client.ListenerSubscription listenerSubscription) Remove a ListenerSubscription for event WindowInEvent.
void	removeWindowInListener(org.kurento.client.ListenerSubscription listenerSubscription, org.kurento.client.Continuation<Void> cont) Remove a ListenerSubscription for event WindowInEvent.
void	removeWindowOutListener(org.kurento.client.ListenerSubscription listenerSubscription) Remove a ListenerSubscription for event WindowOutEvent.
void	removeWindowOutListener(org.kurento.client.ListenerSubscription listenerSubscription, org.kurento.client.Continuation<Void> cont) Remove a ListenerSubscription for event WindowOutEvent.
void	trackColorFromCalibrationRegion() This method allows to calibrate the tracking color.
void	trackColorFromCalibrationRegion(org.kurento.client.Continuation<Void> cont) Asynchronous version of trackColorFromCalibrationRegion: Continuation.onSuccess(F) is called when the action is done.
void	trackColorFromCalibrationRegion(org.kurento.client.Transaction tx) This method allows to calibrate the tracking color.

Methods inherited from interface org.kurento.client.MediaElement

addElementConnectedListener, addElementConnectedListener, addElementDisconnectedListener, addElementDisconnectedListener, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, removeElementConnectedListener, removeElementConnectedListener, removeElementDisconnectedListener, removeElementDisconnectedListener, setAudioFormat, setAudioFormat, setAudioFormat, setOutputBitrate, setOutputBitrate, setOutputBitrate, setVideoFormat, setVideoFormat, setVideoFormat

Methods inherited from interface org.kurento.client.MediaObject

addErrorListener, addErrorListener, addTag, addTag, addTag, getChilds, getChilds, getChilds, getCreationTime, getCreationTime, getCreationTime, getId, getId, getId, getMediaPipeline, getMediaPipeline, getMediaPipeline, getName, getName, getName, getParent, getParent, getParent, getSendTagsInEvents, getSendTagsInEvents, getSendTagsInEvents, getTag, getTag, getTag, getTags, getTags, getTags, removeErrorListener, removeErrorListener, removeTag, removeTag, removeTag, setName, setName, setName, setSendTagsInEvents, setSendTagsInEvents, setSendTagsInEvents

Methods inherited from interface org.kurento.client.KurentoObject

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

Method Detail

addWindow

void addWindow(PointerDetectorWindowMediaParam window)

Adds a new detection window for the filter to detect pointers entering or exiting the window

Parameters:

window - The window to be added

addWindow

void addWindow(PointerDetectorWindowMediaParam window,
             org.kurento.client.Continuation<Void> cont)

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

Parameters:

window - The window to be added

See Also:

addWindow(org.kurento.module.pointerdetector.PointerDetectorWindowMediaParam)

addWindow

void addWindow(org.kurento.client.Transaction tx,
             PointerDetectorWindowMediaParam window)

Adds a new detection window for the filter to detect pointers entering or exiting the window

Parameters:

window - The window to be added

clearWindows

void clearWindows()

Removes all pointer detector windows

clearWindows

void clearWindows(org.kurento.client.Continuation<Void> cont)

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

See Also:

clearWindows()

clearWindows

void clearWindows(org.kurento.client.Transaction tx)

Removes all pointer detector windows

trackColorFromCalibrationRegion

void trackColorFromCalibrationRegion()

This method allows to calibrate the tracking color. The new tracking color will be the color of the object in the colorCalibrationRegion.

trackColorFromCalibrationRegion

void trackColorFromCalibrationRegion(org.kurento.client.Continuation<Void> cont)

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

See Also:

trackColorFromCalibrationRegion()

trackColorFromCalibrationRegion

void trackColorFromCalibrationRegion(org.kurento.client.Transaction tx)

This method allows to calibrate the tracking color. The new tracking color will be the color of the object in the colorCalibrationRegion.

removeWindow

void removeWindow(String windowId)

Removes a window from the list to be monitored

Parameters:

windowId - the id of the window to be removed

removeWindow

void removeWindow(String windowId,
                org.kurento.client.Continuation<Void> cont)

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

Parameters:

windowId - the id of the window to be removed

See Also:

removeWindow(java.lang.String)

removeWindow

void removeWindow(org.kurento.client.Transaction tx,
                String windowId)

Removes a window from the list to be monitored

Parameters:

windowId - the id of the window to be removed

addWindowInListener

org.kurento.client.ListenerSubscription addWindowInListener(org.kurento.client.EventListener<WindowInEvent> listener)

Add a EventListener for event WindowInEvent. Synchronous call.

Parameters:

listener - Listener to be called on WindowInEvent

Returns:

ListenerSubscription for the given Listener

addWindowInListener

void addWindowInListener(org.kurento.client.EventListener<WindowInEvent> listener,
                       org.kurento.client.Continuation<org.kurento.client.ListenerSubscription> cont)

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

Parameters:

listener - Listener to be called on WindowInEvent

cont - Continuation to be called when the listener is registered

removeWindowInListener

void removeWindowInListener(org.kurento.client.ListenerSubscription listenerSubscription)

Remove a ListenerSubscription for event WindowInEvent. Synchronous call.

Parameters:

listenerSubscription - Listener subscription to be removed

removeWindowInListener

void removeWindowInListener(org.kurento.client.ListenerSubscription listenerSubscription,
                          org.kurento.client.Continuation<Void> cont)

Remove a ListenerSubscription for event WindowInEvent. 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

addWindowOutListener

org.kurento.client.ListenerSubscription addWindowOutListener(org.kurento.client.EventListener<WindowOutEvent> listener)

Add a EventListener for event WindowOutEvent. Synchronous call.

Parameters:

listener - Listener to be called on WindowOutEvent

Returns:

ListenerSubscription for the given Listener

addWindowOutListener

void addWindowOutListener(org.kurento.client.EventListener<WindowOutEvent> listener,
                        org.kurento.client.Continuation<org.kurento.client.ListenerSubscription> cont)

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

Parameters:

listener - Listener to be called on WindowOutEvent

cont - Continuation to be called when the listener is registered

removeWindowOutListener

void removeWindowOutListener(org.kurento.client.ListenerSubscription listenerSubscription)

Remove a ListenerSubscription for event WindowOutEvent. Synchronous call.

Parameters:

listenerSubscription - Listener subscription to be removed

removeWindowOutListener

void removeWindowOutListener(org.kurento.client.ListenerSubscription listenerSubscription,
                           org.kurento.client.Continuation<Void> cont)

Remove a ListenerSubscription for event WindowOutEvent. 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