com.amx.duet.impl.sonance.amp875d.dr1_0_0
Interface ISonanceAMP875D

All Superinterfaces:
com.amx.duet.devicesdk.IAmplifier, com.amx.duet.devicesdk.component.IAmplifierComponent, com.amx.duet.devicesdk.component.IAmplifierComponentListener, com.amx.duet.devicesdk.component.IPowerComponent, com.amx.duet.devicesdk.component.IPowerComponentListener, com.amx.duet.devicesdk.component.IVolumeComponent, com.amx.duet.devicesdk.component.IVolumeComponent2, com.amx.duet.devicesdk.component.IVolumeComponentListener

public interface ISonanceAMP875D
extends com.amx.duet.devicesdk.IAmplifier

Author:
spunreddy To change the template for this generated type comment go to Window>Preferences>Java>Code Generation>Code and Comments

Method Summary
 void adjustVolume(int offset)
          Adjust the volume by offset.
 void cyclePowerInternal()
          Cycles the power Note:This method should not be called directly from the Device class.
 void cycleVolumeMute()
          Cycle the mute state.
 void dispose()
           
 com.amx.duet.devicesdk.component.IAmplifierComponent getAmplifierComponent(int index)
          Get the Amplifier Component for the specified index
 int getAmplifierComponentCount()
          Get the Amplifier Component count
 com.amx.duet.devicesdk.component.IPowerComponent getPowerComponent(int index)
          Get the Power Component for the specified index
 int getPowerComponentCount()
          Get the Power Component count
 com.amx.duet.devicesdk.component.IVolumeComponent getVolumeComponent(int index)
          Get the Volume Component for the specified index
 int getVolumeComponentCount()
          Get the Volume Component count
 boolean isBBEHiFreqBoostOn()
          Gets the BBE High Frequency Boost state.
 boolean isBBELoFreqBoostOn()
          Gets the BBE Low Frequency Boost state.
 boolean isBBESignalProcessingOn()
          Gets the BBE Signal Processing state.
 boolean isDataInitialized()
          Checks if the data is initialized
 boolean isDeviceOnLine()
          Checks if the device is online
 void passThru(byte[] buffer)
          Allows the capability of sending commands directly to whatever unit is attached without processing by the module.
 void refresh()
          Regenerates all the appropriate events
 void reinitialize()
          Reinitializes the module data
 void setBBEHiFreqBoost(boolean state)
          Sets the BBE High Frequency Boost.
 void setBBELoFreqBoost(boolean state)
          Sets the BBE Low Frequency Boost.
 void setBBESignalProcessing(boolean state)
          Sets the BBE Signal Processing.
 void setPowerInternal(com.amx.duet.devicesdk.type.PowerState ps)
          Set the power state
 void setVolume(int level)
          Set the volume level.
 void setVolumeMuteOn(boolean state)
          Set the mute state.
 void setVolumeRamp(com.amx.duet.devicesdk.type.LevelRamp rl)
          Sets the current volume ramp level state.
 
Methods inherited from interface com.amx.duet.devicesdk.component.IAmplifierComponent
addAmplifierComponentListener, removeAmplifierComponentListener
 
Methods inherited from interface com.amx.duet.devicesdk.component.IPowerComponent
addPowerComponentListener, cyclePower, getPower, removePowerComponentListener, setPower, setPowerSensor, setPowerSensor
 
Methods inherited from interface com.amx.duet.devicesdk.component.IPowerComponentListener
processPowerEvent
 
Methods inherited from interface com.amx.duet.devicesdk.component.IVolumeComponent2
cycleVolumePreset
 
Methods inherited from interface com.amx.duet.devicesdk.component.IVolumeComponent
addVolumeComponentListener, getVolume, getVolumePreset, getVolumePresetCount, getVolumeRamp, isVolumeMuteOn, removeVolumeComponentListener, saveVolumePreset, setVolumePreset
 
Methods inherited from interface com.amx.duet.devicesdk.component.IVolumeComponentListener
processVolumeEvent, processVolumeMuteEvent, processVolumePresetEvent, processVolumeRampEvent
 

Method Detail

isDeviceOnLine

public boolean isDeviceOnLine()
Checks if the device is online

Returns:
boolean [TRUE,FALSE]

isDataInitialized

public boolean isDataInitialized()
Checks if the data is initialized

Returns:
boolean [TRUE,FALSE]

refresh

public void refresh()
Regenerates all the appropriate events


reinitialize

public void reinitialize()
Reinitializes the module data


getPowerComponent

public com.amx.duet.devicesdk.component.IPowerComponent getPowerComponent(int index)
Get the Power Component for the specified index

Specified by:
getPowerComponent in interface com.amx.duet.devicesdk.component.IPowerComponent
Parameters:
index - [1..4]
Returns:
IPowerComponent

getPowerComponentCount

public int getPowerComponentCount()
Get the Power Component count

Specified by:
getPowerComponentCount in interface com.amx.duet.devicesdk.component.IPowerComponent
Returns:
int

cyclePowerInternal

public void cyclePowerInternal()
Cycles the power Note:This method should not be called directly from the Device class. Use getPowerComponent() in order to retrieve the desired component, and then use this method on that object. If this method is called directly from the Device class, it will perform on component index 0 if it exists

Specified by:
cyclePowerInternal in interface com.amx.duet.devicesdk.component.IPowerComponent

setPowerInternal

public void setPowerInternal(com.amx.duet.devicesdk.type.PowerState ps)
Set the power state

Specified by:
setPowerInternal in interface com.amx.duet.devicesdk.component.IPowerComponent
Parameters:
ps - [ON,OFF] Note:This method should not be called directly from the Device class. Use getPowerComponent() in order to retrieve the desired component, and then use this method on that object. If this method is called directly from the Device class, it will perform on component index 0 if it exists

