org.jmythapi.protocol.response
Interface IInputInfo

All Superinterfaces:

IBasicInputInfo, IVersionable

All Known Subinterfaces:

IInputInfoFree, IInputInfoTuned

All Known Implementing Classes:

InputInfoFree, InputInfoTuned

public interface IInputInfo
extends IBasicInputInfo, IVersionable

An interface to get informations about a recorder input.

This interface represents the response to a IRemoteEncoder.getInputs() request.
This interface is the parent interface of IInputInfoFree and InputInfoTuned.

Usage Example:

    IRemoteEncoder encoder = ...; // an already connected encoder
  
    // get all encoder inputs (busy and free)
    List<IInputInfo> allInputs = encoder.getInputs();
    for(IInputInfo input : allInputs) {
       System.out.println(String.format(
          "Input %d (name: %s, source: %d, card: %d, multiplex: %d) is %s.",
          input.getInputID(),
          input.getInputName(),
          input.getSourceID(),
          input.getCardID(),
          input.getMultiplexID(),
          input.isBusy()?"busy":"idle"
       ));
     }
  
  

Since:

37

See Also:

get all inputs, get free inputs, bet gusy inputs

Field Summary

static String

EMPTY_INPUT Constant used as input name if the encoder is idle.

Method Summary

Integer	getCardID() Gets the ID of the physical capture card.
Integer	getInputID() Gets the ID of a specific input.
String	getInputName() Gets the name of the input.
Integer	getLiveTvOrder() Gets the live-TV order of the input.
Integer	getMultiplexID() Gets the multiplex ID of the input.
Integer	getSourceID() Gets the source ID.
boolean	isBusy() Gets the busy status of the encoder input.

Methods inherited from interface org.jmythapi.IVersionable

getVersionNr

Field Detail

EMPTY_INPUT

static final String EMPTY_INPUT

Constant used as input name if the encoder is idle.

See Also:

Constant Field Values

Method Detail

getSourceID

Integer getSourceID()

Gets the source ID.

Specified by:

getSourceID in interface IBasicInputInfo

Returns:

the source ID. This is usually the first digit of the channel ID.

getInputID

Integer getInputID()

Gets the ID of a specific input.

Specified by:

getInputID in interface IBasicInputInfo

Returns:

the input ID

getCardID

Integer getCardID()

Gets the ID of the physical capture card.

Specified by:

getCardID in interface IBasicInputInfo

Returns:

the capture card ID

getInputName

String getInputName()

Gets the name of the input.

Returns:

the input name

getMultiplexID

Integer getMultiplexID()

Gets the multiplex ID of the input.

Returns:

the multiplex id.

getLiveTvOrder

Integer getLiveTvOrder()

Gets the live-TV order of the input.

Returns:

the order for live-TV

isBusy

boolean isBusy()

Gets the busy status of the encoder input.

Returns:

true if this input is busy.