TeamTalk 5 C-API DLL: Windows Mixer

TeamTalk 5 C-API DLL Version 5.18A

Loading...
Searching...
No Matches
Typedefs | Enumerations | Functions
Windows Mixer

This section explains how to control the Windows mixer. More...

## Typedefs

typedef enum MixerControl | MixerControl
| The Windows mixer controls which can be queried by the TT_Mixer_* functions.

## Enumerations

enum | MixerControl { WAVEOUT_MASTER , WAVEOUT_WAVE , WAVEOUT_MICROPHONE , WAVEIN_MICROPHONE , WAVEIN_LINEIN , WAVEIN_WAVEOUT }
| The Windows mixer controls which can be queried by the TT_Mixer_* functions. More...

## Functions

TEAMTALKDLL_API INT32 | TT_Mixer_GetMixerCount (void)
| Get the number of Windows Mixers available.
TEAMTALKDLL_API TTBOOL | TT_Mixer_GetMixerName (IN INT32 nMixerIndex, OUT TTCHAR szMixerName[TT_STRLEN])
| Get the name of a Windows Mixer based on its name.
TEAMTALKDLL_API TTBOOL | TT_Mixer_GetWaveInName (IN INT32 nWaveDeviceID, OUT TTCHAR szMixerName[TT_STRLEN])
| Get the name of the mixer associated with a wave-in device.
TEAMTALKDLL_API TTBOOL | TT_Mixer_GetWaveOutName (IN INT32 nWaveDeviceID, OUT TTCHAR szMixerName[TT_STRLEN])
| Get the name of the mixer associated with a wave-out device.
TEAMTALKDLL_API TTBOOL | TT_Mixer_SetWaveOutMute (IN INT32 nWaveDeviceID, IN MixerControl nControl, IN TTBOOL bMute)
| Mute or unmute a Windows Mixer Wave-Out device from the 'enum' of devices.
TEAMTALKDLL_API INT32 | TT_Mixer_GetWaveOutMute (IN INT32 nWaveDeviceID, IN MixerControl nControl)
| Get the mute state of a Windows Mixer Wave-Out device from the 'enum' of devices.
TEAMTALKDLL_API TTBOOL | TT_Mixer_SetWaveOutVolume (IN INT32 nWaveDeviceID, IN MixerControl nControl, IN INT32 nVolume)
| Set the volume of a Windows Mixer Wave-Out device from the 'enum' of devices.
TEAMTALKDLL_API INT32 | TT_Mixer_GetWaveOutVolume (IN INT32 nWaveDeviceID, IN MixerControl nControl)
| Get the volume of a Windows Mixer Wave-Out device from the 'enum' of devices.
TEAMTALKDLL_API TTBOOL | TT_Mixer_SetWaveInSelected (IN INT32 nWaveDeviceID, IN MixerControl nControl)
| Set the selected state of a Windows Mixer Wave-In device from the 'enum' of devices.
TEAMTALKDLL_API INT32 | TT_Mixer_GetWaveInSelected (IN INT32 nWaveDeviceID, IN MixerControl nControl)
| Get the selected state of a Windows Mixer Wave-In device from the 'enum' of devices.
TEAMTALKDLL_API TTBOOL | TT_Mixer_SetWaveInVolume (IN INT32 nWaveDeviceID, IN MixerControl nControl, IN INT32 nVolume)
| Set the volume of a Windows Mixer Wave-In device from the 'enum' of devices.
TEAMTALKDLL_API INT32 | TT_Mixer_GetWaveInVolume (IN INT32 nWaveDeviceID, IN MixerControl nControl)
| Get the volume of a Windows Mixer Wave-In device from the 'enum' of devices.
TEAMTALKDLL_API TTBOOL | TT_Mixer_SetWaveInBoost (IN INT32 nWaveDeviceID, IN TTBOOL bEnable)
| Enable and disable microphone boost.
TEAMTALKDLL_API INT32 | TT_Mixer_GetWaveInBoost (IN INT32 nWaveDeviceID)
| See if microphone boost is enabled.
TEAMTALKDLL_API TTBOOL | TT_Mixer_SetWaveInMute (IN INT32 nWaveDeviceID, IN TTBOOL bEnable)
| Mute/unmute microphone input.
TEAMTALKDLL_API INT32 | TT_Mixer_GetWaveInMute (IN INT32 nWaveDeviceID)
| See if microphone is muted.
TEAMTALKDLL_API INT32 | TT_Mixer_GetWaveInControlCount (IN INT32 nWaveDeviceID)
| Get the number of Windows Mixer Wave-In devices.
TEAMTALKDLL_API TTBOOL | TT_Mixer_GetWaveInControlName (IN INT32 nWaveDeviceID, IN INT32 nControlIndex, OUT TTCHAR szDeviceName[TT_STRLEN])
| Get the name of the Wave-In device with the specified index.
TEAMTALKDLL_API TTBOOL | TT_Mixer_SetWaveInControlSelected (IN INT32 nWaveDeviceID, IN INT32 nControlIndex)
| Set the selected state of a Wave-In device in the Windows Mixer.
TEAMTALKDLL_API TTBOOL | TT_Mixer_GetWaveInControlSelected (IN INT32 nWaveDeviceID, IN INT32 nControlIndex)
| Get the selected state of a Wave-In device in the Windows Mixer.

