crayon icon indicating copy to clipboard operation
crayon copied to clipboard

High-churn list of Issues found while making docs

Open blakeohare opened this issue 3 years ago • 0 comments

These are all the observations I made while making docs. Most of these can be dealt with trivially. After finishing docs, I'll be making a few quick passes over this list to fix what I can and then promote the remaining issues to their own bugs that can be tracked individually. Ideally these should be dealt with before releasing 2.9.0.

Audio library

  • TODO: audio format detection. right now it only checks for ogg and assumes mp3 for the rest.
  • TODO: convert Audio library to use Suspension
  • TODO: document or fix what happens when no error callback is passed to soundloader's async load functions
  • TODO: create a more specific exception for the above error other than Core.Exception
  • TODO: add error check for setDuration
  • TODO: in general the SoundBuffer library feels very type unsafe
  • TODO: change SoundBuffer.setDuration(seconds) to multiple options that clearly state the units. e.g. setDurationSeconds(n) + setDurationSampleCount(n)
  • TODO: optional callbacks in play/fade/etc to indicate when the sound has stopped
  • TODO: an abstract Audio Source class for each of the 3 supported sources (bytes, resource, samples). This class can be overridden in an audio + HTTP library

blakeohare avatar Dec 15 '21 21:12 blakeohare