org.jmythapi.protocol.response
Enum IProgramInfo.Props

java.lang.Object
  extended by java.lang.Enum<IProgramInfo.Props>
      extended by org.jmythapi.protocol.response.IProgramInfo.Props
All Implemented Interfaces:
Serializable, Comparable<IProgramInfo.Props>
Enclosing interface:
IProgramInfo

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

The properties of an IProgramInfo response.

MythTV Protocol Version Matrix
 Protocol
NameTypeRange0002030608111215182223253132354123056576776-1
TITLEString[00,-1)XXXXXXXXXXXXXXXXXXXXX
SUBTITLEString[00,-1)XXXXXXXXXXXXXXXXXXXXX
DESCRIPTIONString[00,-1)XXXXXXXXXXXXXXXXXXXXX
SEASONInteger[67,-1)------------------XXX
EPISODEInteger[67,-1)------------------XXX
SYNDICATED_EPISODEString[76,-1)-------------------XX
CATEGORYString[00,-1)XXXXXXXXXXXXXXXXXXXXX
CHANNEL_IDInteger[00,-1)XXXXXXXXXXXXXXXXXXXXX
CHANNEL_NUMBERString[00,-1)XXXXXXXXXXXXXXXXXXXXX
CHANNEL_SIGNString[00,-1)XXXXXXXXXXXXXXXXXXXXX
CHANNEL_NAMEString[00,-1)XXXXXXXXXXXXXXXXXXXXX
PATH_NAMEString[00,-1)XXXXXXXXXXXXXXXXXXXXX
FILESIZE_HIGHLong[00,57)XXXXXXXXXXXXXXXXX----
FILESIZE_LOWLong[00,57)XXXXXXXXXXXXXXXXX----
FILESIZELong[57,-1)-----------------XXXX
START_DATE_TIMEDate[00,-1)XXXXXXXXXXXXXXXXXXXXX
END_DATE_TIMEDate[00,-1)XXXXXXXXXXXXXXXXXXXXX
DUPLICATEBoolean[00,57)XXXXXXXXXXXXXXXXX----
SHAREABLEBoolean[00,57)XXXXXXXXXXXXXXXXX----
FIND_IDInteger[00,-1)XXXXXXXXXXXXXXXXXXXXX
HOSTNAMEString[00,-1)XXXXXXXXXXXXXXXXXXXXX
SOURCE_IDInteger[00,-1)XXXXXXXXXXXXXXXXXXXXX
CARD_IDInteger[00,-1)XXXXXXXXXXXXXXXXXXXXX
INPUT_IDInteger[00,-1)XXXXXXXXXXXXXXXXXXXXX
REC_PRIORITYInteger[00,-1)XXXXXXXXXXXXXXXXXXXXX
REC_STATUSIProgramRecordingStatus[00,-1)XXXXXXXXXXXXXXXXXXXXX
REC_IDInteger[00,-1)XXXXXXXXXXXXXXXXXXXXX
REC_TYPEIProgramRecordingType[00,-1)XXXXXXXXXXXXXXXXXXXXX
REC_DUPSInteger[00,03)XX-------------------
DUP_INIProgramRecordingDupInType[03,-1)--XXXXXXXXXXXXXXXXXXX
DUP_METHODIProgramRecordingDupMethodType[03,-1)--XXXXXXXXXXXXXXXXXXX
REC_START_TIMEDate[00,-1)XXXXXXXXXXXXXXXXXXXXX
REC_END_TIMEDate[00,-1)XXXXXXXXXXXXXXXXXXXXX
REPEATBoolean[00,57)XXXXXXXXXXXXXXXXX----
PROGRAM_FLAGSIProgramFlags[00,-1)XXXXXXXXXXXXXXXXXXXXX
REC_GROUPString[03,-1)--XXXXXXXXXXXXXXXXXXX
CHAN_COMM_FREEBoolean[03,57)--XXXXXXXXXXXXXXX----
CHANNEL_OUTPUT_FILTERSString[06,-1)---XXXXXXXXXXXXXXXXXX
SERIES_IDString[08,-1)----XXXXXXXXXXXXXXXXX
PROGRAM_IDString[08,-1)----XXXXXXXXXXXXXXXXX
INETREFString[67,-1)------------------XXX
LAST_MODIFIEDDate[11,-1)-----XXXXXXXXXXXXXXXX
STARSFloat[12,-1)------XXXXXXXXXXXXXXX
ORIGINAL_AIRDATEDate[12,-1)------XXXXXXXXXXXXXXX
HAS_AIRDATEBoolean[15,57)-------XXXXXXXXXX----
TIMESTRETCHFloat[18,23)--------XX-----------
PLAY_GROUPString[23,-1)----------XXXXXXXXXXX
REC_PRIORITY2Integer[25,-1)-----------XXXXXXXXXX
PARENT_IDInteger[31,-1)------------XXXXXXXXX
STORAGE_GROUPString[32,-1)-------------XXXXXXXX
AUDIO_PROPERTIESIProgramAudioProperties[35,-1)--------------XXXXXXX
VIDEO_PROPERTIESIProgramVideoProperties[35,-1)--------------XXXXXXX
SUBTITLE_TYPEIProgramSubtitleType[35,-1)--------------XXXXXXX
YEARInteger[41,-1)---------------XXXXXX
PART_NUMBERInteger[76,-1)-------------------XX
PART_TOTALInteger[76,-1)-------------------XX

