From 464aa2283b3fff6f689470c8f7c55e6a3cbb57aa Mon Sep 17 00:00:00 2001 From: midijohnny Date: Mon, 12 Apr 2021 11:03:53 +0100 Subject: [PATCH] Update README-tmpl.rst (#29) See issues: there was a typo in the docs. The parameter "txProtocol" should be "txProtocolId" --- bindings/python/README-tmpl.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/bindings/python/README-tmpl.rst b/bindings/python/README-tmpl.rst index 6a524fc..e07bd74 100644 --- a/bindings/python/README-tmpl.rst +++ b/bindings/python/README-tmpl.rst @@ -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)