mirror/sointu
1
0
Fork 0
mirror of https://github.com/vsariola/sointu.git synced 2026-02-13 19:53:16 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: update comments

Browse Source
This commit is contained in:
5684185+vsariola@users.noreply.github.com
2023-10-18 18:34:14 +03:00
parent 0a67129a0c
commit ccd283d2ea
2 changed files with 11 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
synth.go
View File

@ -53,12 +53,12 @@ func Render(synth Synth, buffer AudioBuffer) error {
return nil
}
// Play plays the Song using a given Synther, returning the stereo audio
// buffer and the sync buffer as a result (and possible errors). Passing
// 'release' as true means that all the notes are released when the synth is
// created. The default behaviour during runtime rendering is to leave them
// playing, meaning that envelopes start attacking right away unless an explicit
// note release is put to every track.
// Play plays the Song by first compiling the patch with the given Synther,
// returning the stereo audio buffer and the sync buffer as a result (and
// possible errors). Passing 'release' as true means that all the notes are
// released when the synth is created. The default behaviour during runtime
// rendering is to leave them playing, meaning that envelopes start attacking
// right away unless an explicit note release is put to every track.
func Play(synther Synther, song Song, release bool) (AudioBuffer, error) {
err := song.Validate()
if err != nil {