You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

38 line
1.5KB

  1. <h3>Summary</h3>
  2. <p>Play audio data provided by the Arduino sketch. This object provides
  3. functions to allow the sketch code to push data into the audio system.</p>
  4. <h3>Audio Connections</h3>
  5. <table class=doc align=center cellpadding=3>
  6. <tr class=top><th>Port</th><th>Purpose</th></tr>
  7. <tr class=odd><td align=center>Out 0</td><td>Sound Output</td></tr>
  8. </table>
  9. <h3>Functions</h3>
  10. <p class=func><span class=keyword>play</span>(int16);</p>
  11. <p class=desc>not yet implemented
  12. </p>
  13. <p class=func><span class=keyword>play</span>(int16[], length);</p>
  14. <p class=desc>not yet implemented
  15. </p>
  16. <p class=func><span class=keyword>getBuffer</span>();</p>
  17. <p class=desc>Returns a pointer to an array of 128 int16. This buffer
  18. is within the audio library memory pool, providing the most efficient
  19. way to input data to the audio system. The buffer is likely to be
  20. populated by previously used data, so the entire 128 words should be
  21. written before calling playBuffer(). Only a single buffer should be
  22. requested at a time. This function may return NULL if no memory is
  23. available.
  24. </p>
  25. <p class=func><span class=keyword>playBuffer</span>();</p>
  26. <p class=desc>Transmit the buffer previously obtained from getBuffer().
  27. </p>
  28. <h3>Examples</h3>
  29. <p><a href="http://community.arm.com/groups/embedded/blog/2014/05/23/led-video-panel-at-maker-faire-2014" target="_blank">4320 LED Video+Sound Project</a>
  30. </p>
  31. <!--<p class=exam>File &gt; Examples &gt; Audio &gt;
  32. </p>-->
  33. <h3>Notes</h3>
  34. <p>TODO: many caveats....</p>
  35. <p>
  36. </p>