|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amx.duet.devicesdk.component.PreAmpComponentImpl
com.amx.duet.tools.comm.component.VirtualPreAmpComponent
The VirtualPreAmpComponent class stores and maintains a list of
selectable surround modes for the device. Each source is added to both an
internal list within this class and a list stored in the parent class.
The active surroundMode can be changed with a call to the updateSurroundMode
method.
In the constructor of the implemented class (i.e. MakeModelPreAmpComponent )
the surround modes for the device should be added. One way to
accomplish this with TSE's as described in the duet module programming guide
is setSurroundModeList( MakeModeSurroundModes.VALUES );
.
Constructor Summary | |
VirtualPreAmpComponent(com.amx.duet.devicesdk.component.IPreAmpComponent caller,
int index)
|
Method Summary | |
com.amx.duet.devicesdk.type.SurroundMode |
addSurroundMode(int surroundModeNumber,
java.lang.String surroundModeLabel)
Creates an InternalSurroundMode for the surroundModeLabel speceified, then adds that SurroundMode object to the source select list. |
com.amx.duet.devicesdk.type.SurroundMode |
addSurroundMode(int surroundModeNumber,
com.amx.duet.devicesdk.type.SurroundMode surroundMode)
Adds a SurroundMode object to the source select list. |
void |
dispose()
Class destructor used for clean up |
com.amx.duet.devicesdk.type.SurroundMode |
getSurroundMode(int surroundModeNumber)
Returns the SurroundMode for the specified surroundModeNumber. |
int |
getSurroundModeCount()
Returns the number of valid surround mode settings. |
int |
getSurroundModeNumber(com.amx.duet.devicesdk.type.SurroundMode surroundMode)
Find the number of the surround mode. |
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 |
processAddSurroundModeEvent(int surroundModeNumber,
java.lang.String surroundModeLabel)
Processes the event when a Surround Mode is added. |
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. |
abstract void |
sendCommandFeedback(java.lang.String message,
com.amx.duet.devicesdk.base.AdvancedEvent advEv,
int zone)
Sends feedback to the device. |
abstract void |
setSurroundMode(com.amx.duet.devicesdk.type.SurroundMode surroundMode)
Send the command to the device to set the specified surround mode. |
void |
setSurroundModeList(java.util.List surroundModes)
Sets list of surround modes for the device. This method should not be overridden by the programmer unless non-standard behavior is desired. |
void |
setSurroundModeList(com.amx.duet.devicesdk.type.SurroundMode[] surroundModes)
A convenience method to set the list of surround modes for the device. |
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 |
updateSurroundMode(com.amx.duet.devicesdk.type.SurroundMode surroundMode)
A convenience method to update the Surround Mode |
void |
updateSurroundModeSelect(int surroundModeNumber)
Set the SurroundMode for the device. The new value is compared against the current value. |
Methods inherited from class com.amx.duet.devicesdk.component.PreAmpComponentImpl |
addPreAmpComponentListener, adjustBalance, adjustBass, adjustTreble, cycleLoudness, getBalance, getBass, getPreAmpComponent, getPreAmpComponentCount, getPreAmpComponentIndex, getSurroundMode, getSurroundModeDisplayText, getSurroundModeValues, getTreble, isLoudnessOn, nextSurroundMode, previousSurroundMode, processBalanceEvent, processBassEvent, processLoudnessEvent, processSurroundModeEvent, processTrebleEvent, refresh, reinitialize, removePreAmpComponentListener, setBalance, setBass, setLoudnessOn, setTreble, updateBalance, updateBass, updateLoudness, updateTreble |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.amx.duet.tools.comm.ICommonComponent |
refresh, reinitialize |
Constructor Detail |
public VirtualPreAmpComponent(com.amx.duet.devicesdk.component.IPreAmpComponent caller, int index)
caller
- index
- Method Detail |
public com.amx.duet.devicesdk.type.SurroundMode addSurroundMode(int surroundModeNumber, java.lang.String surroundModeLabel)
surroundModeNumber
- integer value representing the selectable surround modesurroundModeLabel
- the name of the surround mode.
addSurroundMode( int, SurroundMode );
public com.amx.duet.devicesdk.type.SurroundMode addSurroundMode(int surroundModeNumber, com.amx.duet.devicesdk.type.SurroundMode surroundMode)
surroundModeNumber
- integer value representing the selectable surround modesurroundMode
- a predefined SurroundMode used by the device
public void dispose()
ICommonComponent
dispose
in interface ICommonComponent
public com.amx.duet.devicesdk.type.SurroundMode getSurroundMode(int surroundModeNumber)
surroundModeNumber
- integer value representing the selectable surround mode
public int getSurroundModeCount()
getSurroundModeCount
in interface ISurroundModes
public int getSurroundModeNumber(com.amx.duet.devicesdk.type.SurroundMode surroundMode)
surroundMode
- the SurroundMode to match
public java.lang.String[] getSurroundModeProperties()
getSurroundModeProperties
in interface ISurroundModes
public java.lang.String getSurroundModeProperty(int surroundModeNumber)
getSurroundModeProperty
in interface ISurroundModes
surroundModeNumber
- integer value representing the selectable surround mode
public int getSurroundModeSelect()
getSurroundModeSelect
in interface ISurroundModes
public void processAddSurroundModeEvent(int surroundModeNumber, java.lang.String surroundModeLabel)
surroundModeNumber
- integer value representing the selectable surround modesurroundModeLabel
- the name of the surround mode.public void processSurroundModeCountEvent(int surroundModeNumber)
processSurroundModeCountEvent
in interface ISurroundModes
surroundModeNumber
- integer value representing the selectable surround modepublic void processSurroundModeProperties(java.lang.String[] propertyArray)
processSurroundModeProperties
in interface ISurroundModes
propertyArray
- public void processSurroundModePropertyEvent(java.lang.String propertyValue)
processSurroundModePropertyEvent
in interface ISurroundModes
propertyValue
- public void processSurroundModeSelectEvent(int surroundModeNumber)
processSurroundModeSelectEvent
in interface ISurroundModes
surroundModeNumber
- integer value representing the selectable surround modepublic abstract void sendCommandFeedback(java.lang.String message, com.amx.duet.devicesdk.base.AdvancedEvent advEv, int zone)
utilities.sendCommandFeedback( message, advEv, zone, utilities.getNetLinxDevice() );
message
- The feedback message to send back to the deiveadvEv
- The AdvancedEvent to processzone
- The zone of the virtual device the feedback is sent to.public abstract void setSurroundMode(com.amx.duet.devicesdk.type.SurroundMode surroundMode)
setSurroundMode
in interface com.amx.duet.devicesdk.component.IPreAmpComponent
surroundMode
- a predefined SurroundMode used by the devicepublic void setSurroundModeList(java.util.List surroundModes)
surroundModes
- Listpublic void setSurroundModeList(com.amx.duet.devicesdk.type.SurroundMode[] surroundModes)
surroundModes
- setSurroundModeList( List );
public void setSurroundModeSelect(int surroundModeNumber)
setSurroundModeSelect
in interface ISurroundModes
surroundModeNumber
- integer value representing the selectable surround modepublic void updateSurroundMode(com.amx.duet.devicesdk.type.SurroundMode surroundMode)
surroundMode
- the desired surround modeupdateSurroundModeSelect( int );
public void updateSurroundModeSelect(int surroundModeNumber)
updateSurroundModeSelect
in interface ISurroundModes
surroundModeNumber
- the number of the surround mode selected
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |