UNPKG

tone-rhythm

Version:

Generate an array of Tone.Transport times for use in Tone.Part

github.com/scraggo/tone-rhythm

scraggo/tone-rhythm

146 lines (64 loc) • 3.68 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# tone-rhythm *0.0.0* through *0.0.2* **tone-rhythm@0.0.2.min.js is bundled with Tone.Time from tone@0.12.80** If this causes issues, I recommend upgrading to **tone-rhythm@1.0.0** so that you can bundle in your own version of tone as a dependency. ## Usage `import toneRhythm from 'tone-rhythm'` or `import { mergeMusicDataPart } from 'tone-rhythm'` Or import `tone-rhythm.min.js` into html page: ```html <head> <!-- Import `tone-rhythm.min.js` from node_modules: --> <script src="node_modules/tone-rhythm/dist/tone-rhythm.min.js"></script> <!-- OR simply provide your path/to/tone-rhythm.min.js --> </head> ``` > Generate an array of Tone.Transport times for use in Tone.Part ### src/tone-rhythm.js #### getBarsBeats(value) ##### Parameters | Name | Type | Description | | | ----- | ----------------- | -------------------------------- | ------ | | value | `string` `number` | - a rhythm value Tone recognizes | &nbsp; | ##### Examples ```javascript getBarsBeats('4n') -> '0:1:0' ``` ##### Returns - `string` - rhythm value converted to Tone's bars/beats format. #### addTimes(item) ##### Parameters | Name | Type | Description | | | ---- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------ | | item | `Array.<string>` `string` | if item is array, return summation of items in Tone's bars/beats format.<br> Note: The first item of the array may be 'r' (rest) | &nbsp; | ##### Examples ```javascript addTimes('4n.') -> '4n.' ``` ```javascript addTimes(['8n', '4t', '4t', '4t', '4t', '4t', '4t', '8n']) -> '1:1:0' ``` ##### Returns - `string` - if item is an array, returns rhythm value converted to Tone's bars/beats format. If item was a string, it gets returned as is. #### getTransportTimes(arrOfDurations[, startTime&#x3D;0]) Given an array of durations (see API), return transport times. see [README.md](README.md) for examples ##### Parameters | Name | Type | Description | | | ---------------- | ----------------- | ------------------------------------- | ---------- | | arrOfDurations | `Array.<string>` | - see README.md API | &nbsp; | | startTime&#x3D;0 | `number` `string` | - a start time in Tone's Time format. | *Optional* | ##### Returns - `Array` of start times in Tone's bars/beats format. #### mergeMusicDataPart(config) see [README.md](README.md) for examples ##### Parameters | Name | Type | Description | | | ---------------- | ----------------- | -------------------------------------- | ---------- | | config | `Object` | (see properties below) | &nbsp; | | config.rhythms | `Array` | - see API | &nbsp; | | config.notes | `Array.<string>` | - ex: ['C4', 'D4', 'E4'] | *Optional* | | config.times | `Array` | - see return of `getTransportTimes` | *Optional* | | config.startTime | `string` `number` | - see startTime of `getTransportTimes` | *Optional* | ##### Returns - `Array` of objects for consumption by Tone.Part. Object properties always include time and duration. May also include notes and velocities. *Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*