HIEarconOptionsObject

java.lang.Object
- java.util.Observable
- - com.highsoft.highcharts.core.HIFoundation
  - - com.highsoft.highcharts.common.hichartsclasses.HIEarconOptionsObject

public class HIEarconOptionsObject
extends HIFoundation

Constructor Summary

Constructors
Constructor and Description

HIEarconOptionsObject()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getId()`
`java.util.ArrayList`	`getInstruments()`
`HIFunction`	`getOnEnd()`
`java.lang.Number`	`getPan()`
`java.util.HashMap<java.lang.String,java.lang.Object>`	`getParams()`
`java.lang.Number`	`getVolume()`
`void`	`setId(java.lang.String id)` The unique ID of the Earcon.
`void`	`setInstruments(java.util.ArrayList instruments)` The instruments and their options defining this earcon.
`void`	`setOnEnd(HIFunction onEnd)` Callback function to call when earcon has finished playing.
`void`	`setPan(java.lang.Number pan)` Global panning of all instruments.
`void`	`setVolume(java.lang.Number volume)` Master volume for all instruments.

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
  - HIEarconOptionsObject
```
public HIEarconOptionsObject()
```
- Method Detail
  - getId
```
public java.lang.String getId()
```
  - getInstruments
```
public java.util.ArrayList getInstruments()
```
  - getOnEnd
```
public HIFunction getOnEnd()
```
  - getPan
```
public java.lang.Number getPan()
```
  - getParams
```
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
```
    Specified by:
    
    getParams in class HIFoundation
  - getVolume
```
public java.lang.Number getVolume()
```
  - setId
```
public void setId(java.lang.String id)
```
    The unique ID of the Earcon. Generated if not supplied.
  - setInstruments
```
public void setInstruments(java.util.ArrayList instruments)
```
    The instruments and their options defining this earcon.
  - setOnEnd
```
public void setOnEnd(HIFunction onEnd)
```
    Callback function to call when earcon has finished playing.
  - setPan
```
public void setPan(java.lang.Number pan)
```
    Global panning of all instruments. Overrides all panning on individual instruments. Can be a number between -1 and 1.
  - setVolume
```
public void setVolume(java.lang.Number volume)
```
    Master volume for all instruments. Volume settings on individual instruments can still be used for relative volume between the instruments. This setting does not affect volumes set by functions in individual instruments. Can be a number between 0 and 1. Defaults to 1.