org.jmythapi.protocol.response
Enum IRemoteEncoderFlags.Flags

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

public static enum IRemoteEncoderFlags.Flags
extends Enum<IRemoteEncoderFlags.Flags>
implements IFlag

The flags of an IRemoteEncoderFlags response.

MythTV Protocol Version Matrix
 Protocol
NameTypeRange00-1
NONEIFlag[00,-1)XX
FRONTEND_READYIFlag[00,-1)XX
RUN_MAIN_LOOPIFlag[00,-1)XX
EXIT_PLAYERIFlag[00,-1)XX
FINISH_RECORDINGIFlag[00,-1)XX
ERROREDIFlag[00,-1)XX
CANCEL_NEXT_RECORDINGIFlag[00,-1)XX
LIVE_TVIFlag[00,-1)XX
RECORDINGIFlag[00,-1)XX
ANTENNA_ADJUSTIFlag[00,-1)XX
RECIFlag[00,-1)XX
EIT_SCANIFlag[00,-1)XX
CLOSED_RECIFlag[00,-1)XX
KILL_RECIFlag[00,-1)XX
NO_RECIFlag[00,-1)XX
KILL_RINGBUFFERIFlag[00,-1)XX
WAITING_FOR_REC_PAUSEIFlag[00,-1)XX
WAITING_FOR_SIGNALIFlag[00,-1)XX
NEED_TO_START_RECORDERIFlag[00,-1)XX
PENDING_ACTIONSIFlag[00,-1)XX
SIGNAL_MONITOR_RUNNINGIFlag[00,-1)XX
EIT_SCANNER_RUNNINGIFlag[00,-1)XX
DUMMY_RECORDER_RUNNINGIFlag[00,-1)XX
RECORDER_RUNNINGIFlag[00,-1)XX
ANY_REC_RUNNINGIFlag[00,-1)XX
ANY_RUNNINGIFlag[00,-1)XX
RINGBUFFER_READYIFlag[00,-1)XX
DETECTIFlag[00,-1)XX

See Also:
tv_rec.h

Enum Constant Summary
ANTENNA_ADJUST
          Tuning Flag: Antenna adjust.
ANY_REC_RUNNING
          Running State: Any rec. running.
ANY_RUNNING
          Running State: Any running.
CANCEL_NEXT_RECORDING
          General State Flag: Cancel next recording.
CLOSED_REC
          Non-recording Command: Close Recorder.
DETECT
          Tuning state: Detect.
DUMMY_RECORDER_RUNNING
          Running State: Dummy recorder running.
EIT_SCAN
          Non-recording Command: EIT Scan.
EIT_SCANNER_RUNNING
          Running State: EIT scanner running.
ERRORED
          General State Flag: Errored.
EXIT_PLAYER
          General State Flag: Exit player.
FINISH_RECORDING
          General State Flag: Finish recording.
FRONTEND_READY
          General State Flag: Frontend Ready.
KILL_REC
          Non-recording Command: Kill Recording.
KILL_RINGBUFFER
          Non-recording Command: Kill Ringbuffer.
LIVE_TV
          Tuning Flag: Live TV.
NEED_TO_START_RECORDER
          Waiting State: Need to start recorder.
NO_REC
          Non-recording Command: No Rec.
NONE
          None.
PENDING_ACTIONS
          Waiting State: Pending actions.
REC
          Tuning Flag: Rec.
RECORDER_RUNNING
          Running State: Recorder running.
RECORDING
          Tuning Flag: Recording.
RINGBUFFER_READY
          Tuning state: Ringbuffer ready.
RUN_MAIN_LOOP
          General State Flag: Run main loop.
SIGNAL_MONITOR_RUNNING
          Running State: Signal monitor running.
WAITING_FOR_REC_PAUSE
          Waiting State: Waiting for rec. pause.
WAITING_FOR_SIGNAL
          Waiting State: Waiting for signal.
 
Method Summary
 Long getFlagValue()
          Gets the value associated with the flag.
static IRemoteEncoderFlags.Flags valueOf(String name)
          Returns the enum constant of this type with the specified name.
static IRemoteEncoderFlags.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

NONE

public static final IRemoteEncoderFlags.Flags NONE
None.


FRONTEND_READY

public static final IRemoteEncoderFlags.Flags FRONTEND_READY
General State Flag: Frontend Ready.

