org.kurento.module.pointerdetector

Class PointerDetectorWindowMediaParam

java.lang.Object

org.kurento.module.pointerdetector.PointerDetectorWindowMediaParam

public class PointerDetectorWindowMediaParam
extends Object

Data structure for UI Pointer detection in video streams. All the coordinates are in pixels. X is horizontal, Y is vertical, running from the top of the window. Thus, 0,0 corresponds to the topleft corner.

Constructor Summary

Constructors

Constructor and Description
PointerDetectorWindowMediaParam(String id, int height, int width, int upperRightX, int upperRightY) Create a PointerDetectorWindowMediaParam

Method Summary

Methods

Modifier and Type	Method and Description
String	getActiveImage() get uri of the image to be used when the pointer is inside the window
int	getHeight() get height in pixels
String	getId() get id of the window for pointer detection
String	getImage() get uri of the image to be used for the window.
Float	getImageTransparency() get transparency ratio of the image
int	getUpperRightX() get X coordinate in pixels of the upper left corner
int	getUpperRightY() get Y coordinate in pixels of the upper left corner
int	getWidth() get width in pixels
void	setActiveImage(String activeImage) set uri of the image to be used when the pointer is inside the window
void	setHeight(int height) set height in pixels
void	setId(String id) set id of the window for pointer detection
void	setImage(String image) set uri of the image to be used for the window.
void	setImageTransparency(Float imageTransparency) set transparency ratio of the image
void	setUpperRightX(int upperRightX) set X coordinate in pixels of the upper left corner
void	setUpperRightY(int upperRightY) set Y coordinate in pixels of the upper left corner
void	setWidth(int width) set width in pixels

Methods inherited from class java.lang.Object

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

Constructor Detail

PointerDetectorWindowMediaParam

public PointerDetectorWindowMediaParam(String id,
                               int height,
                               int width,
                               int upperRightX,
                               int upperRightY)

Create a PointerDetectorWindowMediaParam

Method Detail

getId

public String getId()

get id of the window for pointer detection

setId

public void setId(String id)

set id of the window for pointer detection

getHeight

public int getHeight()

get height in pixels

setHeight

public void setHeight(int height)

set height in pixels

getWidth

public int getWidth()

get width in pixels

setWidth

public void setWidth(int width)

set width in pixels

getUpperRightX

public int getUpperRightX()

get X coordinate in pixels of the upper left corner

setUpperRightX

public void setUpperRightX(int upperRightX)

set X coordinate in pixels of the upper left corner

getUpperRightY

public int getUpperRightY()

get Y coordinate in pixels of the upper left corner

setUpperRightY

public void setUpperRightY(int upperRightY)

set Y coordinate in pixels of the upper left corner

getActiveImage

public String getActiveImage()

get uri of the image to be used when the pointer is inside the window

setActiveImage

public void setActiveImage(String activeImage)

set uri of the image to be used when the pointer is inside the window

getImageTransparency

public Float getImageTransparency()

get transparency ratio of the image

setImageTransparency

public void setImageTransparency(Float imageTransparency)

set transparency ratio of the image

getImage

public String getImage()

get uri of the image to be used for the window. If activeImage has been set, it will only be shown when the pointer is outside of the window.

setImage

public void setImage(String image)

set uri of the image to be used for the window. If activeImage has been set, it will only be shown when the pointer is outside of the window.