https://github.com/alysivji/mute-microphone-mac-streamdeck-plugin

Stream Deck plugin to allow users to mute their microphone on MacOS. Written in Python.
https://github.com/alysivji/mute-microphone-mac-streamdeck-plugin

Last synced: 7 days ago
JSON representation

Stream Deck plugin to allow users to mute their microphone on MacOS. Written in Python.

• Host: GitHub
• URL: https://github.com/alysivji/mute-microphone-mac-streamdeck-plugin
• Owner: alysivji
• Created: 2020-06-07T01:06:31.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-06-11T01:28:56.000Z (over 4 years ago)
• Last Synced: 2024-04-16T02:12:58.625Z (7 months ago)
• Language: Python
• Homepage:
• Size: 44.9 KB
• Stars: 14
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Mute Microphone Stream Deck Plugin

[Stream Deck](https://www.elgato.com/en/gaming/stream-deck) plugin

to allow users to mute their microphone on MacOS.

## Design

- connect to Elgato Stream Deck software using Websockets

- we use the asyncio event loop to manage running workloads for communicating with StreamDeck software and managing system sound

- Plugin manager handles the coordination

## Installation Instructions

1. Download repo

1. Create a virtual environment with Python 3.7+

1. `pip install -r requirements.txt`

1. Update [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)) at top of `mic_control/app.py` with the Python Path from your virtual evironment above

1. Link folder `ln -s [path-to-file] /Users/[username]/Library/Application Support/com.elgato.StreamDeck/Plugins/com.alysivji.mutemic-mac.sdPlugin`

1. Restart StreamDeck software

## Resources

- [`websockets` documentation](https://websockets.readthedocs.io/en/stable/intro.html)

- Medium: [How to create a Web Socket client](https://medium.com/better-programming/how-to-create-a-websocket-in-python-b68d65dbd549)

- Lynn Root - [Advanced asyncio: Solving Real-world Production Problems](https://www.youtube.com/watch?v=sW76-pRkZk8)

## Testing

```console

pytest

python mic_control/main.py  -port 123 -info='{"application": {"language": "en", "platform": "mac", "version": "4.7.0.12981"}, "devicePixelRatio": 2, "devices": [{"id": "A123", "name": "Stream Deck", "size": {"columns": 5, "rows": 3}, "type": 0}, {"id": "D453", "name": "iPhone", "size": {"columns": 5, "rows": 3}, "type": 3}], "plugin": {"version": "1.4"}}'

```

## Todo

- https://github.com/aaugustin/websockets

- what happens when client deletes our icon?

- need to add a state machine around sound control, two states: `ON` and `OFF`

- Lynn Root's video

  - handling signals

    - add handler

  - exception handling

    - add global exception handler

  - [testing](https://youtu.be/sW76-pRkZk8?t=1350)

  - debugging