## Detailed Description

This section explains how to control the Windows mixer.

The Windows mixer can be manipulated so e.g. Line In can be chosen instead of Microphone for recording.

To find the mixer which is associated with the current sound input or output device the nWaveDeviceID member of SoundDevice must be used when querying the mixer.

## Typedef Documentation

## ◆ MixerControl

typedef enum MixerControl MixerControl

The Windows mixer controls which can be queried by the TT_Mixer_* functions.

Wave-In devices which are not in the enum-structure can be accessed by TT_Mixer_GetWaveInControlCount which allows the user to query selection based on an index.

Note that Windows Vista has deprecated mixer controls.

See also
  TT_Mixer_SetWaveOutMute
  TT_Mixer_SetWaveOutVolume
  TT_Mixer_SetWaveInSelected
  TT_Mixer_SetWaveInVolume
  TT_Mixer_GetWaveInControlName
  TT_Mixer_SetWaveInControlSelected

## Enumeration Type Documentation

## ◆ MixerControl

enum MixerControl

The Windows mixer controls which can be queried by the TT_Mixer_* functions.

Wave-In devices which are not in the enum-structure can be accessed by TT_Mixer_GetWaveInControlCount which allows the user to query selection based on an index.

Note that Windows Vista has deprecated mixer controls.

See also
  TT_Mixer_SetWaveOutMute
  TT_Mixer_SetWaveOutVolume
  TT_Mixer_SetWaveInSelected
  TT_Mixer_SetWaveInVolume
  TT_Mixer_GetWaveInControlName
  TT_Mixer_SetWaveInControlSelected

Enumerator
WAVEOUT_MASTER |
WAVEOUT_WAVE |
WAVEOUT_MICROPHONE |
WAVEIN_MICROPHONE |
WAVEIN_LINEIN |
WAVEIN_WAVEOUT |

Definition at line 7911 of file TeamTalk.h.

## Function Documentation

## ◆ TT_Mixer_GetMixerCount()

TEAMTALKDLL_API INT32 TT_Mixer_GetMixerCount | ( | void |  | ) |

Get the number of Windows Mixers available.

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

See also
  TT_Mixer_GetMixerName

## ◆ TT_Mixer_GetMixerName()

TEAMTALKDLL_API TTBOOL TT_Mixer_GetMixerName | ( | IN INT32 | nMixerIndex,
|  | OUT TTCHAR | szMixerName[TT_STRLEN] )

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

Parameters

  nMixerIndex | The index of the mixer. Ranging from 0 to TT_Mixer_GetMixerCount()-1.
  szMixerName | The output string receiving the name of the device.

## ◆ TT_Mixer_GetWaveInName()

TEAMTALKDLL_API TTBOOL TT_Mixer_GetWaveInName | ( | IN INT32 | nWaveDeviceID,
|  | OUT TTCHAR | szMixerName[TT_STRLEN] )

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

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.
  szMixerName | The output string receiving the name of the device.

See also
  TT_GetSoundDevices()

## ◆ TT_Mixer_GetWaveOutName()

TEAMTALKDLL_API TTBOOL TT_Mixer_GetWaveOutName | ( | IN INT32 | nWaveDeviceID,
|  | OUT TTCHAR | szMixerName[TT_STRLEN] )

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

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.
  szMixerName | The output string receiving the name of the device.

See also
  TT_GetSoundDevices

## ◆ TT_Mixer_SetWaveOutMute()

TEAMTALKDLL_API TTBOOL TT_Mixer_SetWaveOutMute | ( | IN INT32 | nWaveDeviceID,
|  | IN MixerControl | nControl,
|  | IN TTBOOL | bMute )

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

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.
  nControl | A mixer control.
  bMute | True if device should be muted, False if it should be unmuted.

See also
  TT_Mixer_GetWaveOutMute

## ◆ TT_Mixer_GetWaveOutMute()

TEAMTALKDLL_API INT32 TT_Mixer_GetWaveOutMute | ( | IN INT32 | nWaveDeviceID,
|  | IN MixerControl | nControl )

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

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.
  nControl | A mixer control.

Returns
  TRUE if mute, FALSE if unmuted, -1 on error.

See also
  TT_Mixer_SetWaveOutMute

## ◆ TT_Mixer_SetWaveOutVolume()

TEAMTALKDLL_API TTBOOL TT_Mixer_SetWaveOutVolume | ( | IN INT32 | nWaveDeviceID,
|  | IN MixerControl | nControl,
|  | IN INT32 | nVolume )

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

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.
  nControl | A mixer control.
  nVolume | A value ranging from 0 to 65535.

## ◆ TT_Mixer_GetWaveOutVolume()

