mirror of
https://github.com/ggerganov/ggwave.git
synced 2026-02-07 01:11:22 +08:00
Update README-tmpl.rst (#29)
See issues: there was a typo in the docs. The parameter "txProtocol" should be "txProtocolId"
This commit is contained in:
@@ -69,7 +69,7 @@ encode()
|
||||
|
||||
.. code:: python
|
||||
|
||||
encode(payload, [txProtocol], [volume], [instance])
|
||||
encode(payload, [txProtocolId], [volume], [instance])
|
||||
|
||||
Encodes ``payload`` into an audio waveform.
|
||||
|
||||
@@ -138,7 +138,7 @@ Usage
|
||||
p = pyaudio.PyAudio()
|
||||
|
||||
# generate audio waveform for string "hello python"
|
||||
waveform = ggwave.encode("hello python", txProtocol = 1, volume = 20)
|
||||
waveform = ggwave.encode("hello python", txProtocolId = 1, volume = 20)
|
||||
|
||||
print("Transmitting text 'hello python' ...")
|
||||
stream = p.open(format=pyaudio.paFloat32, channels=1, rate=48000, output=True, frames_per_buffer=4096)
|
||||
|
||||
Reference in New Issue
Block a user