Add shush-like functionality #13

adamyonk · 2017-01-30T22:47:11Z

This is a work-in-progress and just a proof-of-concept right now.

I wanted to see if I could copy the functionality of Shush.app with Hammerspoon - turns out it was not that difficult. Basically, you hold a hot key to mute or unmute the mic, and double-tap the hot key to toggle hold-to-mute or hold-to-unmute. It's a super minimal app that just brings push-to-talk to macOS.

Building out the hotkey functionality is kind of funny in Hammerspoon - from what I could tell you can't use hs.hotKey or hs.hotKey.modal to listen for meta-only keys (like ⌥), so I ended up doing basically the same thing you did in control-escape.lua.

I got all the way to this point and realized that hs.audiodevice:setMuted(state) doesn't exactly work as advertised. I can see the current device being muted/unmuted in Audio MIDI Setup.app, but it still comes through in all of the applications I tested in.

It sounds like another option is to set the input volume to 0, but I've read that it doesn't completely mute the input, but just makes it really quiet. I'm going to try that next, but I just wanted to put this here to see if it is something you're interested in (and to see if maybe someone knows why setMuted doesn't actually work 😄).

jasonrudolph · 2017-01-30T23:59:35Z

Nice. I hadn't considered anything like this before, but I ❤️ the idea of having a universal keystroke that provides mute/push-to-talk in every app.

adamyonk · 2017-03-08T15:30:55Z

So I tried this out again, I'm not sure what my deal was before, but I think it's working! If anyone would like to try it out and report back, I think it's ready to move forward.

I set the key to ⌥. When you reload your config, it should show a little alert that says if the mic is hot or muted.

While the mic is hot, holding ⌥ will mute, while muted, opposite
Double-tapping ⌥ will toggle muted/hot and show a notification

jasonrudolph

This is slick, @adamyonk! ⚡ I tested this out locally and it works advertised. Thanks for this contribution!

I've included a few questions and requests in the code review below. If you have any questions, just let me know.

jasonrudolph · 2017-03-09T22:29:45Z

hammerspoon/microphone.lua

+
+local messageMuting = message.new('muted 🎤')
+local messageHot = message.new('hot 🎤')
+local last_mods = {}


I think the snake_case here comes from the snake_case used in control-escape.lua. Truth be told, control-escape.lua only uses snake_case because I haven't gotten around to changing it to the more idiomatic camelCase naming used everywhere else in this repo. 😇

Would you mind changing these snake_case names to camelCase?

jasonrudolph · 2017-03-09T22:31:16Z

hammerspoon/microphone.lua

+  recently_clicked = false
+end
+
+control_key_timer = hs.timer.delayed.new(0.3, control_key_handler)


I suspect that the name control_key_timer is copy-and-paste from control_escape.lua. Since we're dealing with the option key here, I think optionKeyHandler would be a more intention-revealing name.

jasonrudolph · 2017-03-09T22:41:57Z

hammerspoon/microphone.lua

+end
+display_status()
+
+toggle = function (device)


Tiny style-related request: Remove the whitespace between function and ( for consistency with the existing code.

jasonrudolph · 2017-03-09T22:42:07Z

hammerspoon/microphone.lua

+local recently_clicked = false
+local second_click = false
+
+display_status = function ()


Tiny style-related request: Remove the whitespace between function and ( for consistency with the existing code.

jasonrudolph · 2017-03-09T22:42:14Z

hammerspoon/status-message.lua

+    notify = function(self, seconds)
+      local seconds = seconds or 1
+      self:show()
+      hs.timer.delayed.new(seconds, function () return self:hide() end):start()


Tiny style-related request: Remove the whitespace between function and ( for consistency with the existing code.

I don't think the return is required here. If it's not required, would you mind removing it?

You're right!

jasonrudolph · 2017-03-09T22:44:52Z

hammerspoon/init.lua

@@ -34,6 +34,7 @@ require('control-escape')
 require('delete-words')
 require('hyper')
 require('markdown')
+require('microphone')


Alphabetical order 😻

jasonrudolph · 2017-03-09T22:49:13Z

hammerspoon/microphone.lua

+control_key_timer = hs.timer.delayed.new(0.3, control_key_handler)
+
+option_handler = function(event)
+  local device = hs.audiodevice.current(true).device


Would it make sense to use hs.audiodevice.defaultInputDevice() here instead?

Yeah, I think I was taking the long way around here.

adamyonk · 2017-03-09T23:12:07Z

Changes made, thanks for the feedback! Let me know if there's anything else you want tweaked.

xref: jasonrudolph#13 (comment)

jasonrudolph · 2017-03-10T01:14:05Z

Changes made

Thanks, @adamyonk. You rock! 🤘

adamyonk · 2017-03-10T01:22:08Z

Yeah, thanks for the additional cleanup! Looks like I still missed a few!

jasonrudolph · 2017-03-10T01:24:58Z

This is cool enough that it deserves its own section in the README, but I didn't want to hold up sharing this goodness with the world. If you're up for it, it would be awesome to have a PR to add a section to the README describing this feature. 😁

jasonrudolph · 2017-03-26T18:10:08Z

After using this for a couple weeks, I'm digging the functionality, but I'm struggling with the keybinding. While on a video chat, I'm often talking and typing at the same time, either for pairing or for taking notes during a meeting. And since I often hit the option key while typing, my audio occasionally gets muted unintentionally while I'm talking. @adamyonk: Have you run into this at all?

So far, I'm thinking that I could resolve this issue by changing the keybinding to a key that I use less frequently than the option key. I pushed up a branch that uses the fn key (b05b17e). I'm gonna try that for a while and see how it feels.

bkeepers · 2017-03-27T13:23:54Z

And since I often hit the option key while typing, my audio occasionally gets muted unintentionally while I'm talking. @adamyonk: Have you run into this at all?

This happens to me on pretty much every video call. It might help to increase the delay from 0.3, but even then I think it's common to hold option for longer than that since you're often pressing another key with it.

👍 for fn

jnunemaker · 2017-03-29T13:03:08Z

Agreed. I hit option all the time to jump words left and right and have been doing a lot of muting/unmuting. 😄

adamyonk · 2017-03-29T13:06:46Z

Yeah, I don't run into this much, but I can see that being frustrating. I'm for it. 👍

…

On Mar 29, 2017, at 8:03 AM, John Nunemaker ***@***.***> wrote: Agreed. I hit option all the time to jump words left and right and have been doing a lot of muting/unmuting. 😄 — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

jasonrudolph · 2017-04-01T13:47:48Z

And since I often hit the option key while typing, my audio occasionally gets muted unintentionally while I'm talking. ... I'm thinking that I could resolve this issue by changing the keybinding to a key that I use less frequently than the option key. I pushed up a branch that uses the fn key (b05b17e).

Thanks for the discussion. #21 changes the keybinding from option to fn.

adamyonk force-pushed the microphone branch 5 times, most recently from 3e928dd to 1b5c730 Compare March 8, 2017 15:26

Add shush-like functionality

6d20641

adamyonk force-pushed the microphone branch from 1b5c730 to 6d20641 Compare March 8, 2017 15:27

jasonrudolph requested changes Mar 9, 2017

View reviewed changes

Code style changes

4d29372

jasonrudolph added 3 commits March 9, 2017 20:04

🔥 whitespace

97a38f6

xref: jasonrudolph#13 (comment)

Less 🐍, more 🐪

2bbc7b9

Add TODO re: docs for jasonrudolph#13

52d4350

jasonrudolph approved these changes Mar 10, 2017

View reviewed changes

jasonrudolph merged commit 5ba80d5 into jasonrudolph:master Mar 10, 2017

jasonrudolph added a commit that referenced this pull request Mar 10, 2017

Add link to #13

d6d5318

bkeepers mentioned this pull request Mar 10, 2017

Make Hyper Mode keybindings more configurable #19

Closed

jasonrudolph mentioned this pull request Apr 1, 2017

Use 'fn' instead of 'option' to mute/unmute microphone #21

Merged

jasonrudolph mentioned this pull request Jun 12, 2017

[WIP] Offer some features à la carte #26

Closed

10 tasks

landongrindheim mentioned this pull request Oct 27, 2018

Enhance format consistency #49

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add shush-like functionality #13

Add shush-like functionality #13

adamyonk commented Jan 30, 2017

jasonrudolph commented Jan 30, 2017

adamyonk commented Mar 8, 2017

jasonrudolph left a comment

jasonrudolph Mar 9, 2017

jasonrudolph Mar 9, 2017

jasonrudolph Mar 9, 2017

jasonrudolph Mar 9, 2017

jasonrudolph Mar 9, 2017

jasonrudolph Mar 9, 2017

adamyonk Mar 9, 2017

jasonrudolph Mar 9, 2017

jasonrudolph Mar 9, 2017

adamyonk Mar 9, 2017

adamyonk commented Mar 9, 2017

jasonrudolph commented Mar 10, 2017

adamyonk commented Mar 10, 2017

jasonrudolph commented Mar 10, 2017

jasonrudolph commented Mar 26, 2017

bkeepers commented Mar 27, 2017

jnunemaker commented Mar 29, 2017

adamyonk commented Mar 29, 2017 via email

jasonrudolph commented Apr 1, 2017

Add shush-like functionality #13

Add shush-like functionality #13

Conversation

adamyonk commented Jan 30, 2017

jasonrudolph commented Jan 30, 2017

adamyonk commented Mar 8, 2017

jasonrudolph left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamyonk commented Mar 9, 2017

jasonrudolph commented Mar 10, 2017

adamyonk commented Mar 10, 2017

jasonrudolph commented Mar 10, 2017

jasonrudolph commented Mar 26, 2017

bkeepers commented Mar 27, 2017

jnunemaker commented Mar 29, 2017

adamyonk commented Mar 29, 2017 via email

jasonrudolph commented Apr 1, 2017