com.sun.tv.media

Class MediaSelectControlImpl

java.lang.Object

com.sun.tv.media.MediaSelectControlImpl

All Implemented Interfaces:

EventListener, Control, MediaSelectControl, ServiceContextListener

public class MediaSelectControlImpl
extends Object
implements MediaSelectControl, ServiceContextListener

Provides an interface to allow the selection of different kinds of content from a running Player. It serves as a high level demultiplex control, where the selection is specified by locators indicating one or more service components to present.

If the Player on which a MediaSelectControlImpl operates is an instance of ServiceMediaHandler, then MediaSelectControlImpl is restricted to demultiplexing only content from the Service with which the ServiceMediaHandler is associated.

See Also:

ServiceMediaHandler

Constructor Summary

Constructors

Constructor and Description
MediaSelectControlImpl(Handler handler, ServiceContextImpl context) Constructs a new media select control

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Locator component) Adds a service component (for example, sub-titles) to the presentation.
void	addMediaSelectListener(MediaSelectListener listener) Subscribes the specifed MediaSelectListener to receive events related to media selection on this Player.
Component	getControlComponent() Get the Component associated with this Control object.
Locator[]	getCurrentSelection() Reports the components of the current selection.
void	receiveServiceContextEvent(ServiceContextEvent e) Notifies the ServiceContextListener of an event generated by a ServiceContext.
void	remove(Locator component) Removes a service component from the presentation.
void	removeMediaSelectListener(MediaSelectListener listener) Unsubscribes the specifed MediaSelectListener from receiving events related to media selection on this Player.
void	replace(Locator fromComponent, Locator toComponent) Replaces a service component in the presentation.
void	select(Locator component) Selects a new service component for presentation.
void	select(Locator[] components) Selects one or more service components for presentation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MediaSelectControlImpl

public MediaSelectControlImpl(Handler handler,
                      ServiceContextImpl context)

Constructs a new media select control

Parameters:

player - The player associated with the media select control.

Method Detail

select

public void select(Locator component)
            throws InvalidLocatorException,
                   InvalidServiceComponentException,
                   InsufficientResourcesException,
                   SecurityException

Selects a new service component for presentation. If some content is currently playing, it is replaced in its entirety by the specified selection. This is an asynchronous operation that is completed on receipt of a MediaSelectEvent. Note that for certain selections that imply a different time base or otherwise change synchronization relationships a RestartingEvent will be posted by the Player.

Specified by:

select in interface MediaSelectControl

Parameters:

component - A locator representing an individual service component to present.

Throws:

InvalidLocatorException - If the locator does not reference a selectable service component, or references a service component that is not part of the Service to which the MediaSelectControlImpl is restricted.

InsufficientResourcesException - If the operation cannot be completed due to a lack of system resources.

SecurityException - If the caller does not have MediaSelectPermission(component) permission.

InvalidServiceComponentException - If the specified service component is not part of the Service to which the MediaSelectControl is restricted, or if it cannot be presented alone.

select

public void select(Locator[] components)
            throws InvalidLocatorException,
                   InvalidServiceComponentException,
                   InsufficientResourcesException,
                   SecurityException

Selects one or more service components for presentation. If some content is currently playing, it is replaced in its entirety by the specified selection. This is an asynchronous operation that is completed on receipt of a MediaSelectEvent. Note that for certain selections that imply a different time base or otherwise change synchronization relationships a RestartingEvent will be posted by the Player.

Specified by:

select in interface MediaSelectControl

Parameters:

components - An array of locators representing a set of individual service components to present together.

Throws:

InvalidLocatorException - If a locator provided does not reference a selectable service component or references a service component that is not part of the Service to which the MediaSelectControlImpl is restricted .

InvalidServiceComponentException - If the specified set of service components cannot be presented as a coherent whole or if the service components are not all available simultaneously.

InsufficientResourcesException - If the operation cannot be completed due to a lack of system resources.

SecurityException - If the caller does not have MediaSelectPermission(components[i]) permission for any valid i.

add

public void add(Locator component)
         throws InvalidLocatorException,
                InvalidServiceComponentException,
                InsufficientResourcesException,
                SecurityException

Adds a service component (for example, sub-titles) to the presentation. Components whose addition would require Player resynchronization are not permitted.

