djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update doc comments for PWMAudioOut

This commit is contained in:
Scott Shawcroft 2019-07-29 17:43:22 -07:00 committed by GitHub
parent b72352949b
commit 3961014a9e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
shared-bindings/audiopwmio/PWMAudioOut.c
View File

@ -38,14 +38,14 @@
//| .. currentmodule:: audiopwmio //| .. currentmodule:: audiopwmio
//| //|
//| :class:`AudioOut` -- Output an analog audio signal //| :class:`PWMAudioOut` -- Output an analog audio signal
//| ======================================================== //| ========================================================
//| //|
//| AudioOut can be used to output an analog audio signal on a given pin. //| AudioOut can be used to output an analog audio signal on a given pin.
//| //|
//| .. class:: AudioOut(left_channel, *, right_channel=None, quiescent_value=0x8000) //| .. class:: PWMAudioOut(left_channel, *, right_channel=None, quiescent_value=0x8000)
//| //|
//| Create a AudioOut object associated with the given pin(s). This allows you to //| Create a PWMAudioOut object associated with the given pin(s). This allows you to
//| play audio signals out on the given pin(s). In contrast to mod:`audioio`, //| play audio signals out on the given pin(s). In contrast to mod:`audioio`,
//| the pin(s) specified are digital pins, and are driven with a device-dependent PWM //| the pin(s) specified are digital pins, and are driven with a device-dependent PWM
//| signal. //| signal.
@ -70,7 +70,7 @@
//| for i in range(length): //| for i in range(length):
//| sine_wave[i] = int(math.sin(math.pi * 2 * i / 18) * (2 ** 15) + 2 ** 15) //| sine_wave[i] = int(math.sin(math.pi * 2 * i / 18) * (2 ** 15) + 2 ** 15)
//| //|
//| dac = audiopwmio.AudioOut(board.SPEAKER) //| dac = audiopwmio.PWMAudioOut(board.SPEAKER)
//| sine_wave = audiocore.RawSample(sine_wave, sample_rate=8000) //| sine_wave = audiocore.RawSample(sine_wave, sample_rate=8000)
//| dac.play(sine_wave, loop=True) //| dac.play(sine_wave, loop=True)
//| time.sleep(1) //| time.sleep(1)
@ -89,7 +89,7 @@
//| //|
//| data = open("cplay-5.1-16bit-16khz.wav", "rb") //| data = open("cplay-5.1-16bit-16khz.wav", "rb")
//| wav = audiocore.WaveFile(data) //| wav = audiocore.WaveFile(data)
//| a = audiopwmio.AudioOut(board.SPEAKER) //| a = audiopwmio.PWMAudioOut(board.SPEAKER)
//| //|
//| print("playing") //| print("playing")
//| a.play(wav) //| a.play(wav)
@ -128,7 +128,7 @@ STATIC mp_obj_t audiopwmio_pwmaudioout_make_new(const mp_obj_type_t *type, size_
//| .. method:: deinit() //| .. method:: deinit()
//| //|
//| Deinitialises the AudioOut and releases any hardware resources for reuse. //| Deinitialises the PWMAudioOut and releases any hardware resources for reuse.
//| //|
STATIC mp_obj_t audiopwmio_pwmaudioout_deinit(mp_obj_t self_in) { STATIC mp_obj_t audiopwmio_pwmaudioout_deinit(mp_obj_t self_in) {
audiopwmio_pwmaudioout_obj_t *self = MP_OBJ_TO_PTR(self_in); audiopwmio_pwmaudioout_obj_t *self = MP_OBJ_TO_PTR(self_in);