See Also:
programinfo.cpp: ProgramInfo::ToStringList(..)

Enum Constant Summary
AUDIO_PROPERTIES
          Audio properties.
CARD_ID
          The ID of a physical capture card.
CATEGORY
          The category of the recording.
CHAN_COMM_FREE
          Deprecated. 57, replaced by IProgramFlags.Flags.FL_CHANCOMMFREE
CHANNEL_ID
          The channel ID.
CHANNEL_NAME
          The channel name.
CHANNEL_NUMBER
          The channel number.
CHANNEL_OUTPUT_FILTERS
          Output filters.
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.
DUPLICATE
          Deprecated. 57, replaced by IProgramFlags.Flags.FL_DUPLICATE
END_DATE_TIME
          The scheduled end of the program.
EPISODE
          The episode number of the recording.
FILESIZE
          The recording file size.
FILESIZE_HIGH
          Deprecated. 57, replaced by FILESIZE
FILESIZE_LOW
          Deprecated. 57, replaced by FILESIZE
FIND_ID
          The find-id.
HAS_AIRDATE
          Deprecated. 57
HOSTNAME
          The recording host.
INETREF
          An identification string used by metadata grabbers.
INPUT_ID
          The ID of a specific input.
LAST_MODIFIED
          Last modification time.
ORIGINAL_AIRDATE
          The original airdate.
PARENT_ID
          Parent ID.
PART_NUMBER
          Part Number.
PART_TOTAL
          Part Total.
PATH_NAME
          The recording file.
PLAY_GROUP
          The play group.
PROGRAM_FLAGS
          Program flags.
PROGRAM_ID
          Program ID.
REC_DUPS
          Deprecated. 03, replaced by DUP_IN and DUP_METHOD
REC_END_TIME
          End of actual recording.
REC_GROUP
          Recording Groups.
REC_ID
          The recording ID.
REC_PRIORITY
          The recording priority.
REC_PRIORITY2
          Recording Priority 2.
REC_START_TIME
          Beginning of actual recording.
REC_STATUS
          The current recording status of the encoder.
REC_TYPE
          The recording type.
REPEAT
          Deprecated. 57, replaced by IProgramFlags.Flags.FL_REPEAT
SEASON
          The season number of the recording.
SERIES_ID
          Series ID.
SHAREABLE
          Deprecated. 57
SOURCE_ID
          The source ID.
STARS
          Rating.
START_DATE_TIME
          The scheduled start of the program.
STORAGE_GROUP
          Storage group.
SUBTITLE
          The recording sub-title.
SUBTITLE_TYPE
          Subtitle type.
SYNDICATED_EPISODE
          The syndicated episode of the recording.
TIMESTRETCH
          Deprecated. 23, replaced by PLAY_GROUP.
TITLE
          The recording title.
VIDEO_PROPERTIES
          Video Properties.
YEAR
          Production year.
 
Method Summary
static IProgramInfo.Props valueOf(String name)
          Returns the enum constant of this type with the specified name.
static IProgramInfo.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

TITLE

public static final IProgramInfo.Props TITLE
The recording title.

E.g. Malcolm mittendrin

See Also:
IProgramInfo.getTitle()

SUBTITLE

public static final IProgramInfo.Props SUBTITLE
The recording sub-title.

