Java DTV API 1.0
12-Dec-2008

com.sun.dtv.media.format
Interface VideoPresentationControl

All Superinterfaces:
Control
All Known Subinterfaces:
BackgroundVideoPresentationControl

public interface VideoPresentationControl
extends Control

Provides the means to query and manipulate the actual presentation of the Video.


Method Summary
 void addVideoPresentationListener(VideoPresentationListener listener)
          Add a listener to the VideoFormatControl.
 Rectangle getActiveVideoOnScreenRectangle()
          Returns the rectangle of the video that is used on the screen without any areas used letterboxing or pillarboxing are not part of the Rectangle.
 Rectangle getActiveVideoRectangle()
          Returns the rectangle that covers the actual video without any areas used letterboxing or pillarboxing are not part of the Rectangle.
 Dimension getActualVideoSize()
          This method allows the application to query the actual dimension of the presented video, effects like clipping and scaling are taking into account.
 Dimension getDecodedVideoSize()
          Returns the dimension of the size of the decoded video as it is presented to the user.
 float[] getHorizontalScalingFactors()
          Returns the values of the supported discrete horizontal scaling factors.
 Dimension getInputSize()
          Returns the dimension of the video before any scaling.
 Rectangle getTotalVideoRectangle()
          This method returns the entire rectangle used for the video in the broadcast stream.
 float[] getVerticalScalingFactors()
          Returns the values of the supported discrete vertical scaling factors.
 void removeVideoPresentationListener(VideoPresentationListener listener)
          Removes a VideoFormatListener object.
 
Methods inherited from interface javax.media.Control
getControlComponent
 

Method Detail

getActiveVideoRectangle

public Rectangle getActiveVideoRectangle()
Returns the rectangle that covers the actual video without any areas used letterboxing or pillarboxing are not part of the Rectangle. The Rectangle takes the actual scaling into account.

Returns:
rectangle of the actual video

getActiveVideoOnScreenRectangle

public Rectangle getActiveVideoOnScreenRectangle()
Returns the rectangle of the video that is used on the screen without any areas used letterboxing or pillarboxing are not part of the Rectangle. The Rectangle takes the actual scaling into account.

Returns:
rectangle of the video on the screen

getTotalVideoRectangle

public Rectangle getTotalVideoRectangle()
This method returns the entire rectangle used for the video in the broadcast stream. Any scaling is taking into account.

Returns:
rectangle of the video on the screen with letterbox and pillarbox included.

getInputSize

public Dimension getInputSize()
Returns the dimension of the video before any scaling.

Returns:
the dimension of the decoded video

getDecodedVideoSize

public Dimension getDecodedVideoSize()
Returns the dimension of the size of the decoded video as it is presented to the user.

Returns:
the dimension of the video how it is presented to the user

getActualVideoSize

public Dimension getActualVideoSize()
This method allows the application to query the actual dimension of the presented video, effects like clipping and scaling are taking into account.

Returns:
the dimension of the presented video

getHorizontalScalingFactors

public float[] getHorizontalScalingFactors()
Returns the values of the supported discrete horizontal scaling factors.

Returns:
array of float values giving the horizontal scaling factors, including the factor 1.

getVerticalScalingFactors

public float[] getVerticalScalingFactors()
Returns the values of the supported discrete vertical scaling factors.

Returns:
array of float values giving the vertical scaling factors, including the factor 1.

addVideoPresentationListener

public void addVideoPresentationListener(VideoPresentationListener listener)
Add a listener to the VideoFormatControl.

Parameters:
listener - The object implementing the listener interface to be added to the Control.
See Also:
removeVideoPresentationListener(com.sun.dtv.media.format.VideoPresentationListener)

removeVideoPresentationListener

public void removeVideoPresentationListener(VideoPresentationListener listener)
Removes a VideoFormatListener object.

Parameters:
listener - The object to be removed from the Control.
See Also:
addVideoPresentationListener(com.sun.dtv.media.format.VideoPresentationListener)

Java DTV API 1.0
12-Dec-2008

Copyright © 2008 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, California 95054, U.S.A. All rights reserved.

U.S. Government Rights - Commercial software. Government users are subject to the Sun Microsystems, Inc. standard license agreement and applicable provisions of the FAR and its supplements. Sun, Sun Microsystems, the Sun logo and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.Products covered by and information contained in this service manual are controlled by U.S. Export Control laws and may be subject to the export or import laws in other countries. Nuclear, missile, chemical biological weapons or nuclear maritime end uses or end users, whether direct or indirect, are strictly prohibited. Export or reexport to countries subject to U.S. embargo or to entities identified on U.S. export exclusion lists, including, but not limited to, the denied persons and specially designated nationals lists is strictly prohibited.

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.

Use of this document is subject to license terms.