Class MediaSegment

java.lang.Object

ca.phon.extensions.ExtendableObject

ca.phon.session.MediaSegment

All Implemented Interfaces:

IExtendable

public final class MediaSegment
extends ExtendableObject

Media segment

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MediaSegment.OverlapType	Media segment overlap type

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object b)	Equals will return true if start/end times are the same.
float	getEndTime()	Return end time in seconds
float	getEndValue()	Get end value
long	getEndValueMs()	Return end time in milliseconds
float	getLength()	Return segment length in seconds
long	getLengthMs()	Return segment length in milliseconds
float	getStartTime()	Return start time in seconds
float	getStartValue()	Get start value as a floating point number
long	getStartValueMs()	Return start time in milliseconds
MediaUnit	getUnitType()	Get media unit represented by getStartValue() and getEndValue()
boolean	isPoint()	Is the media segment a single point
boolean	isPointAtOrigin()	Is the media segment a single point at the origin (0.0f)
MediaSegment.OverlapType	overlaps(MediaSegment seg)	Does this segment overlap the given segment
void	setEndTime(float endTime)	Set end time in seconds
void	setEndTimeMs(long endTime)	Set end time in milliseconds
void	setEndValue(float end)	Set end value
void	setSegment(float startValue, float endValue)
void	setSegment(float startValue, float endValue, MediaUnit unit)
void	setSegment(MediaSegment seg)
void	setStartTime(float startTime)	Set start time in seconds
void	setStartTimeMs(long startTime)	Set start time in milliseconds
void	setStartValue(float start)	Set start value, unit is specified by getUnitType()
void	setUnitType(MediaUnit mediaUnit)	Set media unit for segment
String	toString()

Methods inherited from class ca.phon.extensions.ExtendableObject

getExtension, getExtensions, putExtension, removeExtension

Methods inherited from class java.lang.Object

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

Method Details

getStartValue

public float getStartValue()

Get start value as a floating point number

Returns:

start value

setStartValue

public void setStartValue(float start)

Set start value, unit is specified by getUnitType()

Parameters:

start -

getEndValue

public float getEndValue()

Get end value

Returns:

end value

setEndValue

public void setEndValue(float end)

Set end value

Parameters:

end -

getUnitType

public MediaUnit getUnitType()

Get media unit represented by getStartValue() and getEndValue()

Returns:

media unit

getStartTime

public float getStartTime()

Return start time in seconds

Returns:

start time in seconds

setStartTime

public void setStartTime(float startTime)

Set start time in seconds

Parameters:

startTime -

getStartValueMs

public long getStartValueMs()

Return start time in milliseconds

Returns:

start time in milliseconds

setStartTimeMs

public void setStartTimeMs(long startTime)

Set start time in milliseconds

Parameters:

startTime -

getEndTime

public float getEndTime()

Return end time in seconds

Returns:

end time in seconds

setEndTime

public void setEndTime(float endTime)

Set end time in seconds

Parameters:

endTime -

getEndValueMs

public long getEndValueMs()

Return end time in milliseconds

Returns:

end time in milliseconds

setEndTimeMs

public void setEndTimeMs(long endTime)

Set end time in milliseconds

Parameters:

endTime -

getLength

public float getLength()

Return segment length in seconds

Returns:

length in seconds

getLengthMs

public long getLengthMs()

Return segment length in milliseconds

Returns:

length in milliseconds

setUnitType

public void setUnitType(MediaUnit mediaUnit)

Set media unit for segment

Parameters:

mediaUnit -

setSegment

public void setSegment(float startValue,
 float endValue)

isPoint

public boolean isPoint()

Is the media segment a single point

Returns:

true if getStartValue() == getEndValue()

isPointAtOrigin

public boolean isPointAtOrigin()

Is the media segment a single point at the origin (0.0f)

Returns:

true if isPoint() == true invalid input: '&'invalid input: '&' getStartValue() == 0.0f

setSegment

public void setSegment(float startValue,
 float endValue,
 MediaUnit unit)

setSegment

public void setSegment(MediaSegment seg)

equals

public boolean equals(Object b)

Equals will return true if start/end times are the same. Unit is ignored

Overrides:

equals in class Object

Parameters:

b -

Returns:

toString

public String toString()

Overrides:

toString in class Object

overlaps

public MediaSegment.OverlapType overlaps(MediaSegment seg)

Does this segment overlap the given segment

Parameters:

seg - the segment to check against

Returns:

the overlap type of the two segments