All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.std.clocks.TimeBase

java.lang.Object
   |
   +----quicktime.QTObject
           |
           +----quicktime.std.clocks.TimeBase

public final class TimeBase

extends QTObject

implements QuickTimeLib

TimeBase()

This allows your application to obtain a new time base.

fromICMFrameTime(ICMFrameTime)

fromMovie(Movie)

This method allows you to get movie's TimeBase.

fromQTCallBack(QTCallBack)

Retrieve the time base of a callback event.

fromSequenceGrabber(SequenceGrabber)

Returns the SequenceGrabber's current time Base.

fromTimeRecord(TimeRecord)

Return the TimeBase that is associated with this record.

fromTunePlayer(TunePlayer)

Returns the TunePlayer's current time Base.

getEffectiveRate()

Useful when needed to make scheduling decisions based on the rate of a time base.

getFlags()

This allows your application to obtain the contents of the control flags of a time base.

getMasterClock()

Determines the clock component that is assigned to a time base.

getMasterTimeBase()

This allows your application to determine the master time base that is assigned to a time base.

getRate()

This allows your application to retrieve the rate of a time base.

getStartTime()

This allows you to determine the start time of a time base in the preferred scale of the time base

QuickTime::GetTimeBaseStartTime

getStartTime(int)

This allows you to determine the start time of a time base.

getStatus(TimeRecord)

This allows your application to retrieve status information from a time base.

getStopTime()

This allows you to determine the stop time of a time base in the preferred time scale of the TimeBase

QuickTime::GetTimeBaseStopTime

getStopTime(int)

This allows you to determine the stop time of a time base in the default scale of the time base.

getTime()

This allows your application to obtain the current time value from a time base in its preferred time scale.

getTime(int)

This allows your application to obtain the current time value from a time base.

getTRStartTime()

This allows you to determine the start time of a time base in the default scale of the time base.

getTRStartTime(int)

This allows you to determine the start time of a time base.

getTRStopTime()

This allows you to determine the stop time of a time base in the default scale of the time base.

getTRStopTime(int)

This allows you to determine the stop time of a time base in the default scale of the time base.

getTRTime()

This allows your application to obtain the current time value from a time base in the default scale of the time base.

getTRTime(int)

This allows your application to obtain the current time value from a time base.

setFlags(int)

This allows your application to set the contents of the control flags of a time base.

setMasterClock(Clock, TimeRecord)

Specifies the clock component that is assigned to a time base.

setMasterTimeBase(TimeBase, TimeRecord)

This allows your application to assign a master time base to a time base.

setRate(float)

This allows your application to set the rate of a time base.

setStartTime(TimeRecord)

This allows you to set the start time of a time base and defines the time base's the minimum time value.

setStopTime(TimeRecord)

This allows you to set the stop time of a time base and defines the time base's the maximum time value.

setTime(TimeRecord)

This allows your application to set the current time of a time base.

setValue(int, int)

This allows your application to set the current time of a time base.

setZero(TimeRecord)

This allows your application to change the offset from a time base to either its master time base or its clock component.

toString()

Print information about this TimeBase object.

 public TimeBase() throws QTException

This allows your application to obtain a new time base.

QuickTime::NewTimeBase

 public static TimeBase fromTimeRecord(TimeRecord tr)

Return the TimeBase that is associated with this record. If there is no TimeBase then returns null.

See Also:

getTimeBase

 public static TimeBase fromQTCallBack(QTCallBack cb)

Retrieve the time base of a callback event.

QuickTime::GetCallBackTimeBase()

Returns:

the time base of the callback.

See Also:

getTimeBase

 public static TimeBase fromICMFrameTime(ICMFrameTime ft)

Returns:

the current time base - can be null

See Also:

getBase

 public static TimeBase fromMovie(Movie m) throws StdQTException

This method allows you to get movie's TimeBase.

QuickTime::GetMovieTimeBase()

Returns:

a TimeBase object for movie's timebase

See Also:

getTimeBase

 public static TimeBase fromTunePlayer(TunePlayer tp) throws StdQTException

Returns the TunePlayer's current time Base.

QuickTime::TuneGetTimeBase

Returns:

the TimeBase

See Also:

getTimeBase

 public static TimeBase fromSequenceGrabber(SequenceGrabber sg) throws StdQTException

Returns the SequenceGrabber's current time Base.

QuickTime::TuneGetTimeBase

Returns:

the TimeBase

See Also:

getTimeBase

 public int getTime()

This allows your application to obtain the current time value from a time base in its preferred time scale.

QuickTime::GetTimeBaseTime

Returns:

The time value that contains the current time from the specified time base in specified time scale

 public int getTime(int scale)

This allows your application to obtain the current time value from a time base.

QuickTime::GetTimeBaseTime

Parameters:

scale - Specifies the time scale in which to return the current time value

Returns:

The time value that contains the current time from the specified time base in specified time scale

 public TimeRecord getTRTime() throws QTException

This allows your application to obtain the current time value from a time base in the default scale of the time base.

QuickTime::GetTimeBaseTime

Returns:

the current time specified as a TimeRecord

 public TimeRecord getTRTime(int scale) throws QTException

This allows your application to obtain the current time value from a time base.

QuickTime::GetTimeBaseTime

Parameters:

scale - Specifies the time scale in which to return the current time value

Returns:

the current time specified as a TimeRecord

 public void setTime(TimeRecord tr)

This allows your application to set the current time of a time base.

QuickTime::SetTimeBaseTime

Parameters:

tr - The time structure that contains the current time

 public void setValue(int time,
                      int scale)

This allows your application to set the current time of a time base.

