Java DTV API 1.3
18-Nov-2009

com.sun.dtv.media.format
Interface VideoFormatControl

All Superinterfaces:
Control

public interface VideoFormatControl
extends Control

Provides the means to retrieve informations about the format and aspect ratio of the video.


Field Summary
static int AF_149_CENTRAL
          Constant representing an active format description of 14:9 (central).
static int AF_169_CENTRAL
          Constant representing an active format description of 16:9 (central).
static int AF_169_SHOOT_149_CENTRAL
          Constant representing an active format description of 16:9 (with shoot & protect 14:9 central).
static int AF_169_SHOOT_43_CENTRAL
          Constant representing an active format description of 16:9 (with shoot & protect 4:3 central).
static int AF_43_CENTRAL
          Constant representing an active format description of 4:3 (central).
static int AF_43_SHOOT_149_CENTRAL
          Constant representing an active format description of 4:3 (with shoot & protect 14:9 central).
static int AF_AS_THE_CODED_FRAME
          Constant representing an active format as the coded frame.
static int AF_BOX_149_UPPER
          Constant representing an active format description of Box 14:9 (upper).
static int AF_BOX_169_CENTRAL
          Constant representing an active format description of Box > 16:9 (central).
static int AF_BOX_169_UPPER
          Constant representing an active format description of Box 16:9 (upper).
static int AF_NOT_PRESENT
          Constant representing a not present active format description.
static int ASPECT_RATIO_169
          The 16x9 aspect ratio.
static int ASPECT_RATIO_43
          The 4x3 aspect ratio.
static int ASPECT_RATIO_NOT_PRESENT
          No aspect ratio not known.
