diff --git a/release-packaging/HelpSource/Classes/FluidBufTransientSlice.schelp b/release-packaging/HelpSource/Classes/FluidBufTransientSlice.schelp index 824b983..e620352 100644 --- a/release-packaging/HelpSource/Classes/FluidBufTransientSlice.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufTransientSlice.schelp @@ -46,7 +46,7 @@ ARGUMENT:: padSize The size of the handles on each sides of the block simply used for analysis purpose and avoid boundary issues. ARGUMENT:: skew - The hysteresis on the bespoke detection function. Values from -10 to 10 will allow to prioritise change in the low or high register. + The nervousness of the bespoke detection function with values from -10 to 10. It allows to decide how peaks are amplified or smoothed before the thresholding. High values increase the sensitivity to small variations. ARGUMENT:: threshFwd The threshold of the onset of the smoothed error function. It allows tight start of the identification of the anomaly as it proceeds forward. diff --git a/release-packaging/HelpSource/Classes/FluidBufTransients.schelp b/release-packaging/HelpSource/Classes/FluidBufTransients.schelp index 0dfc0e3..ca09715 100644 --- a/release-packaging/HelpSource/Classes/FluidBufTransients.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufTransients.schelp @@ -54,7 +54,7 @@ ARGUMENT:: padSize The size of the handles on each sides of the block simply used for analysis purpose and avoid boundary issues. ARGUMENT:: skew - The hysteresis on the bespoke detection function. Values from -10 to 10 will allow to prioritise change in the low or high register. + The nervousness of the bespoke detection function with values from -10 to 10. It allows to decide how peaks are amplified or smoothed before the thresholding. High values increase the sensitivity to small variations. ARGUMENT:: threshFwd The threshold of the onset of the smoothed error function. It allows tight start of the identification of the anomaly as it proceeds forward. diff --git a/release-packaging/HelpSource/Classes/FluidGain.schelp b/release-packaging/HelpSource/Classes/FluidGain.schelp index 9489a77..a20f9e8 100644 --- a/release-packaging/HelpSource/Classes/FluidGain.schelp +++ b/release-packaging/HelpSource/Classes/FluidGain.schelp @@ -23,7 +23,7 @@ ARGUMENT:: gain Audio or control rate change of the gain. RETURNS:: - Same as input, delayed by the windowSize, multiplied by the gain factor. + Same as input, delayed by the frameSize, multiplied by the gain factor. EXAMPLES:: diff --git a/release-packaging/HelpSource/Classes/FluidHPSS.schelp b/release-packaging/HelpSource/Classes/FluidHPSS.schelp index dfd49e7..a63a1d1 100644 --- a/release-packaging/HelpSource/Classes/FluidHPSS.schelp +++ b/release-packaging/HelpSource/Classes/FluidHPSS.schelp @@ -11,7 +11,7 @@ This was made possible thanks to the FluCoMa project ( http://www.flucoma.org/ CLASSMETHODS:: METHOD:: ar -(describe method here) + The audio rate version of the object. ARGUMENT:: in (describe argument here) @@ -43,10 +43,12 @@ ARGUMENT:: fftSize The inner FFT/IFFT size. It should be at least 4 samples long, at least the size of the window, and a power of 2. Making it larger allows an oversampling of the spectral precision. RETURNS:: -(describe returnvalue here) + An array of three audio streams: [0] is the harmonic part extracted, [1] is the percussive part extracted, [2] is the rest. The latency between the input and the output is TBC samples. + EXAMPLES:: CODE:: safdsad -:: \ No newline at end of file +:: + \ No newline at end of file diff --git a/release-packaging/HelpSource/Classes/FluidSTFTPass.schelp b/release-packaging/HelpSource/Classes/FluidSTFTPass.schelp index 7a51887..2252f44 100644 --- a/release-packaging/HelpSource/Classes/FluidSTFTPass.schelp +++ b/release-packaging/HelpSource/Classes/FluidSTFTPass.schelp @@ -16,7 +16,7 @@ METHOD:: ar ARGUMENT:: in The input to be passed-through -ARGUMENT:: windowSize +ARGUMENT:: winSize The size of the buffered window to be analysed, in samples. It will add that much latency to the signal. This is not modulatable. ARGUMENT:: hopSize @@ -26,7 +26,7 @@ ARGUMENT:: fftSize How large will the FFT be, zero-padding the buffer to the right size, which should be bigger than the windowSize argument, bigger than 4 samples, and should be a power of 2. This is a way to oversample the FFT for extra precision. The -1 default value will default to windowSize. This is not modulatable. RETURNS:: - Same as input, delayed by the windowSize. + Same as input, delayed by the winSize. EXAMPLES:: diff --git a/release-packaging/HelpSource/Classes/FluidSines.schelp b/release-packaging/HelpSource/Classes/FluidSines.schelp index f3e28bb..8e477aa 100644 --- a/release-packaging/HelpSource/Classes/FluidSines.schelp +++ b/release-packaging/HelpSource/Classes/FluidSines.schelp @@ -11,7 +11,7 @@ This was made possible thanks to the FluCoMa project ( http://www.flucoma.org/ CLASSMETHODS:: METHOD:: ar -(describe method here) + The audio rate version of the object. ARGUMENT:: in (describe argument here) @@ -40,7 +40,8 @@ ARGUMENT:: hopSize ARGUMENT:: fftSize (describe argument here) -RETURNS:: (describe returnvalue here) +RETURNS:: + An array of two audio streams: [0] is the harmonic part extracted, [1] is the rest. The latency between the input and the output is (( hopSize * minTrackLen) + windowSize) samples. EXAMPLES:: diff --git a/release-packaging/HelpSource/Classes/FluidTransientSlice.schelp b/release-packaging/HelpSource/Classes/FluidTransientSlice.schelp index dc2a147..4578e18 100644 --- a/release-packaging/HelpSource/Classes/FluidTransientSlice.schelp +++ b/release-packaging/HelpSource/Classes/FluidTransientSlice.schelp @@ -7,10 +7,11 @@ DESCRIPTION:: It is part of the Fluid Decomposition Toolkit of the FluCoMa project. footnote:: This was made possible thanks to the FluCoMa project ( http://www.flucoma.org/ ) funded by the European Research Council ( https://erc.europa.eu/ ) under the European Union’s Horizon 2020 research and innovation programme (grant agreement No 725899).:: + CLASSMETHODS:: METHOD:: ar -(describe method here) + The audio rate version of the object. ARGUMENT:: in (describe argument here) @@ -39,10 +40,8 @@ ARGUMENT:: winSize ARGUMENT:: debounce (describe argument here) -RETURNS:: (describe returnvalue here) - - -INSTANCEMETHODS:: +RETURNS:: + An audio stream with impulses at detected transients. The latency between the input and the output is (blockSize + padSize - order) samples. EXAMPLES:: diff --git a/release-packaging/HelpSource/Classes/FluidTransients.schelp b/release-packaging/HelpSource/Classes/FluidTransients.schelp index 9db5afd..d7c3a3b 100644 --- a/release-packaging/HelpSource/Classes/FluidTransients.schelp +++ b/release-packaging/HelpSource/Classes/FluidTransients.schelp @@ -11,7 +11,7 @@ This was made possible thanks to the FluCoMa project ( http://www.flucoma.org/ CLASSMETHODS:: METHOD:: ar -(describe method here) + The audio rate version of the object. ARGUMENT:: in (describe argument here) @@ -41,7 +41,8 @@ ARGUMENT:: debounce (describe argument here) RETURNS:: - (describe returnvalue here) + An array of two audio streams: [0] is the transient extracted, [1] is the rest. The latency between the input and the output is (blockSize + padSize - order) samples. + EXAMPLES::