E.g. Victors zweite Familie

For a manually scheduled recording the subtitle is always set to the program-start-time by the MythTV scheduler.

See Also:
IProgramInfo.getSubtitle()

DESCRIPTION

public static final IProgramInfo.Props DESCRIPTION
A description about the recording.

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

See Also:
IProgramInfo.getDescription()

SEASON

public static final IProgramInfo.Props SEASON
The season number of the recording.

Since:
67
See Also:
IProgramInfo.getSeason()

EPISODE

public static final IProgramInfo.Props EPISODE
The episode number of the recording.

Since:
67
See Also:
IProgramInfo.getEpisode()

SYNDICATED_EPISODE

public static final IProgramInfo.Props SYNDICATED_EPISODE
The syndicated episode of the recording.

Since:
76
See Also:
IProgramInfo.getSyndicatedEpisode()

CATEGORY

public static final IProgramInfo.Props CATEGORY
The category of the recording.

E.g. comedy

See Also:
IProgramInfo.getCategory()

CHANNEL_ID

public static final IProgramInfo.Props CHANNEL_ID
The channel ID.

The unique id of the channel: e.g. 1001.
This is similar to IRecorderChannelInfo.Props#CHANNEL_ID.

See Also:
IProgramInfo.getChannelID()

CHANNEL_NUMBER

public static final IProgramInfo.Props CHANNEL_NUMBER
The channel number.

The user defined number of the channel: e.g. 2
This is similar to IRecorderChannelInfo.Props#CHANNEL_NUMBER.

See Also:
IProgramInfo.getChannelNumber()

CHANNEL_SIGN

public static final IProgramInfo.Props CHANNEL_SIGN
The channel abbreviation.

E.g. ORF1
This is similar to IRecorderChannelInfo.Props#CHANNEL_SIGN.

See Also:
IProgramInfo.getChannelSign()

CHANNEL_NAME

public static final IProgramInfo.Props CHANNEL_NAME
The channel name.

The full name of the channel: e.g. ORF 1
This is similar to IRecorderChannelInfo.Props#CHANNEL_NAME.

See Also:
IProgramInfo.getChannelName()

PATH_NAME

public static final IProgramInfo.Props PATH_NAME
The recording file.

E.g. myth://127.0.0.1:6543/1000_20100512085000.mpg or E.g. /var/lib/mythtv/livetv/1004_20120113085933.mpg

See Also:
IProgramInfo.getPathName()

FILESIZE_HIGH

public static final IProgramInfo.Props FILESIZE_HIGH
Deprecated. 57, replaced by FILESIZE
First part of the file size.

High 32bit of the file-size.

See Also:
IProgramInfo.getFileSize()

FILESIZE_LOW

public static final IProgramInfo.Props FILESIZE_LOW
Deprecated. 57, replaced by FILESIZE
Second part of the file size.

Low 32bit of the file-size.

See Also:
IProgramInfo.getFileSize()

FILESIZE

public static final IProgramInfo.Props FILESIZE
The recording file size.

This is a replacement for FILESIZE_LOW and FILESIZE_HIGH.

See Also:
IProgramInfo.getFileSize()

START_DATE_TIME

public static final IProgramInfo.Props START_DATE_TIME
The scheduled start of the program.

See Also:
IProgramInfo.getStartDateTime()

END_DATE_TIME

public static final IProgramInfo.Props END_DATE_TIME
The scheduled end of the program.

See Also:
IProgramInfo.getEndDateTime()

DUPLICATE

public static final IProgramInfo.Props DUPLICATE
Deprecated. 57, replaced by IProgramFlags.Flags.FL_DUPLICATE
Marks a recording as duplicate.

Note:
In protocol 04 this was the conflicting property?

See Also:
IProgramInfo.isDuplicate()

SHAREABLE

public static final IProgramInfo.Props SHAREABLE
Deprecated. 57
Shareable card inputs.

Signals that the used card input can be shared, e.g. on DVB cards. Till protocol version 57 this information was used by the scheduler.

Note:
In protocol 04 this was the recording.

See Also:
IProgramInfo.isShareable()

FIND_ID

public static final IProgramInfo.Props FIND_ID
The find-id.

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

Note:
In protocol 04, this was the override property.

See Also:
IProgramInfo.getFindID()

HOSTNAME

public static final IProgramInfo.Props HOSTNAME
The recording host.