static int DF_CENTER
          Constant representing a decoder format description of center (only the central part of the 16:9 video will be displayed on a 4:3 frame.
static int DF_FULL
          Constant representing a decoder format description of fullscreen.
static int DF_LETTERBOX
          Constant representing a decoder format description of letterbox (the full 16:9 video will be displayed in the central part of a 4:3 frame black bars on top and bottom of the frame.
static int DF_NOT_PRESENT
          Constant representing a not present decoder format description.
static int DF_PANSCAN
          Constant representing a decoder format description of pan scan (only the central part of the 16:9 video will be displayed on a 4:3 frame using pan scan vectors).
static int DF_SYSTEM
          Constant representing that the decoder format description is set by the system.
static int DF_ZOOM
          Constant representing a decoder format description of zoom (only the central part of the 4:3 video will be displayed on a 16:9 frame.
 
Method Summary
 void addVideoFormatListener(VideoFormatListener listener)
          Add a listener to the VideoFormatControl.
 int getActiveFormatDefinition()
          Gives the active_format of the Active Format Description (in ABNT NBR 15602-1:2007) if present as one of the defined AFD constant values.
 int getAspectRatio()
          Gives the aspect ratio defined for the media under the control of this Player as it is displayed, i.e. after all transformations have been applied to it.
 int getDecoderFormatDefinition()
          Gives the actual format definition that is currently used by the decoder.
 int getOriginalAspectRatio()
          Gives the original aspect ratio defined for the media (as it has been transmitted).
 Transformation getTransformation(int decoderFormatConversion)
          Returns the Transformation that describes the given decoder format conversion.
 void removeVideoFormatListener(VideoFormatListener listener)
          Removes a VideoFormatListener object.
 
Methods inherited from interface javax.media.Control
getControlComponent
 

Field Detail

ASPECT_RATIO_43

static final int ASPECT_RATIO_43
The 4x3 aspect ratio.

See Also:
Constant Field Values

ASPECT_RATIO_169

static final int ASPECT_RATIO_169
The 16x9 aspect ratio.

See Also:
Constant Field Values

ASPECT_RATIO_NOT_PRESENT

static final int ASPECT_RATIO_NOT_PRESENT
No aspect ratio not known.

See Also:
Constant Field Values

AF_NOT_PRESENT

static final int AF_NOT_PRESENT
Constant representing a not present active format description.

See Also:
Constant Field Values

AF_BOX_169_UPPER

static final int AF_BOX_169_UPPER
Constant representing an active format description of Box 16:9 (upper).

See Also:
Constant Field Values

AF_BOX_149_UPPER

static final int AF_BOX_149_UPPER
Constant representing an active format description of Box 14:9 (upper).

See Also:
Constant Field Values

AF_BOX_169_CENTRAL

static final int AF_BOX_169_CENTRAL
Constant representing an active format description of Box > 16:9 (central).

See Also:
Constant Field Values

AF_AS_THE_CODED_FRAME

static final int AF_AS_THE_CODED_FRAME
Constant representing an active format as the coded frame.

See Also:
Constant Field Values

AF_43_CENTRAL

static final int AF_43_CENTRAL
Constant representing an active format description of 4:3 (central).

See Also:
Constant Field Values

AF_169_CENTRAL

static final int AF_169_CENTRAL
Constant representing an active format description of 16:9 (central).

See Also:
Constant Field Values

AF_149_CENTRAL

static final int AF_149_CENTRAL
Constant representing an active format description of 14:9 (central).

See Also:
Constant Field Values

AF_43_SHOOT_149_CENTRAL

static final int AF_43_SHOOT_149_CENTRAL
Constant representing an active format description of 4:3 (with shoot & protect 14:9 central).

See Also:
Constant Field Values

AF_169_SHOOT_149_CENTRAL

static final int AF_169_SHOOT_149_CENTRAL
Constant representing an active format description of 16:9 (with shoot & protect 14:9 central).

See Also:
Constant Field Values

AF_169_SHOOT_43_CENTRAL

static final int AF_169_SHOOT_43_CENTRAL
Constant representing an active format description of 16:9 (with shoot & protect 4:3 central).

See Also:
Constant Field Values

DF_NOT_PRESENT

static final int DF_NOT_PRESENT
Constant representing a not present decoder format description.

See Also:
Constant Field Values

DF_SYSTEM

static final int DF_SYSTEM
Constant representing that the decoder format description is set by the system.

See Also:
Constant Field Values

DF_FULL

static final int DF_FULL
Constant representing a decoder format description of fullscreen.

See Also:
Constant Field Values

DF_LETTERBOX

static final int DF_LETTERBOX
Constant representing a decoder format description of letterbox (the full 16:9 video will be displayed in the central part of a 4:3 frame black bars on top and bottom of the frame.

See Also:
Constant Field Values

DF_ZOOM

static final int DF_ZOOM
Constant representing a decoder format description of zoom (only the central part of the 4:3 video will be displayed on a 16:9 frame.

See Also:
Constant Field Values

DF_CENTER

static final int DF_CENTER
Constant representing a decoder format description of center (only the central part of the 16:9 video will be displayed on a 4:3 frame.

See Also:
Constant Field Values

DF_PANSCAN

static final int DF_PANSCAN
Constant representing a decoder format description of pan scan (only the central part of the 16:9 video will be displayed on a 4:3 frame using pan scan vectors).

See Also:
Constant Field Values
Method Detail

getAspectRatio

int getAspectRatio()
Gives the aspect ratio defined for the media under the control of this Player as it is displayed, i.e. after all transformations have been applied to it.

Returns:
One of the ASPECT_RATIO_* constant values defined in this interface that indicates the aspect ratio of the media as it is displayed.

getOriginalAspectRatio

int getOriginalAspectRatio()
Gives the original aspect ratio defined for the media (as it has been transmitted).

Returns:
One of the ASPECT_RATIO_* constant values defined in this interface that indicates the aspect ratio of the media as originally transmitted.

getActiveFormatDefinition

int getActiveFormatDefinition()
Gives the active_format of the Active Format Description (in ABNT NBR 15602-1:2007) if present as one of the defined AFD constant values.

Returns:
one of the AF_ constant value.

getDecoderFormatDefinition

int getDecoderFormatDefinition()
Gives the actual format definition that is currently used by the decoder.

Returns:
one of the DF_ constant values

getTransformation

Transformation getTransformation(int decoderFormatConversion)
Returns the Transformation that describes the given decoder format conversion.

Parameters:
decoderFormatConversion - one of the DF_ constants values.
Returns:
Transformation for the given deciderFormatConversion (one of the DF constants) or null if this format conversion is not available.

addVideoFormatListener

void addVideoFormatListener(VideoFormatListener listener)
Add a listener to the VideoFormatControl.

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

removeVideoFormatListener

void removeVideoFormatListener(VideoFormatListener listener)
Removes a VideoFormatListener object.

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

Java DTV API 1.3
18-Nov-2009

Copyright © 2008-2009 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.