{"description":"<p>Default options for all this series&#39; speech tracks.</p>\n","typeList":{"names":[]},"children":[{"description":"<p>Define a condition for when a track should be active and not.</p>\n<p>Can either be a function callback or a configuration object.</p>\n<p>If a function is used, it should return a <code>boolean</code> for whether\nor not the track should be active. The function is called for\neach audio event, and receives a parameter object with <code>time</code>,\nand potentially <code>point</code> and <code>value</code> properties depending on the\ntrack. <code>point</code> is available if the audio event is related to a\ndata point. <code>value</code> is available if the track is used as a\ncontext track, and <code>valueInterval</code> is used.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"plotOptions.series.sonification.defaultSpeechOptions.activeWhen","isLeaf":false,"line":357,"lineEnd":376,"name":"activeWhen","samples":[{"name":"Mapping zones","value":"highcharts/sonification/mapping-zones"}],"since":"11.0.0","typeList":{"names":["function","*"]},"version":"12.6.0"},{"default":"en-US","description":"<p>The language to speak in for speech tracks, as an IETF BCP 47\nlanguage tag.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"plotOptions.series.sonification.defaultSpeechOptions.language","isLeaf":true,"line":744,"lineEnd":753,"name":"language","samples":[{"name":"French language speech","value":"maps/demo/audio-map"}],"since":"11.0.0","typeList":{"names":["string"]},"version":"12.6.0"},{"description":"<p>Mapping configuration for the speech/audio parameters.</p>\n<p>All parameters except <code>text</code> can be either:</p>\n<ul>\n<li>A string, referencing a point property to map to.</li>\n<li>A number, setting the value of the speech parameter directly.</li>\n<li>A callback function, returning the value programmatically.</li>\n<li>An object defining detailed configuration of the mapping.</li>\n</ul>\n<p>If a function is used, it should return the desired value for\nthe speech parameter. The function is called for each speech\nevent to be played, and receives a context object parameter with\n<code>time</code>, and potentially <code>point</code> and <code>value</code> depending on the\ntrack. <code>point</code> is available if the audio event is related to a\ndata point, and <code>value</code> is available if the track is used for a\ncontext track using <code>valueInterval</code>.</p>\n","extends":"","filename":"ts/Extensions/Sonification/Options.ts","fullname":"plotOptions.series.sonification.defaultSpeechOptions.mapping","isLeaf":false,"line":774,"lineEnd":796,"name":"mapping","samples":[{"name":"Overview of common mapping parameters","value":"highcharts/sonification/mapping-overview"},{"name":"Various types of mapping used","value":"highcharts/sonification/pitch-mapping"},{"name":"Inverted mapping to property","value":"highcharts/sonification/polarity-invert"},{"name":"Logarithmic mapping to property","value":"highcharts/sonification/log-mapping"}],"since":"11.0.0","typeList":{"names":["*"]},"version":"12.6.0"},{"description":"<p>Options for point grouping, specifically for instrument tracks.</p>\n","extends":"","filename":"ts/Extensions/Sonification/Options.ts","fullname":"plotOptions.series.sonification.defaultSpeechOptions.pointGrouping","isLeaf":false,"line":881,"lineEnd":881,"name":"pointGrouping","since":"11.0.0","typeList":{"names":["*"]},"version":"12.6.0"},{"description":"<p>Name of the voice synthesis to prefer for speech tracks.</p>\n<p>If not available, falls back to the default voice for the\nselected language.</p>\n<p>Different platforms provide different voices for web speech\nsynthesis.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"plotOptions.series.sonification.defaultSpeechOptions.preferredVoice","isLeaf":true,"line":754,"lineEnd":765,"name":"preferredVoice","since":"11.0.0","typeList":{"names":["string"]},"version":"12.6.0"},{"default":"true","description":"<p>Show play marker (tooltip and/or crosshair) for a track.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"plotOptions.series.sonification.defaultSpeechOptions.showPlayMarker","isLeaf":true,"line":335,"lineEnd":341,"name":"showPlayMarker","since":"11.0.0","typeList":{"names":["boolean"]},"version":"12.6.0"},{"default":"speech","description":"<p>Type of track. Always <code>&quot;instrument&quot;</code> for instrument tracks, and\n<code>&quot;speech&quot;</code> for speech tracks.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"plotOptions.series.sonification.defaultSpeechOptions.type","isLeaf":true,"line":744,"lineEnd":753,"name":"type","since":"11.0.0","typeList":{"names":["\"instrument\"","\"speech\""]},"version":"12.6.0"}]}