service.tut.pori.contentanalysis.video.reference

Class ExampleService

java.lang.Object

service.tut.pori.contentanalysis.video.reference.ExampleService

@HTTPService(name="vcare")
public class ExampleService
extends java.lang.Object

Generates example XML output

Constructor Summary

Constructors

Constructor and Description
ExampleService()

Method Summary

Modifier and Type	Method and Description
Response	analysisParameters() Generates example video options
Response	deletedVideoList(Limits limits) Generates example deleted video list
Response	taskDetails(DataGroups dataGroups, Limits limits, StringParameter taskType) Generates example task details
Response	taskResults(Limits limits) Generates example task response
Response	timecode() Generates example time code
Response	timecodeList(Limits limits) Generates example time code list
Response	video(DataGroups dataGroups) Generates example video
Response	videoList(DataGroups dataGroups, Limits limits) Generates example video list

Methods inherited from class java.lang.Object

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

Constructor Detail

ExampleService

public ExampleService()

Method Detail

video

@HTTPServiceMethod(name="media")
public Response video(@HTTPMethodParameter(name="data_groups",required=false)
                                                        DataGroups dataGroups)

Generates example video

Parameters:

dataGroups - For supported data groups, see ClientService.retrieveMediaObjects(core.tut.pori.http.parameters.AuthenticationParameter, DataGroups, Limits, core.tut.pori.http.parameters.IntegerParameter, StringParameter).

Returns:

Video

See Also:

Video

videoList

@HTTPServiceMethod(name="mediaList")
public Response videoList(@HTTPMethodParameter(name="data_groups",required=false)
                                                                DataGroups dataGroups,
                                                                @HTTPMethodParameter(name="limits",required=false,defaultValue="0-0")
                                                                Limits limits)

Generates example video list

Parameters:

dataGroups - For supported data groups, see ClientService.retrieveMediaObjects(core.tut.pori.http.parameters.AuthenticationParameter, DataGroups, Limits, core.tut.pori.http.parameters.IntegerParameter, core.tut.pori.http.parameters.StringParameter).

limits - paging limits

Returns:

VideoList

See Also:

VideoList

timecode

@HTTPServiceMethod(name="timeCode")
public Response timecode()

Generates example time code

Returns:

Timecode

See Also:

Timecode

timecodeList

@HTTPServiceMethod(name="timeCodeList")
public Response timecodeList(@HTTPMethodParameter(name="limits",required=false,defaultValue="0-0")
                                                                      Limits limits)

Generates example time code list

Parameters:

limits - paing limits

Returns:

TimecodeList

See Also:

TimecodeList

analysisParameters

@HTTPServiceMethod(name="taskParameters")
public Response analysisParameters()

Generates example video options

Returns:

VideoOptions

See Also:

VideoParameters

deletedVideoList

@HTTPServiceMethod(name="deletedMediaList")
public Response deletedVideoList(@HTTPMethodParameter(name="limits",required=false,defaultValue="0-0")
                                                                              Limits limits)

Generates example deleted video list

Parameters:

limits - paging limits

Returns:

DeletedVideoList

See Also:

DeletedVideoList

taskResults

@HTTPServiceMethod(name="taskResults")
public Response taskResults(@HTTPMethodParameter(name="limits",required=false,defaultValue="0-0")
                                                                    Limits limits)

Generates example task response

Parameters:

limits - paging limits

Returns:

VideoTaskResponse

See Also:

VideoTaskResponse

taskDetails

@HTTPServiceMethod(name="taskDetails")
public Response taskDetails(@HTTPMethodParameter(name="data_groups",required=false)
                                                                    DataGroups dataGroups,
                                                                    @HTTPMethodParameter(name="limits",required=false,defaultValue="0-0")
                                                                    Limits limits,
                                                                    @HTTPMethodParameter(name="task_type",required=false)
                                                                    StringParameter taskType)

Generates example task details

Parameters:

dataGroups - For supported data groups, see ClientService.retrieveMediaObjects(core.tut.pori.http.parameters.AuthenticationParameter, DataGroups, Limits, core.tut.pori.http.parameters.IntegerParameter, core.tut.pori.http.parameters.StringParameter).

limits - paging limits

taskType - Will default to AsyncTask.TaskType.ANALYSIS, if missing

Returns:

VideoTaskDetails

See Also:

VideoTaskDetails