org.jmythapi.protocol.response
Interface IRecordingStatus

All Superinterfaces:

Cloneable, IPropertyAware<IRecordingStatus.Props>, IVersionable

All Known Implementing Classes:

RecordingStatus

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

An interface to get the recording status of a MythTV backend.

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

Response example:

Protocol Version 15 example:

<0>RECORDING_IN_PROGRESS: 0

Protocol Version 56 example:

<0>RECORDING_IN_PROGRESS: 0 | <1>LIVETV_IN_PROGRESS: 0

See Also:

IBackend.queryIsRecording(), QUERY_ISRECORDING

Nested Class Summary

static class

IRecordingStatus.Props The properties of IRecordingStatus.

Method Summary

int	getActiveRecordings() Get the total amount of active recordings.
int	getLiveTVRecordings() Get the total amount of recordings due to live-tv sessions
boolean	isRecording() Gets the current recording status.

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

getActiveRecordings

int getActiveRecordings()

Get the total amount of active recordings.

Returns:

the amount of active recordins

getLiveTVRecordings

int getLiveTVRecordings()

Get the total amount of recordings due to live-tv sessions

Returns:

the amount of live-tv recordings

Since:

40

isRecording

boolean isRecording()

Gets the current recording status.

Returns:

true if there is at least one active recording.