org.mythtv.services.api.frontend
Interface FrontendOperations

All Known Implementing Classes:

FrontendTemplate

public interface FrontendOperations

Author:

Daniel Frey

Method Summary

org.springframework.http.ResponseEntity<FrontendActionList>	getActionList(String frontedApiUrlBase, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<FrontendStatus>	getStatus(String frontedApiUrlBase, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<Bool>	playRecording(String frontedApiUrlBase, int channelId, org.joda.time.DateTime startTime) - GET
org.springframework.http.ResponseEntity<Bool>	playVideo(String frontedApiUrlBase, String id, boolean useBookmark)
org.springframework.http.ResponseEntity<Bool>	sendAction(String frontedApiUrlBase, String action, String file, int width, int height) - GET
org.springframework.http.ResponseEntity<Bool>	sendMessage(String frontedApiUrlBase, String message) - GET

Method Detail

getStatus

org.springframework.http.ResponseEntity<FrontendStatus> getStatus(String frontedApiUrlBase,
                                                                  ETagInfo etag)
                                                                  throws MythServiceApiRuntimeException

- GET

Parameters:

frontedApiUrlBase -

Returns:

Throws:

MythServiceApiRuntimeException

sendMessage

org.springframework.http.ResponseEntity<Bool> sendMessage(String frontedApiUrlBase,
                                                          String message)
                                                          throws MythServiceApiRuntimeException

- GET

Parameters:

frontedApiUrlBase -

message -

Returns:

Throws:

MythServiceApiRuntimeException

sendAction

org.springframework.http.ResponseEntity<Bool> sendAction(String frontedApiUrlBase,
                                                         String action,
                                                         String file,
                                                         int width,
                                                         int height)
                                                         throws MythServiceApiRuntimeException

- GET

Parameters:

frontedApiUrlBase -

action -

file -

width -

height -

Returns:

Throws:

MythServiceApiRuntimeException

getActionList

org.springframework.http.ResponseEntity<FrontendActionList> getActionList(String frontedApiUrlBase,
                                                                          ETagInfo etag)
                                                                          throws MythServiceApiRuntimeException

- GET

Parameters:

frontedApiUrlBase -

Returns:

Throws:

MythServiceApiRuntimeException

playRecording

org.springframework.http.ResponseEntity<Bool> playRecording(String frontedApiUrlBase,
                                                            int channelId,
                                                            org.joda.time.DateTime startTime)
                                                            throws MythServiceApiRuntimeException

- GET

Parameters:

frontedApiUrlBase -

channelId - - (Required) The database channel id for the recording

startTime - - (Required) The recording start time for the item. This should be in MySQL ISO format, eg: 2011-08-29 18:59:00. You can replace the space with %20 or T.

Returns:

Throws:

MythServiceApiRuntimeException

playVideo

org.springframework.http.ResponseEntity<Bool> playVideo(String frontedApiUrlBase,
                                                        String id,
                                                        boolean useBookmark)
                                                        throws MythServiceApiRuntimeException

Parameters:

frontedApiUrlBase -

id - - (Required) The database id for the video file

useBookmark - - (Optional) Pass 1 to resume playback at a bookmark

Returns:

Throws:

MythServiceApiRuntimeException