Easily handle media keys on OS X.
Python
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
osxmmkeys
.gitignore
LICENSE
MANIFEST.in
README.rst
setup.py

README.rst

osxmmkeys

osxmmkeys is a simple Python library for handling media keys on OS X. Key presses can be observed with no side effects, or have their default behaviours overridden entirely.

Installation

To install osxmmkeys with pip, use:

$ pip install pyobjc-core
$ pip install osxmmkeys

The extra install command is due to an issue in pyobjc. It will work without it, but will be quite a bit slower.

Usage

Simple example:

import osxmmkeys

def handler():
    print("Play/pause key was pressed")

tap = osxmmkeys.Tap()
tap.on('play_pause', handler)
tap.run()

Threaded example:

import osxmmkeys, time

def handler():
    print("Play/pause key was pressed")

tap = osxmmkeys.Tap()
tap.on('play_pause', handler)
tap.start()

try:
    while True:
        time.sleep(1)
except (KeyboardInterrupt, SystemExit):
    tap.stop()

Supported key names:

  • play_pause
  • next_track
  • prev_track
  • mute
  • volume_down
  • volume_up
  • backlight_down
  • backlight_up
  • kb_backlight_down
  • kb_backlight_up