com.highsoft.highcharts.common.hichartsclasses

Class HIInstrumentPlayOptionsObject

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIInstrumentPlayOptionsObject

public class HIInstrumentPlayOptionsObject
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIInstrumentPlayOptionsObject()

Method Summary

Modifier and Type	Method and Description
java.lang.Number	getDuration()
java.lang.Object	getFrequency()
java.lang.Number	getMasterVolume()
java.lang.Number	getMaxFrequency()
java.lang.Number	getMinFrequency()
HIFunction	getOnEnd()
java.lang.Object	getPan()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.lang.Object	getVolume()
void	setDuration(java.lang.Number duration) The duration of the note in milliseconds.
void	setFrequency(java.lang.Object frequency) The frequency of the note to play.
void	setMasterVolume(java.lang.Number masterVolume) The master volume multiplier to apply to the instrument, regardless of other volume changes.
void	setMaxFrequency(java.lang.Number maxFrequency) The maximum frequency to allow.
void	setMinFrequency(java.lang.Number minFrequency) The minimum frequency to allow.
void	setOnEnd(HIFunction onEnd) Callback function to be called when the play is completed.
void	setPan(java.lang.Object pan) The panning of the instrument.
void	setVolume(java.lang.Object volume) The volume of the instrument.

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HIInstrumentPlayOptionsObject

public HIInstrumentPlayOptionsObject()

Method Detail

getDuration

public java.lang.Number getDuration()

getFrequency

public java.lang.Object getFrequency()

getMasterVolume

public java.lang.Number getMasterVolume()

getMaxFrequency

public java.lang.Number getMaxFrequency()

getMinFrequency

public java.lang.Number getMinFrequency()

getOnEnd

public HIFunction getOnEnd()

getPan

public java.lang.Object getPan()

getParams

public java.util.HashMap<java.lang.String,java.lang.Object> getParams()

Specified by:

getParams in class HIFoundation

getVolume

public java.lang.Object getVolume()

setDuration

public void setDuration(java.lang.Number duration)

The duration of the note in milliseconds.

setFrequency

public void setFrequency(java.lang.Object frequency)

The frequency of the note to play. Can be a fixed number, or a function. The function receives one argument: the relative time of the note playing (0 being the start, and 1 being the end of the note). It should return the frequency number for each point in time. The poll interval of this function is specified by the Instrument.playCallbackInterval option.

setMasterVolume

public void setMasterVolume(java.lang.Number masterVolume)

The master volume multiplier to apply to the instrument, regardless of other volume changes. Defaults to 1.

setMaxFrequency

public void setMaxFrequency(java.lang.Number maxFrequency)

The maximum frequency to allow. If the instrument has a set of allowed frequencies, the closest frequency is used by defaults. Use this option to stop too high frequencies from being used.

setMinFrequency

public void setMinFrequency(java.lang.Number minFrequency)

The minimum frequency to allow. If the instrument has a set of allowed frequencies, the closest frequency is used by defaults. Use this option to stop too low frequencies from being used.

setOnEnd

public void setOnEnd(HIFunction onEnd)

Callback function to be called when the play is completed.

setPan

public void setPan(java.lang.Object pan)

The panning of the instrument. Can be a fixed number between -1 and 1, or a function. The function receives one argument: the relative time of the note playing (0 being the start, and 1 being the end of the note). It should return the panning value for each point in time. The poll interval of this function is specified by the Instrument.playCallbackInterval option. Defaults to 0.

setVolume

public void setVolume(java.lang.Object volume)

The volume of the instrument. Can be a fixed number between 0 and 1, or a function. The function receives one argument: the relative time of the note playing (0 being the start, and 1 being the end of the note). It should return the volume for each point in time. The poll interval of this function is specified by the Instrument.playCallbackInterval option. Defaults to 1.