org.jmythapi.protocol.response
Enum IProgramRecordingStatus.Status

java.lang.Object
  java.lang.Enum<IProgramRecordingStatus.Status>
      org.jmythapi.protocol.response.IProgramRecordingStatus.Status

All Implemented Interfaces:

Serializable, Comparable<IProgramRecordingStatus.Status>, IVersionableValue

Enclosing interface:

IProgramRecordingStatus

public static enum IProgramRecordingStatus.Status
extends Enum<IProgramRecordingStatus.Status>
implements IVersionableValue

The values of the IProgramInfo.Props.REC_STATUS property.

A response example:

For Live-TV recording:

-2=> {RECORDING}

MythTV Protocol Version Matrix
		Protocol
Name	Type	Range	00	03	04	06	07	12	15	17	18	19	28	31	33	63	65	73	-1
OTHER_RECORDING	String	[73,-1)	-	-	-	-	-	-	-	-	-	-	-	-	-	-	-	X	X
OTHER_TUNING	String	[73,-1)	-	-	-	-	-	-	-	-	-	-	-	-	-	-	-	X	X
MISSED_FUTURE	String	[65,-1)	-	-	-	-	-	-	-	-	-	-	-	-	-	-	X	X	X
TUNING	String	[63,-1)	-	-	-	-	-	-	-	-	-	-	-	-	-	X	X	X	X
FAILED	String	[31,-1)	-	-	-	-	-	-	-	-	-	-	-	X	X	X	X	X	X
TUNER_BUSY	String	[00,-1)	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X
LOW_DISKSPACE	String	[00,-1)	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X
CANCELLED	String	[00,-1)	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X
DELETED	String	[00,19)	X	X	X	X	X	X	X	X	X	-	-	-	-	-	-	-	-
MISSED	String	[19,-1)	-	-	-	-	-	-	-	-	-	X	X	X	X	X	X	X	X
STOPPED	String	[00,19)	X	X	X	X	X	X	X	X	X	-	-	-	-	-	-	-	-
ABORTED	String	[19,-1)	-	-	-	-	-	-	-	-	-	X	X	X	X	X	X	X	X
RECORDED	String	[00,-1)	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X
RECORDING	String	[00,-1)	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X
WILL_RECORD	String	[00,-1)	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X
UNKNOWN	String	[00,-1)	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X
MANUAL_OVERRIDE	String	[00,07)	X	X	X	X	-	-	-	-	-	-	-	-	-	-	-	-	-
DONT_RECORD	String	[07,-1)	-	-	-	-	X	X	X	X	X	X	X	X	X	X	X	X	X
PREVIOUS_RECORDING	String	[00,-1)	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X
CURRENT_RECORDING	String	[00,-1)	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X
EARLIER_SHOWING	String	[00,-1)	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X
TOO_MANY_RECORDINGS	String	[00,-1)	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X
NOT_LISTED	String	[17,-1)	-	-	-	-	-	-	-	X	X	X	X	X	X	X	X	X	X
LOWER_REC_PRIORITY	String	[00,04)	X	X	-	-	-	-	-	-	-	-	-	-	-	-	-	-	-
CONFLICT	String	[04,-1)	-	-	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X
MANUAL_CONFLICT	String	[00,04)	X	X	-	-	-	-	-	-	-	-	-	-	-	-	-	-	-
LATER_SHOWING	String	[04,-1)	-	-	X	X	X	X	X	X	X	X	X	X	X	X	X	X	X
AUTO_CONFLICT	String	[00,04)	X	X	-	-	-	-	-	-	-	-	-	-	-	-	-	-	-
REPEAT	String	[12,-1)	-	-	-	-	-	X	X	X	X	X	X	X	X	X	X	X	X
OVERLAP	String	[00,07)	X	X	X	X	-	-	-	-	-	-	-	-	-	-	-	-	-
INACTIVE	String	[15,-1)	-	-	-	-	-	-	X	X	X	X	X	X	X	X	X	X	X
NEVER_RECORD	String	[19,-1)	-	-	-	-	-	-	-	-	-	X	X	X	X	X	X	X	X
OFFLINE	String	[28,-1)	-	-	-	-	-	-	-	-	-	-	X	X	X	X	X	X	X
OTHER_SHOWING	String	[33,-1)	-	-	-	-	-	-	-	-	-	-	-	-	X	X	X	X	X

See Also:

libmyth/programtypes.h, libmyth/mythcontext.h (as of 2010-05-16), libmyth/programinfo.h (till 2010-05-16)

Nested Class Summary

Nested classes/interfaces inherited from interface org.jmythapi.protocol.response.IVersionableValue

IVersionableValue.VersionablePair

Enum Constant Summary

ABORTED
Aborted.

AUTO_CONFLICT
Deprecated. as of 04