TEAMTALKDLL_API INT32 TT_Mixer_GetWaveOutVolume | ( | IN INT32 | nWaveDeviceID,
|  | IN MixerControl | nControl )

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

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.
  nControl | A mixer control.

Returns
  A value ranging from 0 to 65535, or -1 on error.

## ◆ TT_Mixer_SetWaveInSelected()

TEAMTALKDLL_API TTBOOL TT_Mixer_SetWaveInSelected | ( | IN INT32 | nWaveDeviceID,
|  | IN MixerControl | nControl )

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

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.
  nControl | A mixer control.

## ◆ TT_Mixer_GetWaveInSelected()

TEAMTALKDLL_API INT32 TT_Mixer_GetWaveInSelected | ( | IN INT32 | nWaveDeviceID,
|  | IN MixerControl | nControl )

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

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.
  nControl | A mixer control.

Returns
  TRUE if mute, FALSE if unmuted, -1 on error.

## ◆ TT_Mixer_SetWaveInVolume()

TEAMTALKDLL_API TTBOOL TT_Mixer_SetWaveInVolume | ( | IN INT32 | nWaveDeviceID,
|  | IN MixerControl | nControl,
|  | IN INT32 | nVolume )

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

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.
  nControl | A mixer control.
  nVolume | A value ranging from 0 to 65535.

## ◆ TT_Mixer_GetWaveInVolume()

TEAMTALKDLL_API INT32 TT_Mixer_GetWaveInVolume | ( | IN INT32 | nWaveDeviceID,
|  | IN MixerControl | nControl )

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

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.
  nControl | A mixer control.

Returns
  A value ranging from 0 to 65535, or -1 on error.

## ◆ TT_Mixer_SetWaveInBoost()

TEAMTALKDLL_API TTBOOL TT_Mixer_SetWaveInBoost | ( | IN INT32 | nWaveDeviceID,
|  | IN TTBOOL | bEnable )

Enable and disable microphone boost.

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.
  bEnable | TRUE to enable, FALSE to disable.

## ◆ TT_Mixer_GetWaveInBoost()

TEAMTALKDLL_API INT32 TT_Mixer_GetWaveInBoost | ( | IN INT32 | nWaveDeviceID | ) |

See if microphone boost is enabled.

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.

Returns
  TRUE if boost is enabled, FALSE if disabled, -1 on error.

## ◆ TT_Mixer_SetWaveInMute()

TEAMTALKDLL_API TTBOOL TT_Mixer_SetWaveInMute | ( | IN INT32 | nWaveDeviceID,
|  | IN TTBOOL | bEnable )

Mute/unmute microphone input.

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.
  bEnable | TRUE to enable, FALSE to disable.

## ◆ TT_Mixer_GetWaveInMute()

TEAMTALKDLL_API INT32 TT_Mixer_GetWaveInMute | ( | IN INT32 | nWaveDeviceID | ) |

See if microphone is muted.

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.

Returns
  TRUE if mute is enabled, FALSE if disabled, -1 on error.

## ◆ TT_Mixer_GetWaveInControlCount()

TEAMTALKDLL_API INT32 TT_Mixer_GetWaveInControlCount | ( | IN INT32 | nWaveDeviceID | ) |

Get the number of Windows Mixer Wave-In devices.

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.

Returns
  Number of controls, or -1 on error.

See also
  TT_Mixer_GetWaveInControlName
  TT_Mixer_SetWaveInControlSelected
  TT_Mixer_GetWaveInControlSelected

## ◆ TT_Mixer_GetWaveInControlName()

TEAMTALKDLL_API TTBOOL TT_Mixer_GetWaveInControlName | ( | IN INT32 | nWaveDeviceID,
|  | IN INT32 | nControlIndex,
|  | OUT TTCHAR | szDeviceName[TT_STRLEN] )

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

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.
  nControlIndex | The index of the control. Randing from 0 to TT_Mixer_GetWaveInControlCount()-1.
  szDeviceName | The output string of the name of the device.

See also
  TT_Mixer_GetWaveInControlCount

## ◆ TT_Mixer_SetWaveInControlSelected()

TEAMTALKDLL_API TTBOOL TT_Mixer_SetWaveInControlSelected | ( | IN INT32 | nWaveDeviceID,
|  | IN INT32 | nControlIndex )

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

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.
  nControlIndex | The index of the device. Randing from 0 to TT_Mixer_GetWaveInControlCount()-1.

See also
  TT_Mixer_GetWaveInControlCount

## ◆ TT_Mixer_GetWaveInControlSelected()

TEAMTALKDLL_API TTBOOL TT_Mixer_GetWaveInControlSelected | ( | IN INT32 | nWaveDeviceID,
|  | IN INT32 | nControlIndex )

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

Parameters

  nWaveDeviceID | The nWaveDeviceID from the SoundDevice struct.
  nControlIndex | The index of the device. Randing from 0 to TT_Mixer_GetWaveInControlCount()-1.

Returns
  TRUE if selected, FALSE if unselected, -1 on error.

See also
  TT_Mixer_GetWaveInControlCount