Skip to content

Commit 199367b

Browse files
committed
Update readme
1 parent d37bb41 commit 199367b

File tree

2 files changed

+39
-1
lines changed

2 files changed

+39
-1
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,44 @@ convert_files_to_wav(dir_path, audio_format="mp4")
205205
206206
```
207207

208+
209+
## Audio cleaning
210+
211+
To remove low-activity regions from your audio clip, the following sample usage can be referred to.
212+
213+
```
214+
from pyAudioProcessing import clean
215+
216+
clean.remove_silence(
217+
<path to wav file>,
218+
output_file=<path where you want to store cleaned wav file>
219+
)
220+
```
221+
222+
## Audio visualization
223+
224+
To see time-domain view of the audios, and the spectrogram of the audios, please refer to the following sample usage.
225+
226+
```
227+
from pyAudioProcessing import plot
228+
229+
# spectrogram plot
230+
plot.spectrogram(
231+
<path to wav file>,
232+
show=True, # set to False if you do not want the plot to show
233+
save_to_disk=True, # set to False if you do not want the plot to save
234+
output_file=<path where you want to store spectrogram as a png>
235+
)
236+
237+
# time-series plot
238+
plot.time(
239+
<path to wav file>,
240+
show=True, # set to False if you do not want the plot to show
241+
save_to_disk=True, # set to False if you do not want the plot to save
242+
output_file=<path where you want to store the plot as a png>
243+
)
244+
```
245+
208246
## Author
209247

210248
Jyotika Singh

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ def get_requirements(path=REQUIREMENTS_PATH):
2323

2424
setuptools.setup(
2525
name='pyAudioProcessing',
26-
version='1.1.9',
26+
version='1.2.0',
2727
description='Audio processing-feature extraction and building machine learning models from audio data.',
2828
long_description=long_description,
2929
long_description_content_type="text/markdown",

0 commit comments

Comments
 (0)