docs » PushToTalk

Implements push-to-talk and push-to-mute functionality with fn key. I implemented this after reading Gitlab remote handbook https://about.gitlab.com/handbook/communication/ about Shush utility.

My workflow:

When Zoom starts, PushToTalk automatically changes mic state from default to push-to-talk, so I need to press fn key to unmute myself and speak. If I need to actively chat in group meeting or it's one-on-one meeting, I'm switching to push-to-mute state, so mic will be unmute by default and fn key mutes it.

PushToTalk has menubar with colorful icons so you can easily see current mic state.

Sample config: spoon.SpoonInstall:andUse("PushToTalk", {start = true, config = { app_switcher = { ['zoom.us'] = 'push-to-talk' }}}) and separate keybinding to toggle states with lambda function function() spoon.PushToTalk.toggleStates({'push-to-talk', 'release-to-talk'}) end

Check out my config: https://github.com/skrypka/hammerspoon_config/blob/master/init.lua

API Overview

API Documentation

Variables

app_switcher
Signature PushToTalk.app_switcher
Type Variable
Description Takes mapping from application name to mic state.
Notes
  • For example this { ['zoom.us'] = 'push-to-talk' } will switch mic to push-to-talk state when Zoom app starts.
Source Source/PushToTalk.spoon/init.lua line 35
detect_on_start
Signature PushToTalk.detect_on_start
Type Variable
Description Check running applications when starting PushToTalk.
Notes
  • Defaults to false for backwards compatibility. With this disabled, PushToTalk will only change state when applications are launched or quit while PushToTalk is already active. Enable this to look through list of running applications when PushToTalk is started. If multiple apps defined in app_switcher are running, it will set state to the first one it encounters.
Source Source/PushToTalk.spoon/init.lua line 43

Methods

init
Signature PushToTalk:init()
Type Method
Description Starts menu and key watcher
Parameters
  • None
Returns
Source Source/PushToTalk.spoon/init.lua line 134
stop
Signature PushToTalk:stop()
Type Method
Description Stops PushToTalk
Parameters
  • None
Returns
Source Source/PushToTalk.spoon/init.lua line 154
toggleStates
Signature PushToTalk:toggleStates()
Type Method
Description Cycle states in order
Parameters
  • states - A array of states to toggle. For example: {'push-to-talk', 'release-to-talk'}
Returns
Source Source/PushToTalk.spoon/init.lua line 166