If a frontend has sent IMythCommand.QUERY_RECORDER_FRONTEND_READY to the recorder.


RUN_MAIN_LOOP

public static final IRemoteEncoderFlags.Flags RUN_MAIN_LOOP
General State Flag: Run main loop.

If the recorder main thread is up and running.


EXIT_PLAYER

public static final IRemoteEncoderFlags.Flags EXIT_PLAYER
General State Flag: Exit player.

If LiveTV needs to be aborted due to a pending recording.


FINISH_RECORDING

public static final IRemoteEncoderFlags.Flags FINISH_RECORDING
General State Flag: Finish recording.


ERRORED

public static final IRemoteEncoderFlags.Flags ERRORED
General State Flag: Errored.

If the recorder is in an error state.


CANCEL_NEXT_RECORDING

public static final IRemoteEncoderFlags.Flags CANCEL_NEXT_RECORDING
General State Flag: Cancel next recording.

If the next pending recording should be canceled due to a running LiveTV recording.


LIVE_TV

public static final IRemoteEncoderFlags.Flags LIVE_TV
Tuning Flag: Live TV.

Final result desired is LiveTV recording.


RECORDING

public static final IRemoteEncoderFlags.Flags RECORDING
Tuning Flag: Recording.

final result desired is a timed recording


ANTENNA_ADJUST

public static final IRemoteEncoderFlags.Flags ANTENNA_ADJUST
Tuning Flag: Antenna adjust.

antenna adjusting mode (LiveTV without recording).


REC

public static final IRemoteEncoderFlags.Flags REC
Tuning Flag: Rec.


EIT_SCAN

public static final IRemoteEncoderFlags.Flags EIT_SCAN
Non-recording Command: EIT Scan.

final result desired is an EIT Scan


CLOSED_REC

public static final IRemoteEncoderFlags.Flags CLOSED_REC
Non-recording Command: Close Recorder.

close recorder, keep recording


KILL_REC

public static final IRemoteEncoderFlags.Flags KILL_REC
Non-recording Command: Kill Recording.

close recorder, discard recording


NO_REC

public static final IRemoteEncoderFlags.Flags NO_REC
Non-recording Command: No Rec.


KILL_RINGBUFFER

public static final IRemoteEncoderFlags.Flags KILL_RINGBUFFER
Non-recording Command: Kill Ringbuffer.


WAITING_FOR_REC_PAUSE

public static final IRemoteEncoderFlags.Flags WAITING_FOR_REC_PAUSE
Waiting State: Waiting for rec. pause.


WAITING_FOR_SIGNAL

public static final IRemoteEncoderFlags.Flags WAITING_FOR_SIGNAL
Waiting State: Waiting for signal.


NEED_TO_START_RECORDER

public static final IRemoteEncoderFlags.Flags NEED_TO_START_RECORDER
Waiting State: Need to start recorder.


PENDING_ACTIONS

public static final IRemoteEncoderFlags.Flags PENDING_ACTIONS
Waiting State: Pending actions.


SIGNAL_MONITOR_RUNNING

public static final IRemoteEncoderFlags.Flags SIGNAL_MONITOR_RUNNING
Running State: Signal monitor running.


EIT_SCANNER_RUNNING

public static final IRemoteEncoderFlags.Flags EIT_SCANNER_RUNNING
Running State: EIT scanner running.


DUMMY_RECORDER_RUNNING

public static final IRemoteEncoderFlags.Flags DUMMY_RECORDER_RUNNING
Running State: Dummy recorder running.


RECORDER_RUNNING

public static final IRemoteEncoderFlags.Flags RECORDER_RUNNING
Running State: Recorder running.


ANY_REC_RUNNING

public static final IRemoteEncoderFlags.Flags ANY_REC_RUNNING
Running State: Any rec. running.


ANY_RUNNING

public static final IRemoteEncoderFlags.Flags ANY_RUNNING
Running State: Any running.


RINGBUFFER_READY

public static final IRemoteEncoderFlags.Flags RINGBUFFER_READY
Tuning state: Ringbuffer ready.


DETECT

public static final IRemoteEncoderFlags.Flags DETECT
Tuning state: Detect.

Method Detail

values

public static IRemoteEncoderFlags.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 (IRemoteEncoderFlags.Flags c : IRemoteEncoderFlags.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 IRemoteEncoderFlags.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

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


Copyright © 2008-2013. All Rights Reserved.