# SoundGet

Retrieves various settings from a sound device (master mute, master volume, etc.)

SoundGet, OutputVar [, ComponentType, ControlType, DeviceNumber]

#### Parameters

OutputVar | The name of the variable in which to store the retrieved setting, which is either a floating point number between 0 and 100 (inclusive) or the word ON or OFF (used only for ControlTypes ONOFF, MUTE, MONO, LOUDNESS, STEREOENH, and BASSBOOST). The variable will be made blank if there was a problem retrieving the setting. The format of the floating point number, such as its decimal places, is determined by SetFormat.
ComponentType | If omitted or blank, it defaults to the word MASTER. Otherwise, it can be one of the following words: MASTER (synonymous with SPEAKERS), DIGITAL, LINE, MICROPHONE, SYNTH, CD, TELEPHONE, PCSPEAKER, WAVE, AUX, ANALOG, HEADPHONES, or N/A. If the sound device lacks the specified ComponentType, ErrorLevel will indicate the problem. The component labled Auxiliary in some mixers might be accessible as ANALOG rather than AUX. If a device has more than one instance of ComponentType (two of type LINE, for example), usually the first contains the playback settings and the second contains the recording settings. To access an instance other than the first, append a colon and a number to this parameter. For example: Analog:2 is the second instance of the analog component.
ControlType | If omitted or blank, it defaults to VOLUME. Otherwise, it can be one of the following words: VOLUME (or VOL), ONOFF, MUTE, MONO, LOUDNESS, STEREOENH, BASSBOOST, PAN, QSOUNDPAN, BASS, TREBLE, EQUALIZER, or the number of a valid control type (see soundcard analysis script). If the specified ComponentType lacks the specified ControlType, ErrorLevel will indicate the problem.
DeviceNumber | If this parameter is omitted, it defaults to 1 (the first sound device), which is usually the system's default device for recording and playback. Specify a number higher than 1 to operate upon a different sound device. This parameter can be an expression.

#### ErrorLevel

ErrorLevel is set to 0 if the command succeeded. Otherwise, it is set to one of the following phrases:

Invalid Control Type or Component Type
Can't Open Specified Mixer
Mixer Doesn't Support This Component Type
Mixer Doesn't Have That Many of That Component Type
Component Doesn't Support This Control Type
Can't Get Current Setting

#### Remarks

On Windows Vista or later, SoundGet retrieves the script's own settings, not those of the active window. This may be resolved in a future version. To work around it, in the properties dialog for the file "AutoHotkey.exe" (or a compiled script), change the compatibility setting to "Windows XP".

To discover the capabilities of the sound devices (mixers) installed on the system -- such as the available component types and control types -- run the soundcard analysis script.

Use SoundSet to change a setting.

#### Related

SoundSet, SoundGetWaveVolume, SoundSetWaveVolume, SoundPlay

#### Examples

    SoundGet, master_volume
    MsgBox, Master volume is %master_volume% percent.

    SoundGet, master_mute, , mute
    MsgBox, Master Mute is currently %master_mute%.

    SoundGet, bass_level, Master, bass
    if ErrorLevel
        MsgBox, Error Description: %ErrorLevel%
    else
        MsgBox, The BASS level for MASTER is %bass_level% percent.

    SoundGet, microphone_mute, Microphone, mute
    if microphone_mute = Off
        MsgBox, The microphone is not muted.