public class HISonification extends HIFoundation
Constructor and Description |
---|
HISonification() |
Modifier and Type | Method and Description |
---|---|
java.lang.Number |
getAfterSeriesWait() |
java.util.ArrayList |
getContextTracks() |
HIDefaultInstrumentOptions |
getDefaultInstrumentOptions() |
HIDefaultSpeechOptions |
getDefaultSpeechOptions() |
java.lang.Number |
getDuration() |
java.lang.Boolean |
getEnabled() |
HIEvents |
getEvents() |
java.util.ArrayList |
getGlobalContextTracks() |
java.util.ArrayList |
getGlobalTracks() |
java.lang.Number |
getMasterVolume() |
java.lang.String |
getOrder() |
java.util.HashMap<java.lang.String,java.lang.Object> |
getParams() |
java.lang.String |
getPlayAsSoundButtonText() |
java.lang.String |
getPlayAsSoundClickAnnouncement() |
HIPointGrouping |
getPointGrouping() |
java.lang.Boolean |
getShowCrosshair() |
java.lang.Boolean |
getShowTooltip() |
java.util.ArrayList |
getTracks() |
java.lang.Number |
getUpdateInterval() |
void |
setAfterSeriesWait(java.lang.Number afterSeriesWait)
The time to wait in milliseconds after each data series when playing the series one after the other.
|
void |
setContextTracks(java.util.ArrayList contextTracks)
Context tracks for this series.
|
void |
setDefaultInstrumentOptions(HIDefaultInstrumentOptions defaultsInstrumentOptions)
Default sonification options for all instrument tracks.
|
void |
setDefaultSpeechOptions(HIDefaultSpeechOptions defaultsSpeechOptions)
Default sonification options for all speech tracks.
|
void |
setDuration(java.lang.Number duration)
The total duration of the sonification, in milliseconds.
|
void |
setEnabled(java.lang.Boolean enabled)
Enable sonification functionality for the chart.
|
void |
setEvents(HIEvents events)
Set up event handlers for the sonification
|
void |
setGlobalContextTracks(java.util.ArrayList globalContextTracks)
Context tracks to add globally, an array of either instrument tracks, speech tracks, or a mix.
|
void |
setGlobalTracks(java.util.ArrayList globalTracks)
Global tracks to add to every series.
|
void |
setMasterVolume(java.lang.Number masterVolume)
Overall/master volume for the sonification, from 0 to 1.
|
void |
setOrder(java.lang.String order)
What order to play the data series in, either `sequential` where the series play individually one after the other, or `simultaneous` where the series play all at once.
|
void |
setPlayAsSoundButtonText(java.lang.String playAsSoundButtonText) |
void |
setPlayAsSoundClickAnnouncement(java.lang.String playAsSoundClickAnnouncement) |
void |
setPointGrouping(HIPointGrouping pointGrouping)
Options for grouping data points together when sonifying.
|
void |
setShowCrosshair(java.lang.Boolean showCrosshair)
Show X and Y axis crosshairs (if they exist) as the chart plays.
|
void |
setShowTooltip(java.lang.Boolean showTooltip)
Show tooltip as the chart plays.
|
void |
setTracks(java.util.ArrayList tracks)
Tracks for this series.
|
void |
setUpdateInterval(java.lang.Number updateInterval)
How long to wait between each recomputation of the sonification, if the chart updates rapidly.
|
public java.lang.Number getAfterSeriesWait()
public java.util.ArrayList getContextTracks()
public HIDefaultInstrumentOptions getDefaultInstrumentOptions()
public HIDefaultSpeechOptions getDefaultSpeechOptions()
public java.lang.Number getDuration()
public java.lang.Boolean getEnabled()
public HIEvents getEvents()
public java.util.ArrayList getGlobalContextTracks()
public java.util.ArrayList getGlobalTracks()
public java.lang.Number getMasterVolume()
public java.lang.String getOrder()
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
getParams
in class HIFoundation
public java.lang.String getPlayAsSoundButtonText()
public java.lang.String getPlayAsSoundClickAnnouncement()
public HIPointGrouping getPointGrouping()
public java.lang.Boolean getShowCrosshair()
public java.lang.Boolean getShowTooltip()
public java.util.ArrayList getTracks()
public java.lang.Number getUpdateInterval()
public void setAfterSeriesWait(java.lang.Number afterSeriesWait)
public void setContextTracks(java.util.ArrayList contextTracks)
public void setDefaultInstrumentOptions(HIDefaultInstrumentOptions defaultsInstrumentOptions)
public void setDefaultSpeechOptions(HIDefaultSpeechOptions defaultsSpeechOptions)
public void setDuration(java.lang.Number duration)
public void setEnabled(java.lang.Boolean enabled)
public void setEvents(HIEvents events)
public void setGlobalContextTracks(java.util.ArrayList globalContextTracks)
public void setGlobalTracks(java.util.ArrayList globalTracks)
public void setMasterVolume(java.lang.Number masterVolume)
public void setOrder(java.lang.String order)
public void setPlayAsSoundButtonText(java.lang.String playAsSoundButtonText)
public void setPlayAsSoundClickAnnouncement(java.lang.String playAsSoundClickAnnouncement)
public void setPointGrouping(HIPointGrouping pointGrouping)
public void setShowCrosshair(java.lang.Boolean showCrosshair)
public void setShowTooltip(java.lang.Boolean showTooltip)
public void setTracks(java.util.ArrayList tracks)
public void setUpdateInterval(java.lang.Number updateInterval)