BearWare.WindowsMixer Class Reference
[Windows Mixer]

A wrapper for the Windows Mixer API. More...

List of all members.

Static Public Member Functions

static int GetMixerCount ()
 Get the number of Windows Mixers available.
static bool GetMixerName (int nMixerIndex, out string szMixerName)
 Get the name of a Windows Mixer based on its name.
static bool GetWaveInName (int nWaveDeviceID, out string szMixerName)
 Get the name of the mixer associated with a wave-in device.
static bool GetWaveOutName (int nWaveDeviceID, out string szMixerName)
 Get the name of the mixer associated with a wave-out device.
static bool SetWaveOutMute (int nWaveDeviceID, MixerControl nControl, bool bMute)
 Mute or unmute a Windows Mixer Wave-Out device from the 'enum' of devices.
static int GetWaveOutMute (int nWaveDeviceID, MixerControl nControl)
 Get the mute state of a Windows Mixer Wave-Out device from the 'enum' of devices.
static bool SetWaveOutVolume (int nWaveDeviceID, MixerControl nControl, int nVolume)
 Set the volume of a Windows Mixer Wave-Out device from the 'enum' of devices.
static int GetWaveOutVolume (int nWaveDeviceID, MixerControl nControl)
 Get the volume of a Windows Mixer Wave-Out device from the 'enum' of devices.
static bool SetWaveInSelected (int nWaveDeviceID, MixerControl nControl)
 Set the selected state of a Windows Mixer Wave-In device from the 'enum' of devices.
static int GetWaveInSelected (int nWaveDeviceID, MixerControl nControl)
 Get the selected state of a Windows Mixer Wave-In device from the 'enum' of devices.
static bool SetWaveInVolume (int nWaveDeviceID, MixerControl nControl, int nVolume)
 Set the volume of a Windows Mixer Wave-In device from the 'enum' of devices.
static int GetWaveInVolume (int nWaveDeviceID, MixerControl nControl)
 Get the volume of a Windows Mixer Wave-In device from the 'enum' of devices.
static bool SetWaveInBoost (int nWaveDeviceID, bool bEnable)
 Enable and disable microphone boost.
static int GetWaveInBoost (int nWaveDeviceID)
 See if microphone boost is enabled.
static bool SetWaveInMute (int nWaveDeviceID, bool bEnable)
 Mute/unmute microphone input.
static int GetWaveInMute (int nWaveDeviceID)
 See if microphone is muted.
static int GetWaveInControlCount (int nWaveDeviceID)
 Get the number of Windows Mixer Wave-In devices.
static bool GetWaveInControlName (int nWaveDeviceID, int nControlIndex, out string szDeviceName)
 Get the name of the Wave-In device with the specified index.
static bool SetWaveInControlSelected (int nWaveDeviceID, int nControlIndex)
 Set the selected state of a Wave-In device in the Windows Mixer.
static bool GetWaveInControlSelected (int nWaveDeviceID, int nControlIndex)
 Get the selected state of a Wave-In device in the Windows Mixer.

Detailed Description

A wrapper for the Windows Mixer API.


Member Function Documentation

static int BearWare.WindowsMixer.GetMixerCount (  )  [static]

Get the number of Windows Mixers available.

The index from 0 to GetMixerCount() - 1 should be passed to the WindowsMixer.* functions.

See also:
WindowsMixer.GetMixerName
static bool BearWare.WindowsMixer.GetMixerName ( int  nMixerIndex,
out string  szMixerName 
) [static]

Get the name of a Windows Mixer based on its name.

Parameters:
nMixerIndex The index of the mixer. Ranging from 0 to GetMixerCount() - 1.
szMixerName The output string receiving the name of the device.
static bool BearWare.WindowsMixer.GetWaveInName ( int  nWaveDeviceID,
out string  szMixerName 
) [static]

Get the name of the mixer associated with a wave-in device.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
szMixerName The output string receiving the name of the device.
See also:
TeamTalk4.GetSoundInputDevices
static bool BearWare.WindowsMixer.GetWaveOutName ( int  nWaveDeviceID,
out string  szMixerName 
) [static]

Get the name of the mixer associated with a wave-out device.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
szMixerName The output string receiving the name of the device.
See also:
TeamTalk4.GetSoundOutputDevices
static bool BearWare.WindowsMixer.SetWaveOutMute ( int  nWaveDeviceID,
MixerControl  nControl,
bool  bMute 
) [static]

Mute or unmute a Windows Mixer Wave-Out device from the 'enum' of devices.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
nControl A mixer control.
bMute True if device should be muted, False if it should be unmuted.
See also:
WindowsMixer.GetWaveOutMute
static int BearWare.WindowsMixer.GetWaveOutMute ( int  nWaveDeviceID,
MixerControl  nControl 
) [static]

