org.jmythapi.protocol.response
Interface IRemoteEncoderState

All Superinterfaces:

Cloneable, IPropertyAware<IRemoteEncoderState.Props>, IVersionable

All Known Implementing Classes:

RemoteEncoderState

public interface IRemoteEncoderState
extends IVersionable, IPropertyAware<IRemoteEncoderState.Props>

An interface to geht the state of a MythTV encoder.

This interface represents the response to a IRemoteEncoder.getState() request.
This interface is property-aware. See the properties-list for all properties of this interface.

Response example:

If the encoder is recording:

<0>STATE: RECORDING_ONLY

If watching Live TV:

<0>STATE: WATCHING_LIVE_TV

If the encoder is idle:

<0>STATE: NONE

See Also:

IRemoteEncoder.getState(), QUERY_REMOTEENCODER_GET_STATE

Nested Class Summary

static class	IRemoteEncoderState.Props The properties of an IRemoteEncoderState response.
static class	IRemoteEncoderState.State The states of an IRemoteEncoderState response.

Method Summary

IRemoteEncoderState.State	getState() Gets the current state of a remote encoder.
int	getStateValue() Gets the current state of a remote encoder as integer value.
boolean	hasState(IRemoteEncoderState.State... states)
boolean	hasState(IRemoteEncoderState.State state)

Methods inherited from interface org.jmythapi.IVersionable

getVersionNr

Methods inherited from interface org.jmythapi.IPropertyAware

getProperties, getProperty, getPropertyClass, getPropertyCount, getPropertyIndex, getPropertyMap, getPropertyValue, getPropertyValue, getPropertyValueObject, getPropertyValues, setPropertyValue, setPropertyValue, setPropertyValueObject

Method Detail

getStateValue

int getStateValue()

Gets the current state of a remote encoder as integer value.

This is the ordinal number of the IRemoteEncoderState.Props.

Returns:

the current state as integer value.

getState

IRemoteEncoderState.State getState()

Gets the current state of a remote encoder.

Returns:

the encoder state or null on errors.

hasState

boolean hasState(IRemoteEncoderState.State state)

hasState

boolean hasState(IRemoteEncoderState.State... states)