docs » hs.audiodevice

Returns a list of all connected devices

• None

• A table of zero or more audio devices connected to the system

Returns a list of all connected input devices.

• None

• A table of zero or more audio input devices connected to the system

Returns a list of all connected output devices

• None

• A table of zero or more audio output devices connected to the system

Fetch various metadata about the current default audio devices

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

• A table with the following contents:

{
        name = defaultOutputDevice():name(),
        uid = module.defaultOutputDevice():uid(),
        muted = defaultOutputDevice():muted(),
        volume = defaultOutputDevice():volume(),
        device = defaultOutputDevice(),
    }

Get the currently selected sound effect device

• None

• An hs.audiodevice object, or nil if no suitable device could be found

Get the currently selected audio input device

• None

• An hs.audiodevice object, or nil if no suitable device could be found

Get the currently selected audio output device

• None

• An hs.audiodevice object, or nil if no suitable device could be found

Find an audio device by name

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

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

Find an audio device by UID

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

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

Find an audio input device by name

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

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

Find an audio input device by UID

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

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

Find an audio output device by name

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

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

Find an audio output device by UID

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

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

Gets all of the input data sources of an audio device

• None

• A list of hs.audiodevice.dataSource objects, or nil if an error occurred

Gets all of the output data sources of an audio device

• None

• A list of hs.audiodevice.dataSource objects, or nil if an error occurred

Get the current left/right balance of this audio device

• None

• A number between 0.0 and 1.0, representing the balance (0.0 for full left, 1.0 for full right, 0.5 for center), or nil if the audio device does not support balance

• 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()

Gets the current input data source of an audio device

• None

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

• Before calling this method, you should check the result of hs.audiodevice:supportsInputDataSources()

Gets the current output data source of an audio device

• None

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

• Before calling this method, you should check the result of hs.audiodevice:supportsOutputDataSources()

Get the Input mutedness state of the audio device

• None

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

Get the current input volume of this audio device

• None

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

• The return value will be a floating point number

Check if the audio device is in use

• None

• True if the audio device is in use, False if not. nil if an error occurred.

Determines if an audio device is an input device

• None

• A boolean, true if the device is an input device, false if not

Determines if an audio device is an output device

• None

• A boolean, true if the device is an output device, false if not

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

• None

• A boolean, true if a jack is connected, false if not, or nil if the device does not support jack sense

Get the mutedness state of the audio device

• None

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

• If a device is capable of both input and output, this method will prefer the output. See :inputMuted() and :outputMuted() for specific variants.

Get the name of the audio device

• None

• A string containing the name of the audio device, or nil if it has no name

Get the Output mutedness state of the audio device

• None

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

Get the current output volume of this audio device

• None

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

• The return value will be a floating point number

Set the balance of this audio device

• level - A number between 0.0 and 1.0, representing the balance (0.0 for full left, 1.0 for full right, 0.5 for center)

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

• 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()

Selects this device as the audio output device for system sound effects

• None

• True if the audio device was successfully selected, otherwise false.

Selects this device as the system's audio input device

• None

• True if the audio device was successfully selected, otherwise false.

Selects this device as the system's audio output device

• None

• True if the audio device was successfully selected, otherwise false.

Set the mutedness state of the Input of the audio device

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

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

Set the input volume of this audio device

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

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

• 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

Set the mutedness state of the audio device

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

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

• If a device is capable of both input and output, this method will prefer the output. See :setInputMuted() and :setOutputMuted() for specific variants.

Set the mutedness state of the Output of the audio device

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

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

Set the output volume of this audio device

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

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

• 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

Set the volume of this audio device

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

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

• 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()

Determines whether an audio device supports input data sources

• None

• A boolean, true if the device supports input data sources, false if not

Determines whether an audio device supports output data sources

• None

• A boolean, true if the device supports output data sources, false if not

Gets the hardware transport type of an audio device

• None

• A string containing the transport type, or nil if an error occurred

Get the unique identifier of the audio device

• None

• A string containing the UID of the audio device, or nil if it has no UID.

Get the current volume of this audio device

• None

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

• 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()

Sets or removes a callback function for an audio device watcher

• 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)
  • gone - The device's "in use" status changed (ie another app started using the device, or stopped using it)
  • 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

• The hs.audiodevice object

• 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

Gets the status of the hs.audiodevice object watcher

• None

• A boolean, true if the watcher is running, false if not

Starts the watcher on an hs.audiodevice object

• None

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

Stops the watcher on an hs.audiodevice object

• None

• The hs.audiodevice object