org.jmythapi.protocol.response
Enum IProgramFlags.Flags

java.lang.Object
  java.lang.Enum<IProgramFlags.Flags>
      org.jmythapi.protocol.response.IProgramFlags.Flags

All Implemented Interfaces:

Serializable, Comparable<IProgramFlags.Flags>, IFlag, IVersionableValue

Enclosing interface:

IProgramFlags

public static enum IProgramFlags.Flags
extends Enum<IProgramFlags.Flags>
implements IFlag, IVersionableValue

The flags of the PROGRAM_FLAGS property.

MythTV Protocol Version Matrix
		Protocol
Name	Type	Range	00	21	23	27	28	31	32	34	35	53	57	-1
FL_NONE	IFlag	[57,-1)	-	-	-	-	-	-	-	-	-	-	X	X
FL_COMMFLAG	IFlag	[00,-1)	X	X	X	X	X	X	X	X	X	X	X	X
FL_CUTLIST	IFlag	[00,-1)	X	X	X	X	X	X	X	X	X	X	X	X
FL_AUTOEXP	IFlag	[00,-1)	X	X	X	X	X	X	X	X	X	X	X	X
FL_EDITING	IFlag	[00,-1)	X	X	X	X	X	X	X	X	X	X	X	X
FL_BOOKMARK	IFlag	[00,-1)	X	X	X	X	X	X	X	X	X	X	X	X
FL_INUSERECORDING	IFlag	[21,-1)	-	X	X	X	X	X	X	X	X	X	X	X
FL_INUSEPLAYING	IFlag	[23,-1)	-	-	X	X	X	X	X	X	X	X	X	X
FL_STEREO	IFlag	[27,35)	-	-	-	X	X	X	X	X	-	-	-	-
FL_REALLYEDITING	IFlag	[53,-1)	-	-	-	-	-	-	-	-	-	X	X	X
FL_CC	IFlag	[27,35)	-	-	-	X	X	X	X	X	-	-	-	-
FL_COMMPROCESSING	IFlag	[53,-1)	-	-	-	-	-	-	-	-	-	X	X	X
FL_HDTV	IFlag	[27,35)	-	-	-	X	X	X	X	X	-	-	-	-
FL_DELETEPENDING	IFlag	[53,-1)	-	-	-	-	-	-	-	-	-	X	X	X
FL_TRANSCODED	IFlag	[28,-1)	-	-	-	-	X	X	X	X	X	X	X	X
FL_WATCHED	IFlag	[31,-1)	-	-	-	-	-	X	X	X	X	X	X	X
FL_PRESERVED	IFlag	[32,-1)	-	-	-	-	-	-	X	X	X	X	X	X
FL_CHANCOMMFREE	IFlag	[57,-1)	-	-	-	-	-	-	-	-	-	-	X	X
FL_REPEAT	IFlag	[57,-1)	-	-	-	-	-	-	-	-	-	-	X	X
FL_DUPLICATE	IFlag	[57,-1)	-	-	-	-	-	-	-	-	-	-	X	X
FL_REACTIVATE	IFlag	[57,-1)	-	-	-	-	-	-	-	-	-	-	X	X
FL_IGNOREBOOKMARK	IFlag	[57,-1)	-	-	-	-	-	-	-	-	-	-	X	X
FL_TYPEMASK	IFlag	[57,-1)	-	-	-	-	-	-	-	-	-	-	X	X
FL_INUSEOTHER	IFlag	[57,-1)	-	-	-	-	-	-	-	-	-	-	X	X

See Also:

ProgramInfoFilters#flag(Flags), libmythtv/programinfo.h (till 21.08.2009), libmyth/programinfo.h (till 19.04.2010), libmyth/programtypes.h (since 16.05.2010)

Nested Class Summary

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

IVersionableValue.VersionablePair

Enum Constant Summary

FL_AUTOEXP
Autoexpire.

FL_BOOKMARK
Bookmark.

FL_CC
Deprecated. 35, moved to IProgramSubtitleType

FL_CHANCOMMFREE
Channel Commercial free.

FL_COMMFLAG
Commercial flags.

FL_COMMPROCESSING
Commercial flagging in progress.

FL_CUTLIST
Cutlist.

FL_DELETEPENDING
Delete Pending.

FL_DUPLICATE
This flag replaces ProgramInfo.Props#DUPLICATE.

FL_EDITING
Editing.

FL_HDTV
Deprecated. 35, moved into IProgramVideoProperties.Flags.VID_HDTV

FL_IGNOREBOOKMARK

FL_INUSEOTHER

FL_INUSEPLAYING
In Use Playing.

FL_INUSERECORDING
In Use Recording.

FL_NONE

FL_PRESERVED
Preserved.

FL_REACTIVATE

