docs » hs.audiodevice

Manipulate the system's audio devices

This module is based primarily on code from the previous incarnation of Mjolnir by Steven Degutis.

Submodules

API Overview

API Documentation

Functions

allDevices
Signature hs.audiodevice.allDevices() -> hs.audiodevice[]
Type Function
Description

Returns a list of all connected devices

Parameters:

  • None

Returns:

  • A table of zero or more audio devices connected to the system
allInputDevices
Signature hs.audiodevice.allInputDevices() -> audio[]
Type Function
Description

Returns a list of all connected input devices.

Parameters:

  • None

Returns:

  • A table of zero or more audio input devices connected to the system
allOutputDevices
Signature hs.audiodevice.allOutputDevices() -> hs.audiodevice[]
Type Function
Description

Returns a list of all connected output devices

Parameters:

  • None

Returns:

  • A table of zero or more audio output devices connected to the system
current
Signature hs.audiodevice.current([input]) -> table
Type Function
Description

Fetch various metadata about the current default audio devices

Parameters:

  • output - An optional boolean, true to fetch information about the default input device, false for output device. Defaults to false

Returns:

  • A table with the following contents:
    {
         name = defaultOutputDevice():name(),
         uid = module.defaultOutputDevice():uid(),
         muted = defaultOutputDevice():muted(),
         volume = defaultOutputDevice():volume(),
         device = defaultOutputDevice(),
     }
    
defaultInputDevice
Signature hs.audiodevice.defaultInputDevice() -> audio or nil
Type Function
Description

Get the currently selected audio input device

Parameters:

  • None

Returns:

  • An hs.audiodevice object, or nil if no suitable device could be found
defaultOutputDevice
Signature hs.audiodevice.defaultOutputDevice() -> audio or nil
Type Function
Description

Get the currently selected audio output device

Parameters:

  • None

Returns:

  • An hs.audiodevice object, or nil if no suitable device could be found
findDeviceByName
Signature hs.audiodevice.findDeviceByName(name) -> device or nil
Type Function
Description

Find an audio device by name

Parameters:

  • name - A string containing the name of an audio device to search for

Returns:

  • An hs.audiodevice object or nil if the device could not be found
findDeviceByUID
Signature hs.audiodevice.findDeviceByUID(uid) -> device or nil
Type Function
Description

Find an audio device by UID

Parameters:

  • uid - A string containing the UID of an audio device to search for

Returns:

  • An hs.audiodevice object or nil if the device could not be found
findInputByName
Signature hs.audiodevice.findInputByName(name) -> device or nil
Type Function
Description

Find an audio input device by name

Parameters:

  • name - A string containing the name of an audio input device to search for

Returns:

  • An hs.audiodevice object or nil if the device could not be found
findInputByUID
Signature hs.audiodevice.findInputByUID(uid) -> device or nil
Type Function
Description

Find an audio input device by UID

Parameters:

  • name - A string containing the UID of an audio input device to search for

Returns:

  • An hs.audiodevice object or nil if the device could not be found
findOutputByName
Signature hs.audiodevice.findOutputByName(name) -> device or nil
Type Function
Description

Find an audio output device by name

Parameters:

  • name - A string containing the name of an audio output device to search for

Returns:

  • An hs.audiodevice object or nil if the device could not be found
findOutputByUID
Signature hs.audiodevice.findOutputByUID(uid) -> device or nil
Type Function
Description

Find an audio output device by UID

Parameters:

  • name - A string containing the UID of an audio output device to search for

Returns:

  • An hs.audiodevice object or nil if the device could not be found

Methods

allInputDataSources
Signature hs.audiodevice:allInputDataSources() -> hs.audiodevice.dataSource[] or nil
Type Method
Description

Gets all of the input data sources of an audio device

Parameters:

  • None

Returns:

  • A list of hs.audiodevice.dataSource objects, or nil if an error occurred
allOutputDataSources
Signature hs.audiodevice:allOutputDataSources() -> hs.audiodevice.dataSource[] or nil
Type Method
Description

Gets all of the output data sources of an audio device

Parameters:

  • None

Returns:

  • A list of hs.audiodevice.dataSource objects, or nil if an error occurred
currentInputDataSource
Signature hs.audiodevice:currentInputDataSource() -> hs.audiodevice.dataSource object or nil
Type Method
Description

Gets the current input data source of an audio device

Parameters:

  • None

Returns:

  • An hs.audiodevice.dataSource object, or nil if an error occurred

Notes:

  • Before calling this method, you should check the result of hs.audiodevice:supportsInputDataSources()
currentOutputDataSource
Signature hs.audiodevice:currentOutputDataSource() -> hs.audiodevice.dataSource object or nil
Type Method
Description