See Also:
IProgramInfo.getHostName()

SOURCE_ID

public static final IProgramInfo.Props SOURCE_ID
The source ID.

This is usually the first digit of the channel ID.

See Also:
IProgramInfo.getSourceID()

CARD_ID

public static final IProgramInfo.Props CARD_ID
The ID of a physical capture card.

This is the ID of the recorder that will record a scheduled program.
The card-is is 0 for an already recorded program.

See Also:
IProgramInfo.getCardID()

INPUT_ID

public static final IProgramInfo.Props INPUT_ID
The ID of a specific input.
The card-is is 0 for an already recorded program.

See Also:
IProgramInfo.getInputID()

REC_PRIORITY

public static final IProgramInfo.Props REC_PRIORITY
The recording priority.

Values are between -20 and 20.

See Also:
IProgramInfo.getRecordingPriority()

REC_STATUS

public static final IProgramInfo.Props REC_STATUS
The current recording status of the encoder.

This is similar to IRemoteEncoder.getRecordingStatus().
See here for all available status types.

See Also:
IProgramRecordingStatus, IProgramInfo.getRecordingStatus(), IRemoteEncoder.getRecordingStatus()

REC_ID

public static final IProgramInfo.Props REC_ID
The recording ID.

ATTENTION: This is the ID of the mythtv scheduling rule, stored in the database. Therefore multiple recordings may have the same recording id!
If you require a unique id for a recording, use IProgramInfo.getUniqueRecordingId() instead.

See Also:
IProgramInfo.getRecordingId()

REC_TYPE

public static final IProgramInfo.Props REC_TYPE
The recording type.

E.g. if the program is recorded a single time or using a weekly time-slot, etc.
See here for all available types.

See Also:
IProgramRecordingType, IProgramInfo.getRecordingType()

REC_DUPS

public static final IProgramInfo.Props REC_DUPS
Deprecated. 03, replaced by DUP_IN and DUP_METHOD
The duplication type and mode of the recording.


DUP_IN

public static final IProgramInfo.Props DUP_IN
The duplication type of the recording.

Specifies how to handle duplicates.
See here for all available types.

Since:
03
See Also:
IProgramRecordingDupInType, IProgramInfo.getRecordingDuplicationType()

DUP_METHOD

public static final IProgramInfo.Props DUP_METHOD
The duplication mode to use for the recording.

Specifies how a check for duplicates is done.
See here for all available types.

Since:
03
See Also:
IProgramRecordingDupMethodType, IProgramInfo.getRecordingDuplicationMethod()
MythTV protocol range: [03,-1)
 VersionDateAdditional Version Info
Added032004-02-05Changelog, SVN-Rev.: 3112
Removed-1 

REC_START_TIME

public static final IProgramInfo.Props REC_START_TIME
Beginning of actual recording.

See Also:
IProgramInfo.getRecordingStartTime()

REC_END_TIME

public static final IProgramInfo.Props REC_END_TIME
End of actual recording.

See Also:
IProgramInfo.getRecordingEndTime()

REPEAT

public static final IProgramInfo.Props REPEAT
Deprecated. 57, replaced by IProgramFlags.Flags.FL_REPEAT
Repeated program.

Specifies if this is a duplicate to a previously recorded program.

See Also:
IProgramInfo.isRepeat()

PROGRAM_FLAGS

public static final IProgramInfo.Props PROGRAM_FLAGS
Program flags.

Additional information about the current state of the recording.
See here for all available flags}.

See Also:
IProgramInfo.getProgramFlags(), IProgramFlags

REC_GROUP

public static final IProgramInfo.Props REC_GROUP
Recording Groups.

A scheduled recording can have a group assigned.

Since:
03
See Also:
IProgramInfo.getRecordingGroup()

CHAN_COMM_FREE

public static final IProgramInfo.Props CHAN_COMM_FREE
Deprecated. 57, replaced by IProgramFlags.Flags.FL_CHANCOMMFREE
Commercial free status.

Indicates if the channel is commercial free.

Since:
03
See Also:
IProgramInfo.isChannelCommFree()

CHANNEL_OUTPUT_FILTERS

public static final IProgramInfo.Props CHANNEL_OUTPUT_FILTERS
Output filters.

Allows to specify a set of filters to be used when playing back recordings from a given channel. This is useful for those with hardware encoders and more than one source, since filters are rarely a one-size-fits-all thing.