QuickTime::SetTimeBaseValue

Parameters:

time - Specifies the new time value

scale - Specifies the time scale of the new time value

 public float getRate()

This allows your application to retrieve the rate of a time base.

QuickTime::GetTimeBaseRate

Returns:

The current rate of the time base as a float

 public void setRate(float rate)

This allows your application to set the rate of a time base.

QuickTime::SetTimeBaseRate

Parameters:

rate - Specifies the time rate of the time base

 public float getEffectiveRate()

Useful when needed to make scheduling decisions based on the rate of a time base.

QuickTime::GetTimeBaseEffectiveRate

Returns:

The effective rate as an float

 public int getStartTime()

This allows you to determine the start time of a time base in the preferred scale of the time base

QuickTime::GetTimeBaseStartTime

Returns:

The time value that contains the start time from the specified time base in the specified time scale

 public int getStartTime(int scale)

This allows you to determine the start time of a time base.

QuickTime::GetTimeBaseStartTime

Parameters:

scale - Specifies the time scale in which to return the start time

Returns:

The time value that contains the start time from the specified time base in the specified time scale

 public TimeRecord getTRStartTime() throws QTException

This allows you to determine the start time of a time base in the default scale of the time base.

QuickTime::GetTimeBaseStartTime

Returns:

The time value that contains the start time from the specified time base in the specified time scale

 public TimeRecord getTRStartTime(int scale) throws QTException

This allows you to determine the start time of a time base.

QuickTime::GetTimeBaseStartTime

Parameters:

scale - Specifies the time scale in which to return the start time

Returns:

The time value that contains the start time from the specified time base in the specified time scale

 public void setStartTime(TimeRecord tr)

This allows you to set the start time of a time base and defines the time base's the minimum time value.

QuickTime::SetTimeBaseStartTime

Parameters:

tr - The time object that contains the start time value

 public int getStopTime()

This allows you to determine the stop time of a time base in the preferred time scale of the TimeBase

QuickTime::GetTimeBaseStopTime

Returns:

The time value that contains the stop time from the specified time base in the specified time scale

 public int getStopTime(int scale)

This allows you to determine the stop time of a time base in the default scale of the time base.

QuickTime::GetTimeBaseStopTime

Parameters:

scale - Specifies the time scale in which to return the stop time

Returns:

The time value that contains the stop time from the specified time base in the specified time scale

 public TimeRecord getTRStopTime() throws QTException

This allows you to determine the stop time of a time base in the default scale of the time base.

QuickTime::GetTimeBaseStopTime

Returns:

The time value that contains the stop time from the specified time base in the specified time scale

 public TimeRecord getTRStopTime(int scale) throws QTException

This allows you to determine the stop time of a time base in the default scale of the time base.

QuickTime::GetTimeBaseStopTime

Returns:

The time value that contains the stop time from the specified time base in the specified time scale

 public void setStopTime(TimeRecord tr)

This allows you to set the stop time of a time base and defines the time base's the maximum time value.

QuickTime::SetTimeBaseStopTime

Parameters:

tr - The time structure that contains the stop time value

 public int getFlags()

This allows your application to obtain the contents of the control flags of a time base. Flags defined are loopTimeBase or palindromeLoopTimeBase, cf quicktime.std.movies package.

QuickTime::GetTimeBaseFlags

Returns:

the control flags.

 public void setFlags(int timeBaseFlags)

This allows your application to set the contents of the control flags of a time base.

QuickTime::SetTimeBaseFlags

Parameters:

timeBaseFlags - Specifies the control flags for the time base.

 public int getStatus(TimeRecord unpinnedTime)

This allows your application to retrieve status information from a time base.

QuickTime::GetTimeBaseStatus

Parameters:

unpinnedTime - The time structure that will receive the current time of the time base

Returns:

The flags that indicate whether the returned time value is outside the range of values specified by the start and stop times of the time base

 public void setZero(TimeRecord zero)

This allows your application to change the offset from a time base to either its master time base or its clock component.

QuickTime::SetTimeBaseZero

Parameters:

zero - The time structure that corresponds to a 0 time value for the slave time scale

 public void setMasterTimeBase(TimeBase master,
                               TimeRecord slaveZero)

This allows your application to assign a master time base to a time base.

QuickTime::SetTimeBaseMasterTimeBase

Parameters:

master - Specifies the master time base to be assigned to this slaved time base

slaveZero - Specifies the time, in the master time base time scale, that corresponds to a 0 time value for this slaved time base

 public TimeBase getMasterTimeBase()

This allows your application to determine the master time base that is assigned to a time base. If the TimeBase is slaved to a clock this will return null.

QuickTime::GetTimeBaseMasterTimeBase

Returns:

The master time base assigned to this time base or null

See Also:

getMasterClock

 public void setMasterClock(Clock clockMeister,
                            TimeRecord slaveZero)

Specifies the clock component that is assigned to a time base.

QuickTime::SetTimeBaseMasterClock

Parameters:

clockMeister - The specified clock.

slaveZero - The specified time record used in offsetting the time value of the time base and specified clock.

Returns:

A clock component instance.

 public Clock getMasterClock()

Determines the clock component that is assigned to a time base. If this call returns null then the TimeBase is not slaved to a clock, but is slaved to another TimeBase.

QuickTime::GetTimeBaseMasterClock

Parameters:

tb - The specified time base.

Returns:

A clock component instance or null

See Also:

getMasterTimeBase

 public String toString()

Print information about this TimeBase object.

Returns:

a string representing this TimeBase object

Overrides:

toString in class QTObject

All Packages  Class Hierarchy  This Package  Previous  Next  Index