ISchedule.Props (jMythAPI 1.0.3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

org.jmythapi.database
Enum ISchedule.Props

java.lang.Object
  java.lang.Enum<ISchedule.Props>
      org.jmythapi.database.ISchedule.Props

All Implemented Interfaces:: Serializable, Comparable<ISchedule.Props>

Enclosing interface:: ISchedule

public static enum ISchedule.Props
extends Enum<ISchedule.Props>
extends Enum<ISchedule.Props>

Properties of an ISchedule object.

MythTV Protocol Version Matrix
		Protocol
Name	Type	Range	00	-1
REC_ID	Integer	[00,-1)	X	X
REC_TYPE	IProgramRecordingType	[00,-1)	X	X
CHANNEL_ID	Integer	[00,-1)	X	X
START_TIME	Time	[00,-1)	X	X
START_DATE	Date	[00,-1)	X	X
END_TIME	Time	[00,-1)	X	X
END_DATE	Date	[00,-1)	X	X
TITLE	String	[00,-1)	X	X
SUBTITLE	String	[00,-1)	X	X
DESCRIPTION	String	[00,-1)	X	X
SEASON	Integer	[00,-1)	X	X
EPISODE	Integer	[00,-1)	X	X
CATEGORY	String	[00,-1)	X	X
PROFILE	String	[00,-1)	X	X
REC_PRIORITY	Integer	[00,-1)	X	X
AUTOEXPIRE	Boolean	[00,-1)	X	X
'>MAX_EPISODES	Integer	[00,-1)	X	X
'>MAX_NEWEST	Boolean	[00,-1)	X	X
START_OFFSET	Integer	[00,-1)	X	X
END_OFFSET	Integer	[00,-1)	X	X
REC_GROUP	String	[00,-1)	X	X
REC_DUPS	String	[00,-1)	X	X
DUP_METHOD	IProgramRecordingDupMethodType	[00,-1)	X	X
DUP_IN	IProgramRecordingDupInType	[00,-1)	X	X
CHANNEL_SIGN	String	[00,-1)	X	X
SERIES_ID	String	[00,-1)	X	X
PROGRAM_ID	String	[00,-1)	X	X
SEARCH	IProgramRecordingSearchType	[00,-1)	X	X
AUTO_TRANSCODE	Boolean	[00,-1)	X	X
AUTO_COMMFLAG	Boolean	[00,-1)	X	X
AUTO_USERJOB_1	Boolean	[00,-1)	X	X
AUTO_USERJOB_2	Boolean	[00,-1)	X	X
AUTO_USERJOB_3	Boolean	[00,-1)	X	X
AUTO_USERJOB_4	Boolean	[00,-1)	X	X
AUTO_METADATA	Boolean	[00,-1)	X	X
FIND_DAY	Integer	[00,-1)	X	X
FIND_TIME	Time	[00,-1)	X	X
FIND_ID	Integer	[00,-1)	X	X
INACTIVE	Boolean	[00,-1)	X	X
PARENT_ID	Integer	[00,-1)	X	X
TRANSCODER	Integer	[00,-1)	X	X
TS_DEFAULT	Float	[00,-1)	X	X
PLAY_GROUP	String	[00,-1)	X	X
PREF_INPUT	Integer	[00,-1)	X	X
NEXT_RECORD	Date	[00,-1)	X	X
LAST_RECORD	Date	[00,-1)	X	X
LAST_DELETE	Date	[00,-1)	X	X
STORAGEGROUP	String	[00,-1)	X	X
AVG_DELAY	Integer	[00,-1)	X	X
FILTER	Integer	[00,-1)	X	X
INETREF	String	[00,-1)	X	X

Enum Constant Summary
`AUTO_COMMFLAG` Auto commflagging.
`AUTO_METADATA` Auto metadata.
`AUTO_TRANSCODE` Autotranscode.
`AUTO_USERJOB_1` Auto userjob 1.
`AUTO_USERJOB_2` Auto userjob 2.
`AUTO_USERJOB_3` Auto userjob 3.
`AUTO_USERJOB_4` Auto user job 4.
`AUTOEXPIRE` Specifies if the recording will automatically expire.
`AVG_DELAY` Average delay.
`CATEGORY` The category of the recording.
`CHANNEL_ID` The channel ID.
`CHANNEL_SIGN` The channel abbreviation.
`DESCRIPTION` A description about the recording.
`DUP_IN` The duplication type of the recording.
`DUP_METHOD` The duplication mode to use for the recording.
`END_DATE` The scheduled end date of the program.
`END_OFFSET` The recording end offset.
`END_TIME` The scheduled end time of the program.
`EPISODE` The episode number.
`FILTER` Recording filter.
`FIND_DAY` The findday.
`FIND_ID` Find-ID.
`FIND_TIME` The find time.
`INACTIVE` Inactive.
`INETREF` An identification string used by metadata grabbers.
`LAST_DELETE` Last delete.
`LAST_RECORD` Last record.
`MAX_EPISODES` `maxepisodes` int(11) NOT NULL DEFAULT '0'
`MAX_NEWEST` `maxnewest` int(11) NOT NULL DEFAULT '0'
`NEXT_RECORD` Next record.
`PARENT_ID` The recorings parent ID.
`PLAY_GROUP` The play group.
`PREF_INPUT` The prefered input to use.
`PROFILE` The recording profile to use.
`PROGRAM_ID` The program ID.
`REC_DUPS` Deprecated. dbver == "1029"
`REC_GROUP` The recording group.
`REC_ID` The recording ID.
`REC_PRIORITY` The recording priority.
`REC_TYPE` The recording type.
`SEARCH` The search type.
`SEASON` The season.
`SERIES_ID` The series ID.
`START_DATE` The scheduled start date of the program.
`START_OFFSET` The recording start offset.
`START_TIME` The scheduled start time of the program.
`STORAGEGROUP` The storage group.
`SUBTITLE` The recording sub-title.
`TITLE` The recording title.
`TRANSCODER` Transcoder.
`TS_DEFAULT` Deprecated. dbver == "1257"

Method Summary
`static ISchedule.Props`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ISchedule.Props[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Enum Constant Detail

REC_ID

public static final ISchedule.Props REC_ID

The recording ID.

The id the recording in the MythTV database.

`recordid` int(10) unsigned NOT NULL AUTO_INCREMENT

REC_TYPE

public static final ISchedule.Props REC_TYPE

The recording type.

E.g. if the program is recorded a single time or using a weekly time-slot, etc.

`type` int(10) unsigned NOT NULL DEFAULT '0'

See Also:: IProgramRecordingType

CHANNEL_ID

public static final ISchedule.Props CHANNEL_ID

The channel ID.

The unique id of the channel: e.g. 1001.

`chanid` int(10) unsigned DEFAULT NULL

START_TIME

public static final ISchedule.Props START_TIME

The scheduled start time of the program.

`starttime` time NOT NULL DEFAULT '00:00:00'

START_DATE

public static final ISchedule.Props START_DATE

The scheduled start date of the program.

`startdate` date NOT NULL DEFAULT '0000-00-00'

END_TIME

public static final ISchedule.Props END_TIME

The scheduled end time of the program.

`endtime` time NOT NULL DEFAULT '00:00:00'

END_DATE

public static final ISchedule.Props END_DATE

The scheduled end date of the program.

`enddate` date NOT NULL DEFAULT '0000-00-00'

TITLE

public static final ISchedule.Props TITLE

The recording title.

E.g. Malcolm mittendrin

`title` varchar(128) NOT NULL DEFAULT ''

SUBTITLE

public static final ISchedule.Props SUBTITLE

The recording sub-title.

E.g. Victors zweite Familie

`subtitle` varchar(128) NOT NULL DEFAULT ''

DESCRIPTION

public static final ISchedule.Props DESCRIPTION

A description about the recording.

E.g. Als Lois erfährt, dass ihr Vater eine zweite Familie hatte, beschließt sie kurzerhand...

`description` text NOT NULL

SEASON

public static final ISchedule.Props SEASON

The season.

Since:: 67, dbver == "1277"

EPISODE

public static final ISchedule.Props EPISODE

The episode number.

episode SMALLINT(5) NOT NULL"

Since:: 67, dbver == "1277"

PROFILE

public static final ISchedule.Props PROFILE

The recording profile to use.

`profile` varchar(128) NOT NULL DEFAULT 'Default'

REC_PRIORITY

public static final ISchedule.Props REC_PRIORITY

The recording priority.

`recpriority` int(10) NOT NULL DEFAULT '0'

AUTOEXPIRE

public static final ISchedule.Props AUTOEXPIRE

Specifies if the recording will automatically expire.

`autoexpire` int(11) NOT NULL DEFAULT '0'

TODO: this seems to have multiple possible values: http://code.mythtv.org/doxygen/programtypes_8h.html#aa2dbdc45e75666cdb568f45660525c18

MAX_EPISODES

public static final ISchedule.Props MAX_EPISODES

`maxepisodes` int(11) NOT NULL DEFAULT '0'

MAX_NEWEST

public static final ISchedule.Props MAX_NEWEST

`maxnewest` int(11) NOT NULL DEFAULT '0'

START_OFFSET

public static final ISchedule.Props START_OFFSET

The recording start offset.

`startoffset` int(11) NOT NULL DEFAULT '0'

END_OFFSET

public static final ISchedule.Props END_OFFSET

The recording end offset.

`endoffset` int(11) NOT NULL DEFAULT '0'

REC_GROUP

public static final ISchedule.Props REC_GROUP

The recording group.

`recgroup` varchar(32) NOT NULL DEFAULT 'Default'

Since:: dbver == "1029"

REC_DUPS

public static final ISchedule.Props REC_DUPS

Deprecated. dbver == "1029"

The duplication mode and type.

DUP_METHOD

public static final ISchedule.Props DUP_METHOD

The duplication mode to use for the recording.

Specifies how a check for duplicates is done.

`dupmethod` int(11) NOT NULL DEFAULT '6'

Since:

03, dbver == "1029"

See Also:

IProgramRecordingDupMethodType

MythTV protocol range: [00,-1)

	Version	Date	Additional Version Info
Added	00
Removed	-1

DUP_IN

public static final ISchedule.Props DUP_IN

The duplication type of the recording.

Specifies how to handle duplicates.

`dupin` int(11) NOT NULL DEFAULT '15'

Since:: 03, dbver == "1029"
See Also:: IProgramRecordingDupInType

CHANNEL_SIGN

public static final ISchedule.Props CHANNEL_SIGN

The channel abbreviation.

E.g. ORF1

`station` varchar(20) NOT NULL DEFAULT ''

Since:: dbver == "1037"
See Also:: IProgramInfo.getChannelSign()

SERIES_ID

public static final ISchedule.Props SERIES_ID

The series ID.

`seriesid` varchar(40) NOT NULL DEFAULT ''

Since:: 08, dbver == "1042"

PROGRAM_ID

public static final ISchedule.Props PROGRAM_ID

The program ID.

`programid` varchar(40) NOT NULL DEFAULT ''

Since:: 08, dbver == "1042"

SEARCH

public static final ISchedule.Props SEARCH

The search type.

`search` int(10) unsigned NOT NULL DEFAULT '0'

Since:: dbver == "1047"

AUTO_TRANSCODE

public static final ISchedule.Props AUTO_TRANSCODE

Autotranscode.

`autotranscode` tinyint(1) NOT NULL DEFAULT '0'

Since:: dbver == "1057"

AUTO_COMMFLAG

public static final ISchedule.Props AUTO_COMMFLAG

Auto commflagging.

`autocommflag` tinyint(1) NOT NULL DEFAULT '0'

Since:: dbver == "1057"

AUTO_USERJOB_1

public static final ISchedule.Props AUTO_USERJOB_1

Auto userjob 1.

`autouserjob1` tinyint(1) NOT NULL DEFAULT '0'

Since:: dbver == "1057"

AUTO_USERJOB_2

public static final ISchedule.Props AUTO_USERJOB_2

Auto userjob 2.

`autouserjob2` tinyint(1) NOT NULL DEFAULT '0'

Since:: dbver == "1057"

AUTO_USERJOB_3

public static final ISchedule.Props AUTO_USERJOB_3

Auto userjob 3.

`autouserjob3` tinyint(1) NOT NULL DEFAULT '0'

Since:: dbver == "1057"

AUTO_USERJOB_4

public static final ISchedule.Props AUTO_USERJOB_4

Auto user job 4.

`autouserjob4` tinyint(1) NOT NULL DEFAULT '0'

Since:: dbver == "1057"

AUTO_METADATA

public static final ISchedule.Props AUTO_METADATA

Auto metadata.

autometadata TINYINT(1) NOT NULL DEFAULT '0'

FIND_DAY

public static final ISchedule.Props FIND_DAY

The findday.

`findday` tinyint(4) NOT NULL DEFAULT '0'

Since:: dbver == "1061"

FIND_TIME

public static final ISchedule.Props FIND_TIME

The find time.

`findtime` time NOT NULL DEFAULT '00:00:00'

Since:: dbver == "1061"

FIND_ID

public static final ISchedule.Props FIND_ID

Find-ID.

According to the MythTV wiki, this is calculated like this: (UNIX_TIMESTAMP(program.starttime)/60/60/24)+719528

`findid` int(11) NOT NULL DEFAULT '0'

Since:: dbver == "1061"

INACTIVE

public static final ISchedule.Props INACTIVE

Inactive.

Allow deactivating and reactivating a recording rule. When a rule is inactive, programs matching it will not be recorded.

`inactive` tinyint(1) NOT NULL DEFAULT '0'

Since:: dbver == "1062"

PARENT_ID

public static final ISchedule.Props PARENT_ID

The recorings parent ID.

`parentid` int(11) NOT NULL DEFAULT '0'

Since:: dbver == "1082"

TRANSCODER

public static final ISchedule.Props TRANSCODER

Transcoder.

`transcoder` int(11) NOT NULL DEFAULT '0'

Since:: dbver == "1085"

TS_DEFAULT

public static final ISchedule.Props TS_DEFAULT

Deprecated. dbver == "1257"

Time stretch setting.

`tsdefault` float NOT NULL DEFAULT '1'

Since:: dbver == "1088"

PLAY_GROUP

public static final ISchedule.Props PLAY_GROUP

The play group.

`playgroup` varchar(32) NOT NULL DEFAULT 'Default'

dbver == "1108"

PREF_INPUT

public static final ISchedule.Props PREF_INPUT

The prefered input to use.

`prefinput` int(10) NOT NULL DEFAULT '0'

Since:: dbver == "1143"

NEXT_RECORD

public static final ISchedule.Props NEXT_RECORD

Next record.

`next_record` datetime NOT NULL

Since:: dbver == "1158"

LAST_RECORD

public static final ISchedule.Props LAST_RECORD

Last record.

`last_record` datetime NOT NULL

Since:: dbver == "1158"

LAST_DELETE

public static final ISchedule.Props LAST_DELETE

Last delete.

`last_delete` datetime NOT NULL

Since:: dbver == "1158"

STORAGEGROUP

public static final ISchedule.Props STORAGEGROUP

The storage group.

`storagegroup` varchar(32) NOT NULL DEFAULT 'Default'

Since:: dbver == "1171"

AVG_DELAY

public static final ISchedule.Props AVG_DELAY

Average delay.

`avg_delay` int(11) NOT NULL DEFAULT '100'

Since:: dbver == "1193"

FILTER

public static final ISchedule.Props FILTER

Recording filter.

filter INT UNSIGNED NOT NULL DEFAULT 0

Since:: dbver == "1277"

INETREF

public static final ISchedule.Props INETREF

An identification string used by metadata grabbers.

inetref VARCHAR(40) NOT NULL

Since:: dbver == "1278"

Method Detail

values

public static ISchedule.Props[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ISchedule.Props c : ISchedule.Props.values())
    System.out.println(c);

Returns:: an array containing the constants of this enum type, in the order they are declared

valueOf

public static ISchedule.Props valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:: name - the name of the enum constant to be returned.
Returns:: the enum constant with the specified name
Throws:: IllegalArgumentException - if this enum type has no constant with the specified name; NullPointerException - if the argument is null