How to Use the Audio-SpectraCLI Extension

Follow these steps to use the Audio-SpectraCLI extension in Visual Studio Code:

1. Open Visual Studio Code

   • Launch VS Code on your computer (macOS, Windows, or Linux).

2. Install the Audio-SpectraCLI Extension

   • Go to the Extensions sidebar by clicking on the Extensions icon in the Activity Bar (or press Ctrl+Shift+X on Windows/Linux or Cmd+Shift+X on macOS).
   • Search for "Audio-SpectraCLI" in the Extensions Marketplace.
   • Click Install next to the Audio-SpectraCLI extension.

3. Activate the Extension

   • After installation, open the Command Palette by pressing F1 or Ctrl+Shift+P on Windows/Linux or Cmd+Shift+P on macOS.
   • Type >Audio-SpectraCLI: Add Sample Code or >Audio-SpectraCLI: View Status.
   • Select either command to activate and use the extension.

4. Using the Commands

   • Add Sample Code: Inserts sample code for Audio-SpectraCLI into the current editor window.
     • Open any Python file or create a new one.
     • Run the command Audio-SpectraCLI: Add Sample Code from the Command Palette.
     • The sample code should appear in the editor.
   • View Extension Status: Displays the current status of Audio-SpectraCLI.
     • Run the command Audio-SpectraCLI: View Status from the Command Palette.
     • You’ll see a notification indicating that Audio-SpectraCLI is ready to use.

5. Verify the Extension

   • Ensure that the Audio-SpectraCLI commands work as expected by following the steps above.
   • You should see notifications for the status and sample code added in the editor.

6. Customize as Needed

   • You can modify the inserted code or use the extension as a reference for developing your own custom scripts with Audio-SpectraCLI.

> Note: If you encounter issues, check the extension's README or reach out to contact@adityaseth.in support for troubleshooting.

Enjoy using Audio-SpectraCLI in VS Code!

Once you have activated the audio_visualizer instance, feel free to use it wherever in the program. It consists of several parameters (which gives more control to the user), so make sure to configure and add those before using it in your code. Also, the user can modify (wrt v4.1.0) the Duration (in seconds), Sampling Rate (in Hz), and Block Size.

1. Install using pip (Use pip3 instead, if pip doesn't work.)

pip install Audio-SpectraCLI

2. Import and use modules

• Create a Python file.
• You can use Example.py as a reference or use the following code :

from Audio_SpectraCLI import AudioSpectrumVisualizer
from PyQt5.QtWidgets import QApplication

# Creating an instance of AudioSpectrumVisualizer with custom parameters
app = QApplication([])
audio_visualizer = AudioSpectrumVisualizer(
    duration=5, fs=22050, block_size=1024, frequency_range=(1000, 5000), color='red')

# Starting the audio spectrum visualization
audio_visualizer.show()
app.exec_()

Once you have activated the audio_visualizer instance, feel free to use it wherever in the program. It consists of several parameters (which gives more control to the user), so make sure to configure and add those before using it in your code. Also, the user can modify (wrt v4.1.0) the Duration (in seconds), Sampling Rate (in Hz), and Block Size.

1. Install using pip (Use pip3 instead, if pip doesn't work.)

brew install pyaudio
pip install Audio-SpectraCLI

2. Import and use modules

• Create a Python file.
• You can use Example.py as a reference or use the following code :

from Audio_SpectraCLI import AudioSpectrumVisualizer
from PyQt5.QtWidgets import QApplication

# Creating an instance of AudioSpectrumVisualizer with custom parameters
app = QApplication([])
audio_visualizer = AudioSpectrumVisualizer(
    duration=5, fs=22050, block_size=1024, frequency_range=(1000, 5000), color='red')

# Starting the audio spectrum visualization
audio_visualizer.show()
app.exec_()

Once you have activated the audio_visualizer instance, feel free to use it wherever in the program. It consists of several parameters (which gives more control to the user), so make sure to configure and add those before using it in your code. Also, the user can modify (wrt v4.1.0) the Duration (in seconds), Sampling Rate (in Hz), and Block Size.

1. Prerequisites You should have docker installed on your machine. You can download and install Docker from here.
2. Pulling the Docker Image

You can pull the pre-built Docker image from Docker Hub using the following command:

docker pull adityaseth777/audio-spectracli

3. Viewing Files Inside the Docker Container For seeing the files inside the Docker container for debugging purposes, you can run an interactive shell session:

docker run --rm -it --entrypoint /bin/bash audio-spectracli

4. Use the 'ls' command to view the files and get a proper understanding of the file structure :

ls

5. You can use Example.py as a reference or use the following code :

from Audio_SpectraCLI import AudioSpectrumVisualizer
from PyQt5.QtWidgets import QApplication

# Creating an instance of AudioSpectrumVisualizer with custom parameters
app = QApplication([])
audio_visualizer = AudioSpectrumVisualizer(
    duration=5, fs=22050, block_size=1024, frequency_range=(1000, 5000), color='red')

# Starting the audio spectrum visualization
audio_visualizer.show()
app.exec_()

Once you have activated the audio_visualizer instance, feel free to use it wherever in the program. It consists of several parameters (which gives more control to the user), so make sure to configure and add those before using it in your code. Also, the user can modify (wrt v4.1.0) the Duration (in seconds), Sampling Rate (in Hz), and Block Size.

If you prefer to build the Docker image locally, follow these steps:

1. Clone the repository :

git clone https://github.com/AdityaSeth777/Audio-SpectraCLI.git
cd Audio-SpectraCLI

2. Build the Docker image:

docker build -t audio-spectracli .

3. Viewing Files Inside the Docker Container For seeing the files inside the Docker container for debugging purposes, you can run an interactive shell session:

docker run --rm -it --entrypoint /bin/bash audio-spectracli

4. Use the 'ls' command to view the files and get a proper understanding of the file structure :

ls

5. You can use Example.py as a reference or use the following code :

from Audio_SpectraCLI import AudioSpectrumVisualizer
from PyQt5.QtWidgets import QApplication

# Creating an instance of AudioSpectrumVisualizer with custom parameters
app = QApplication([])
audio_visualizer = AudioSpectrumVisualizer(
    duration=5, fs=22050, block_size=1024, frequency_range=(1000, 5000), color='red')

# Starting the audio spectrum visualization
audio_visualizer.show()
app.exec_()

Once you have activated the audio_visualizer instance, feel free to use it wherever in the program. It consists of several parameters (which gives more control to the user), so make sure to configure and add those before using it in your code. Also, the user can modify (wrt v4.1.0) the Duration (in seconds), Sampling Rate (in Hz), and Block Size.