CANCELLED
Manual Cancel.

CONFLICT
Conflicting.

CURRENT_RECORDING
Currently Recorded.

DELETED
Deprecated. in 19

DONT_RECORD
Don't Record.

EARLIER_SHOWING
Earlier Showing.

FAILED
Recorder Failed.

INACTIVE
Inactive.

LATER_SHOWING
Later Showing.

LOW_DISKSPACE
Low Disk Space.

LOWER_REC_PRIORITY
Deprecated. as of 04, replaced by CONFLICT.

MANUAL_CONFLICT
Deprecated. as of 04

MANUAL_OVERRIDE
Deprecated. as of 07, use DONT_RECORD instead.

MISSED
Missed.

MISSED_FUTURE
Missed Future.

NEVER_RECORD
Never Record.

NOT_LISTED
Not Listed.

OFFLINE
Recorder Off-Line.

OTHER_RECORDING
Other Recording.

OTHER_SHOWING
Other Showing.

OTHER_TUNING
Other Tuning.

OVERLAP
Deprecated. as of 07

PREVIOUS_RECORDING
Previously Recorded.

RECORDED
Recorded.

RECORDING
Recording.

REPEAT
Repeat.

STOPPED
Deprecated. in 19

TOO_MANY_RECORDINGS
Max Recordings.

TUNER_BUSY
Tuner Busy.

TUNING
Tuning.

UNKNOWN
Unknown.

WILL_RECORD
Will Record.

Method Summary

Long	getFlagValue()
Long	getValue(ProtocolVersion protoVersion) Returns the actual property value for the given protocol version.
IVersionableValue.VersionablePair[]	getValues() Gets all possible values for the given property.
static IProgramRecordingStatus.Status	valueOf(String name) Returns the enum constant of this type with the specified name.
static IProgramRecordingStatus.Status[]	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

OTHER_RECORDING

public static final IProgramRecordingStatus.Status OTHER_RECORDING

Other Recording.

This showing is being recorded on a different channel.

These status is analogous to the existing RECORDING status and indicates that a recording of the program is active on another related channel.

Since:

73

See Also:

RECORDING

OTHER_TUNING

public static final IProgramRecordingStatus.Status OTHER_TUNING

Other Tuning.

The showing is being tuned on a different channel.

These status is analogous to the existing TUNING status and indicates that a recording of the program is active on another related channel.

Since:

73

See Also:

TUNING

MISSED_FUTURE

public static final IProgramRecordingStatus.Status MISSED_FUTURE

Missed Future.

This showing was not recorded because the master backend was hung or not running.

Since:

65

TUNING

public static final IProgramRecordingStatus.Status TUNING

Tuning.

The channel is being tuned.

Since:

63

FAILED

public static final IProgramRecordingStatus.Status FAILED

Recorder Failed.

E.g. if the recorder fails to tune in the channel.

Since:

31

TUNER_BUSY

public static final IProgramRecordingStatus.Status TUNER_BUSY

Tuner Busy.

The tuner card was already being used.

LOW_DISKSPACE

public static final IProgramRecordingStatus.Status LOW_DISKSPACE

Low Disk Space.

There wasn't enough disk space available.

CANCELLED

public static final IProgramRecordingStatus.Status CANCELLED

Manual Cancel.

This showing was not recorded because it was manually cancelled.

DELETED

public static final IProgramRecordingStatus.Status DELETED

Deprecated. in 19

Deleted.

This showing was recorded but was deleted.

MISSED

public static final IProgramRecordingStatus.Status MISSED

Missed.

This showing was not recorded because it was scheduled after it would have ended.

Since:

19

STOPPED

public static final IProgramRecordingStatus.Status STOPPED

Deprecated. in 19

Stopped.

This showing was recorded but was stopped before recording was completed.

ABORTED

public static final IProgramRecordingStatus.Status ABORTED

Aborted.

This showing was recorded but was aborted before recording was completed.

Since:

19

RECORDED

public static final IProgramRecordingStatus.Status RECORDED

Recorded.

This showing was recorded.

RECORDING

public static final IProgramRecordingStatus.Status RECORDING

Recording.

This showing is being recorded.

WILL_RECORD

public static final IProgramRecordingStatus.Status WILL_RECORD

Will Record.

This showing will be recorded.

UNKNOWN

public static final IProgramRecordingStatus.Status UNKNOWN

Unknown.

The status of this showing is unknown.

MANUAL_OVERRIDE

public static final IProgramRecordingStatus.Status MANUAL_OVERRIDE

Deprecated. as of 07, use DONT_RECORD instead.

Manual Override.

It was manually set to not record.

DONT_RECORD

public static final IProgramRecordingStatus.Status DONT_RECORD

Don't Record.

It was manually set to not record.

