org.gytheio.content.transform.options

Class TemporalSourceOptions

java.lang.Object

org.gytheio.content.transform.options.AbstractTransformationSourceOptions

org.gytheio.content.transform.options.TemporalSourceOptions

All Implemented Interfaces:

Serializable, TransformationSourceOptions, org.gytheio.util.Mergable<TransformationSourceOptions>

public class TemporalSourceOptions
extends AbstractTransformationSourceOptions

Time-based content conversion options to specify an offset and duration. Useful for audio and video.

If only the offset is specified transformers should attempt a transform from that offset to the end if possible.

If only a duration is specified transformers should attempt a transform from the start until that duration is reached if possible.

Author:

Ray Gauss II

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TemporalSourceOptions.TemporalSourceOptionsSerializer Serializer for temporal source options

Nested classes/interfaces inherited from interface org.gytheio.content.transform.options.TransformationSourceOptions

TransformationSourceOptions.TransformationSourceOptionsSerializer

Constructor Summary

Constructors

Constructor and Description
TemporalSourceOptions()
TemporalSourceOptions(TemporalSourceOptions options)

Method Summary

Methods

Modifier and Type	Method and Description
static TransformationSourceOptions.TransformationSourceOptionsSerializer	createSerializerInstance() Creates an instance of the options serializer
String	getDuration() Gets the duration of the source to read with a format of hh:mm:ss[.xxx]
Integer	getElementIntervalSeconds() Gets the interval in seconds to pull elements from the source, i.e.
Integer	getMaxElements() Gets the maximum number of elements that should be returned from the transformation.
String	getOffset() Gets the offset time code from which to start the transformation with a format of hh:mm:ss[.xxx]
TransformationSourceOptions.TransformationSourceOptionsSerializer	getSerializer() Gets the serializer for the source options.
boolean	isApplicableForMediaType(String sourceMimetype) Gets whether or not these transformation source options apply for the given media type
void	setDuration(String duration) Sets the duration of the source to read with a format of hh:mm:ss[.xxx]
void	setElementIntervalSeconds(Integer elementIntervalSeconds) Sets the interval in seconds to pull elements from the source, i.e.
void	setMaxElements(Integer maxElements) Sets the maximum number of elements that should be returned from the transformation.
void	setOffset(String offset) Sets the offset time code from which to start the transformation with a format of hh:mm:ss[.xxx]
static void	validateTimeString(String value) Validates that the given value is of the form hh:mm:ss[.xxx]

Methods inherited from class org.gytheio.content.transform.options.AbstractTransformationSourceOptions

getApplicableMediaTypes, merge, putParameterIfNotNull, setApplicableMediaTypes, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TemporalSourceOptions

public TemporalSourceOptions()

TemporalSourceOptions

public TemporalSourceOptions(TemporalSourceOptions options)

Method Detail

isApplicableForMediaType

public boolean isApplicableForMediaType(String sourceMimetype)

Description copied from class: AbstractTransformationSourceOptions

Gets whether or not these transformation source options apply for the given media type

Specified by:

isApplicableForMediaType in interface TransformationSourceOptions

Overrides:

isApplicableForMediaType in class AbstractTransformationSourceOptions

Parameters:

sourceMimetype - the media type of the source

Returns:

if these transformation source options apply

getOffset

public String getOffset()

Gets the offset time code from which to start the transformation with a format of hh:mm:ss[.xxx]

Returns:

the offset

setOffset

public void setOffset(String offset)

Sets the offset time code from which to start the transformation with a format of hh:mm:ss[.xxx]

Parameters:

offset -

getDuration

public String getDuration()

Gets the duration of the source to read with a format of hh:mm:ss[.xxx]

Returns:

setDuration

public void setDuration(String duration)

Sets the duration of the source to read with a format of hh:mm:ss[.xxx]

Parameters:

duration -

getElementIntervalSeconds

public Integer getElementIntervalSeconds()

Gets the interval in seconds to pull elements from the source, i.e. 3 indicates one element (frame) every 3 seconds.

Returns:

the element interval

setElementIntervalSeconds

public void setElementIntervalSeconds(Integer elementIntervalSeconds)

Sets the interval in seconds to pull elements from the source, i.e. 3 indicates one element (frame) every 3 seconds.

Parameters:

elementIntervalSeconds -

getMaxElements

public Integer getMaxElements()

Gets the maximum number of elements that should be returned from the transformation.

Returns:

the maximum number of elements

setMaxElements

public void setMaxElements(Integer maxElements)

Sets the maximum number of elements that should be returned from the transformation.

Parameters:

maxElements -

validateTimeString

public static void validateTimeString(String value)

Validates that the given value is of the form hh:mm:ss[.xxx]

Parameters:

value -

getSerializer

public TransformationSourceOptions.TransformationSourceOptionsSerializer getSerializer()

Description copied from interface: TransformationSourceOptions

Gets the serializer for the source options.

Returns:

the serializer

createSerializerInstance

public static TransformationSourceOptions.TransformationSourceOptionsSerializer createSerializerInstance()

Creates an instance of the options serializer

Returns:

the options serializer