TeamTalk 4 .NET DLL  Version 4.5A
BearWare.WindowsMixer Class Reference

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

Static Public Member Functions

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

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
nMixerIndexThe index of the mixer. Ranging from 0 to GetMixerCount() - 1.
szMixerNameThe 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
nWaveDeviceIDThe nWaveDeviceID from the BearWare.SoundDevice struct.
szMixerNameThe 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
nWaveDeviceIDThe nWaveDeviceID from the BearWare.SoundDevice struct.
szMixerNameThe 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
nWaveDeviceIDThe nWaveDeviceID from the BearWare.SoundDevice struct.
nControlA mixer control.
bMuteTrue 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
nWaveDeviceIDThe nWaveDeviceID from the BearWare.SoundDevice struct.
nControlA 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
nWaveDeviceIDThe nWaveDeviceID from the BearWare.SoundDevice struct.
nControlA mixer control.
nVolumeA 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
nWaveDeviceIDThe nWaveDeviceID from the BearWare.SoundDevice struct.
nControlA 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
nWaveDeviceIDThe nWaveDeviceID from the BearWare.SoundDevice struct.
nControlA 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
nWaveDeviceIDThe nWaveDeviceID from the BearWare.SoundDevice struct.
nControlA 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
nWaveDeviceIDThe nWaveDeviceID from the BearWare.SoundDevice struct.
nControlA mixer control.
nVolumeA 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
nWaveDeviceIDThe nWaveDeviceID from the BearWare.SoundDevice struct.
nControlA 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
nWaveDeviceIDThe nWaveDeviceID from the BearWare.SoundDevice struct.
bEnableTRUE to enable, FALSE to disable.
static int BearWare.WindowsMixer.GetWaveInBoost ( int  nWaveDeviceID)
static

See if microphone boost is enabled.

Parameters
nWaveDeviceIDThe 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
nWaveDeviceIDThe nWaveDeviceID from the BearWare.SoundDevice struct.
bEnableTRUE to enable, FALSE to disable.
static int BearWare.WindowsMixer.GetWaveInMute ( int  nWaveDeviceID)
static

See if microphone is muted.

Parameters
nWaveDeviceIDThe 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
nWaveDeviceIDThe 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
nWaveDeviceIDThe nWaveDeviceID from the BearWare.SoundDevice struct.
nControlIndexThe index of the control. Randing from 0 to GetWaveInControlCount() - 1.
szDeviceNameThe 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
nWaveDeviceIDThe nWaveDeviceID from the BearWare.SoundDevice struct.
nControlIndexThe 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
nWaveDeviceIDThe nWaveDeviceID from the BearWare.SoundDevice struct.
nControlIndexThe index of the device. Randing from 0 to GetWaveInControlCount() - 1.
See Also
WindowsMixer.GetWaveInControlCount