Specified by:

add in interface MediaSelectControl

Parameters:

component - The locator representing an individual service component to add to the presentation.

Throws:

InvalidLocatorException - If the specified locator does not reference a selectable service component, references a service component whose addition would require resynchronization of the Player, or references a service component that is not part of the Service to which the MediaSelectControlImpl is restricted.

InsufficientResourcesException - If the operation cannot be completed due to a lack of system resources.

SecurityException - If the caller does not have MediaSelectPermission(component) permission.

InvalidServiceComponentException - If the addition of the service component would require resynchronization of the Player, If the specified service component is not part of the Service or Services to which the MediaSelectControl is restricted, or if the service component must be presented in conjunction with another service component that is not part of the current presentation.

remove

public void remove(Locator component)
            throws InvalidLocatorException,
                   InvalidServiceComponentException,
                   SecurityException

Removes a service component from the presentation. Components whose removal would require Player resynchronization are not permitted.

Specified by:

remove in interface MediaSelectControl

Parameters:

component - The locator representing an individual service component to remove from the presentation.

Throws:

InvalidLocatorException - If the specified locator does not reference a service component in the current selection, references a service component whose addition would require resynchronization of the Player, or references a service component that is not part of the Service to which the MediaSelectControlImpl is restricted.

SecurityException - If the caller does not have MediaSelectPermission(component) permission.

InvalidServiceComponentException - If removal of the specified service component would require resynchronization of the Player, or if another service component in the current presentation must be presented in conjunction with component.

replace

public void replace(Locator fromComponent,
           Locator toComponent)
             throws InvalidLocatorException,
                    InvalidServiceComponentException,
                    InsufficientResourcesException,
                    SecurityException

Description copied from interface: MediaSelectControl

Replaces a service component in the presentation. This is an asynchronous operation that is completed on receipt of a MediaSelectEvent. Components whose replacement would require Player resynchronization are not permitted.

Specified by:

replace in interface MediaSelectControl

Parameters:

fromComponent - The locator that represents the service component to remove from the presentation.

toComponent - The locator that represents the service component to add to the presentation.

Throws:

InvalidLocatorException - If fromComponent does not reference a service component in the current selection, or if toComponent does not reference a selectable service component.

InvalidServiceComponentException - If toComponent references a service component that is not part of the Service to which the MediaSelectControl is restricted, if fromComponent or toComponent reference service components for which this operation would require resynchronization of the Player, if another service component in the current presentation must be presented in conjunction with fromComponent, or if toComponent must be presented in conjunction with a service component not in the resulting presentation.

InsufficientResourcesException - If the operation cannot be completed due to a lack of system resources.

SecurityException - If the caller does not have MediaSelectPermission(fromComponent) and MediaSelectPermission(toComponent) permission.

addMediaSelectListener

public void addMediaSelectListener(MediaSelectListener listener)

Subscribes the specifed MediaSelectListener to receive events related to media selection on this Player.

Specified by:

addMediaSelectListener in interface MediaSelectControl

Parameters:

listener - The MediaSelectListener to which to send events.

removeMediaSelectListener

public void removeMediaSelectListener(MediaSelectListener listener)

Unsubscribes the specifed MediaSelectListener from receiving events related to media selection on this Player.

Specified by:

removeMediaSelectListener in interface MediaSelectControl

Parameters:

listener - The MediaSelectListener to unsubscribe.

getCurrentSelection

public Locator[] getCurrentSelection()

Reports the components of the current selection.

Specified by:

getCurrentSelection in interface MediaSelectControl

Returns:

An array of locators representing the service components in the current selection.

getControlComponent

public Component getControlComponent()

Get the Component associated with this Control object. For example, this method might return a slider for volume control or a panel containing radio buttons for CODEC control. The getControlComponent method can return null if there is no GUI control for this Control.

Specified by:

getControlComponent in interface Control

receiveServiceContextEvent

public void receiveServiceContextEvent(ServiceContextEvent e)

Description copied from interface: ServiceContextListener

Notifies the ServiceContextListener of an event generated by a ServiceContext.

Specified by:

receiveServiceContextEvent in interface ServiceContextListener

Parameters:

e - The generated event.