docs » HeadphoneAutoPause

Boolean value indicating if music should be automatically resumed when headphones are plugged in again. Only works if music was automatically paused when headphones were unplugged.

• Default value: true

Table containing one key per application, with the value indicating whether HeadphoneAutoPause should try to pause/unpause that application in response to the headphone being plugged/unplugged.

• The key name must ideally correspond to the name of the corresponding hs.* module. Default value:

{
   itunes = true,
   spotify = true,
   deezer = true,
   vox = false -- Vox has built-in headphone detection support
}

Table containing control functions for each application to control.

• The keys must correspond to the values in HeadphoneAutoPause.control, and the value is a table with the following elements:
• appname - application name (case-sensitive, as the application appears to the system)
• isPlaying - function that returns a true value if the application is playing
• play - function that starts playback in the application
• pause - function that pauses playback in the application
• The default value includes definitions for iTunes, Spotify, Deezer and Vox, using the corresponding functions from hs.itunes, hs.spotify, hs.deezer and hs.vox, respectively.

Logger object used within the Spoon. Can be accessed to set the default log level for the messages coming from the Spoon.

Callback function to use as an audio device watcher, to pause/unpause the application on headphones plugged/unplugged

• dev_uid - The audio device
• event_name - The event name

Generate the most common set of application control definition.

• app - name of the application, with its correct letter casing (i.e. "iTunes"). The name as provided will be used to find the running application, and its lowercase version will be used to find the corresponding hs.* module.

• A table in the correct format for HeadphoneAutoPause.controlfns, using the lower-case value of app as the module name (for example, if app = "iTunes", the module loaded will be hs.itunes, and assuming the functions isPlaying(), play() and pause() exist in that module.

Start headphone detection on all audio devices that support it

• None

Stop headphone detection

• None