#8 feat: documentation and version to release

pablodz · Oct 11, 2021 · 0a48f92 · 0a48f92
1 parent 15c331d
commit 0a48f92
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,10 +1,14 @@
+# v0.0.95 (2021-10-10)
+
+Add feature #8
+
 # v0.0.93-94 (2021-09-02)
 
 Fix issue #5
 
 # v0.0.92 (2021-06-23)
 
-ALL functions of usuall way implemented and documented
+ALL functions of usual way implemented and documented
 
 # v0.0.89 (2021-06-21)
 
@@ -24,7 +28,7 @@ ASYNC still not implemented
 
 ### Features
 
-- ASYNCIO support play
+- Asyncio support play
 - Record default 5 seconds and more selected.
 
 ### Issues

diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@ Python controller, player and recorder via pipewire's commands.
 
 ## Requirements
 
-1. A pipewire version installed (clean or via pulseaudio) is needed, to check if you have pipewire installed and running, run this command, if the output is different, you'll need to [install pipewire](./docs/INSTALL_PIPEWIRE.md):
+1. A Pipewire version installed (clean or via Pulseaudio) is needed, to check if you have pipewire installed and running, run this command, if the output is different, you'll need to [install pipewire](./docs/INSTALL_PIPEWIRE.md):
 
     1. Pipewire versions supported: 0.3.30, 0.3.32+
 
@@ -60,11 +60,13 @@ pip3 install pipewire_python # or pip
 
 ### Tutorial
 
+#### PLAY AND RECORD
+
 ```python
 from pipewire_python.controller import Controller
 
 # [PLAYBACK]: normal way
-audio_controller = Controller(verbose=True)
+audio_controller = Controller()
 audio_controller.set_config(rate=384000,
                             channels=2,
                             _format='f64',
@@ -73,22 +75,39 @@ audio_controller.set_config(rate=384000,
 audio_controller.playback(audio_filename='docs/beers.wav')
 
 # [RECORD]: normal way
-audio_controller = Controller(verbose=True)
+audio_controller = Controller()
 audio_controller.record(audio_filename='docs/5sec_record.wav',
                         timeout_seconds=5)
 ```
+#### GET INTERFACES
+
+```python
+from pipewire_python.controller import Controller
+
+audio_controller = Controller()
+# Return all Client Interfaces on Pipewire
+audio_controller.get_list_interfaces(
+    type_interfaces="Client",
+    filtered_by_type=True,
+)
+# Return all interfaces
+audio_controller.get_list_interfaces(
+    filtered_by_type=False,
+)
+```
+
 
 ## Documentation
 
-You can check the automatic builded documentation [HERE](https://pablodz.github.io/pipewire_python/html/)
+You can check the automatic build documentation [HERE](https://pablodz.github.io/pipewire_python/html/)
 
 ## Roadmap
 
-Future implementations, next steps, API implementation and Control over pipewire directly from python in the [ROADMAP](docs/ROADMAP.md).
+Future implementations, next steps, API implementation and Control over Pipewire directly from python in the [ROADMAP](docs/ROADMAP.md).
 
 ## Contributions
 
-PR, FR and issues are welcome. Changes with PR in `dev` branch please due documentation runs after each commit in `main` branch. Check more [here](docs/NEW_RELEASE.md)
+PR, FR, and issues are welcome. Changes with PR in `dev` branch please due documentation runs after each commit in `main` branch. Check more [here](docs/NEW_RELEASE.md)
 
 ## License
 

diff --git a/pipewire_python/__init__.py b/pipewire_python/__init__.py
@@ -47,17 +47,15 @@
 from pipewire_python.controller import Controller
 
 # PLAYBACK: normal way
-audio_controller = Controller(verbose=True)
+audio_controller = Controller()
 audio_controller.set_config(rate=384000,
                             channels=2,
                             _format='f64',
                             volume=0.98,
                             quality=4,
                             # Debug
                             verbose=True)
-audio_controller.playback(audio_filename='docs/beers.wav',
-                          # Debug
-                          verbose=True)
+audio_controller.playback(audio_filename='docs/beers.wav')
 
 # RECORD: normal way
 audio_controller = Controller(verbose=True)
@@ -69,7 +67,7 @@
 ```
 """
 
-__version__ = "0.0.94"
+__version__ = "0.0.95"
 
 import sys