Since:
06
See Also:
IProgramInfo.getChannelOuputFilters()

SERIES_ID

public static final IProgramInfo.Props SERIES_ID
Series ID.

Is used for dup checks.

Since:
08
See Also:
IProgramInfo.getSeriesID()

PROGRAM_ID

public static final IProgramInfo.Props PROGRAM_ID
Program ID.

Is used for dup checks.

Since:
08
See Also:
IProgramInfo.getProgramID()

INETREF

public static final IProgramInfo.Props INETREF
An identification string used by metadata grabbers.

Since:
67
See Also:
IProgramInfo.getInetRef()

LAST_MODIFIED

public static final IProgramInfo.Props LAST_MODIFIED
Last modification time.

Keeps track of the last time the entry was updated.

Since:
11
See Also:
IProgramInfo.getLastModified()

STARS

public static final IProgramInfo.Props STARS
Rating.

The "stars" rating of the program.

Since:
12
See Also:
IProgramInfo.getStars()

ORIGINAL_AIRDATE

public static final IProgramInfo.Props ORIGINAL_AIRDATE
The original airdate.

Since:
12
See Also:
IProgramInfo.getOriginalAirdate()

HAS_AIRDATE

public static final IProgramInfo.Props HAS_AIRDATE
Deprecated. 57
Air date available.

Specifies if an original air date is available.

Since:
15
See Also:
IProgramInfo.hasAirDate()

TIMESTRETCH

public static final IProgramInfo.Props TIMESTRETCH
Deprecated. 23, replaced by PLAY_GROUP.
Time stretch setting for recording.

Since:
18
See Also:
IProgramInfo.getTimeStretch()

PLAY_GROUP

public static final IProgramInfo.Props PLAY_GROUP
The play group.

The play group of the recording.

Like recording groups (aka recgroups), each recording is put into a playgroup when it is recorded as specified in its recording rule. When that recording is watched, selected playback options are set based on the playgroup instead of using system or host specific settings.

Since:
23
See Also:
IProgramInfo.getPlayGroup()

REC_PRIORITY2

public static final IProgramInfo.Props REC_PRIORITY2
Recording Priority 2.

An additional priority value.

TODO: This priority value seems to be specified via programinfo.h/WatchListStatus, if the value is lower -1. Otherwise it is interpreted as "watchListScore".

Since:
25
See Also:
IProgramInfo.getRecordingPriority2()

PARENT_ID

public static final IProgramInfo.Props PARENT_ID
Parent ID.

If this recording is a duplicate, the ID of the parent is specified here.

This is used in combination with IProgramRecordingType.Type.OVERRIDE_RECORD.

Since:
31
See Also:
IProgramInfo.getParentID(), ISchedule.Props#PARENT_ID

STORAGE_GROUP

public static final IProgramInfo.Props STORAGE_GROUP
Storage group.

The storage group of the recording.

Since:
32
See Also:
IProgramInfo.getStorageGroup()

AUDIO_PROPERTIES

public static final IProgramInfo.Props AUDIO_PROPERTIES
Audio properties.

Audio properties of the recording.
See here for all available properties.

Since:
35
See Also:
IProgramInfo.getAudioProperties(), IProgramAudioProperties

VIDEO_PROPERTIES

public static final IProgramInfo.Props VIDEO_PROPERTIES
Video Properties.

Video properties of the recording.
See here for all available properties.

Since:
35
See Also:
IProgramInfo.getVideoProperties(), IProgramVideoProperties

SUBTITLE_TYPE

public static final IProgramInfo.Props SUBTITLE_TYPE
Subtitle type.

The subtitle type of the recording.
See here for all available types.

Since:
35
See Also:
IProgramInfo.getSubtitleType(), IProgramSubtitleType

YEAR

public static final IProgramInfo.Props YEAR
Production year.

Since:
41
See Also:
IProgramInfo.getYear()

PART_NUMBER

public static final IProgramInfo.Props PART_NUMBER
Part Number.

Since:
76

PART_TOTAL

public static final IProgramInfo.Props PART_TOTAL
Part Total.

Since:
76
Method Detail

values

public static IProgramInfo.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 (IProgramInfo.Props c : IProgramInfo.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 IProgramInfo.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


Copyright © 2008-2013. All Rights Reserved.