com.highsoft.highcharts.common.hichartsclasses

Class HIDefaultSpeechOptions

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIDefaultSpeechOptions

public class HIDefaultSpeechOptions
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIDefaultSpeechOptions()

Method Summary

Modifier and Type	Method and Description
HIActiveWhen	getActiveWhen()
java.lang.String	getLanguage()
HIMapping	getMapping()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
HIPointGrouping	getPointGrouping()
java.lang.String	getPreferredVoice()
java.lang.Boolean	getShowPlayMarker()
java.lang.String	getType()
void	setActiveWhen(HIActiveWhen activeWhen) Define a condition for when a track should be active and not.
void	setLanguage(java.lang.String language) The language to speak in for speech tracks, as an IETF BCP 47 language tag.
void	setMapping(HIMapping mapping) /** * description: Mapping configuration for the speech/audio parameters.
void	setPointGrouping(HIPointGrouping pointGrouping) /** * description: Options for point grouping, specifically for instrument tracks.
void	setPreferredVoice(java.lang.String preferredVoice) Name of the voice synthesis to prefer for speech tracks.
void	setShowPlayMarker(java.lang.Boolean showPlayMarker) Show play marker (tooltip and/or crosshair) for a track.
void	setType(java.lang.String type) /** * description: Type of track.

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

HIDefaultSpeechOptions

public HIDefaultSpeechOptions()

Method Detail

getActiveWhen

public HIActiveWhen getActiveWhen()

getLanguage

public java.lang.String getLanguage()

getMapping

public HIMapping getMapping()

getParams

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

Specified by:

getParams in class HIFoundation

getPointGrouping

public HIPointGrouping getPointGrouping()

getPreferredVoice

public java.lang.String getPreferredVoice()

getShowPlayMarker

public java.lang.Boolean getShowPlayMarker()

getType

public java.lang.String getType()

setActiveWhen

public void setActiveWhen(HIActiveWhen activeWhen)

Define a condition for when a track should be active and not. Can either be a function callback or a configuration object. If a function is used, it should return a `boolean` for whether or not the track should be active. The function is called for each audio event, and receives a parameter object with `time`, and potentially `point` and `value` properties depending on the track. `point` is available if the audio event is related to a data point. `value` is available if the track is used as a context track, and `valueInterval` is used.

setLanguage

public void setLanguage(java.lang.String language)

The language to speak in for speech tracks, as an IETF BCP 47 language tag.

defaults:

 en-US

setMapping

public void setMapping(HIMapping mapping)

/** * description: Mapping configuration for the speech/audio parameters. All parameters except `text` can be either: - A string, referencing a point property to map to. - A number, setting the value of the speech parameter directly. - A callback function, returning the value programmatically. - An object defining detailed configuration of the mapping. If a function is used, it should return the desired value for the speech parameter. The function is called for each speech event to be played, and receives a context object parameter with `time`, and potentially `point` and `value` depending on the track. `point` is available if the audio event is related to a data point, and `value` is available if the track is used for a context track using `valueInterval`. * demo: * [Overview of common mapping parameters](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/sonification/mapping-overview) * [Various types of mapping used](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/sonification/pitch-mapping) * [Inverted mapping to property](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/sonification/polarity-invert) * [Logarithmic mapping to property](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/sonification/log-mapping)

setPointGrouping

public void setPointGrouping(HIPointGrouping pointGrouping)

/** * description: Options for point grouping, specifically for instrument tracks.

setPreferredVoice

public void setPreferredVoice(java.lang.String preferredVoice)

Name of the voice synthesis to prefer for speech tracks. If not available, falls back to the defaults voice for the selected language. Different platforms provide different voices for web speech synthesis.

setShowPlayMarker

public void setShowPlayMarker(java.lang.Boolean showPlayMarker)

Show play marker (tooltip and/or crosshair) for a track.

defaults:

 true

setType

public void setType(java.lang.String type)

/** * description: Type of track. Always `"instrument"` for instrument tracks, and `"speech"` for speech tracks. defaults: speech