service.tut.pori.contentanalysis.video

Class VideoParameters

java.lang.Object

service.tut.pori.contentanalysis.AbstractTaskDetails.TaskParameters

service.tut.pori.contentanalysis.video.VideoParameters

public final class VideoParameters
extends AbstractTaskDetails.TaskParameters

Options for video analysis.

Conditional Elements

• sequenceDuration

If sequence type VideoParameters.SequenceType.SECOND is used, the element sequenceDuration must be present.

Optional Elements

• analysisTypeList. If not given, the defaults PhotoParameters.AnalysisType.KEYWORD_EXTRACTION and PhotoParameters.AnalysisType.VISUAL should be used.
• timeCodeList. Can be used to specify which parts of the video should be analysed.

XML Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<taskParameters>
  <analysisTypeList>
    <analysisType>AUDIO</analysisType>
    <analysisType>FACE_DETECTION</analysisType>
    <analysisType>KEYWORD_EXTRACTION</analysisType>
    <analysisType>VISUAL</analysisType>
  </analysisTypeList>
  <sequenceDuration>123180267</sequenceDuration>
  <sequenceType>SECOND</sequenceType>
  <timeCodeList>
    <timeCode>
      <to>6003.033406149492</to>
      <from>3281.8886457574004</from>
    </timeCode>
  </timeCodeList>
</taskParameters>

See Also:

TimecodeList

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VideoParameters.SequenceType Type of the requested analysis sequence

Constructor Summary

Constructors

Constructor and Description
VideoParameters()

Method Summary

Modifier and Type	Method and Description
java.util.Set<PhotoParameters.AnalysisType>	getAnalysisTypes()
java.lang.Integer	getSequenceDuration()
VideoParameters.SequenceType	getSequenceType()
TimecodeList	getTimecodes()
void	initialize(java.util.Map<java.lang.String,java.lang.String> metadata) initialize the the parameters from the given metadata map
void	setAnalysisTypes(java.util.Set<PhotoParameters.AnalysisType> analysisTypes)
void	setSequenceDuration(java.lang.Integer sequenceDuration)
void	setSequenceType(VideoParameters.SequenceType sequenceType)
void	setTimecodes(TimecodeList timecodes)
java.util.HashMap<java.lang.String,java.lang.String>	toMetadata()

Methods inherited from class java.lang.Object

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

Constructor Detail

VideoParameters

public VideoParameters()

Method Detail

getSequenceDuration

public java.lang.Integer getSequenceDuration()

Returns:

the sequence duration in seconds or null if none set

See Also:

setSequenceDuration(Integer)

setSequenceDuration

public void setSequenceDuration(java.lang.Integer sequenceDuration)

Parameters:

sequenceDuration - the sequence duration in seconds

See Also:

getSequenceDuration()

getSequenceType

public VideoParameters.SequenceType getSequenceType()

Returns:

the sequenceType

See Also:

setSequenceType(service.tut.pori.contentanalysis.video.VideoParameters.SequenceType)

setSequenceType

public void setSequenceType(VideoParameters.SequenceType sequenceType)

Parameters:

sequenceType - the sequenceType to set

See Also:

getSequenceType()

getTimecodes

public TimecodeList getTimecodes()

Returns:

the timecodes

See Also:

setTimecodes(TimecodeList)

setTimecodes

public void setTimecodes(TimecodeList timecodes)

Parameters:

timecodes - the timecodes to set

See Also:

getTimecodes()

initialize

public void initialize(java.util.Map<java.lang.String,java.lang.String> metadata)
                throws java.lang.IllegalArgumentException

Description copied from class: AbstractTaskDetails.TaskParameters

initialize the the parameters from the given metadata map

Specified by:

initialize in class AbstractTaskDetails.TaskParameters

Throws:

java.lang.IllegalArgumentException - on bad values

toMetadata

public java.util.HashMap<java.lang.String,java.lang.String> toMetadata()

Specified by:

toMetadata in class AbstractTaskDetails.TaskParameters

Returns:

this object converted to metadata map or null if no content

getAnalysisTypes

public java.util.Set<PhotoParameters.AnalysisType> getAnalysisTypes()

Returns:

the analysisTypes

setAnalysisTypes

public void setAnalysisTypes(java.util.Set<PhotoParameters.AnalysisType> analysisTypes)

Parameters:

analysisTypes - the analysisTypes to set