org.jmythapi.protocol.response
Enum IRecorderProgramInfo.Props

java.lang.Object
  java.lang.Enum<IRecorderProgramInfo.Props>
      org.jmythapi.protocol.response.IRecorderProgramInfo.Props

All Implemented Interfaces:

Serializable, Comparable<IRecorderProgramInfo.Props>

Enclosing interface:

IRecorderProgramInfo

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

The properties of an IRecorderProgramInfo response.

MythTV Protocol Version Matrix
		Protocol
Name	Type	Range	00	08	10	13	20	21
TITLE	String	[00,21)	X	X	X	X	X	-
SUBTITLE	String	[00,21)	X	X	X	X	X	-
DESCRIPTION	String	[00,21)	X	X	X	X	X	-
CATEGORY	String	[00,21)	X	X	X	X	X	-
START_DATE_TIME	Date	[00,21)	X	X	X	X	X	-
END_DATE_TIME	Date	[00,21)	X	X	X	X	X	-
CHANNEL_SIGN	String	[00,21)	X	X	X	X	X	-
CHANNEL_ICON_PATH	String	[00,21)	X	X	X	X	X	-
CHANNEL_NUMBER	String	[00,21)	X	X	X	X	X	-
CHANNEL_ID	Integer	[00,21)	X	X	X	X	X	-
SERIES_ID	String	[08,21)	-	X	X	X	X	-
PROGRAM_ID	String	[08,21)	-	X	X	X	X	-
CHANNEL_OUTPUT_FILTERS	String	[10,21)	-	-	X	X	X	-
REPEAT	Boolean	[13,21)	-	-	-	X	X	-
ORIGINAL_AIRDATE	Date	[13,21)	-	-	-	X	X	-
STARS	Float	[13,21)	-	-	-	X	X	-

Enum Constant Summary

CATEGORY
The program category.

CHANNEL_ICON_PATH
The channel icon path.

CHANNEL_ID
The channel ID.

CHANNEL_NUMBER
The channel number.

CHANNEL_OUTPUT_FILTERS
Output filters.

CHANNEL_SIGN
The channel abbreviation.

DESCRIPTION
A description about the program.

END_DATE_TIME
The scheduled end of the program.

ORIGINAL_AIRDATE
The original airdate.

PROGRAM_ID
Program ID.

REPEAT
Repeated program.

SERIES_ID
Series ID.

STARS
Rating.

START_DATE_TIME
The scheduled start of the program.

SUBTITLE
The program sub-title.

TITLE
The program title.

Method Summary

static IRecorderProgramInfo.Props	valueOf(String name) Returns the enum constant of this type with the specified name.
static IRecorderProgramInfo.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 IRecorderProgramInfo.Props TITLE

The program title.

See Also:

IRecorderProgramInfo.getTitle()

SUBTITLE

public static final IRecorderProgramInfo.Props SUBTITLE

The program sub-title.

See Also:

IRecorderProgramInfo.getSubtitle()

DESCRIPTION

public static final IRecorderProgramInfo.Props DESCRIPTION

A description about the program.

See Also:

IRecorderProgramInfo.getDescription()

CATEGORY

public static final IRecorderProgramInfo.Props CATEGORY

The program category.

e.g. comedy

See Also:

IRecorderProgramInfo.getCategory()

START_DATE_TIME

public static final IRecorderProgramInfo.Props START_DATE_TIME

The scheduled start of the program.

See Also:

IRecorderProgramInfo.getStartDateTime()

END_DATE_TIME

public static final IRecorderProgramInfo.Props END_DATE_TIME

The scheduled end of the program.

See Also:

IRecorderProgramInfo.getEndDateTime()

CHANNEL_SIGN

public static final IRecorderProgramInfo.Props CHANNEL_SIGN

The channel abbreviation.

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

See Also:

IRecorderProgramInfo.getChannelSign()

CHANNEL_ICON_PATH

public static final IRecorderProgramInfo.Props CHANNEL_ICON_PATH

The channel icon path.

See Also:

IRecorderProgramInfo.getChannelIconPath()

CHANNEL_NUMBER

public static final IRecorderProgramInfo.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:

IRecorderProgramInfo.getChannelNumber()

CHANNEL_ID

public static final IRecorderProgramInfo.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:

IRecorderProgramInfo.getChannelID()

SERIES_ID

public static final IRecorderProgramInfo.Props SERIES_ID

Series ID.

Is used for dup checks.

Since:

08

See Also:

IRecorderProgramInfo.getSeriesID()

PROGRAM_ID

public static final IRecorderProgramInfo.Props PROGRAM_ID

Program ID.

Is used for dup checks.

Since:

08

See Also:

IRecorderProgramInfo.getProgramID()

CHANNEL_OUTPUT_FILTERS

public static final IRecorderProgramInfo.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:

10

See Also:

IRecorderProgramInfo.getChannelOutputFilters()

REPEAT

public static final IRecorderProgramInfo.Props REPEAT

Repeated program.

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

Since:

13

See Also:

IRecorderProgramInfo.isRepeat()

ORIGINAL_AIRDATE

public static final IRecorderProgramInfo.Props ORIGINAL_AIRDATE

The original airdate.

Since:

13

See Also:

IRecorderProgramInfo.getOritinalAirDate()

STARS

public static final IRecorderProgramInfo.Props STARS

Rating.

Since:

13

See Also:

IRecorderProgramInfo.getStars()

Method Detail

values

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