ChartAudioGraph
public sealed class ChartAudioGraphConverts chart data into inspectable sonification notes and optional PCM
playback through a caller-owned ChartGuru.ChartAudioGraph.AudioSource.
Methods
Section titled “Methods”
Sonify(IReadOnlyList, Vector2)
Section titled “Sonify(IReadOnlyList, Vector2)”public List<SonificationNote> Sonify(IReadOnlyList<DataPoint> points, Vector2 yDomain)Creates one pitch-mapped note per point.
Parameters
| Name | Type |
|---|---|
points |
System.Collections.Generic.IReadOnlyList{ChartGuru.DataPoint} |
yDomain |
UnityEngine.Vector2 |
Returns
System.Collections.Generic.List{ChartGuru.SonificationNote}
FillNotes(IReadOnlyList, Vector2, List)
Section titled “FillNotes(IReadOnlyList, Vector2, List)”public void FillNotes(IReadOnlyList<DataPoint> points, Vector2 yDomain, List<SonificationNote> destination)Reuses destination while generating notes for a point sequence.
Parameters
| Name | Type |
|---|---|
points |
System.Collections.Generic.IReadOnlyList{ChartGuru.DataPoint} |
yDomain |
UnityEngine.Vector2 |
destination |
System.Collections.Generic.List{ChartGuru.SonificationNote} |
Sonify(Chart)
Section titled “Sonify(Chart)”public List<SonificationNote> Sonify(Chart chart)Generates notes from every visible, non-hidden chart mark.
Parameters
| Name | Type |
|---|---|
chart |
ChartGuru.Chart |
Returns
System.Collections.Generic.List{ChartGuru.SonificationNote}
CreateAudioClip(IReadOnlyList, Vector2, string)
Section titled “CreateAudioClip(IReadOnlyList, Vector2, string)”public AudioClip CreateAudioClip(IReadOnlyList<DataPoint> points, Vector2 yDomain, string clipName = "Chart Audio Graph")Creates and owns a mono AudioClip for the supplied point data.
Parameters
| Name | Type |
|---|---|
points |
System.Collections.Generic.IReadOnlyList{ChartGuru.DataPoint} |
yDomain |
UnityEngine.Vector2 |
clipName |
System.String |
Returns
UnityEngine.AudioClip
CreateAudioClip(Chart, string)
Section titled “CreateAudioClip(Chart, string)”public AudioClip CreateAudioClip(Chart chart, string clipName = "Chart Audio Graph")Creates and owns a mono AudioClip for every accessible chart mark.
Parameters
| Name | Type |
|---|---|
chart |
ChartGuru.Chart |
clipName |
System.String |
Returns
UnityEngine.AudioClip
Play(Chart, string)
Section titled “Play(Chart, string)”public AudioClip Play(Chart chart, string clipName = "Chart Audio Graph")Generates and starts playback through the configured AudioSource.
Parameters
| Name | Type |
|---|---|
chart |
ChartGuru.Chart |
clipName |
System.String |
Returns
UnityEngine.AudioClip
Stop()
Section titled “Stop()”public void Stop()Stops configured playback without destroying the caller-owned AudioSource.
ReleaseGeneratedClip()
Section titled “ReleaseGeneratedClip()”public void ReleaseGeneratedClip()Releases the generated clip and leaves the caller-owned AudioSource intact.
DescribeTrend(IReadOnlyList)
Section titled “DescribeTrend(IReadOnlyList)”public string DescribeTrend(IReadOnlyList<DataPoint> points)Generates a concise, objective trend summary.
Parameters
| Name | Type |
|---|---|
points |
System.Collections.Generic.IReadOnlyList{ChartGuru.DataPoint} |
Returns
System.String
Dispose()
Section titled “Dispose()”public void Dispose()Releases the generated audio clip owned by this graph.
Constructors
Section titled “Constructors”
ChartAudioGraph()
Section titled “ChartAudioGraph()”public ChartAudioGraph()Properties
Section titled “Properties”
Options
Section titled “Options”public SonificationOptions Options { get; set; }Returns
ChartGuru.SonificationOptions
AudioSource
Section titled “AudioSource”public AudioSource AudioSource { get; set; }Optional caller-owned AudioSource used by Play(Chart).
Returns
UnityEngine.AudioSource
GeneratedClip
Section titled “GeneratedClip”public AudioClip GeneratedClip { get; }The last clip generated by this graph, or null after release.
Returns
UnityEngine.AudioClip