com.amx.duet.tools.comm
Interface ISurroundModes

All Known Implementing Classes:
VirtualPreAmpComponent

public interface ISurroundModes

Author:
mmanners

Method Summary
 int getSurroundModeCount()
          Returns the number of valid surround mode settings.
 java.lang.String[] getSurroundModeProperties()
          Returns the properties for all surround mode settings.
 java.lang.String getSurroundModeProperty(int surroundModeNumber)
          Returns the properties for a single surround mode setting.
 int getSurroundModeSelect()
          Returns the currently selected surround mode.
 void processSurroundModeCountEvent(int surroundModeNumber)
          Processes the event when the PreAmp Surround Mode Count is requested.
 void processSurroundModeProperties(java.lang.String[] propertyArray)
          Processes the event when the PreAmp Surround Mode properties are requested.
 void processSurroundModePropertyEvent(java.lang.String propertyValue)
          Processes the event when the PreAmp Surround Mode Property is changed.
 void processSurroundModeSelectEvent(int surroundModeNumber)
          Processes the event when the PreAmp Surround Mode selection is made.
 void setSurroundModeSelect(int surroundModeNumber)
          Sets the current surround mode setting, where index is a virtual index number between 1 and the value returned by getSurroundModeCount().
 void updateSurroundModeSelect(int surroundModeNumber)
          Set the SurroundMode for the device.
The new value is compared against the current value.
 

Method Detail

getSurroundModeCount

public int getSurroundModeCount()
Returns the number of valid surround mode settings.

Returns:
The number of surround mode settings.

getSurroundModeProperties

public java.lang.String[] getSurroundModeProperties()
Returns the properties for all surround mode settings.

Returns:
All the properties for the surround modes.

getSurroundModeProperty

public java.lang.String getSurroundModeProperty(int surroundModeNumber)
Returns the properties for a single surround mode setting.

Parameters:
surroundModeNumber - integer value representing the selectable surround mode
Returns:
String

getSurroundModeSelect

public int getSurroundModeSelect()
Returns the currently selected surround mode.

Returns:
int

processSurroundModeCountEvent

public void processSurroundModeCountEvent(int surroundModeNumber)
Processes the event when the PreAmp Surround Mode Count is requested.

Parameters:
surroundModeNumber - integer value representing the selectable surround mode

processSurroundModeProperties

public void processSurroundModeProperties(java.lang.String[] propertyArray)
Processes the event when the PreAmp Surround Mode properties are requested.

Parameters:
propertyArray -

processSurroundModePropertyEvent

public void processSurroundModePropertyEvent(java.lang.String propertyValue)
Processes the event when the PreAmp Surround Mode Property is changed.

Parameters:
propertyValue -

processSurroundModeSelectEvent

public void processSurroundModeSelectEvent(int surroundModeNumber)
Processes the event when the PreAmp Surround Mode selection is made.

Parameters:
surroundModeNumber - integer value representing the selectable surround mode

setSurroundModeSelect

public void setSurroundModeSelect(int surroundModeNumber)
Sets the current surround mode setting, where index is a virtual index number between 1 and the value returned by getSurroundModeCount().

Parameters:
surroundModeNumber - integer value representing the selectable surround mode

updateSurroundModeSelect

public void updateSurroundModeSelect(int surroundModeNumber)
Set the SurroundMode for the device.
The new value is compared against the current value. If the value has changed, the new value is saved and a process event for the SurroundMode is called.

Parameters:
surroundModeNumber - the number of the surround mode selected


Copyright © 2008 AMX LLC. All Rights Reserved.