FL_REALLYEDITING
Editing in progress.

FL_REPEAT
This flag replaces ProgramInfo.Props#REPEAT.

FL_STEREO
Deprecated. 35, moved to IProgramAudioProperties.Flags.AUD_STEREO

FL_TRANSCODED
Transcoded.

FL_TYPEMASK

FL_WATCHED
Watched.

Method Summary

Long	getFlagValue() Gets the value associated with the flag.
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 IProgramFlags.Flags	valueOf(String name) Returns the enum constant of this type with the specified name.
static IProgramFlags.Flags[]	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

Methods inherited from interface org.jmythapi.protocol.response.IFlag

name

Enum Constant Detail

FL_NONE

public static final IProgramFlags.Flags FL_NONE

Since:

57

FL_COMMFLAG

public static final IProgramFlags.Flags FL_COMMFLAG

Commercial flags.

Commercials are flagged.

Since:

00

FL_CUTLIST

public static final IProgramFlags.Flags FL_CUTLIST

Cutlist.

An editing cutlist is present.

Since:

00

FL_AUTOEXP

public static final IProgramFlags.Flags FL_AUTOEXP

Autoexpire.

The program is able to auto-expire

Since:

00

FL_EDITING

public static final IProgramFlags.Flags FL_EDITING

Editing.

If the user has started editing a recording or if commercials are being flagged.

Since:

00

FL_BOOKMARK

public static final IProgramFlags.Flags FL_BOOKMARK

Bookmark.

A bookmark is set.

Since:

00

FL_INUSERECORDING

public static final IProgramFlags.Flags FL_INUSERECORDING

In Use Recording.

This recording is currently in use by another Myth program.

This was renamed from In-Use to In-Use-Recording in SVN Rev 7928.

Since:

21

FL_INUSEPLAYING

public static final IProgramFlags.Flags FL_INUSEPLAYING

In Use Playing.

Since:

23

FL_STEREO

public static final IProgramFlags.Flags FL_STEREO

Deprecated. 35, moved to IProgramAudioProperties.Flags.AUD_STEREO

Stereo.

Since:

27

FL_REALLYEDITING

public static final IProgramFlags.Flags FL_REALLYEDITING

Editing in progress.

If the user has started but not finished editing.

Since:

53

FL_CC

public static final IProgramFlags.Flags FL_CC

Deprecated. 35, moved to IProgramSubtitleType

Closed captioned Flag.

Recording is Closed Captioned.

Since:

27

FL_COMMPROCESSING

public static final IProgramFlags.Flags FL_COMMPROCESSING

Commercial flagging in progress.

If commercials are being flagged.

Since:

53

FL_HDTV

public static final IProgramFlags.Flags FL_HDTV

Deprecated. 35, moved into IProgramVideoProperties.Flags.VID_HDTV

High Definition.

Recording is in High Definition

Since:

27

FL_DELETEPENDING

public static final IProgramFlags.Flags FL_DELETEPENDING

Delete Pending.

Deleting of the recording is pending.

Since:

53

FL_TRANSCODED

public static final IProgramFlags.Flags FL_TRANSCODED

Transcoded.

Recording has been transcoded.

Since:

28

FL_WATCHED

public static final IProgramFlags.Flags FL_WATCHED

Watched.

Marks a recording as watched.

Since:

31

FL_PRESERVED

public static final IProgramFlags.Flags FL_PRESERVED

Preserved.

Marks an episode as preserved.

Since:

32

FL_CHANCOMMFREE

public static final IProgramFlags.Flags FL_CHANCOMMFREE

Channel Commercial free.

Marks a channel to be commercial free.

This flag replaces ProgramInfo.Props#CHAN_COMM_FREE.

Since:

57

FL_REPEAT

public static final IProgramFlags.Flags FL_REPEAT

This flag replaces ProgramInfo.Props#REPEAT.

Since:

57

FL_DUPLICATE

public static final IProgramFlags.Flags FL_DUPLICATE

This flag replaces ProgramInfo.Props#DUPLICATE.

Since:

57

FL_REACTIVATE

public static final IProgramFlags.Flags FL_REACTIVATE

Since:

57

FL_IGNOREBOOKMARK

public static final IProgramFlags.Flags FL_IGNOREBOOKMARK

Since:

57

FL_TYPEMASK

public static final IProgramFlags.Flags FL_TYPEMASK

Since:

57

FL_INUSEOTHER

public static final IProgramFlags.Flags FL_INUSEOTHER

Since:

57

Method Detail

values

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

Returns:

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

valueOf

public static IProgramFlags.Flags 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()

Description copied from interface: IFlag

Gets the value associated with the flag.

Specified by:

getFlagValue in interface IFlag

Returns:

the flag value

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