Since:

07

PREVIOUS_RECORDING

public static final IProgramRecordingStatus.Status PREVIOUS_RECORDING

Previously Recorded.

This episode was previously recorded according to the duplicate policy chosen for this title.

CURRENT_RECORDING

public static final IProgramRecordingStatus.Status CURRENT_RECORDING

Currently Recorded.

This episode was previously recorded and is still available in the list of recordings.

EARLIER_SHOWING

public static final IProgramRecordingStatus.Status EARLIER_SHOWING

Earlier Showing.

This episode will be recorded at an earlier time instead.

This was previously (before protocol 04) named OTHER_SHOWING. TODO: when was this introduced?

TOO_MANY_RECORDINGS

public static final IProgramRecordingStatus.Status TOO_MANY_RECORDINGS

Max Recordings.

Too many recordings of this program have already been recorded.

NOT_LISTED

public static final IProgramRecordingStatus.Status NOT_LISTED

Not Listed.

This rule does not match any showing in the current program listings.
This seem also to be true for an inactive manually scheduled recording.

Since:

17

LOWER_REC_PRIORITY

public static final IProgramRecordingStatus.Status LOWER_REC_PRIORITY

Deprecated. as of 04, replaced by CONFLICT.

Low Priority.

Another program with a higher recording priority wil be recorded.

CONFLICT

public static final IProgramRecordingStatus.Status CONFLICT

Conflicting.

Another program with a higher priority will be recorded.

Since:

04

MANUAL_CONFLICT

public static final IProgramRecordingStatus.Status MANUAL_CONFLICT

Deprecated. as of 04

Manual Conflict.

Another program was manually chosen to be recorded instead.

LATER_SHOWING

public static final IProgramRecordingStatus.Status LATER_SHOWING

Later Showing.

This episode will be recorded at an later time.

Since:

04

AUTO_CONFLICT

public static final IProgramRecordingStatus.Status AUTO_CONFLICT

Deprecated. as of 04

Auto Conflict.

Another program was automatically chosen to be recorded instead.

REPEAT

public static final IProgramRecordingStatus.Status REPEAT

Repeat.

This episode is a repeat.

Since:

12

OVERLAP

public static final IProgramRecordingStatus.Status OVERLAP

Deprecated. as of 07

Overlap.

It is covered by another scheduled recording for the same program.

INACTIVE

public static final IProgramRecordingStatus.Status INACTIVE

Inactive.

This recording rule is inactive.

Since:

15

NEVER_RECORD

public static final IProgramRecordingStatus.Status NEVER_RECORD

Never Record.

It was marked to never be recorded.

Since:

19

OFFLINE

public static final IProgramRecordingStatus.Status OFFLINE

Recorder Off-Line.

The backend recorder is off-line.

Since:

28

OTHER_SHOWING

public static final IProgramRecordingStatus.Status OTHER_SHOWING

Other Showing.

If an episode is shown on two or more channels at the same time, the showing on the channel(s) not recording are neither Earlier nor Later. A show marked rsOtherShowing means "this episode will be recorded on a different channel at this time."

Protocol Version Hint

Till protocol version 74 this status is similar to WILL_RECORD, TUNING or RECORDING.
As of 75 new status values are introduced for OTHER_TUNING and OTHER_RECORDING. Therefore this status is then only similar to WILL_RECORD.

Since:

33

See Also:

WILL_RECORD, TUNING, RECORDING, OTHER_RECORDING, OTHER_TUNING

Method Detail

values

public static IProgramRecordingStatus.Status[] 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 (IProgramRecordingStatus.Status c : IProgramRecordingStatus.Status.values())
    System.out.println(c);

Returns:

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

valueOf

public static IProgramRecordingStatus.Status 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

getValues

public IVersionableValue.VersionablePair[] getValues()

Description copied from interface: IVersionableValue

Gets all possible values for the given property.

There are some restrictions to the content of the array:

• If a property has only one value over time, the array only contains a single value, e.g. FL_BOOKMARK(0x00000010).
• If a property has multiple values over time, the array contains multiple pairs. The first part of a value pair is the protocol version when the new value was introduced, the second number is the property value itself.
  E.g. FL_INUSERECORDING(VersionablePair.valueOf(PROTO_VERSION_21,0x00000020),VersionablePair.valueOf(PROTO_VERSION_57,0x00100000)).

Specified by:

getValues in interface IVersionableValue

Returns:

all possible values for the given property.

getFlagValue

public Long getFlagValue()

getValue

public Long getValue(ProtocolVersion protoVersion)

Description copied from interface: IVersionableValue

Returns the actual property value for the given protocol version.

Specified by:

getValue in interface IVersionableValue

Parameters:

protoVersion - the protocol version

Returns:

the property value for the given protocol version