Get the mute state of a Windows Mixer Wave-Out device from the 'enum' of devices.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
nControl A mixer control.
Returns:
TRUE if mute, FALSE if unmuted, -1 on error.
See also:
WindowsMixer.SetWaveOutMute
static bool BearWare.WindowsMixer.SetWaveOutVolume ( int  nWaveDeviceID,
MixerControl  nControl,
int  nVolume 
) [static]

Set the volume of a Windows Mixer Wave-Out device from the 'enum' of devices.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
nControl A mixer control.
nVolume A value ranging from 0 to 65535.
static int BearWare.WindowsMixer.GetWaveOutVolume ( int  nWaveDeviceID,
MixerControl  nControl 
) [static]

Get the volume of a Windows Mixer Wave-Out device from the 'enum' of devices.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
nControl A mixer control.
Returns:
A value ranging from 0 to 65535, or -1 on error.
static bool BearWare.WindowsMixer.SetWaveInSelected ( int  nWaveDeviceID,
MixerControl  nControl 
) [static]

Set the selected state of a Windows Mixer Wave-In device from the 'enum' of devices.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
nControl A mixer control.
static int BearWare.WindowsMixer.GetWaveInSelected ( int  nWaveDeviceID,
MixerControl  nControl 
) [static]

Get the selected state of a Windows Mixer Wave-In device from the 'enum' of devices.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
nControl A mixer control.
Returns:
TRUE if mute, FALSE if unmuted, -1 on error.
static bool BearWare.WindowsMixer.SetWaveInVolume ( int  nWaveDeviceID,
MixerControl  nControl,
int  nVolume 
) [static]

Set the volume of a Windows Mixer Wave-In device from the 'enum' of devices.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
nControl A mixer control.
nVolume A value ranging from 0 to 65535.
static int BearWare.WindowsMixer.GetWaveInVolume ( int  nWaveDeviceID,
MixerControl  nControl 
) [static]

Get the volume of a Windows Mixer Wave-In device from the 'enum' of devices.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
nControl A mixer control.
Returns:
A value ranging from 0 to 65535, or -1 on error.
static bool BearWare.WindowsMixer.SetWaveInBoost ( int  nWaveDeviceID,
bool  bEnable 
) [static]

Enable and disable microphone boost.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
bEnable TRUE to enable, FALSE to disable.
static int BearWare.WindowsMixer.GetWaveInBoost ( int  nWaveDeviceID  )  [static]

See if microphone boost is enabled.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
Returns:
TRUE if boost is enabled, FALSE if disabled, -1 on error.
static bool BearWare.WindowsMixer.SetWaveInMute ( int  nWaveDeviceID,
bool  bEnable 
) [static]

Mute/unmute microphone input.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
bEnable TRUE to enable, FALSE to disable.
static int BearWare.WindowsMixer.GetWaveInMute ( int  nWaveDeviceID  )  [static]

See if microphone is muted.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
Returns:
TRUE if mute is enabled, FALSE if disabled, -1 on error.
static int BearWare.WindowsMixer.GetWaveInControlCount ( int  nWaveDeviceID  )  [static]

Get the number of Windows Mixer Wave-In devices.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
See also:
WindowsMixer.GetWaveInControlName
WindowsMixer.SetWaveInControlSelected
WindowsMixer.GetWaveInControlSelected
static bool BearWare.WindowsMixer.GetWaveInControlName ( int  nWaveDeviceID,
int  nControlIndex,
out string  szDeviceName 
) [static]

Get the name of the Wave-In device with the specified index.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
nControlIndex The index of the control. Randing from 0 to GetWaveInControlCount() - 1.
szDeviceName The output string of the name of the device.
See also:
WindowsMixer.GetWaveInControlCount
static bool BearWare.WindowsMixer.SetWaveInControlSelected ( int  nWaveDeviceID,
int  nControlIndex 
) [static]

Set the selected state of a Wave-In device in the Windows Mixer.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
nControlIndex The index of the device. Randing from 0 to GetWaveInControlCount() - 1.
See also:
WindowsMixer.GetWaveInControlCount
static bool BearWare.WindowsMixer.GetWaveInControlSelected ( int  nWaveDeviceID,
int  nControlIndex 
) [static]

Get the selected state of a Wave-In device in the Windows Mixer.

Parameters:
nWaveDeviceID The nWaveDeviceID from the BearWare.SoundDevice struct.
nControlIndex The index of the device. Randing from 0 to GetWaveInControlCount() - 1.
See also:
WindowsMixer.GetWaveInControlCount
Generated on Sun Mar 18 17:16:15 2012 for TeamTalk 4 .NET DLL by  doxygen 1.6.3