service.tut.pori.subtitles.reference

Class ClientService

java.lang.Object

service.tut.pori.subtitles.reference.ClientService

@HTTPService(name="subsrc")
public class ClientService
extends java.lang.Object

Reference implementation for client API methods.

Implementation Service path subs

See Also:

SubtitlesService

Constructor Summary

Constructors

Constructor and Description
ClientService()

Method Summary

Modifier and Type	Method and Description
StringResponse	generateSubtitles(AuthenticationParameter authenticatedUser, StringParameter guid, StringParameter fileFormat, StringParameter subtitleFormat, LongParameter userIdFilter)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientService

public ClientService()

Method Detail

generateSubtitles

@HTTPServiceMethod(name="getSubtitles",
                   acceptedMethods="GET")
public StringResponse generateSubtitles(@HTTPAuthenticationParameter(required=false)
                                                                                                                            AuthenticationParameter authenticatedUser,
                                                                                                                            @HTTPMethodParameter(name="uid")
                                                                                                                            StringParameter guid,
                                                                                                                            @HTTPMethodParameter(name="file_format")
                                                                                                                            StringParameter fileFormat,
                                                                                                                            @HTTPMethodParameter(name="subtitle_format")
                                                                                                                            StringParameter subtitleFormat,
                                                                                                                            @HTTPMethodParameter(name="user_id",required=false)
                                                                                                                            LongParameter userIdFilter)

Parameters:

authenticatedUser -

guid - video GUID

fileFormat - format of the subtitle file

subtitleFormat - one of the supported formatting options

userIdFilter - optional user id filter for media objects

Returns:

formatted subtitle file

See Also:

SubtitlesCore.SubtitleFormat, SubtitlesCore.FileFormat