Methods Summary |
---|
public int | getDisplayHeight()Return the actual height of the current render video.
|
public int | getDisplayWidth()Return the actual width of the current render video.
|
public int | getDisplayX()Return the X-coordinate of the video with respect
to the GUI object where the video is displayed.
The coordinate is specified in pixel values relative to the
upper left hand corner of the GUI object.
The return value is undefined if initDisplayMode
has not been called.
|
public int | getDisplayY()Return the Y-coordinate of the video with respective
to the GUI object where the video is displayed.
The coordinate is specified in pixel values relative to the
upper left hand corner of the GUI object.
The return value is undefined if initDisplayMode
has not been called.
|
public byte[] | getSnapshot(java.lang.String imageType)Get a snapshot of the displayed content. Features and format
of the captured image are specified by imageType .
Supported formats can be queried from System.getProperty
with
video.snapshot.encodings as the key.
The first format in the supported list is the default capture format.
|
public int | getSourceHeight()Return the height of the source video. The
height must be a positive number.
|
public int | getSourceWidth()Return the width of the source video. The
width must be a positive number.
|
public java.lang.Object | initDisplayMode(int mode, java.lang.Object arg)Initialize the mode on how the video is displayed.
This method must be called before video can be displayed.
Two modes are defined:
On platforms with LCDUI support, both modes must be supported.
|
public void | setDisplayFullScreen(boolean fullScreenMode)Set the size of the render region for the video clip to be
fullscreen. It is left up to the underlying implementation how
fullscreen mode is
implemented and what actual dimensions constitutes fullscreen.
This is useful when the application does not know the actual
width and height dimensions
that are needed to make setDisplaySize(width, height) go to
fullscreen mode.
For example, on a device with a 400 pixel wide by 200 pixel
high screen, a video
clip that is 50 pixels wide by 100 pixels high in fullscreen
mode may be
100 pixels wide by 200 pixels high if the underlying implementation
wants
to preserve the aspect ratio. In this case, an exception
is not thrown.
|
public void | setDisplayLocation(int x, int y)Set the location of the video with respect to
the canvas where the video is displayed.
This method only works when the USE_DIRECT_VIDEO
mode is set. In USE_GUI_PRIMITIVE mode,
this call will be ignored.
The location is specified in pixel values relative to the
upper left hand corner of the GUI object.
By default, video appears at location (0,0).
The location can be given in negative values or can be
greater than the actual size of the canvas. When
that happens, the video should be clipped to the
boundaries of the canvas.
|
public void | setDisplaySize(int width, int height)Resize the video image.
If the video mode is set to USE_DIRECT_VIDEO ,
setting the size of the video will not
affect the size of the GUI object that the video is
displayed.
If the video is scaled to beyond the size of the
GUI object, the video will be clipped.
If the video mode is set to USE_GUI_PRIMITIVE ,
Scaling the video will also scale the GUI object.
The actual scaling algorithm is left up
to the underlying implementation. If
the dimensions of the requested display size are smaller than
the dimensions of the video clip, some implementations may
choose to merely clip the video while other implementations
may resize the video.
If the dimensions of the requested display size are bigger than
the dimensions of the video clip, some implementations may
resize the video while others may leave the video clip in the
original size and just enlarge the display region. It is
left up to the implementation
where the video clip is placed in the display region in this
instance (i.e., it can be in the center of the window or
in a corner of the window).
|
public void | setVisible(boolean visible)Show or hide the video.
If USE_GUI_PRIMITIVE is set, the video by
default is shown when the GUI primitive is displayed.
If USE_DIRECT_VIDEO is set, the video by
default is not shown when the canvas is displayed
until setVisible(true) is called. If
the canvas is removed from the screen, the video
will not be displayed.
|