org.jmythapi
Interface IRecorderInfo

All Superinterfaces:

Cloneable, IPropertyAware<IRecorderInfo.Props>, IVersionable

All Known Implementing Classes:

RecorderInfo, RecorderInfo

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

An interface to get connection informations of a MythTV recorder.

This interface represents the response the a IBackend.getNextFreeRecorder() and similar request.
This interface is property-aware. See IRecorderInfo.Props for all available object properties.

How to start:

The following backend functions can be used to get recorder-info object:

• Get the next free recorder:
  IRecorderInfo recorderInfo = backend.getNextFreeRecorder();
• Get a busy recorder:
  IRecorderInfo recorderInfo = backend.getRecorderForProgram(IProgramInfo);
• Get a recorder by id:
  IRecorderInfo recorderInfo = backend.getRecorderForNum(Integer);

Usage Example:

    // an already connected backend
    IBackend backend = ...;

    // getting the next free recorder
    IRecorderInfo recorderInfo = backend.getNextFreeRecorder();
    if(recorderInfo == null) {
        System.out.println("No free recorder available");
    } else {
        // connect to the recorder
        IRecorder recorder = backend.getRecorder(recorderInfo);

        // do something with the recorder ...
        
        // close recorder connection
        recorder.close();
    }
 

Response Example:

<0>RECORDER_ID: 2 | <1>HOSTNAME: 192.168.10.201 | <2>HOSTPORT: 6543

See Also:

Backend.getFreeRecorder(), Backend.getNextFreeRecorder(), Backend.getRecorderForNum(int), Backend.getRecorderNum(org.jmythapi.protocol.response.IProgramInfo)

Nested Class Summary

static class

IRecorderInfo.Props Properties of an IRecorderInfo response.

Field Summary

static String

ERROR_HOSTNAME The IRecorderInfo.Props.HOSTNAME that is returned on error.

Method Summary

String	getHostName()
int	getHostPort()
int	getRecorderID()

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

Field Detail

ERROR_HOSTNAME

static final String ERROR_HOSTNAME

The IRecorderInfo.Props.HOSTNAME that is returned on error.

See Also:

Constant Field Values

Method Detail

getRecorderID

int getRecorderID()

getHostName

String getHostName()

getHostPort

int getHostPort()