Overview  Package   Class  Use  Deprecated  Index  Help 
Java DTV API 1.0
12-Dec-2008
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.sun.dtv.media.text
Interface OverlayTextControl

All Superinterfaces:
Control, LanguageControl
public interface OverlayTextControl
extends LanguageControl

Interface to provide control for "Subtitles" and "Closed Captioning". This generic interface allows to manipulate and request status information about the two types of overlay or superimposed text. It shall be available when the OverlayText informations is present in the media.

Method Summary
 void addOverlayTextListener(OverlayTextListener overlayTextListener)
          Add a overlay text listener interface.
 boolean isTextAvailable()
          Request if overlay text are available in the medium.
 boolean isTextOn()
          Returns the current state of the presentation of the OverlayText.
 void removeOverlayTextListener(OverlayTextListener overlayTextListener)
          Removes a overlay text listener interface.
 void switchTextOff()
          Switches overlay text off.
 void switchTextOn()
          Switches the overlay text on.
 
Methods inherited from interface com.sun.dtv.media.language.LanguageControl
getDefaultLanguage, getLanguage, getSupportedLanguages, setLanguage
 
Methods inherited from interface javax.media.Control
getControlComponent
 

Method Detail

switchTextOn

public void switchTextOn()
Switches the overlay text on.

switchTextOff

public void switchTextOff()
Switches overlay text off.

isTextAvailable

public boolean isTextAvailable()
Request if overlay text are available in the medium.

Returns:
true if subtitles are available.

isTextOn

public boolean isTextOn()
Returns the current state of the presentation of the OverlayText.

Returns:
true if overlay text is presented, false if no overlay text is presented.

addOverlayTextListener

public void addOverlayTextListener(OverlayTextListener overlayTextListener)
Add a overlay text listener interface.

Parameters:
overlayTextListener - the interface that will receive all the overlay text events.
See Also:
removeOverlayTextListener(com.sun.dtv.media.text.OverlayTextListener)

removeOverlayTextListener

public void removeOverlayTextListener(OverlayTextListener overlayTextListener)
Removes a overlay text listener interface.

Parameters:
overlayTextListener - overlay text listener to remove.
See Also:
addOverlayTextListener(com.sun.dtv.media.text.OverlayTextListener)
Overview  Package   Class  Use  Deprecated  Index  Help 
Java DTV API 1.0
12-Dec-2008
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
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.