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 VideoPresentationControl.
Rectangle	getActiveVideoOnScreenRectangle() Returns the rectangle of the active video on the screen, letterboxing or pillarboxing are not part of the Rectangle.
Rectangle	getActiveVideoRectangle() Returns the rectangle that covers the active video area, 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.
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 in case no arbitrary horizontal scaling is supported.
Dimension	getInputSize() Returns the dimension of the video before any scaling, clipping and decoding.
Rectangle	getTotalVideoRectangle() This method returns the entire rectangle used for the video in the broadcast stream including bars for letterboxing and pillarboxing (other than getActiveVideoRectangle).
float[]	getVerticalScalingFactors() Returns the values of the supported discrete vertical scaling factors in case no arbitrary vertical scaling is supported.
void	removeVideoPresentationListener(VideoPresentationListener listener) Removes a VideoFormatListener object.

Methods inherited from interface javax.media.Control

getControlComponent

Method Detail

getActiveVideoRectangle

Rectangle getActiveVideoRectangle()

Returns the rectangle that covers the active video area, letterboxing or pillarboxing are not part of the Rectangle. The Rectangle takes the actual scaling into account. The rectangle can be smaller or even larger than the screen, and it may have an offset. This offset can even be negative, if the top left corner of the active video is left and/or top of the screen's top left corner.

Returns:

rectangle of the actual video

getActiveVideoOnScreenRectangle

Rectangle getActiveVideoOnScreenRectangle()

Returns the rectangle of the active video on the screen, letterboxing or pillarboxing are not part of the Rectangle. The Rectangle takes the actual scaling into account. As the rectangle just describes the part of the active video on screen (other than getActiveVideoRectangle), it can just be smaller than the screen, and - if having an offset - this offset is always positive.

Returns:

rectangle of the video on the screen

getTotalVideoRectangle

Rectangle getTotalVideoRectangle()

This method returns the entire rectangle used for the video in the broadcast stream including bars for letterboxing and pillarboxing (other than getActiveVideoRectangle). Any scaling is taking into account. The rectangle can be smaller or even larger than the screen, and it may have an offset. This offset can even be negative, if the top left corner of the active video is left and/or top of the screen's top left corner.

Returns:

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

getInputSize

Dimension getInputSize()

Returns the dimension of the video before any scaling, clipping and decoding.

Returns:

the dimension of the decoded video

getDecodedVideoSize

Dimension getDecodedVideoSize()

Returns the dimension of the size of the decoded video as it is presented to the user. Other than for getInputSize the result takes decoding into account. Scaling and clipping is not taken into account yet.

Returns:

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

getActualVideoSize

Dimension getActualVideoSize()

This method allows the application to query the actual dimension of the presented video. Other than for getDecodedVideoSize the result takes into account not only decoding, but also effects like clipping and scaling.

Returns:

the dimension of the presented video

getHorizontalScalingFactors

float[] getHorizontalScalingFactors()

Returns the values of the supported discrete horizontal scaling factors in case no arbitrary horizontal scaling is supported.

Returns:

array of float values giving the horizontal scaling factors, including the factor 1, if no arbitrary horizontal scaling is supported, otherwise null

getVerticalScalingFactors

float[] getVerticalScalingFactors()

Returns the values of the supported discrete vertical scaling factors in case no arbitrary vertical scaling is supported.

Returns:

array of float values giving the vertical scaling factors, including the factor 1, if no arbitrary vertical scaling is supported, otherwise null

addVideoPresentationListener

void addVideoPresentationListener(VideoPresentationListener listener)

Add a listener to the VideoPresentationControl.

Parameters:

listener - The object implementing the listener interface to be added to the Control.

See Also:

removeVideoPresentationListener(com.sun.dtv.media.format.VideoPresentationListener)

removeVideoPresentationListener

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)