org.dvb.media
Interface SyncControl

All Superinterfaces:
javax.media.Control

public interface SyncControl
extends javax.media.Control

SyncControl is a Control object for synchronization of a slave JMF Player. SyncControl manipulates offset in time with a master Player and allowable torelance of synchronization. When SyncControl object is obtained from a Controller object of a JMF Player by getControl(String) or getControls() methods, the JMF Player is a potential slave Player. Such a JMF Player becomes a slave Player when the Player is registered as a slave Player by addSlave() methods of MasterSlaveSyncLinkageControl.

SyncControl supports only simple Master/Slave relationship. That is, the object accepts relationship between a single master Player and slave Players. It is not allowed that a single JMF Player becomes a master Player and a slave Player at the same time. In addition, a slave Player can have only a single master Player.

Instance of SyncControl can be obtained from a JMF Player via the methods getControl(String) and getControls(). A single JMF Player can create at most one instance of SyncControl.


Method Summary
 MasterSlaveSyncLinkageControl getMaster()
          Gets a MasterSlaveSinkLinkageControl object that this SyncControl is currently synchronizing with.
 javax.media.Time getOffset()
          Gets offset value of a specified slave Player against master Player, by Time object.
 javax.media.Time getTolerance()
          Gets assigned tolerance value of synchronization for a specified slave Player.
 void setOffset(javax.media.Time t)
          Sets offset value in time for a slave Player to the master Player.
 void setTolerance(javax.media.Time t)
          Sets threshold to determine whether or not a specified slave Player establishes synchronization.
 
Methods inherited from interface javax.media.Control
getControlComponent
 

Method Detail

setTolerance

void setTolerance(javax.media.Time t)
Sets threshold to determine whether or not a specified slave Player establishes synchronization. In other words, an application allows error of synchronization within a given parameter, t.

Parameters:
t - Allowable tolerance of synchronization in terms of Time object.

getTolerance

javax.media.Time getTolerance()
Gets assigned tolerance value of synchronization for a specified slave Player.

Returns:
Value of tolerance for synchronization in terms of Time object.

getOffset

javax.media.Time getOffset()
Gets offset value of a specified slave Player against master Player, by Time object.

Returns:
Offset value in terms of Time object.

setOffset

void setOffset(javax.media.Time t)
Sets offset value in time for a slave Player to the master Player. The value is given by Time object.

Parameters:
t - Offset value in terms of Time object.

getMaster

MasterSlaveSyncLinkageControl getMaster()
Gets a MasterSlaveSinkLinkageControl object that this SyncControl is currently synchronizing with.

Returns:
MasterSlaveSinkLinkageControl object that this SyncControl is currently synchronizing with.