org.mythtv.services.api.dvr

Interface DvrOperations

All Known Implementing Classes:

DvrTemplate

public interface DvrOperations

Author:

Daniel Frey

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<Int>	addRecordingSchedule(int channelId, org.joda.time.DateTime startTime, int parentId, boolean interactive, int season, int episode, String inetRef, int findId, String type, String searchType, int recordingPriority, int perferredInput, int startOffset, int endOffset, String duplicateMethod, String duplicateIn, int filter, String recordingProfile, String recordingGroup, String storageGroup, String playGroup, boolean autoExpire, int maxEpisodes, boolean maxNewest, boolean autoCommercialFlag, boolean autoTranscode, boolean autoMetadataLookup, boolean autoUserJob1, boolean autoUserJob2, boolean autoUserJob3, boolean autoUserJob4, int transcoder) - POST
org.springframework.http.ResponseEntity<Bool>	disableRecordingSchedule(int recordingId) - POST
org.springframework.http.ResponseEntity<Bool>	enableRecordingSchedule(int recordingId) - POST
org.springframework.http.ResponseEntity<ProgramList>	getConflictList(int startIndex, int count, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<EncoderList>	getEncoderList(ETagInfo etag) - GET
org.springframework.http.ResponseEntity<ProgramList>	getExpiringList(int startIndex, int count, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<ProgramList>	getFiltererRecordedList(boolean descending, int startIndex, int count, String titleRegEx, String recordingGroup, String storageGroup, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<ProgramWrapper>	getRecorded(int channelId, org.joda.time.DateTime startTime, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<ProgramList>	getRecordedList(ETagInfo etag) - GET
org.springframework.http.ResponseEntity<ProgramList>	getRecordedList(int startIndex, int count, boolean descending, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<RecRuleWrapper>	getRecordSchedule(int recordId, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<RecRuleList>	getRecordScheduleList(int startIndex, int count, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<ProgramList>	getUpcomingList(int startIndex, int count, boolean showAll, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<Bool>	removeRecorded(int channelId, org.joda.time.DateTime startTime) - GET
org.springframework.http.ResponseEntity<Bool>	removeRecordingSchedule(int recordingId) - POST

Method Detail

addRecordingSchedule

org.springframework.http.ResponseEntity<Int> addRecordingSchedule(int channelId,
                                                                org.joda.time.DateTime startTime,
                                                                int parentId,
                                                                boolean interactive,
                                                                int season,
                                                                int episode,
                                                                String inetRef,
                                                                int findId,
                                                                String type,
                                                                String searchType,
                                                                int recordingPriority,
                                                                int perferredInput,
                                                                int startOffset,
                                                                int endOffset,
                                                                String duplicateMethod,
                                                                String duplicateIn,
                                                                int filter,
                                                                String recordingProfile,
                                                                String recordingGroup,
                                                                String storageGroup,
                                                                String playGroup,
                                                                boolean autoExpire,
                                                                int maxEpisodes,
                                                                boolean maxNewest,
                                                                boolean autoCommercialFlag,
                                                                boolean autoTranscode,
                                                                boolean autoMetadataLookup,
                                                                boolean autoUserJob1,
                                                                boolean autoUserJob2,
                                                                boolean autoUserJob3,
                                                                boolean autoUserJob4,
                                                                int transcoder)
                                                                  throws MythServiceApiRuntimeException

- POST

Parameters:

channelId -

startTime -

parentId -

interactive -

season -

episode -

inetRef -

findId -

type -

searchType -

recordingPriority -

perferredInput -

startOffset -

endOffset -

duplicateMethod -

duplicateIn -

filter -

recordingProfile -

recordingGroup -

storageGroup -

playGroup -

autoExpire -

maxEpisodes -

maxNewest -

autoCommercialFlag -

autoTranscode -

autoMetadataLookup -

autoUserJob1 -

autoUserJob2 -

autoUserJob3 -

autoUserJob4 -

transcoder -

Returns:

Throws:

MythServiceApiRuntimeException

disableRecordingSchedule

org.springframework.http.ResponseEntity<Bool> disableRecordingSchedule(int recordingId)
                                                                       throws MythServiceApiRuntimeException

- POST

Parameters:

recordingId -

Returns:

Throws:

MythServiceApiRuntimeException

enableRecordingSchedule

org.springframework.http.ResponseEntity<Bool> enableRecordingSchedule(int recordingId)
                                                                      throws MythServiceApiRuntimeException

- POST

Parameters:

recordingId -

Returns:

Throws:

MythServiceApiRuntimeException

getConflictList

org.springframework.http.ResponseEntity<ProgramList> getConflictList(int startIndex,
                                                                   int count,
                                                                   ETagInfo etag)
                                                                     throws MythServiceApiRuntimeException

- GET

Parameters:

startIndex -

count -

Returns:

Throws:

MythServiceApiRuntimeException

getEncoderList

org.springframework.http.ResponseEntity<EncoderList> getEncoderList(ETagInfo etag)
                                                                    throws MythServiceApiRuntimeException

- GET

Returns:

Throws:

MythServiceApiRuntimeException

getExpiringList

org.springframework.http.ResponseEntity<ProgramList> getExpiringList(int startIndex,
                                                                   int count,
                                                                   ETagInfo etag)
                                                                     throws MythServiceApiRuntimeException

- GET

Parameters:

startIndex -

count -

Returns:

Throws:

MythServiceApiRuntimeException

getFiltererRecordedList

org.springframework.http.ResponseEntity<ProgramList> getFiltererRecordedList(boolean descending,
                                                                           int startIndex,
                                                                           int count,
                                                                           String titleRegEx,
                                                                           String recordingGroup,
                                                                           String storageGroup,
                                                                           ETagInfo etag)
                                                                             throws MythServiceApiRuntimeException

- GET

Parameters:

descending -

startIndex -

count -

titleRegEx -

recordingGroup -

storageGroup -

Returns:

Throws:

MythServiceApiRuntimeException

getRecordSchedule

org.springframework.http.ResponseEntity<RecRuleWrapper> getRecordSchedule(int recordId,
                                                                        ETagInfo etag)
                                                                          throws MythServiceApiRuntimeException

- GET

Parameters:

recordId -

Returns:

Throws:

MythServiceApiRuntimeException

getRecordScheduleList

org.springframework.http.ResponseEntity<RecRuleList> getRecordScheduleList(int startIndex,
                                                                         int count,
                                                                         ETagInfo etag)
                                                                           throws MythServiceApiRuntimeException

- GET

Parameters:

startIndex -

count -

Returns:

Throws:

MythServiceApiRuntimeException

getRecorded

org.springframework.http.ResponseEntity<ProgramWrapper> getRecorded(int channelId,
                                                                  org.joda.time.DateTime startTime,
                                                                  ETagInfo etag)
                                                                    throws MythServiceApiRuntimeException

- GET

Parameters:

channelId -

startTime -

Returns:

Throws:

MythServiceApiRuntimeException

getRecordedList

org.springframework.http.ResponseEntity<ProgramList> getRecordedList(ETagInfo etag)
                                                                     throws MythServiceApiRuntimeException

- GET

Returns:

Throws:

MythServiceApiRuntimeException

getRecordedList

org.springframework.http.ResponseEntity<ProgramList> getRecordedList(int startIndex,
                                                                   int count,
                                                                   boolean descending,
                                                                   ETagInfo etag)
                                                                     throws MythServiceApiRuntimeException

- GET

Parameters:

startIndex -

count -

descending -

Returns:

Throws:

MythServiceApiRuntimeException

getUpcomingList

org.springframework.http.ResponseEntity<ProgramList> getUpcomingList(int startIndex,
                                                                   int count,
                                                                   boolean showAll,
                                                                   ETagInfo etag)
                                                                     throws MythServiceApiRuntimeException

- GET

Parameters:

startIndex -

count -

showAll -

Returns:

Throws:

MythServiceApiRuntimeException

removeRecordingSchedule

org.springframework.http.ResponseEntity<Bool> removeRecordingSchedule(int recordingId)
                                                                      throws MythServiceApiRuntimeException

- POST

Parameters:

recordingId -

Returns:

Throws:

MythServiceApiRuntimeException

removeRecorded

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

- GET

Parameters:

channelId -

startTime -

Returns:

Throws:

MythServiceApiRuntimeException