Gets the current output data source of an audio device

Parameters:

  • None

Returns:

  • An hs.audiodevice.dataSource object, or nil if an error occurred

Notes:

  • Before calling this method, you should check the result of hs.audiodevice:supportsOutputDataSources()
inputMuted
Signature hs.audiodevice:inputMuted() -> bool or nil
Type Method
Description

Get the Input mutedness state of the audio device

Parameters:

  • None

Returns:

  • True if the audio device's Input is muted. False if it's not muted, nil if it does not support muting
inputVolume
Signature hs.audiodevice:inputVolume() -> number or nil
Type Method
Description

Get the current input volume of this audio device

Parameters:

  • None

Returns:

  • A number between 0 and 100, representing the input volume percentage, or nil if the audio device does not support input volume levels

Notes:

  • The return value will be a floating point number
isInputDevice
Signature hs.audiodevice:isInputDevice() -> boolean
Type Method
Description

Determins if an audio device is an input device

Parameters:

  • None

Returns:

  • A boolean, true if the device is an input device, false if not
isOutputDevice
Signature hs.audiodevice:isOutputDevice() -> boolean
Type Method
Description

Determins if an audio device is an output device

Parameters:

  • None

Returns:

  • A boolean, true if the device is an output device, false if not
jackConnected
Signature hs.audiodevice:jackConnected() -> boolean or nil
Type Method
Description

Determines whether an audio jack (e.g. headphones) is connected to an audio device

Parameters:

  • None

Returns:

  • A boolean, true if a jack is connected, false if not, or nil if the device does not support jack sense
muted
Signature hs.audiodevice:muted() -> bool or nil
Type Method
Description

Get the mutedness state of the audio device

Parameters:

  • None

Returns:

  • True if the audio device is muted, False if it is not muted, nil if it does not support muting

Notes:

  • If a device is capable of both input and output, this method will prefer the output. See :inputMuted() and :outputMuted() for specific variants.
name
Signature hs.audiodevice:name() -> string or nil
Type Method
Description

Get the name of the audio device

Parameters:

  • None

Returns:

  • A string containing the name of the audio device, or nil if it has no name
outputMuted
Signature hs.audiodevice:outputMuted() -> bool or nil
Type Method
Description

Get the Output mutedness state of the audio device

Parameters:

  • None

Returns:

  • True if the audio device's Output is muted. False if it's not muted, nil if it does not support muting
outputVolume
Signature hs.audiodevice:outputVolume() -> number or nil
Type Method
Description

Get the current output volume of this audio device

Parameters:

  • None

Returns:

  • A number between 0 and 100, representing the output volume percentage, or nil if the audio device does not support output volume levels

Notes:

  • The return value will be a floating point number
setDefaultInputDevice
Signature hs.audiodevice:setDefaultInputDevice() -> bool
Type Method
Description

Selects this device as the system's audio input device

Parameters:

  • None

Returns:

  • True if the audio device was successfully selected, otherwise false.
setDefaultOutputDevice
Signature hs.audiodevice:setDefaultOutputDevice() -> bool
Type Method
Description

Selects this device as the system's audio output device

Parameters:

  • None

Returns:

  • True if the audio device was successfully selected, otherwise false.
setInputMuted
Signature hs.audiodevice:setInputMuted(state) -> bool
Type Method
Description

Set the mutedness state of the Input of the audio device

Parameters:

  • state - A boolean value. True to mute the device, False to unmute it

Returns:

  • True if the device's Input mutedness state was set, or False if it does not support muting
setInputVolume
Signature hs.audiodevice:setInputVolume(level) -> bool
Type Method
Description

Set the input volume of this audio device

Parameters:

  • level - A number between 0 and 100, representing the input volume as a percentage

Returns:

  • True if the volume was set, false if the audio device does not support setting an input volume level

Notes:

  • The volume level is a floating point number. Depending on your audio hardware, it may not be possible to increase volume in single digit increments
setMuted
Signature hs.audiodevice:setMuted(state) -> bool
Type Method
Description

Set the mutedness state of the audio device

Parameters:

  • state - A boolean value. True to mute the device, False to unmute it

Returns:

  • True if the device's mutedness state was set, or False if it does not support muting

Notes:

  • If a device is capable of both input and output, this method will prefer the output. See :inputSetMuted() and :outputSetMuted() for specific variants.
setOutputMuted
Signature hs.audiodevice:setOutputMuted(state) -> bool
Type Method
Description

Set the mutedness state of the Output of the audio device

Parameters:

  • state - A boolean value. True to mute the device, False to unmute it

Returns:

  • True if the device's Output mutedness state was set, or False if it does not support muting