getVolumeComponent

public com.amx.duet.devicesdk.component.IVolumeComponent getVolumeComponent(int index)
Get the Volume Component for the specified index

Specified by:
getVolumeComponent in interface com.amx.duet.devicesdk.component.IVolumeComponent
Parameters:
index - [1..4]
Returns:
getVolumeComponent

getVolumeComponentCount

public int getVolumeComponentCount()
Get the Volume Component count

Specified by:
getVolumeComponentCount in interface com.amx.duet.devicesdk.component.IVolumeComponent
Returns:
int

setVolumeMuteOn

public void setVolumeMuteOn(boolean state)
Set the mute state.

Specified by:
setVolumeMuteOn in interface com.amx.duet.devicesdk.component.IVolumeComponent
Parameters:
state - Note:This method should not be called directly from the Device class. Use getVolumeComponent() in order to retrieve the desired component, and then use this method on that object. If this method is called directly from the Device class, it will perform on component index 0 if it exists.

cycleVolumeMute

public void cycleVolumeMute()
Cycle the mute state. Note:This method should not be called directly from the Device class. Use getVolumeComponent() in order to retrieve the desired component, and then use this method on that object. If this method is called directly from the Device class, it will perform on component index 0 if it exists.

Specified by:
cycleVolumeMute in interface com.amx.duet.devicesdk.component.IVolumeComponent

setVolume

public void setVolume(int level)
Set the volume level.

Specified by:
setVolume in interface com.amx.duet.devicesdk.component.IVolumeComponent
Parameters:
level - [0..255] Note:This method should not be called directly from the Device class. Use getVolumeComponent() in order to retrieve the desired component, and then use this method on that object. If this method is called directly from the Device class, it will perform on component index 0 if it exists.

adjustVolume

public void adjustVolume(int offset)
Adjust the volume by offset.

Specified by:
adjustVolume in interface com.amx.duet.devicesdk.component.IVolumeComponent
Parameters:
offset - [-255..255]

This method will scale to the device range and will move at least 1 step in the device range, even if the offset is too small to cause a device range step.

If the offset is 0, there is no change.

Note:This method should not be called directly from the Device class. Use getVolumeComponent() in order to retrieve the desired component, and then use this method on that object. If this method is called directly from the Device class, it will perform on component index 0 if it exists.


setVolumeRamp

public void setVolumeRamp(com.amx.duet.devicesdk.type.LevelRamp rl)
Sets the current volume ramp level state.

Specified by:
setVolumeRamp in interface com.amx.duet.devicesdk.component.IVolumeComponent
Parameters:
rl - [UP,DOWN,STOP]

Note:This method should not be called directly from the Device class. Use getVolumeComponent() in order to retrieve the desired component, and then use this method on that object. If this method is called directly from the Device class, it will perform on component index 0 if it exists.


getAmplifierComponent

public com.amx.duet.devicesdk.component.IAmplifierComponent getAmplifierComponent(int index)
Get the Amplifier Component for the specified index

Specified by:
getAmplifierComponent in interface com.amx.duet.devicesdk.component.IAmplifierComponent
Parameters:
index - [1..4]
Returns:
IAmplifierComponent

getAmplifierComponentCount

public int getAmplifierComponentCount()
Get the Amplifier Component count

Specified by:
getAmplifierComponentCount in interface com.amx.duet.devicesdk.component.IAmplifierComponent
Returns:
int

setBBESignalProcessing

public void setBBESignalProcessing(boolean state)
Sets the BBE Signal Processing.

Parameters:
state - Note:This method should not be called directly from the Device class. Use getAmplifierComponent() in order to retrieve the desired component, and then use this method on that object. If this method is called directly from the Device class, it will perform on component index 0 if it exists.

isBBESignalProcessingOn

public boolean isBBESignalProcessingOn()
Gets the BBE Signal Processing state. Note:This method should not be called directly from the Device class. Use getAmplifierComponent() in order to retrieve the desired component, and then use this method on that object. If this method is called directly from the Device class, it will perform on component index 0 if it exists.


setBBEHiFreqBoost

public void setBBEHiFreqBoost(boolean state)
Sets the BBE High Frequency Boost.

Parameters:
state - Note:This method should not be called directly from the Device class. Use getAmplifierComponent() in order to retrieve the desired component, and then use this method on that object. If this method is called directly from the Device class, it will perform on component index 0 if it exists.

isBBEHiFreqBoostOn

public boolean isBBEHiFreqBoostOn()
Gets the BBE High Frequency Boost state. Note:This method should not be called directly from the Device class. Use getAmplifierComponent() in order to retrieve the desired component, and then use this method on that object. If this method is called directly from the Device class, it will perform on component index 0 if it exists.


setBBELoFreqBoost

public void setBBELoFreqBoost(boolean state)
Sets the BBE Low Frequency Boost.

Parameters:
state - Note:This method should not be called directly from the Device class. Use getAmplifierComponent() in order to retrieve the desired component, and then use this method on that object. If this method is called directly from the Device class, it will perform on component index 0 if it exists.

isBBELoFreqBoostOn

public boolean isBBELoFreqBoostOn()
Gets the BBE Low Frequency Boost state. Note:This method should not be called directly from the Device class. Use getAmplifierComponent() in order to retrieve the desired component, and then use this method on that object. If this method is called directly from the Device class, it will perform on component index 0 if it exists.


passThru

public void passThru(byte[] buffer)
Allows the capability of sending commands directly to whatever unit is attached without processing by the module. The caller must be aware of the protocol implemented by the unit to use this command. This gives the caller access to features which may not be directly supported by the module.

Parameters:
buffer -

dispose

public void dispose()