com.amx.duet.tools.comm
Class InputProperty

java.lang.Object
  extended bycom.amx.duet.tools.comm.InputProperty

public class InputProperty
extends java.lang.Object

The InputProperty class is a container for the properties that define a source input on a device. Input select group number has a 1:1 correlation with input source inputNumber. The input source should only be set to active if it has been configured within the group to be the only selectable source. Thus, in a device where all sources are selectable (mutually exclusive) each source must be set as an active source (see setActiveSource(boolean) for more detail).


Constructor Summary
InputProperty(int number, com.amx.duet.devicesdk.type.InputSourceSelect sourceType)
          Creates a new InputProperty object.
InputProperty(int number, java.lang.String label, com.amx.duet.devicesdk.type.AVType avtype, com.amx.duet.devicesdk.type.InputSourceSelect sourceType)
          Creates a new InputProperty object.
 
Method Summary
 com.amx.duet.devicesdk.type.AVType getAVType()
          Gets the Audio/Video property, which states that this source is either an AUDIO, VIDEO, or both source type.
 java.lang.String getDeviceLabel()
          Gets the device label property, which should be the description provided by the device.
 int getInputNumber()
          Get the current input number or group number, where input select groupNumber is a direct 1:1 correlation with input source inputNumber.
 java.lang.String getInputProperty()
          Get a String representation of the properties that define an input contained within this class.
 com.amx.duet.devicesdk.type.InputSourceSelect getInputType()
          Get the current type of input (NamedInput, SignalType, etc.).
 boolean isActiveSource()
          Is the current InputProperty an active selectable source.
 void setActiveSource(boolean bActive)
          Sets the active selectable source property.
 void setAVType(com.amx.duet.devicesdk.type.AVType type)
          Sets the Audio/Video property stating that this source is either an AUDIO, VIDEO, or both source type.
 void setDeviceLabel(java.lang.String label)
          Sets the device label property to the description provided by the device.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

InputProperty

public InputProperty(int number,
                     com.amx.duet.devicesdk.type.InputSourceSelect sourceType)
Creates a new InputProperty object.

Parameters:
number - integer value representing the selectable source (group number)
sourceType - type of input source (NamedInput or SignalType)

InputProperty

public InputProperty(int number,
                     java.lang.String label,
                     com.amx.duet.devicesdk.type.AVType avtype,
                     com.amx.duet.devicesdk.type.InputSourceSelect sourceType)
Creates a new InputProperty object.

Parameters:
number - integer value representing the selectable source (group number)
label - description provided by device to represent source
avtype - Audio/Video type
sourceType - type of input source (NamedInput or SignalType)
Method Detail

setDeviceLabel

public void setDeviceLabel(java.lang.String label)
Sets the device label property to the description provided by the device.

Parameters:
label - description provided by device to represent source

setAVType

public void setAVType(com.amx.duet.devicesdk.type.AVType type)
Sets the Audio/Video property stating that this source is either an AUDIO, VIDEO, or both source type.

Parameters:
type - Audio/Video type

setActiveSource

public void setActiveSource(boolean bActive)
Sets the active selectable source property. In a mutually exclusive source selection device all sources will be active by setting the active state to true. In a device where input signal types are grouped together and only one is configured to be selectable the active state must be set to true for the selectable source and false for all of the other signal types within the group.

Parameters:
bActive - specifies that this is a selectable source (within a group)

isActiveSource

public boolean isActiveSource()
Is the current InputProperty an active selectable source.

Returns:
specifies that this is a selectable source (within a group)

getInputNumber

public int getInputNumber()
Get the current input number or group number, where input select groupNumber is a direct 1:1 correlation with input source inputNumber.

Returns:
integer value representing the selectable source (group number)

getInputType

public com.amx.duet.devicesdk.type.InputSourceSelect getInputType()
Get the current type of input (NamedInput, SignalType, etc.).

Returns:
type of input source (NamedInput or SignalType)

getDeviceLabel

public java.lang.String getDeviceLabel()
Gets the device label property, which should be the description provided by the device.

Returns:
description provided by device to represent source

getAVType

public com.amx.duet.devicesdk.type.AVType getAVType()
Gets the Audio/Video property, which states that this source is either an AUDIO, VIDEO, or both source type.

Returns:
Audio/Video type

getInputProperty

public java.lang.String getInputProperty()
Get a String representation of the properties that define an input contained within this class.

Returns:
Formatted property string

toString

public java.lang.String toString()


Copyright © 2008 AMX LLC. All Rights Reserved.