setOutputVolume
Signature hs.audiodevice:setOutputVolume(level) -> bool
Type Method
Description

Set the output volume of this audio device

Parameters:

  • level - A number between 0 and 100, representing the output volume as a percentage

Returns:

  • True if the volume was set, false if the audio device does not support setting an output volume level

Notes:

  • The volume level is a floating point number. Depending on your audio hardware, it may not be possible to increase volume in single digit increments
setVolume
Signature hs.audiodevice:setVolume(level) -> bool
Type Method
Description

Set the volume of this audio device

Parameters:

  • level - A number between 0 and 100, representing the volume as a percentage

Returns:

  • True if the volume was set, false if the audio device does not support setting a volume level.

Notes:

  • The volume level is a floating point number. Depending on your audio hardware, it may not be possible to increase volume in single digit increments.
  • This method will inspect the device to determine if it is an input or output device, and set the appropriate volume. For devices that are both input and output devices, see :setInputVolume() and :setOutputVolume()
supportsInputDataSources
Signature hs.audiodevice:supportsInputDataSources() -> boolean
Type Method
Description

Determines whether an audio device supports input data sources

Parameters:

  • None

Returns:

  • A boolean, true if the device supports input data sources, false if not
supportsOutputDataSources
Signature hs.audiodevice:supportsOutputDataSources() -> boolean
Type Method
Description

Determines whether an audio device supports output data sources

Parameters:

  • None

Returns:

  • A boolean, true if the device supports output data sources, false if not
transportType
Signature hs.audiodevice:transportType() -> string
Type Method
Description

Gets the hardware transport type of an audio device

Parameters:

  • None

Returns:

  • A string containing the transport type, or nil if an error occurred
uid
Signature hs.audiodevice:uid() -> string or nil
Type Method
Description

Get the unique identifier of the audio device

Parameters:

  • None

Returns:

  • A string containing the UID of the audio device, or nil if it has no UID.
volume
Signature hs.audiodevice:volume() -> number or nil
Type Method
Description

Get the current volume of this audio device

Parameters:

  • None

Returns:

  • A number between 0 and 100, representing the volume percentage, or nil if the audio device does not support volume levels

Notes:

  • The return value will be a floating point number
  • This method will inspect the device to determine if it is an input or output device, and return the appropriate volume. For devices that are both input and output devices, see :inputVolume() and :outputVolume()
watcherCallback
Signature hs.audiodevice:watcherCallback(fn) -> hs.audiodevice
Type Method
Description

Sets or removes a callback function for an audio device watcher

Parameters:

  • fn - A callback function that will be called when properties of this audio device change, or nil to remove an existing callback. The function should accept four arguments:
    • A string containing the UID of the audio device (see hs.audiodevice.findDeviceByUID())
    • A string containing the name of the event. Possible values are:
    • vmvc - Volume changed
    • mute - Mute state changed
    • jack - Jack sense state changed (usually this means headphones were plugged/unplugged)
    • span - Stereo pan changed
    • diff - Device configuration changed (if you are caching audio device properties, this event indicates you should flush your cache)
    • A string containing the scope of the event. Possible values are:
    • glob - This is a global event pertaining to the whole device
    • inpt - This is an event pertaining only to the input functions of the device
    • outp - This is an event pertaining only to the output functions of the device
    • A number containing the element of the event. Typical values are:
    • 0 - Typically this means the Master channel
    • 1 - Typically this means the Left channel
    • 2 - Typically this means the Right channel

Returns:

  • The hs.audiodevice object

Notes:

  • You will receive many events to your callback, so filtering on the name/scope/element arguments is vital. For example, on a stereo device, it is not uncommon to receive a volm event for each audio channel when the volume changes, or multiple mute events for channels. Dragging a volume slider in the system Sound preferences will produce a large number of volm events. Plugging/unplugging headphones may trigger volm events in addition to jack ones, etc.
  • If you need to use the hs.audiodevice object in your callback, use hs.audiodevice.findDeviceByUID() to obtain it fro the first callback argument
watcherIsRunning
Signature hs.audiodevice:watcherIsRunning() -> boolean
Type Method
Description

Gets the status of the hs.audiodevice object watcher

Parameters:

  • None

Returns:

  • A boolean, true if the watcher is running, false if not
watcherStart
Signature hs.audiodevice:watcherStart() -> hs.audiodevice or nil
Type Method
Description

Starts the watcher on an hs.audiodevice object

Parameters:

  • None

Returns:

  • The hs.audiodevice object, or nil if an error occurred
watcherStop
Signature hs.audiodevice:watcherStop() -> hs.audiodevice
Type Method
Description

Stops the watcher on an hs.audiodevice object

Parameters:

  • None

Returns:

  • The hs.audiodevice object