From 6a8d450e87f3c75a46b911425d285fb179bc2e87 Mon Sep 17 00:00:00 2001 From: David Reid Date: Sat, 16 Jan 2021 20:13:57 +1000 Subject: [PATCH] Add some documentation for ma_vocoder_node. --- .../_extras/nodes/ma_vocoder_node/ma_vocoder_node.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/research/_extras/nodes/ma_vocoder_node/ma_vocoder_node.h b/research/_extras/nodes/ma_vocoder_node/ma_vocoder_node.h index fb512d61..12d232fe 100644 --- a/research/_extras/nodes/ma_vocoder_node/ma_vocoder_node.h +++ b/research/_extras/nodes/ma_vocoder_node/ma_vocoder_node.h @@ -8,6 +8,16 @@ extern "C" { #endif + +/* +The vocoder node has two inputs and one output. Inputs: + + Input Bus 0: The source/carrier stream. + Input Bus 1: The excite/modulator stream. + +The source (input bus 0) and output must have the same channel count, and is restricted to 1 or 2. +The excite (input bus 1) is restricted to 1 channel. +*/ typedef struct { ma_node_config nodeConfig;